METODE IDCompositionVisual::SetEffect (dcomp.h)

Mengatur properti Efek visual ini. Properti Efek memodifikasi bagaimana subtree yang berakar pada visual ini dipadukan dengan latar belakang, dan dapat menerapkan transformasi perspektif 3D ke visual.

Sintaks

HRESULT SetEffect(
  [in, optional] IDCompositionEffect *effect
);

Parameter

[in, optional] effect

Jenis: IDCompositionEffect*

Penunjuk ke objek efek. Parameter ini bisa NULL.

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

Metode ini membuat permukaan implisit di luar layar tempat subtree yang berakar pada visual ini disusun. Permukaan digunakan sebagai salah satu input untuk efek yang ditentukan. Output efek terdiri langsung ke target komposisi. Beberapa efek juga menggunakan target komposisi sebagai input implisit lainnya. Ini biasanya terjadi untuk efek komposisi atau campuran seperti opasitas, di mana target komposisi dianggap sebagai "latar belakang." Dalam hal ini, visual apa pun yang "di belakang" visual saat ini disertakan dalam target komposisi ketika visual saat ini dirender dan dianggap sebagai "latar belakang" yang disusuk visual ini.

Jika visual ini bukan akar pohon visual dan salah satu leluhurnya juga memiliki efek yang diterapkan padanya, permukaan di luar layar yang dibuat oleh leluhur terdekat adalah target komposisi tempat efek visual ini disusun. Jika tidak, target komposisi adalah target komposisi akar. Sebagai konsekuensinya, latar belakang untuk efek komposisi dan campuran hanya mencakup visual hingga leluhur terdekat yang memiliki efek. Sebaliknya, efek apa pun yang diterapkan pada visual di bawah visual saat ini menggunakan permukaan di luar layar yang baru dibuat sebagai latar belakang, yang dapat memengaruhi bagaimana visual tersebut pada akhirnya menyusun apa yang dirasakan pengguna akhir sebagai "di belakang" visual tersebut.

Jika parameter efek adalah NULL, tidak ada efek bitmap yang diterapkan ke visual ini. Efek sebelumnya yang terkait dengan visual ini akan dihapus. Permukaan di luar layar juga dihapus dan subtree visual disusun langsung ke target komposisi induk, yang juga dapat memengaruhi bagaimana efek komposisi atau campuran di bawah visual ini dirender.

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

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

IDCompositionEffect

IDCompositionEffectGroup

IDCompositionMatrixTransform3D

IDCompositionRotateTransform3D

IDCompositionScaleTransform3D

IDCompositionTranslateTransform3D

IDCompositionVisual