Stencil face descriptor structure. More...

#include <CeresEngine/RenderAPI/GPUGraphicsPipeline.hpp>

Static Public Member Functions
template<typename Processor >
static constexpr void	reflect (Processor &&RTTI)
	Executes the given processor for every field of the struct.

Public Attributes
GPUStencilOp	stencilFailOp = GPUStencilOp::Keep
	Specifies the operation to take when the stencil test fails.

GPUStencilOp	depthFailOp = GPUStencilOp::Keep
	Specifies the operation to take when the stencil test passes but the depth test fails.

GPUStencilOp	depthPassOp = GPUStencilOp::Keep
	Specifies the operation to take when both the stencil test and the depth test pass.

GPUCompareOp	compareOp = GPUCompareOp::Less
	Specifies the stencil compare operation.

UInt32	readMask = ~0u
	Specifies the portion of the depth-stencil buffer for reading stencil data.

UInt32	writeMask = ~0u
	Specifies the portion of the depth-stencil buffer for writing stencil data.

UInt32	reference = 0
	Specifies the stencil reference value.

Detailed Description

Stencil face descriptor structure.

Member Function Documentation

◆ reflect()

template<typename Processor >

static constexpr void CeresEngine::GPUStencilFaceDescriptor::reflect ( Processor && RTTI )

inlinestaticconstexpr

Executes the given processor for every field of the struct.

Parameters

RTTI	The processor to be ran for every field.

Member Data Documentation

◆ compareOp

GPUCompareOp CeresEngine::GPUStencilFaceDescriptor::compareOp = GPUCompareOp::Less

Specifies the stencil compare operation.

◆ depthFailOp

GPUStencilOp CeresEngine::GPUStencilFaceDescriptor::depthFailOp = GPUStencilOp::Keep

Specifies the operation to take when the stencil test passes but the depth test fails.

◆ depthPassOp

GPUStencilOp CeresEngine::GPUStencilFaceDescriptor::depthPassOp = GPUStencilOp::Keep

Specifies the operation to take when both the stencil test and the depth test pass.

◆ readMask

UInt32 CeresEngine::GPUStencilFaceDescriptor::readMask = ~0u

Specifies the portion of the depth-stencil buffer for reading stencil data.

By default 0xFFFFFFFF.

◆ reference

UInt32 CeresEngine::GPUStencilFaceDescriptor::reference = 0

Specifies the stencil reference value.

Remarks: This value will be used when the stencil operation is StencilOp::Teplace.

◆ stencilFailOp

GPUStencilOp CeresEngine::GPUStencilFaceDescriptor::stencilFailOp = GPUStencilOp::Keep

Specifies the operation to take when the stencil test fails.

◆ writeMask

UInt32 CeresEngine::GPUStencilFaceDescriptor::writeMask = ~0u

Specifies the portion of the depth-stencil buffer for writing stencil data.