Expand Minimize

ClearRenderTargetView routine

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

Syntax


PFND3D10DDI_CLEARRENDERTARGETVIEW ClearRenderTargetView;

VOID APIENTRY ClearRenderTargetView(
  _In_  D3D10DDI_HDEVICE hDevice,
  _In_  D3D10DDI_HRENDERTARGETVIEW hRenderTargetView,
  _In_  FLOAT pColorRGBA
)
{ ... }

Parameters

hDevice [in]

A handle to the display device (graphics context).

hRenderTargetView [in]

A handle to the render-target view to clear.

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).

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

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3d10umddi.h (include D3d10umddi.h)

See also

D3D10DDI_DEVICEFUNCS
pfnSetErrorCb

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.