Edit

D3D10_DEPTH_STENCILOP_DESC structure (d3d10.h)

  • Article

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

Syntax

typedef struct D3D10_DEPTH_STENCILOP_DESC {
  D3D10_STENCIL_OP      StencilFailOp;
  D3D10_STENCIL_OP      StencilDepthFailOp;
  D3D10_STENCIL_OP      StencilPassOp;
  D3D10_COMPARISON_FUNC StencilFunc;
} D3D10_DEPTH_STENCILOP_DESC;

Members

StencilFailOp

Type: D3D10_STENCIL_OP

A member of the D3D10_STENCIL_OP enumerated type that describes the stencil operation to perform when stencil testing fails. The default value is D3D10_STENCIL_OP_KEEP.

StencilDepthFailOp

Type: D3D10_STENCIL_OP

A member of the D3D10_STENCIL_OP enumerated type that describes the stencil operation to perform when stencil testing passes and depth testing fails. The default value is D3D10_STENCIL_OP_KEEP.

StencilPassOp

Type: D3D10_STENCIL_OP

A member of the D3D10_STENCIL_OP enumerated type that describes the stencil operation to perform when stencil testing and depth testing both pass. The default value is D3D10_STENCIL_OP_KEEP.

StencilFunc

Type: D3D10_COMPARISON_FUNC

A member of the D3D10_COMPARISON_FUNC enumerated type that describes how stencil data is compared against existing stencil data. The default value is D3D10_COMPARISON_ALWAYS.

Remarks

The stencil operation can be set differently based on the outcome of the stencil test by using the StencilFunc member. This can be done for the stencil test portion of depth-stencil testing.

The D3D10_DEPTH_STENCILOP_DESC structure is a member of the D3D10_DEPTH_STENCIL_DESC structure.

Requirements

Requirement Value
Header d3d10.h

See also

Core Structures