Método IDirect3DDevice9::Clear (d3d9helper.h)

Borra una o varias superficies, como un destino de representación, varios destinos de representación, un búfer de galería de símbolos y un búfer de profundidad.

Sintaxis

HRESULT Clear(
  [in] DWORD         Count,
  [in] const D3DRECT *pRects,
  [in] DWORD         Flags,
  [in] D3DCOLOR      Color,
  [in] float         Z,
  [in] DWORD         Stencil
);

Parámetros

[in] Count

Tipo: DWORD

Número de rectángulos de la matriz en pRects. Debe establecerse en 0 si pRects es NULL. Puede que no sea 0 si pRects es un puntero válido.

[in] pRects

Tipo: const D3DRECT*

Puntero a una matriz de estructuras D3DRECT que describen los rectángulos que se van a borrar. Establezca un rectángulo en las dimensiones del destino de representación para borrar toda la superficie. Cada rectángulo usa coordenadas de pantalla que corresponden a puntos en el destino de representación. Las coordenadas se recortan en los límites del rectángulo de ventanilla. Para indicar que se va a borrar todo el rectángulo de la ventanilla, establezca este parámetro en NULL y Count en 0.

[in] Flags

Tipo: DWORD

Combinación de una o varias marcas D3DCLEAR que especifican las superficies que se borrarán.

[in] Color

Tipo: D3DCOLOR

Borre un destino de representación a este color ARGB.

[in] Z

Tipo: float

Borre el búfer de profundidad a este nuevo valor z que va de 0 a 1. Vea Notas.

[in] Stencil

Tipo: DWORD

Borre el búfer de galería de símbolos a este nuevo valor que va de 0 a 2ⁿ-1 (n es la profundidad de bits del búfer de galería de símbolos). Vea Notas.

Valor devuelto

Tipo: HRESULT

Si el método se ejecuta correctamente, el valor devuelto es D3D_OK. Si se produce un error en el método, el valor devuelto puede ser: D3DERR_INVALIDCALL.

Comentarios

Use este método para borrar una superficie, incluido: un destino de representación, todos los destinos de representación en un MRT, un búfer de galería de símbolos o un búfer de profundidad. Las marcas determinan cuántas superficies se borran. Use pRects para borrar un subconjunto de una superficie definida por una matriz de rectángulos.

IDirect3DDevice9::Clear producirá un error si:

• Intente borrar el búfer de profundidad o el búfer de galería de símbolos de un destino de representación que no tenga un búfer de profundidad asociado.
• Intente borrar el búfer de galería de símbolos cuando el búfer de profundidad no contenga datos de galería de símbolos.

Requisitos

Plataforma de destino	Windows
Encabezado	d3d9helper.h (incluya D3D9.h)
Library	D3D9.lib

Consulte también

IDirect3DDevice9