PFND3D10DDI_CLEARDEPTHSTENCILVIEW callback function (d3d10umddi.h)
The ClearDepthStencilView function clears the specified currently bound depth-stencil view.
Syntax
PFND3D10DDI_CLEARDEPTHSTENCILVIEW Pfnd3d10ddiCleardepthstencilview;
void Pfnd3d10ddiCleardepthstencilview(
D3D10DDI_HDEVICE unnamedParam1,
D3D10DDI_HDEPTHSTENCILVIEW unnamedParam2,
UINT unnamedParam3,
FLOAT unnamedParam4,
UINT8 unnamedParam5
)
{...}
Parameters
unnamedParam1
hDevice [in]
A handle to the display device (graphics context).
unnamedParam2
hDepthStencilView [in]
A handle to the depth-stencil view to clear.
unnamedParam3
Stencil [in]
An unsigned 8-bit integer value to set the stencil to.
unnamedParam4
Depth [in]
A single-precision float vector to set the depth to.
unnamedParam5
Flags [in]
A value that specifies which parts of the buffer to affect. This parameter must be set to one of the following values from the D3D10_DDI_CLEAR_FLAG enumeration.
| Value | Meaning |
|---|---|
| D3D10_DDI_CLEAR_DEPTH (0x01L) | The depth value (Z) is clamped to the ZNear and ZFar range of the viewport that is currently bound to slot zero by using Microsoft Direct3D. Afterwards, Z is clamped again to the representable range of the currently bound depth-stencil view by again using Direct3D. |
| D3D10_DDI_CLEAR_STENCIL (0x02L) | The stencil value is cleared. |
Return value
None
Remarks
The driver can use the pfnSetErrorCb callback function to set an error code.
Floating point rules apply to the ClearDepthStencilView function.
The driver should not encounter any error, except for D3DDDIERR_DEVICEREMOVED. Therefore, if the driver passes any error, except for D3DDDIERR_DEVICEREMOVED, in a call to the pfnSetErrorCb function, the Direct3D runtime will determine that the error is critical. Even if the device was removed, the driver is not required to return D3DDDIERR_DEVICEREMOVED; however, if device removal interfered with the operation of ClearDepthStencilView (which typically should not happen), the driver can return D3DDDIERR_DEVICEREMOVED.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Available in Windows Vista and later versions of the Windows operating systems. |
| Target Platform | Desktop |
| Header | d3d10umddi.h (include D3d10umddi.h) |