D3D10_DDI_DEPTH_STENCIL_DESC structure (d3d10umddi.h)
The D3D10_DDI_DEPTH_STENCIL_DESC structure describes a depth stencil state.
Syntax
typedef struct D3D10_DDI_DEPTH_STENCIL_DESC {
[in] BOOL DepthEnable;
[in] D3D10_DDI_DEPTH_WRITE_MASK DepthWriteMask;
[in] D3D10_DDI_COMPARISON_FUNC DepthFunc;
[in] BOOL StencilEnable;
[in] BOOL FrontEnable;
[in] BOOL BackEnable;
[in] UINT8 StencilReadMask;
[in] UINT8 StencilWriteMask;
[in] D3D10_DDI_DEPTH_STENCILOP_DESC FrontFace;
[in] D3D10_DDI_DEPTH_STENCILOP_DESC BackFace;
} D3D10_DDI_DEPTH_STENCIL_DESC;
Members
[in] DepthEnable
A Boolean value that specifies whether depth is enabled. TRUE indicates depth is enabled; FALSE indicates depth is disabled.
[in] DepthWriteMask
A bitwise value that indicates the write properties for a depth stencil state. This member is a valid bitwise OR of the following values from the D3D10_DDI_DEPTH_WRITE_MASK enumeration.
| Value | Meaning |
|---|---|
| D3D10_DDI_DEPTH_WRITE_MASK_ZERO (0) | No properties |
| D3D10_DDI_DEPTH_WRITE_MASK_ALL (1) | All properties |
[in] DepthFunc
A D3D10_DDI_COMPARISON_FUNC-typed value that indicates the depth-comparison function to perform.
[in] StencilEnable
A Boolean value that specifies whether stencil is enabled. TRUE indicates stencil is enabled; FALSE indicates stencil is disabled.
[in] FrontEnable
A Boolean value that specifies whether the performance of stencil operations on forward-facing polygons is enabled. TRUE indicates that the performance on forward-facing polygons is enabled; FALSE indicates that it is disabled.
[in] BackEnable
A Boolean value that specifies whether the performance of stencil operations on back-facing polygons is enabled. TRUE indicates that the performance on back-facing polygons is enabled; FALSE indicates that it is disabled.
[in] StencilReadMask
An 8-bit bitwise value that the driver uses in a bitwise AND operation with the stencil value in the stencil buffer immediately after reading the stencil value out of the stencil buffer.
[in] StencilWriteMask
An 8-bit bitwise value that the driver uses in a bitwise AND operation with the current stencil value before writing the result back out to the stencil buffer.
[in] FrontFace
A D3D10_DDI_DEPTH_STENCILOP_DESC structure that describes the stencil operation to perform on forward-facing polygons.
[in] BackFace
A D3D10_DDI_DEPTH_STENCILOP_DESC structure that describes the stencil operation to perform on back-facing polygons.
Remarks
If the StencilEnable member is set to TRUE, the FrontEnable member, BackEnable member, or both must also be set to TRUE.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Available in Windows Vista and later versions of the Windows operating systems. |
| Header | d3d10umddi.h (include D3d10umddi.h) |