IDirect3DDevice9::Clear method (d3d9helper.h)

Menghapus satu atau beberapa permukaan seperti target render, beberapa target render, buffer stensil, dan buffer kedalaman.

Sintaks

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

Parameter

[in] Count

Jenis: DWORD

Jumlah persegi panjang dalam array di pRects. Harus diatur ke 0 jika pRects adalah NULL. Mungkin bukan 0 jika pRects adalah penunjuk yang valid.

[in] pRects

Jenis: const D3DRECT*

Penunjuk ke array struktur D3DRECT yang menjelaskan persegi panjang untuk dihapus. Atur persegi panjang ke dimensi target penyajian untuk menghapus seluruh permukaan. Setiap persegi panjang menggunakan koordinat layar yang sesuai dengan titik pada target render. Koordinat dipotong ke batas persegi panjang viewport. Untuk menunjukkan bahwa seluruh persegi panjang viewport akan dibersihkan, atur parameter ini ke NULL dan Hitung ke 0.

[in] Flags

Jenis: DWORD

Kombinasi satu atau beberapa bendera D3DCLEAR yang menentukan permukaan yang akan dihapus.

[in] Color

Jenis: D3DCOLOR

Bersihkan target render ke warna ARGB ini.

[in] Z

Jenis: float

Bersihkan buffer kedalaman ke nilai z baru ini yang berkisar dari 0 hingga 1. Lihat komentar.

[in] Stencil

Jenis: DWORD

Bersihkan buffer stensil ke nilai baru ini yang berkisar antara 0 hingga 2ⁿ-1 (n adalah kedalaman bit dari buffer stensil). Lihat komentar.

Nilai kembali

Jenis: HRESULT

Jika metode berhasil, nilai yang dikembalikan adalah D3D_OK. Jika metode gagal, nilai yang dikembalikan dapat berupa: D3DERR_INVALIDCALL.

Keterangan

Gunakan metode ini untuk menghapus permukaan termasuk: target render, semua target render dalam MRT, buffer stensil, atau buffer kedalaman. Bendera menentukan berapa banyak permukaan yang dibersihkan. Gunakan pRects untuk menghapus subset permukaan yang ditentukan oleh array persegi panjang.

IDirect3DDevice9::Clear akan gagal jika Anda:

  • Cobalah untuk menghapus buffer kedalaman atau buffer stensil dari target render yang tidak memiliki buffer kedalaman yang terpasang.
  • Cobalah untuk menghapus buffer stensil ketika buffer kedalaman tidak berisi data stensil.

Persyaratan

   
Target Platform Windows
Header d3d9helper.h (termasuk D3D9.h)
Pustaka D3D9.lib

Lihat juga

IDirect3DDevice9