PFND3D10DDI_CLEARRENDERTARGETVIEW callback function

The ClearRenderTargetView function clears the specified render-target view by setting it to a constant value.

Syntax

PFND3D10DDI_CLEARRENDERTARGETVIEW Pfnd3d10ddiClearrendertargetview;

void Pfnd3d10ddiClearrendertargetview(
  D3D10DDI_HDEVICE Arg1,
  D3D10DDI_HRENDERTARGETVIEW Arg2,
  FLOAT[4] Arg3
)
{...}

Parameters

Arg1

hDevice [in]

A handle to the display device (graphics context).

Arg2

pColorRGBA [in]

A four-element array of single-precision float vectors that the driver uses to clear a render-target view. Array element 0 is red (R), 1 is green (G), 2 is blue (B), and 3 is alpha (A).

Arg3

hRenderTargetView [in]

A handle to the render-target view to clear.

Return Value

None

The driver can use the pfnSetErrorCb callback function to set an error code. For more information about setting error codes, see the following Remarks section.

Remarks

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 ClearRenderTargetView (which typically should not happen), the driver can return D3DDDIERR_DEVICEREMOVED.

Requirements

   
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header d3d10umddi.h (include D3d10umddi.h)

See Also

D3D10DDI_DEVICEFUNCS

pfnSetErrorCb