This reference page is linked to from the following overview topics: 2.6 State and State Manager.

Detailed Description

Descriptor for a complete depth-stencil state.

This class encapsulates a complete depth-stencil state, like z buffer enable, z write enable, z comparison function, stencil enable, stencil masks and reference values. It also contains MStencilOpDesc stencil operation descriptors for front and back faces.

Examples:: squareScaleManip.cpp.

#include <MStateManager.h>

List of all members.

Public Member Functions
	MDepthStencilStateDesc ()
	Constructor, builds a default depth stencil state.
	~MDepthStencilStateDesc ()
	Destructor.
void	setDefaults ()
	Set all values for the depth stencil state to their default values.
	MDepthStencilStateDesc (const MDepthStencilStateDesc &rDesc)
	NO SCRIPT SUPPORT.
MDepthStencilStateDesc &	operator= (const MDepthStencilStateDesc &rDesc)
	NO SCRIPT SUPPORT.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class.
Public Attributes
bool	depthEnable
	Enables depth buffer reads and compares, default true.
bool	depthWriteEnable
	Enables depth buffer writes, default true.
MStateManager::CompareMode	depthFunc
	Sets the depth buffer comparison function, default less than.
bool	stencilEnable
	Enables stencil buffer operation.
unsigned char	stencilReadMask
	Sets a bitwise stencil buffer read mask, default 0xff.
unsigned char	stencilWriteMask
	Sets a bitwise stencil buffer write mask, default 0xff.
int	stencilReferenceVal
	Sets the stencil reference value.
MStencilOpDesc	frontFace
	Sets the stencil op for the front facing fragments.
MStencilOpDesc	backFace
	Sets the stencil op for the back facing fragments. Search for all occurrences