GFXStateBlockDesc Struct Reference

#include <gfxStateBlock.h>

Detailed Description

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

Public Member Functions

GFXStateBlockDesc ()

U32 getHashValue () const

Returns the hash value of this state description.

void 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.

const String describeSelf () const

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

void setCullMode (const GFXCullMode m)

Utility functions to make setting up stateblock descriptions less wordy.

void setZEnable (const bool enable)

void setAlphaTest (const bool enable, const GFXCmpFunc func, const S32 alphaRef)

void setBlend (const bool enable, const GFXBlend src, const GFXBlend dest)

Public Attributes

bool blendDefined

bool blendEnable

GFXBlend blendSrc

GFXBlend blendDest

GFXBlendOp blendOp

bool alphaDefined

bool alphaTestEnable

S32 alphaTestRef

GFXCmpFunc alphaTestFunc

bool colorWriteDefined

bool colorWriteRed

bool colorWriteBlue

bool colorWriteGreen

bool colorWriteAlpha

bool cullDefined

GFXCullMode cullMode

bool zDefined

bool zEnable

bool zWriteEnable

GFXCmpFunc zFunc

F32 zBias

F32 zSlopeBias

bool stencilDefined

bool stencilEnable

GFXStencilOp stencilFailOp

GFXStencilOp stencilZFailOp

GFXStencilOp stencilPassOp

GFXCmpFunc stencilFunc

U32 stencilRef

U32 stencilMask

U32 stencilWriteMask

bool ffLighting

bool vertexColorEnable

GFXFillMode fillMode

bool samplersDefined

GFXSamplerStateDesc samplers [TEXTURE_STAGE_COUNT]

ColorI textureFactor

Constructor & Destructor Documentation

GFXStateBlockDesc::GFXStateBlockDesc ( )

Member Function Documentation

U32 GFXStateBlockDesc::getHashValue ( ) const

Returns the hash value of this state description.

void 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.

const String GFXStateBlockDesc::describeSelf ( ) const

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

void GFXStateBlockDesc::setCullMode ( const GFXCullMode m )

Utility functions to make setting up stateblock descriptions less wordy.

void GFXStateBlockDesc::setZEnable ( const bool enable )

void GFXStateBlockDesc::setAlphaTest	(	const bool	enable,
		const GFXCmpFunc	func,
		const S32	alphaRef
	)

void GFXStateBlockDesc::setBlend	(	const bool	enable,
		const GFXBlend	src,
		const GFXBlend	dest
	)

Member Data Documentation

bool GFXStateBlockDesc::blendDefined

bool GFXStateBlockDesc::blendEnable

GFXBlend GFXStateBlockDesc::blendSrc

GFXBlend GFXStateBlockDesc::blendDest

GFXBlendOp GFXStateBlockDesc::blendOp

bool GFXStateBlockDesc::alphaDefined

bool GFXStateBlockDesc::alphaTestEnable

S32 GFXStateBlockDesc::alphaTestRef

GFXCmpFunc GFXStateBlockDesc::alphaTestFunc

bool GFXStateBlockDesc::colorWriteDefined

bool GFXStateBlockDesc::colorWriteRed

bool GFXStateBlockDesc::colorWriteBlue

bool GFXStateBlockDesc::colorWriteGreen

bool GFXStateBlockDesc::colorWriteAlpha

bool GFXStateBlockDesc::cullDefined

GFXCullMode GFXStateBlockDesc::cullMode

bool GFXStateBlockDesc::zDefined

bool GFXStateBlockDesc::zEnable

bool GFXStateBlockDesc::zWriteEnable

GFXCmpFunc GFXStateBlockDesc::zFunc

F32 GFXStateBlockDesc::zBias

F32 GFXStateBlockDesc::zSlopeBias

bool GFXStateBlockDesc::stencilDefined

bool GFXStateBlockDesc::stencilEnable

GFXStencilOp GFXStateBlockDesc::stencilFailOp

GFXStencilOp GFXStateBlockDesc::stencilZFailOp

GFXStencilOp GFXStateBlockDesc::stencilPassOp

GFXCmpFunc GFXStateBlockDesc::stencilFunc

U32 GFXStateBlockDesc::stencilRef

U32 GFXStateBlockDesc::stencilMask

U32 GFXStateBlockDesc::stencilWriteMask

bool GFXStateBlockDesc::ffLighting

bool GFXStateBlockDesc::vertexColorEnable

GFXFillMode GFXStateBlockDesc::fillMode

bool GFXStateBlockDesc::samplersDefined

GFXSamplerStateDesc GFXStateBlockDesc::samplers[TEXTURE_STAGE_COUNT]

ColorI GFXStateBlockDesc::textureFactor