Torque3D Documentation / _generateds / GFXStateBlockDesc

GFXStateBlockDesc

Engine/source/gfx/gfxStateBlock.h

GFXStateBlockDesc defines a render state, which is then used to create a GFXStateBlock instance.

More...

Public Functions

Adds data from desc to this description, uses *defined parameters in desc to figure out what blocks of state to actually copy from desc.

Returns a string that describes the options set (used by GFXStateBlock::describeSelf)

Returns the hash value of this state description.

setAlphaTest(bool enable, GFXCmpFunc func, S32 alphaRef)
setBlend(bool enable, GFXBlend src, GFXBlend dest, GFXBlendOp op)
setColorWrites(bool red, bool green, bool blue, bool alpha)

Utility functions to make setting up stateblock descriptions less wordy.

Helpers for setting the fill modes.

setZReadWrite(bool read, bool write)

Detailed Description

GFXStateBlockDesc defines a render state, which is then used to create a GFXStateBlock instance.

Separate Alpha Blending

bool separateAlphaBlendDefined 
bool separateAlphaBlendEnable 
GFXBlend separateAlphaBlendSrc 
GFXBlend separateAlphaBlendDest 
GFXBlendOp separateAlphaBlendOp 

Public Attributes

bool alphaDefined 
bool alphaTestEnable 
GFXCmpFunc alphaTestFunc 
S32 alphaTestRef 
bool blendDefined 
GFXBlend blendDest 
bool blendEnable 
GFXBlendOp blendOp 
GFXBlend blendSrc 
bool colorWriteAlpha 
bool colorWriteBlue 
bool colorWriteDefined 
bool colorWriteGreen 
bool colorWriteRed 
bool cullDefined 
GFXCullMode cullMode 
GFXFillMode fillMode 
GFXSamplerStateDesc samplers [GFX_TEXTURE_STAGE_COUNT]
bool samplersDefined 
bool stencilDefined 
bool stencilEnable 
GFXStencilOp stencilFailOp 
GFXCmpFunc stencilFunc 
U32 stencilMask 
GFXStencilOp stencilPassOp 
U32 stencilRef 
U32 stencilWriteMask 
GFXStencilOp stencilZFailOp 
ColorI textureFactor 
bool vertexColorEnable 
F32 zBias 
bool zDefined 
bool zEnable 
GFXCmpFunc zFunc 
F32 zSlopeBias 
bool zWriteEnable 

Public Functions

GFXStateBlockDesc()

GFXStateBlockDesc.

addDesc(const GFXStateBlockDesc & desc)

Adds data from desc to this description, uses *defined parameters in desc to figure out what blocks of state to actually copy from desc.

describeSelf()

Returns a string that describes the options set (used by GFXStateBlock::describeSelf)

getHashValue()

Returns the hash value of this state description.

setAlphaTest(bool enable, GFXCmpFunc func, S32 alphaRef)

setBlend(bool enable, GFXBlend src, GFXBlend dest, GFXBlendOp op)

setColorWrites(bool red, bool green, bool blue, bool alpha)

setCullMode(GFXCullMode m)

Utility functions to make setting up stateblock descriptions less wordy.

setFillModePoint()

Helpers for setting the fill modes.

setFillModeSolid()

setFillModeWireframe()

setSeparateAlphaBlend(bool enable, GFXBlend src, GFXBlend dest, GFXBlendOp op)

setZReadWrite(bool read, bool write)