D3DDDIARG_CLEAR structure (d3dumddi.h)

The D3DDDIARG_CLEAR structure describes the parameters of a hardware-assisted clearing operation.

Syntax

typedef struct _D3DDDIARG_CLEAR {
  [in] UINT  Flags;
  [in] UINT  FillColor;
  [in] FLOAT FillDepth;
  [in] UINT  FillStencil;
} D3DDDIARG_CLEAR;

Members

[in] Flags

A UINT value that specifies which buffers the driver should clear and how the clear operation should be performed. This member can be a bitwise OR of the following values. For more information, see the Remarks section in the Clear reference page.

[in] FillColor

The color value that the driver should clear the context's render target to.

[in] FillDepth

The value that the driver should use to set the depth in the context's depth buffer. This member can be a value in the range from 0.0 through 1.0.

[in] FillStencil

The value that the driver should clear the context's stencil buffer to. This member can be an integer in the range from 0 through 2ⁿ-1, where n is the number of bits in the stencil buffer.

Remarks

In a call to the user-mode display driver's Clear function, a pointer to a D3DDDIARG_CLEAR structure is passed in the pData parameter. The Microsoft Direct3D runtime passes information to the NumRect and pRect parameters in a call to the user-mode display driver's Clear function to specify the rectangular areas of the buffer that the driver should clear.

Requirements

See also

Clear