xiiGALStencilOperation Struct Reference

This describes the stencil operation. More...

#include <DepthStencilState.h>

Inheritance diagram for xiiGALStencilOperation:

Public Types
enum	Enum : StorageType {   Undefined = 0U , Keep , Zero , Replace ,   IncrementSaturate , DecrementSaturate , Invert , IncrementWrap ,   DecrementWrap , ENUM_COUNT , Default = Undefined }
using	StorageType = xiiUInt8

Detailed Description

This describes the stencil operation.

This enumeration describes the stencil operation and generally mirrors D3D11_STENCIL_OP/D3D12_STENCIL_OP enumeration.

Member Enumeration Documentation

Enum

enum xiiGALStencilOperation::Enum : StorageType

Enumerator
Undefined	Undefined stencil operation.
Keep	Keep the existing stencil data.
Zero	Set the stencil data to 0.
Replace	Set the stencil data to the reference value.
IncrementSaturate	Increment the current stencil value, and clamp to the maximum representable unsigned value.
DecrementSaturate	Decrement the current stencil value, and clamp to 0.
Invert	Bitwise invert the current stencil buffer value.
IncrementWrap	Increment the current stencil value, and wrap the value to zero when incrementing the maximum representable unsigned value.
DecrementWrap	Decrement the current stencil value, and wrap the value to the maximum representable unsigned value when decrementing a value of zero.

---

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

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