Edit

Share via

D3D12DDI_STENCIL_OP enumeration (d3d12umddi.h)

  • Article

The D3D12DDI_STENCIL_OP enumeration type contains values that identify operations on stencil buffers in a call to the driver's CreateDepthStencilState function.

Syntax

typedef enum D3D12DDI_STENCIL_OP {
  D3D12DDI_STENCIL_OP_KEEP,
  D3D12DDI_STENCIL_OP_ZERO,
  D3D12DDI_STENCIL_OP_REPLACE,
  D3D12DDI_STENCIL_OP_INCR_SAT,
  D3D12DDI_STENCIL_OP_DECR_SAT,
  D3D12DDI_STENCIL_OP_INVERT,
  D3D12DDI_STENCIL_OP_INCR,
  D3D12DDI_STENCIL_OP_DECR
} ;

Constants

 
D3D12DDI_STENCIL_OP_KEEP
Do not update the entry in the stencil buffer. D3D12DDI_STENCIL_OP_KEEP is the default value.
D3D12DDI_STENCIL_OP_ZERO
Set the stencil-buffer entry to 0.
D3D12DDI_STENCIL_OP_REPLACE
Replace the stencil-buffer entry with a reference value.
D3D12DDI_STENCIL_OP_INCR_SAT
Increment the stencil-buffer entry, clamping to the maximum value.
D3D12DDI_STENCIL_OP_DECR_SAT
Decrement the stencil-buffer entry, clamping to zero.
D3D12DDI_STENCIL_OP_INVERT
Invert the bits in the stencil-buffer entry.
D3D12DDI_STENCIL_OP_INCR
Increment the stencil-buffer entry, wrapping to zero if the new value exceeds the maximum value.
D3D12DDI_STENCIL_OP_DECR
Decrement the stencil-buffer entry, wrapping to the maximum value if the new value is less than zero.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809
Header d3d12umddi.h