Skip to main content
Describes stencil operations that can be performed based on the results of stencil test.

Syntax

Members

StencilFailOp
Type: D3D12_STENCIL_OP
A D3D12_STENCIL_OP-typed value that identifies the stencil operation to perform when stencil testing fails. StencilDepthFailOp
Type: D3D12_STENCIL_OP
A D3D12_STENCIL_OP-typed value that identifies the stencil operation to perform when stencil testing passes and depth testing fails. StencilPassOp
Type: D3D12_STENCIL_OP
A D3D12_STENCIL_OP-typed value that identifies the stencil operation to perform when stencil testing and depth testing both pass. StencilFunc
Type: D3D12_COMPARISON_FUNC
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

Header: d3d12_xs.h or d3d12_x.h
Library: d3d12_xs.lib or d3d12_x.lib
Supported Platforms: XBOX Series consoles and XBOX One family

See Also

Core Structures
Last modified on August 20, 2026