Metode IDCompositionVisual::SetClip(constD2D_RECT_F&) (dcomp.h)

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

Sintaks

HRESULT SetClip(
  [in, ref] const D2D_RECT_F & rect
);

Parameter

[in, ref] rect

Jenis: const D2D_RECT_F

Persegi panjang yang digunakan untuk mengklip visual ini. Semua properti parameter rect memiliki batas numerik -2^21 hingga 2^21. API menerima angka di luar rentang ini, tetapi selalu dijepit ke rentang ini.

Nilai kembali

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 objek klip, persegi klip yang baru ditentukan menggantikan objek klip.

Metode ini gagal jika ada anggota struktur rect adalah NaN, infinity positif, atau infinity negatif.

Jika persegi panjang klip 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 [khusus 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