ID3DXContext::SetClearStencil

The ID3DXContext::SetClearStencil method sets the value to which the stencil-buffer surface will be cleared.

HRESULT SetClearStencil( 
  DWORD dwClearValue
); 

Parameters

dwClearValue

DWORD value to store in each stencil buffer entry. This parameter can range from 0 to 2ⁿ-1 inclusive, where n is the bit depth of the stencil buffer. The default value is 0.

Return Values

This method returns S_OK.

Remarks

After setting the stencil value with this method, you can call the ID3DXContext::Clear method to clear the stencil-buffer surface to this value.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Version: Requires DirectX 7.0.
  Header: Declared in d3dxcore.h.
  Library: Use d3dx.lib.

See Also

ID3DXContext::Clear, ID3DXContext::SetClearColor, ID3DXContext::SetClearDepth