D3D12_DEPTH_STENCILOP_DESC structure (d3d12.h)

Describes stencil operations that can be performed based on the results of stencil test.

Syntax

typedef struct D3D12_DEPTH_STENCILOP_DESC {
  D3D12_STENCIL_OP      StencilFailOp;
  D3D12_STENCIL_OP      StencilDepthFailOp;
  D3D12_STENCIL_OP      StencilPassOp;
  D3D12_COMPARISON_FUNC StencilFunc;
} D3D12_DEPTH_STENCILOP_DESC;

Members

StencilFailOp

A D3D12_STENCIL_OP-typed value that identifies the stencil operation to perform when stencil testing fails.

StencilDepthFailOp

A D3D12_STENCIL_OP-typed value that identifies the stencil operation to perform when stencil testing passes and depth testing fails.

StencilPassOp

A D3D12_STENCIL_OP-typed value that identifies the stencil operation to perform when stencil testing and depth testing both pass.

StencilFunc

A D3D12_COMPARISON_FUNC-typed value that identifies the function that compares stencil data against existing stencil data.

Remarks

All stencil operations are specified as a D3D12_STENCIL_OP-typed value. Each stencil operation can be set differently based on the outcome of the stencil test, which is referred to as StencilFunc, in the stencil test portion of depth-stencil testing.

Members of D3D12_DEPTH_STENCIL_DESC have this structure for their data type.

Requirements

Requirement	Value
Header	d3d12.h

See also

Core Structures