Win32 API 日本語リファレンス
ホームGraphics.DirectComposition › IDCompositionTarget

IDCompositionTarget

COM
IIDeacdd04c-117e-4e17-88f4-d1b12b0e3d89継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

Microsoft DirectComposition のビジュアルツリーと、そのビジュアルツリーを合成する先の出力先との結び付きを表します。

メソッド 1

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT SetRoot(IDCompositionVisual* visual)

ビジュアルオブジェクトをビジュアルツリーの新しいルートオブジェクトとして設定します。

visualIDCompositionVisual*inoptionalこのビジュアルツリーの新しいルートとなるビジュアルオブジェクトです。このパラメーターには NULL を指定できます。

戻り値

型: HRESULT

関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、DirectComposition Error Codes を参照してください。

解説(Remarks)

ビジュアルは、単一のビジュアルツリーのルートになるか、他のビジュアルの子になるかのいずれかであり、両方を同時に兼ねることはできません。visual パラメーターが既に別のビジュアルツリーのルートである場合、または別のビジュアルの子である場合、このメソッドは失敗します。

visual が NULL の場合、ビジュアルツリーは空になります。それ以前に NULL でないルートビジュアルが設定されていた場合、そのビジュアルは別のビジュアルツリーのルート、または別のビジュアルの子として再び使用できるようになります。

Examples

例については、How to Build a Simple Visual Tree を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

#define global IID_IDCompositionTarget "{EACDD04C-117E-4E17-88F4-D1B12B0E3D89}"
#usecom global IDCompositionTarget IID_IDCompositionTarget "{}"
#comfunc global IDCompositionTarget_SetRoot  3 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。