LLGL::StencilDescriptor Struct Reference

Stencil state descriptor structure. More...

#include <PipelineStateFlags.h>

Public Attributes
bool	testEnabled = false
	Specifies whether the stencil test is enabled or disabled. By default disabled.
bool	referenceDynamic = false
	Specifies whether the stencil reference values will be set dynamically with the command buffer. By default false.
StencilFaceDescriptor	front
	Specifies the front face settings for the stencil test.
StencilFaceDescriptor	back
	Specifies the back face settings for the stencil test.

Detailed Description

Stencil state descriptor structure.

See also

GraphicsPipelineDescriptor::stencil

Member Data Documentation

back

StencilFaceDescriptor LLGL::StencilDescriptor::back

Specifies the back face settings for the stencil test.

front

StencilFaceDescriptor LLGL::StencilDescriptor::front

Specifies the front face settings for the stencil test.

Note

For Direct3D 11 and Direct3D 12, the members readMask, writeMask, and reference are only supported for the front face.

See also

StencilFaceDescriptor::readMask

StencilFaceDescriptor::writeMask

StencilFaceDescriptor::reference

referenceDynamic

bool LLGL::StencilDescriptor::referenceDynamic = false

Specifies whether the stencil reference values will be set dynamically with the command buffer. By default false.

Remarks

If this is true, StencilFaceDescriptor::reference in front and back is ignored and the stencil reference values must be set with the SetStencilReference function everytime the graphics pipeline is set.

See also

CommandBuffer::SetStencilReference

testEnabled

bool LLGL::StencilDescriptor::testEnabled = false

Specifies whether the stencil test is enabled or disabled. By default disabled.

---

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

• PipelineStateFlags.h