Edit

Share via

ID3D10Device::ClearDepthStencilView method (d3d10.h)

  • Article

Clears the depth-stencil resource.

Syntax

void ClearDepthStencilView(
  [in] ID3D10DepthStencilView *pDepthStencilView,
  [in] UINT                   ClearFlags,
  [in] FLOAT                  Depth,
  [in] UINT8                  Stencil
);

Parameters

[in] pDepthStencilView

Type: ID3D10DepthStencilView*

Pointer to the depth stencil to be cleared.

[in] ClearFlags

Type: UINT

Which parts of the buffer to clear. See D3D10_CLEAR_FLAG.

[in] Depth

Type: FLOAT

Clear the depth buffer with this value. This value will be clamped between 0 and 1.

[in] Stencil

Type: UINT8

Clear the stencil buffer with this value.

Return value

None

Remarks

Differences between Direct3D 9 and Direct3D 10:

Unlike Direct3D 9, the full extent of the resource view is always cleared. Viewport and scissor settings are not applied.

Requirements

Requirement Value
Target Platform Windows
Header d3d10.h
Library D3D10.lib

See also

ID3D10Device Interface