Metodo IDirect3DDevice9::Clear (d3d9.h)

Cancella una o più superfici, ad esempio una destinazione di rendering, più destinazioni di rendering, un buffer degli stencil e un buffer di profondità.

Sintassi

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

Parametri

[in] Count

Tipo: DWORD

Numero di rettangoli nella matrice in corrispondenza di pRects. Deve essere impostato su 0 se pRects è NULL. Potrebbe non essere 0 se pRects è un puntatore valido.

[in] pRects

Tipo: const D3DRECT*

Puntatore a una matrice di strutture D3DRECT che descrivono i rettangoli da cancellare. Impostare un rettangolo sulle dimensioni della destinazione di rendering per cancellare l'intera superficie. Ogni rettangolo usa le coordinate dello schermo che corrispondono ai punti nella destinazione di rendering. Le coordinate vengono ritagliate ai limiti del rettangolo del riquadro di visualizzazione. Per indicare che l'intero rettangolo del riquadro di visualizzazione deve essere cancellato, impostare questo parametro su NULL e Count su 0.

[in] Flags

Tipo: DWORD

Combinazione di uno o più flag D3DCLEAR che specificano le superfici che verranno cancellate.

[in] Color

Tipo: D3DCOLOR

Cancellare una destinazione di rendering in questo colore ARGB.

[in] Z

Tipo: float

Cancellare il buffer di profondità in questo nuovo valore z compreso tra 0 e 1. Vedere la sezione Osservazioni.

[in] Stencil

Tipo: DWORD

Cancellare il buffer degli stencil in questo nuovo valore compreso tra 0 e 2ⁿ-1 (n è la profondità di bit del buffer degli stencil). Vedere la sezione Osservazioni.

Valore restituito

Tipo: HRESULT

Se il metodo ha esito positivo, il valore restituito viene D3D_OK. Se il metodo ha esito negativo, il valore restituito può essere: D3DERR_INVALIDCALL.

Commenti

Usare questo metodo per cancellare una superficie, tra cui una destinazione di rendering, tutte le destinazioni di rendering in un mrT, un buffer degli stencil o un buffer di profondità. I flag determinano il numero di superfici cancellate. Usare pRects per cancellare un subset di una superficie definita da una matrice di rettangoli.

IDirect3DDevice9::Clear avrà esito negativo se:

• Provare a cancellare il buffer di profondità o il buffer degli stencil di una destinazione di rendering che non dispone di un buffer di profondità collegato.
• Provare a cancellare il buffer degli stencil quando il buffer depth non contiene dati stencil.

Requisiti

Vedi anche

IDirect3DDevice9