This describes the depth stencil state creation description. More...

Inheritance diagram for xiiGALDepthStencilStateCreationDescription:

Public Member Functions
	XII_DECLARE_POD_TYPE ()

Public Member Functions inherited from xiiHashableStruct< xiiGALDepthStencilStateCreationDescription >
	xiiHashableStruct (const xiiHashableStruct< xiiGALDepthStencilStateCreationDescription > &other)

void	operator= (const xiiHashableStruct< xiiGALDepthStencilStateCreationDescription > &other)

XII_ALWAYS_INLINE constexpr bool	operator== (const xiiHashableStruct< xiiGALDepthStencilStateCreationDescription > &rhs) const=default

xiiUInt32	CalculateHash () const
	Calculates the 32 bit hash of the struct and returns it.

Public Attributes
bool	m_bDepthEnable = true
	Enable depth-stencil operations. When set to false, the depth test always passes, depth writes are disabled, and no stencil operations are performed. The default is true.

bool	m_bDepthWriteEnable = true
	Enable or disable writes to a depth buffer. The default is true.

xiiEnum< xiiGALComparisonFunction >	m_ComparisonDepthFunction = xiiGALComparisonFunction::Less
	A function that compares depth data against existing depth data. The default is Less.

bool	m_bStencilEnable = false
	Enable stencil operations. The default is false.

xiiUInt8	m_uiStencilReadMask = 0xFFU
	Identify which bits of the depth-stencil buffer are accessed when reading stencil data. The default is 0xFF.

xiiUInt8	m_uiStencilWriteMask = 0xFFU
	Identify which bits of the depth-stencil buffer are accessed when writing stencil data. The default is 0xFF.

xiiGALStencilOperationDescription	m_FrontFace
	Identify stencil operations for the front-facing triangles.

xiiGALStencilOperationDescription	m_BackFace
	Identify stencil operations for the back-facing triangles.

Detailed Description

This describes the depth stencil state creation description.

The documentation for this struct was generated from the following file:

/home/runner/work/XII/XII/Source/Engine/GraphicsFoundation/States/DepthStencilState.h

Public Member Functions