This describes the stencil operation that are performed on the results of the depth test. More...

Inheritance diagram for xiiGALStencilOperationDescription:

Public Member Functions
	XII_DECLARE_POD_TYPE ()

Public Member Functions inherited from xiiHashableStruct< xiiGALStencilOperationDescription >
constexpr	xiiHashableStruct () noexcept
	Default constructor. Initializes all bytes to zero.

	xiiHashableStruct (const xiiHashableStruct &other) noexcept
	Bitwise copy constructor.

xiiHashableStruct &	operator= (const xiiHashableStruct &other) noexcept
	Bitwise assignment operator.

bool	operator== (const xiiHashableStruct &other) const noexcept
	Compares equality via raw byte comparison.

std::strong_ordering	operator<=> (const xiiHashableStruct &other) const noexcept
	Compares ordering via raw byte comparison.

xiiUInt32	CalculateHash () const noexcept
	Calculates a 32-bit hash from raw bytes of the struct.

void	Clear () noexcept
	Fills all bytes with zero.

bool	IsZero () const noexcept
	Returns true if all bytes are zero.

Public Attributes
xiiEnum< xiiGALStencilOperation >	m_StencilFailOperation = xiiGALStencilOperation::Keep
	The stencil operation to perform when stencil testing fails. The default is Keep.

xiiEnum< xiiGALStencilOperation >	m_StencilDepthFailOperation = xiiGALStencilOperation::Keep
	The stencil operation to perform when stencil testing passes and depth testing fails. The default is Keep.

xiiEnum< xiiGALStencilOperation >	m_StencilPassOperation = xiiGALStencilOperation::Keep
	The stencil operation to perform when stencil testing and depth testing both pass. The default is Keep.

xiiEnum< xiiGALComparisonFunction >	m_ComparisonFunction = xiiGALComparisonFunction::Always
	A function that compares stencil data against existing stencil data. The default is Always.

Detailed Description

This describes the stencil operation that are performed on the results of the depth test.

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