Viewport

Scaleform::Render::Viewport

Declaration

class Viewport;

Description

Base class for 2D graphics rendering, used through subclasses Render::D3D9, Render::GL, etc.

Note that viewport requires BufferWidth and BufferHeight values to be provided in addition to the actual viewport rectangle. These values are necessary because they cannot be obtained consistently under all APIs. For render target textures, buffer size is the original render texture size. For a window, buffer should be the size of the client area.

HAL Viewport.

Note that Scale and AspectRatio variables have been removed from HAL viewport. These variables should be applied as a part of Flash scaling by ViewMatrix which can be a part of RootNode and converts Flash coordinate system into the pixel-based one used by HAL.

Data Members

Data Member	Description
BufferHeight	The height of the buffer surface within which a viewport is located.
BufferWidth	The width of the buffer surface within which a viewport is located.
Flags	View flags describing how viewport and its target buffer are used, such as View_IsRenderTexture and View_AlphaComposite.
Height	Height of the viewport rectangle in pixels.
Left	The left side of the viewport rectangle, counting in pixels from the left.
ScissorHeight	The height of the scissor rectangle in pixels.
ScissorWidth	The width of the scissor rectangle in pixels.
ScissorLeft	The left side of the scissor rectangle, counting in pixels from the left. Scissor left are in the same coordinate system as Left (in buffer's ones).
ScissorTop	The top side of the scissor rectangle, counting in pixels from the top. Scissor top are in the same coordinate system as Top (in buffer's ones).
Top	The top side of the viewport rectangle, counting in pixels from the top.
Width	Width of the viewport rectangle in pixels.

Methods

Method	Description
Viewport	Viewport constructor.
GetClippedRect	Calculates the clipped viewport rectangle.
GetCullRectF	Obtains the rectangle that will be used for calling, in viewport-relative coordinates (floating-point).
IsValid	Determines whether the viewport is valid.
SetStereoViewport	Sets the stereo viewport (for split buffer stereo rendering).
Viewport	Viewport constructor.
SetScissorRect	Initializes a scissor rectangle.
ScaleToViewport	Scales a bound rectangle into viewport space.
scaleX	Helper function to scale a normalized clip-space X value to viewport coordinates.
scaleY	Helper function to scale a normalized clip-space Y value to viewport coordinates.

Topics

Topic	Description
Viewport::enum	Describes the flags set in Viewport.

File

Render_Viewport.h