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

Limpa uma ou mais superfícies, como um destino de renderização, vários destinos de renderização, um buffer de estêncil e um buffer de profundidade.

Sintaxe

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 retângulos na matriz em pRects. Deve ser definido como 0 se pRects for NULL. Pode não ser 0 se pRects for um ponteiro válido.

[in] pRects

Tipo: const D3DRECT*

Ponteiro para uma matriz de estruturas D3DRECT que descrevem os retângulos a serem limpos. Defina um retângulo para as dimensões do destino de renderização para limpar toda a superfície. Cada retângulo usa coordenadas de tela que correspondem a pontos no destino de renderização. As coordenadas são recortadas nos limites do retângulo do visor. Para indicar que todo o retângulo do visor deve ser limpo, defina esse parâmetro como NULL e Count como 0.

[in] Flags

Tipo: DWORD

Combinação de um ou mais sinalizadores D3DCLEAR que especificam as superfícies que serão desmarcadas.

[in] Color

Tipo: D3DCOLOR

Desmarque um destino de renderização para essa cor ARGB.

[in] Z

Tipo: float

Limpe o buffer de profundidade para esse novo valor z, que varia de 0 a 1. Consulte Observações.

[in] Stencil

Tipo: DWORD

Desmarque o buffer de estêncil para esse novo valor que varia de 0 a 2ⁿ-1 (n é a profundidade de bit do buffer de estêncil). Consulte Observações.

Valor retornado

Tipo: HRESULT

Se o método for bem-sucedido, o valor retornado será D3D_OK. Se o método falhar, o valor retornado poderá ser: D3DERR_INVALIDCALL.

Comentários

Use esse método para limpar uma superfície, incluindo: um destino de renderização, todos os destinos de renderização em um MRT, um buffer de estêncil ou um buffer de profundidade. Os sinalizadores determinam quantas superfícies são desmarcadas. Use pRects para limpar um subconjunto de uma superfície definida por uma matriz de retângulos.

IDirect3DDevice9::Clear falhará se você:

• Tente limpar o buffer de profundidade ou o buffer de estêncil de um destino de renderização que não tenha um buffer de profundidade anexado.
• Tente limpar o buffer de estêncil quando o buffer de profundidade não contiver dados de estêncil.

Requisitos

Confira também

IDirect3DDevice9