Edit

Share via

D3D12_STENCIL_OP enumeration (d3d12.h)

  • Article

Identifies the stencil operations that can be performed during depth-stencil testing.

Syntax

typedef enum D3D12_STENCIL_OP {
  D3D12_STENCIL_OP_KEEP = 1,
  D3D12_STENCIL_OP_ZERO = 2,
  D3D12_STENCIL_OP_REPLACE = 3,
  D3D12_STENCIL_OP_INCR_SAT = 4,
  D3D12_STENCIL_OP_DECR_SAT = 5,
  D3D12_STENCIL_OP_INVERT = 6,
  D3D12_STENCIL_OP_INCR = 7,
  D3D12_STENCIL_OP_DECR = 8
} ;

Constants

 
D3D12_STENCIL_OP_KEEP
Value: 1
Keep the existing stencil data.
D3D12_STENCIL_OP_ZERO
Value: 2
Set the stencil data to 0.
D3D12_STENCIL_OP_REPLACE
Value: 3
Set the stencil data to the reference value set by calling ID3D12GraphicsCommandList::OMSetStencilRef.
D3D12_STENCIL_OP_INCR_SAT
Value: 4
Increment the stencil value by 1, and clamp the result.
D3D12_STENCIL_OP_DECR_SAT
Value: 5
Decrement the stencil value by 1, and clamp the result.
D3D12_STENCIL_OP_INVERT
Value: 6
Invert the stencil data.
D3D12_STENCIL_OP_INCR
Value: 7
Increment the stencil value by 1, and wrap the result if necessary.
D3D12_STENCIL_OP_DECR
Value: 8
Decrement the stencil value by 1, and wrap the result if necessary.

Remarks

This enum is used by the D3D12_DEPTH_STENCILOP_DESC structure.

Requirements

Requirement Value
Header d3d12.h

See also

CD3DX12_DEPTH_STENCIL_DESC

Core enumerations