| UID | title | description | old-location | ms.date | keywords | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | tech.root | req.typenames | f1_keywords | topic_type | api_type | api_location | api_name | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NC:d3d10umddi.PFND3D10DDI_CLEARDEPTHSTENCILVIEW |
PFND3D10DDI_CLEARDEPTHSTENCILVIEW (d3d10umddi.h) |
The ClearDepthStencilView function clears the specified currently bound depth-stencil view. |
display\cleardepthstencilview.htm |
05/10/2018 |
|
ClearDepthStencilView, ClearDepthStencilView callback function [Display Devices], PFND3D10DDI_CLEARDEPTHSTENCILVIEW, PFND3D10DDI_CLEARDEPTHSTENCILVIEW callback, UserModeDisplayDriverDx10_Functions_580c85a3-3ad9-415c-925c-2ca103d10237.xml, d3d10umddi/ClearDepthStencilView, display.cleardepthstencilview |
d3d10umddi.h |
D3d10umddi.h |
Desktop |
Available in Windows Vista and later versions of the Windows operating systems. |
Windows |
display |
|
|
|
|
|
The ClearDepthStencilView function clears the specified currently bound depth-stencil view.
hDevice [in]
A handle to the display device (graphics context).
hDepthStencilView [in]
A handle to the depth-stencil view to clear.
Stencil [in]
An unsigned 8-bit integer value to set the stencil to.
Depth [in]
A single-precision float vector to set the depth to.
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. |
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.