Metode IDCompositionVisual::SetClip(IDCompositionClip*) (dcomp.h)

Menyetel properti Klip visual ini ke objek klip yang ditentukan. Properti Klip membatasi penyajian subtree visual yang berakar pada visual ini ke wilayah persegi panjang.

Sintaks

HRESULT SetClip(
  [in, optional] IDCompositionClip *clip
);

Parameter

[in, optional] clip

Jenis: IDCompositionClip*

Objek klip yang akan dikaitkan dengan visual ini. Parameter ini bisa NULL. Semua properti float IDCompositionRectangleClip memiliki batas numerik -2^21 hingga 2^21. API menerima angka di luar rentang ini, tetapi selalu dijepit ke rentang ini.

Mengembalikan nilai

Jenis: HRESULT

Jika fungsi berhasil, fungsi akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan. Lihat Kode Kesalahan DirectComposition untuk daftar kode kesalahan.

Keterangan

Mengatur klip properti Klip visual ini bersama dengan semua visual dalam subtree yang berakar pada visual ini. Klip diubah oleh properti OffsetX, OffsetY, dan Transformasi.

Jika properti Klip sebelumnya menentukan persegi klip, objek Klip yang baru ditentukan menggantikan persegi klip.

Metode ini gagal jika klip adalah penunjuk yang tidak valid atau jika tidak dibuat oleh antarmuka IDCompositionDevice yang sama yang membuat visual ini. Antarmuka tidak boleh menjadi implementasi kustom; hanya antarmuka yang dibuat oleh Microsoft DirectComposition yang dapat digunakan dengan metode ini.

Jika klip NULL, visual tidak diklip relatif terhadap induknya. Namun, visual diklip oleh objek klip visual induk, atau oleh visual leluhur terdekat yang memiliki objek klip. Mengatur klip ke NULL mirip dengan menentukan objek klip yang persegi panjang klipnya memiliki sisi kiri dan atas yang diatur ke tak terbatas negatif, dan sisi kanan dan bawah diatur ke tak terbatas positif. Menggunakan objek klip NULL menghasilkan performa yang sedikit lebih baik.

Jika klip menentukan objek klip yang memiliki persegi panjang kosong, visual sepenuhnya terpotong; artinya, visual disertakan dalam pohon visual, tetapi tidak merender apa pun. Untuk mengecualikan visual tertentu dari komposisi, hapus visual dari pohon visual alih-alih mengatur persegi klip kosong. Menghapus hasil visual dalam performa yang lebih baik.

Persyaratan

Klien minimum yang didukung	Windows 8 [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2012 [hanya aplikasi desktop]
Target Platform	Windows
Header	dcomp.h
Pustaka	Dcomp.lib
DLL	Dcomp.dll

Lihat juga

Kliping

IDCompositionRectangleClip

IDCompositionVisual