ホーム › Graphics.DirectComposition › IDCompositionSurfaceFactory

IDCompositionSurfaceFactory

COM

IIDe334bc12-3937-4e02-85eb-fcf4eb30d2c8継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

アプリケーションが提供するレンダリングデバイスに関連付けられたサーフェスオブジェクトおよび仮想サーフェスオブジェクトを作成します。

メソッド 2

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

vtbl 3 HRESULT CreateSurface(DWORD width, DWORD height, DXGI_FORMAT pixelFormat, DXGI_ALPHA_MODE alphaMode, IDCompositionSurface** surface)

合成のために 1 つ以上のビジュアルに関連付けることができるサーフェスオブジェクトを作成します。

width	DWORD	in	サーフェスの幅 (ピクセル単位)。
height	DWORD	in	サーフェスの高さ (ピクセル単位)。
pixelFormat	DXGI_FORMAT	in	サーフェスのピクセル形式。
alphaMode	DXGI_ALPHA_MODE	in	ピクセル形式にアルファチャネルが含まれる場合の、アルファチャネルの形式。DXGI_ALPHA_MODE_PREMULTIPLIED または DXGI_ALPHA_MODE_IGNORE のいずれかを指定できます。DXGI_ALPHA_MODE_UNSPECIFIED を指定することもでき、その場合は DXGI_ALPHA_MODE_IGNORE として解釈されます。
surface	IDCompositionSurface**	out	新しく作成されたサーフェスオブジェクト。このパラメーターを NULL にすることはできません。

戻り値

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

解説(Remarks)

Microsoft DirectComposition のサーフェスは、合成のためにビジュアルへ関連付けることができる矩形のピクセル配列です。

新しく作成されたサーフェスオブジェクトは未初期化の状態です。未初期化の間、サーフェスはビジュアルツリーの合成に影響を与えず、100% 透明なピクセルを持つサーフェスとまったく同じように動作します。

サーフェスをピクセルデータで初期化するには、IDCompositionSurface::BeginDraw メソッドを使用します。このメソッドの最初の呼び出しでは、すべてのピクセルに初期値を与えるためにサーフェス領域全体を対象とする必要があります。以降の呼び出しでは、更新するサーフェスのより小さな部分矩形を指定できます。

幅または高さが最大テクスチャサイズを超える場合、このメソッドは失敗します。最大テクスチャサイズを超える寸法が必要なシナリオでは、CreateVirtualSurface メソッドを使用してください。

DirectComposition のサーフェスは、次のピクセル形式をサポートします。

vtbl 4 HRESULT CreateVirtualSurface(DWORD initialWidth, DWORD initialHeight, DXGI_FORMAT pixelFormat, DXGI_ALPHA_MODE alphaMode, IDCompositionVirtualSurface** virtualSurface)

合成のために 1 つ以上のビジュアルに関連付けることができる、まばらに実体化されたサーフェスを作成します。(IDCompositionSurfaceFactory.CreateVirtualSurface)

initialWidth	DWORD	in	サーフェスの幅 (ピクセル単位)。最大幅は 16,777,216 ピクセルです。
initialHeight	DWORD	in	サーフェスの高さ (ピクセル単位)。最大高さは 16,777,216 ピクセルです。
pixelFormat	DXGI_FORMAT	in	サーフェスのピクセル形式。
alphaMode	DXGI_ALPHA_MODE	in	ピクセル形式にアルファチャネルが含まれる場合の、アルファチャネルの形式。DXGI_ALPHA_MODE_PREMULTIPLIED または DXGI_ALPHA_MODE_IGNORE のいずれかを指定できます。DXGI_ALPHA_MODE_UNSPECIFIED を指定することもでき、その場合は DXGI_ALPHA_MODE_IGNORE として解釈されます。
virtualSurface	IDCompositionVirtualSurface**	out	新しく作成された仮想サーフェスオブジェクト。このパラメーターを NULL にすることはできません。

戻り値

解説(Remarks)

新しく作成された仮想サーフェスオブジェクトは未初期化の状態です。未初期化の間、サーフェスはビジュアルツリーの合成に影響を与えず、100% 透明なピクセルで初期化されたサーフェスとまったく同じように動作します。

サーフェスをピクセルデータで初期化するには、IDCompositionSurface::BeginDraw メソッドを使用します。このメソッドはサーフェスにピクセルを提供するだけでなく、それらのピクセルのための実際の記憶領域も割り当てます。このメモリ割り当ては、アプリケーションがメモリの一部をシステムに返すまで保持されます。アプリケーションは IDCompositionVirtualSurface::Trim メソッドまたは IDCompositionVirtualSurface::Resize メソッドを呼び出すことで、割り当てられたメモリの一部またはすべてを解放できます。

Microsoft DirectComposition のサーフェスは、次のピクセル形式をサポートします。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDCompositionSurfaceFactory "{E334BC12-3937-4E02-85EB-FCF4EB30D2C8}"
#usecom global IDCompositionSurfaceFactory IID_IDCompositionSurfaceFactory "{}"
#comfunc global IDCompositionSurfaceFactory_CreateSurface         3 int,int,int,int,sptr
#comfunc global IDCompositionSurfaceFactory_CreateVirtualSurface  4 int,int,int,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。