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

ID3D12Fence

COM
IID0a753dcf-c4d8-4b91-adf6-be5a60d95a76継承元ID3D12Pageable自前メソッド開始 vtbl8

公式ドキュメント

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

メソッド 3

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

vtbl 8 ULONGLONG GetCompletedValue()

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

戻り値

型: UINT64

フェンスの現在の値を返します。デバイスが削除されている場合、戻り値は UINT64_MAX になります。

vtbl 9 HRESULT SetEventOnCompletion(ULONGLONG Value, HANDLE hEvent)

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

ValueULONGLONGinイベントをシグナル状態にするフェンス値。
hEventHANDLEinイベントオブジェクトへのハンドル。

戻り値

型: HRESULT

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

解説(Remarks)

イベントが発生する前に複数のフェンスを指定するには、SetEventOnMultipleFenceCompletion を参照してください。

hEvent が null ハンドルの場合、この API は指定されたフェンス値に達するまで戻りません。

このメソッドは、複数のスレッドから同時に安全に呼び出すことができます。

D3D12Multithreading サンプルでは、ID3D12Fence::SetEventOnCompletion を次のように使用しています。

// Wait for the command list to execute; we are reusing the same command 
// list in our main loop but for now, we just want to wait for setup to 
// complete before continuing.

// Signal and increment the fence value.
const UINT64 fenceToWaitFor = m_fenceValue;
ThrowIfFailed(m_commandQueue->Signal(m_fence.Get(), fenceToWaitFor));
m_fenceValue++;

// Wait until the fence is completed.
ThrowIfFailed(m_fence->SetEventOnCompletion(fenceToWaitFor, m_fenceEvent));
WaitForSingleObject(m_fenceEvent, INFINITE);

Direct3D 12 リファレンスのサンプルコードを参照してください。

vtbl 10 HRESULT Signal(ULONGLONG Value)

フェンスを指定した値に設定します。

ValueULONGLONGinフェンスに設定する値。

戻り値

型: HRESULT

このメソッドは、Direct3D 12 のリターンコードのいずれかを返します。

解説(Remarks)

CPU 側からフェンス値を設定するには、このメソッドを使用します。GPU 側からフェンスを設定するには、ID3D12CommandQueue::Signal を使用します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ID3D12Fence "{0A753DCF-C4D8-4B91-ADF6-BE5A60D95A76}"
#usecom global ID3D12Fence IID_ID3D12Fence "{}"
#comfunc global ID3D12Fence_GetCompletedValue     8
#comfunc global ID3D12Fence_SetEventOnCompletion  9 int64,sptr
#comfunc global ID3D12Fence_Signal                10 int64
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。