Platform SDK: DirectX

CONST_D3DSTENCILOP

The CONST_D3DSTENCILOP enumeration describes the stencil operations for the D3DRENDERSTATE_STENCILFAIL, D3DRENDERSTATE_STENCILZFAIL, D3DRENDERSTATE_STENCILPASS render states.

Enum CONST_D3DSTENCILOP
    D3DSTENCILOP_DECR = 8
    D3DSTENCILOP_DECRSAT = 5
    D3DSTENCILOP_INCR = 7
    D3DSTENCILOP_INCRSAT = 4
    D3DSTENCILOP_INVERT = 6
    D3DSTENCILOP_KEEP = 1
    D3DSTENCILOP_REPLACE = 3
    D3DSTENCILOP_ZERO = 2
End Enum
D3DSTENCILOP_DECR
Decrement the stencil-buffer entry, wrapping to the maximum value if the new value is less than zero.
D3DSTENCILOP_DECRSAT
Decrement the stencil-buffer entry, clamping to zero.
D3DSTENCILOP_INCRSAT
Increment the stencil-buffer entry, clamping to the maximum value. See remarks for information on the maximum stencil-buffer values.
D3DSTENCILOP_INVERT
Invert the bits in the stencil-buffer entry.
D3DSTENCILOP_INCR
Increment the stencil-buffer entry, wrapping to zero if the new value exceeds the maximum value. See remarks for information on the maximum stencil-buffer values.
D3DSTENCILOP_KEEP
Do not update the entry in the stencil buffer. This is the default value.
D3DSTENCILOP_REPLACE
Replace the stencil-buffer entry with reference value.
D3DSTENCILOP_ZERO
Set the stencil-buffer entry to zero.

Remarks

Stencil-buffer entries are integer values ranging inclusively from 0 to 2n -1, where n is the bit depth of the stencil buffer.

See Also

CONST_D3DRENDERSTATETYPE, Stencil Buffers