ホーム › Graphics.Direct3D11 › ID3D11Fence

ID3D11Fence

COM

📘 Microsoft Learn (日本語) · English

IIDaffde9d1-1df7-4bb7-8a34-0f46251dab80継承元ID3D11DeviceChild自前メソッド開始 vtbl7

公式ドキュメント

フェンスを表します。フェンスは、CPU と 1 つ以上の GPU の同期に使用されるオブジェクトです。(ID3D11Fence)

メソッド 3

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

vtbl 7 HRESULT CreateSharedHandle(SECURITY_ATTRIBUTES* pAttributes, DWORD dwAccess, LPWSTR lpName, HANDLE* pHandle)

フェンスオブジェクトへの共有ハンドルを作成します。

pAttributes	SECURITY_ATTRIBUTES*	inoptional	SECURITY_ATTRIBUTES 構造体へのポインターです。この構造体には、独立しているが関連する 2 つのデータメンバー、すなわち省略可能なセキュリティ記述子と、子プロセスが返されたハンドルを継承できるかどうかを決定する Boolean 値が含まれます。アプリケーションが作成する可能性のある子プロセスに CreateSharedHandle が返すハンドルを継承させたくない場合、および返されたハンドルに関連付けられるリソースに既定のセキュリティ記述子を設定したい場合は、このパラメーターに NULL を設定します。構造体の lpSecurityDescriptor メンバーは、リソースの SECURITY_DESCRIPTOR を指定します。返されたハンドルに関連付けられるリソースに、ランタイムが既定のセキュリティ記述子を割り当てるようにするには、このメンバーに NULL を設定します。リソースの既定のセキュリティ記述子内の ACL は、作成者のプライマリトークンまたは偽装トークンから取得されます。詳細については、「Synchronization Object Security and Access Rights」を参照してください。
dwAccess	DWORD	in	現在、このパラメーターが受け付ける値は GENERIC_ALL のみです。
lpName	LPWSTR	inoptional	共有ヒープに関連付ける名前を含む、NULL で終わる UNICODE 文字列です。名前は MAX_PATH 文字までに制限されます。名前の比較では大文字と小文字が区別されます。 Name が既存のリソースの名前と一致する場合、CreateSharedHandle は DXGI_ERROR_NAME_ALREADY_EXISTS で失敗します。これは、これらのオブジェクトが同じ名前空間を共有するために発生します。名前には "Global" または "Local" というプレフィックスを付けて、グローバル名前空間またはセッション名前空間にオブジェクトを明示的に作成できます。名前の残りの部分には、円記号 (\) 以外の任意の文字を含めることができます。詳細については、「Kernel Object Namespaces」を参照してください。高速ユーザー切り替えはターミナルサービスのセッションを使用して実装されています。アプリケーションが複数のユーザーをサポートできるように、カーネルオブジェクト名はターミナルサービスのガイドラインに従う必要があります。オブジェクトはプライベート名前空間に作成できます。詳細については、「Object Namespaces」を参照してください。
pHandle	HANDLE*	out	共有するリソースの NT HANDLE 値を受け取る変数へのポインターです。このハンドルは、リソースにアクセスするための呼び出しで使用できます。

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合は、次のいずれかの値を返します。

パラメーターのいずれかが無効な場合は DXGI_ERROR_INVALID_CALL。
共有するリソースに指定された名前が既に別のリソースに関連付けられている場合は DXGI_ERROR_NAME_ALREADY_EXISTS。
保護された名前空間にオブジェクトを作成しようとした場合は E_ACCESSDENIED。
ハンドルを作成するのに十分なメモリがない場合は E_OUTOFMEMORY。
「Direct3D 11 Return Codes」に記載されているその他のエラーコードが返される場合もあります。

解説(Remarks)

指定したフェンスの共有ハンドルを作成するには、そのフェンスが D3D11_FENCE_FLAG_SHARED または D3D11_FENCE_FLAG_SHARED_CROSS_ADAPTER フラグを指定して作成されている必要があります。詳細については、D3D11_FENCE_FLAG 列挙型を参照してください。

vtbl 8 ULONGLONG GetCompletedValue()

フェンスの現在の値を取得します。(ID3D11Fence.GetCompletedValue)

戻り値

型: UINT64

フェンスの現在の値を返します。

vtbl 9 HRESULT SetEventOnCompletion(ULONGLONG Value, HANDLE hEvent)

フェンスが特定の値に達したときに発生させるイベントを指定します。(ID3D11Fence.SetEventOnCompletion)

Value	ULONGLONG	in	イベントをシグナル状態にするフェンスの値です。
hEvent	HANDLE	in	イベントオブジェクトへのハンドルです。

戻り値

型: HRESULT

カーネルコンポーネントがイベントをリストに格納するのに十分なメモリを持たない場合、このメソッドは E_OUTOFMEMORY を返します。その他の戻り値については、「Direct3D 11 Return Codes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ID3D11Fence "{AFFDE9D1-1DF7-4BB7-8A34-0F46251DAB80}"
#usecom global ID3D11Fence IID_ID3D11Fence "{}"
#comfunc global ID3D11Fence_CreateSharedHandle    7 var,int,wstr,sptr
#comfunc global ID3D11Fence_GetCompletedValue     8
#comfunc global ID3D11Fence_SetEventOnCompletion  9 int64,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ID3D11Fence "{AFFDE9D1-1DF7-4BB7-8A34-0F46251DAB80}"
#usecom global ID3D11Fence IID_ID3D11Fence "{}"
#comfunc global ID3D11Fence_CreateSharedHandle    7 sptr,int,wstr,sptr
#comfunc global ID3D11Fence_GetCompletedValue     8
#comfunc global ID3D11Fence_SetEventOnCompletion  9 int64,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。