The IDirect3DViewport2::Clear method clears the viewport or a set of rectangles in the viewport to the current background material.
HRESULT Clear(
DWORD dwCount,
LPD3DRECT lpRects,
DWORD dwFlags
);
Parameters
dwCount
Number of rectangles pointed to by lpRects.
lpRects
Address of an array of D3DRECT structures.
dwFlags
Flags indicating what to clear: the rendering target, the z-buffer, or both.
D3DCLEAR_TARGET | Clear the rendering target to the background material (if set). |
D3DCLEAR_ZBUFFER | Clear the z-buffer or set it to the current background depth field (if set). |
Return Values
If the method succeeds, the return value is D3D_OK.
If the method fails, the return value may be one of the following values:
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
Remarks
This method is unchanged from its implementation in the IDirect3DViewport interface.
QuickInfo
Windows NT: Use version 5.0 or later.
Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
Windows CE: Unsupported.
Header: Declared in d3d.h.
Import Library: Use ddraw.lib.