Metode IDirectDrawSurface7::SetClipper (ddraw.h)

Melampirkan objek clipper ke, atau menghapusnya dari permukaan ini.

Sintaks

HRESULT SetClipper(
  [in] LPDIRECTDRAWCLIPPER unnamedParam1
);

Parameter

[in] unnamedParam1

Penunjuk ke antarmuka IDirectDrawClipper untuk objek DirectDrawClipper yang akan dilampirkan ke objek DirectDrawSurface. Jika Anda mengatur parameter ini ke NULL, objek DirectDrawClipper saat ini dilepaskan.

Menampilkan nilai

Jika metode berhasil, nilai yang dikembalikan DD_OK.

Jika gagal, metode dapat mengembalikan salah satu nilai kesalahan berikut:

• DDERR_INVALIDOBJECT
• DDERR_INVALIDPARAMS
• DDERR_INVALIDSURFACETYPE
• DDERR_NOCLIPPERATTACHED

Keterangan

Saat Anda mengatur clipper ke permukaan untuk pertama kalinya, SetClipper menambah jumlah referensi clipper; Panggilan berikutnya tidak memengaruhi jumlah referensi clipper. Jika Anda meneruskan NULL sebagai parameter lpDDClipper , clipper dihapus dari permukaan, dan jumlah referensi clipper berkurang. Jika Anda tidak menghapus clipper, permukaan secara otomatis melepaskan referensinya ke clipper ketika permukaan itu sendiri dilepaskan. Menurut aturan COM, aplikasi Anda harus merilis referensi apa pun yang disimpannya ke clipper ketika objek tidak lagi diperlukan.

SetClipper terutama digunakan oleh permukaan yang sedang dilapisi pada atau bitbltted ke permukaan utama. Namun, dapat digunakan di permukaan apa pun. Setelah objek DirectDrawClipper dilampirkan dan daftar klip dikaitkan dengannya, objek DirectDrawClipper digunakan untuk operasi IDirectDrawSurface7::Blt, IDirectDrawSurface7::BltBatch, dan IDirectDrawSurface7::UpdateOverlay yang melibatkan objek DirectDrawSurface induk. SetClipper juga dapat melepaskan objek DirectDrawClipper saat ini dari objek DirectDrawSurface.

Persyaratan

Target Platform	Windows
Header	ddraw.h
Pustaka	Ddraw.lib
DLL	Ddraw.dll

Lihat juga

IDirectDrawSurface7