HMatrix

Scaleform::Render::MatrixPoolImpl

Scaleform::Render::MatrixPoolImpl::HMatrix

Declaration

class HMatrix : public HMatrixConstants;

Description

HMatrix is a handle to multi-item matrix set reference allocated from MatrixPool (memory pool used for storing matrices and Cxforms) and used by renderer back-end. Using handles allows matrix data set to have optional components (Cxforms and T0/T1 texture matrices are not allocated unless used) and allows matrix memory to be defragmented through a memory squeeze.

Matrix data managed by the matrix pool is accessed through HMatrix handle objects, which have accessors such as GetMatrix2D/SetMatrix2D, GetCxform/SetCxform and GetTextureMatrix/SetTextureMatrix.

Methods

Method	Description
Clear	Resets the matrix values to 0.
GetCxform	Returns the color transformation matrix applied to the rendering.
GetFormatBits	Returns the bits encoded for matrix components.
GetMatrix2D	Returns the 2D transform matrix applied to the rendering.
GetMatrix3D	Returns the 3D transform matrix applied to the rendering.
GetTextureMatrix	Returns the T0/T1 texture transform matrices used for rendering.
GetUserData	Returns user data pointer or Null if not available.
GetUserDataFloat	Returns user data pointer or Null if not available.
HasCxform	Determines whether a color transform matrix is applied while rendering.
HasUserData	Determines whether there is user data in the HMatrix.
HasTextureMatrix	Determines whether texture matrices are allocated for the renderer.
Has3D	Indicates whether the object has a 3D transform applied to it.
HMatrix	HMatrix constructor.
IsNull	Returns true if the null handle points to identity matrix.
SetCxform	Sets the color transformation matrix applied to the rendering.
SetMatrix2D	Sets the 2D transform matrix applied to the rendering.
SetMatrix3D	Sets the 3D transform matrix applied to the rendering.
SetTextureMatrix	Sets the T0/T1 texture transform matrices used for rendering.
SetUserData	Writes user data into user matrix.
SetUserDataFloat	Writes user data into user matrix.

File

Render_MatrixPool.h