LLGL::StencilFaceDescriptor Struct Reference

Stencil face descriptor structure. More...

#include <PipelineStateFlags.h>

Public Attributes
StencilOp	stencilFailOp = StencilOp::Keep
	Specifies the operation to take when the stencil test fails. By default StencilOp::Keep.
StencilOp	depthFailOp = StencilOp::Keep
	Specifies the operation to take when the stencil test passes but the depth test fails. By default StencilOp::Keep.
StencilOp	depthPassOp = StencilOp::Keep
	Specifies the operation to take when both the stencil test and the depth test pass. By default StencilOp::Keep.
CompareOp	compareOp = CompareOp::Less
	Specifies the stencil compare operation. By default CompareOp::Less.
std::uint32_t	readMask = ~0u
	Specifies the portion of the depth-stencil buffer for reading stencil data. By default 0xFFFFFFFF.
std::uint32_t	writeMask = ~0u
	Specifies the portion of the depth-stencil buffer for writing stencil data. By default 0xFFFFFFFF.
std::uint32_t	reference = 0u
	Specifies the stencil reference value. By default 0.

Detailed Description

Stencil face descriptor structure.

See also

StencilDescriptor::front

StencilDescriptor::back

Member Data Documentation

compareOp

CompareOp LLGL::StencilFaceDescriptor::compareOp = CompareOp::Less

Specifies the stencil compare operation. By default CompareOp::Less.

depthFailOp

StencilOp LLGL::StencilFaceDescriptor::depthFailOp = StencilOp::Keep

Specifies the operation to take when the stencil test passes but the depth test fails. By default StencilOp::Keep.

depthPassOp

StencilOp LLGL::StencilFaceDescriptor::depthPassOp = StencilOp::Keep

Specifies the operation to take when both the stencil test and the depth test pass. By default StencilOp::Keep.

readMask

std::uint32_t LLGL::StencilFaceDescriptor::readMask = ~0u

Specifies the portion of the depth-stencil buffer for reading stencil data. By default 0xFFFFFFFF.

Note

For Direct3D 11 and Direct3D 12, only the first 8 least significant bits (i.e. readMask & 0xFF) of the read mask value of the front face will be used.

See also

StencilDescriptor::front

reference

std::uint32_t LLGL::StencilFaceDescriptor::reference = 0u

Specifies the stencil reference value. By default 0.

Remarks

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

If referenceDynamic is set to true, this member is ignored.

Note

For Direct3D 11 and Direct3D 12, only the stencil reference value of the front face will be used.

See also

StencilDescriptor::front

StencilDescriptor::referenceDynamic

CommandBuffer::SetStencilReference

stencilFailOp

StencilOp LLGL::StencilFaceDescriptor::stencilFailOp = StencilOp::Keep

Specifies the operation to take when the stencil test fails. By default StencilOp::Keep.

writeMask

std::uint32_t LLGL::StencilFaceDescriptor::writeMask = ~0u

Specifies the portion of the depth-stencil buffer for writing stencil data. By default 0xFFFFFFFF.

Note

For Direct3D 11 and Direct3D 12, only the first 8 least significant bits (i.e. writeMask & 0xFF) of the write mask value of the front face will be used.

See also

StencilDescriptor::front

---

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

• PipelineStateFlags.h