ホーム › Graphics.DirectComposition › IDCompositionDesktopDevice

IDCompositionDesktopDevice

COM

📘 Microsoft Learn (日本語) · English

IID5f4633fe-1e08-4cb8-8c75-ce24333f5602継承元IDCompositionDevice2自前メソッド開始 vtbl24

公式ドキュメント

Win32 デスクトップアプリケーションで DirectComposition を使用するには、アプリケーションは IDCompositionDesktopDevice インターフェイスを使用する必要があります。

メソッド 3

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

vtbl 24 HRESULT CreateTargetForHwnd(HWND hwnd, BOOL topmost, IDCompositionTarget** target)

指定されたウィンドウハンドルで表されるウィンドウにバインドされた合成ターゲットオブジェクトを作成します。

hwnd	HWND	in	合成ターゲットオブジェクトのバインド先となるウィンドウ。このパラメーターに NULL を指定することはできません。
topmost	BOOL	in	hwnd パラメーターで指定したウィンドウの子ウィンドウよりも手前にビジュアルツリーを表示する場合は TRUE。それ以外の場合、ビジュアルツリーは子ウィンドウの背後に表示されます。
target	IDCompositionTarget**	out	新しい合成ターゲットオブジェクト。このパラメーターに NULL を指定することはできません。

戻り値

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

解説(Remarks)

画面に何かを表示するには、DirectComposition のビジュアルツリーをウィンドウにバインドする必要があります。ウィンドウはトップレベルウィンドウでも子ウィンドウでもかまいません。いずれの場合もレイヤードウィンドウを使用できますが、そのウィンドウは呼び出し元のプロセスに属している必要があります。ウィンドウが別のプロセスに属している場合、このメソッドは DCOMPOSITION_ERROR_ACCESS_DENIED を返します。

DirectComposition のコンテンツがウィンドウに合成されるとき、そのコンテンツは、GetDC 関数から返されるデバイスコンテキストを通じて、または DirectX の Present メソッドの呼び出しによって、そのウィンドウに直接描画された内容の上に常に合成されます。ただし、DirectComposition のコンテンツにはウィンドウのクリッピング規則が適用されるため、ウィンドウに子ウィンドウがある場合、それらの子ウィンドウがビジュアルツリーをクリップすることがあります。子ウィンドウがビジュアルツリーをクリップするかどうかは、topmost パラメーターによって決まります。

概念的には、各ウィンドウは次の 4 つのレイヤーで構成されます。

ウィンドウハンドルに直接描画されたコンテンツ (これが最下層です)。
省略可能な DirectComposition のビジュアルツリー。
すべての子ウィンドウのコンテンツ (存在する場合)。
もう 1 つの省略可能な DirectComposition のビジュアルツリー (これが最上層です)。

これら 4 つのレイヤーはすべて、ウィンドウの可視領域にクリップされます。

システム内の各ウィンドウに対して作成できる合成ターゲットは、最上層のものが 1 つ、最上層でないものが 1 つの、最大 2 つまでです。指定したレイヤーで指定したウィンドウに既に合成ターゲットがバインドされている場合、このメソッドは失敗します。合成ターゲットオブジェクトが破棄されると、それが合成していたレイヤーは新しい合成ターゲットオブジェクトで使用できるようになります。

vtbl 25 HRESULT CreateSurfaceFromHandle(HANDLE handle, IUnknown** surface)

既存の合成サーフェスをラップする新しい合成サーフェスオブジェクトを作成します。

handle	HANDLE	in	DCompositionCreateSurfaceHandle 関数の呼び出しによって作成された既存の合成サーフェスのハンドル。
surface	IUnknown**	out	新しい合成サーフェスオブジェクト。このパラメーターに NULL を指定することはできません。

戻り値

vtbl 26 HRESULT CreateSurfaceFromHwnd(HWND hwnd, IUnknown** surface)

レイヤードウィンドウのラスタライズ結果を表し、合成のためにビジュアルに関連付けることができるラッパーオブジェクトを作成します。

hwnd	HWND	in	ラッパーを作成する対象となるレイヤードウィンドウのハンドル。レイヤードウィンドウは、CreateWindowEx 関数でウィンドウを作成する際に WS_EX_LAYERED を指定するか、ウィンドウの作成後に SetWindowLong で WS_EX_LAYERED を設定することで作成されます。
surface	IUnknown**	out	新しい合成サーフェスオブジェクト。このパラメーターに NULL を指定することはできません。

戻り値

解説(Remarks)

このサーフェスポインターは IDCompositionVisual::SetContent メソッドの呼び出しに使用して、1 つ以上のビジュアルのコンテンツを設定できます。コンテンツを設定すると、対象のウィンドウがレイヤードである限り、これらのビジュアルは指定したレイヤードウィンドウの内容を合成します。ウィンドウのレイヤード属性が解除されると、そのウィンドウのコンテンツは合成ツリーの出力から消えます。その後で再びレイヤード化されると、ビジュアルとの関連付けが残っている限りウィンドウのコンテンツは再び表示されます。ウィンドウのサイズが変更された場合、影響を受けるビジュアルは再合成されます。

ウィンドウのコンテンツはウィンドウの寿命を超えてキャッシュされることはありません。つまり、ウィンドウが破棄されると、影響を受けるビジュアルはそのウィンドウの合成を停止します。

ウィンドウが画面外に移動されたり、サイズがゼロに変更されたりした場合、システムはそれらのビジュアルのコンテンツの合成を停止します。システムにビジュアルのコンテンツの合成を継続させながら元のウィンドウを非表示にする必要がある場合は、DwmSetWindowAttribute 関数を DWMWA_CLOAK フラグとともに使用して、レイヤード子ウィンドウを「クローク」してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDCompositionDesktopDevice "{5F4633FE-1E08-4CB8-8C75-CE24333F5602}"
#usecom global IDCompositionDesktopDevice IID_IDCompositionDesktopDevice "{}"
#comfunc global IDCompositionDesktopDevice_CreateTargetForHwnd      24 sptr,int,sptr
#comfunc global IDCompositionDesktopDevice_CreateSurfaceFromHandle  25 sptr,sptr
#comfunc global IDCompositionDesktopDevice_CreateSurfaceFromHwnd    26 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。