ID3D10Device::OMSetDepthStencilState method

Sets the depth-stencil state of the output-merger stage.

Syntax

void OMSetDepthStencilState(
  [in] ID3D10DepthStencilState *pDepthStencilState,
  [in] UINT                    StencilRef
);

Parameters

pDepthStencilState [in]

Type: ID3D10DepthStencilState*

Pointer to a depth-stencil state interface (see ID3D10DepthStencilState) to bind to the device.

StencilRef [in]

Type: UINT

Reference value to perform against when doing a depth-stencil test. See remarks.

Return value

Returns nothing.

Remarks

To create a depth-stencil state interface, call ID3D10Device::CreateDepthStencilState.

Depth-stencil state is used by the output-merger stage to setup depth-stencil testing. The stencil reference value is the control value used in the depth-stencil test.

The method will not hold a reference to the interfaces passed in. For that reason, applications should be careful not to release an interface currently in use by the device.

Requirements

See also

ID3D10Device Interface