ID3D12DebugCommandList1
COM公式ドキュメント
このインターフェイスは、コマンドリストのデバッグレイヤーの追加設定を変更できるようにします。
解説(Remarks)
このインターフェイスは現在プレビュー段階です。
メソッド 3
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
コマンドリストの記録時にサブリソースの状態が判明している場合に、指定した状態がそのサブリソースの状態と一致することを検証します (例:
| pResource | ID3D12Resource* | in | 確認対象の ID3D12Resource を指定します。 |
| Subresource | DWORD | in | 確認するサブリソースのインデックス。インデックスを指定するか、D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES を指定できます。 |
| State | DWORD | in | 確認する状態を指定します。1 つ以上の D3D12_RESOURCE_STATES フラグを OR で組み合わせて指定できます。 |
戻り値
型: BOOL
リソースまたはサブリソースの追跡されている状態が指定した状態と一致する場合は true、それ以外の場合は false を返します。
解説(Remarks)
コマンドリストの実行は記録から遅れて行われるため、コマンドリストの記録時にはリソースの状態が判明していないことがよくあります。AssertResourceState を使用すると、アプリケーション開発者はコマンドリスト内の特定の記録位置において、リソースまたはサブリソースに想定される状態を課すことができます。
リソースまたはサブリソースの状態は、直前のバリアによって判明している場合や、使用方法から推測できる場合 (たとえば、以前の CopyBufferRegion の呼び出しで使用された場合) がよくあります。そのような場合、指定した状態が判明している状態または想定される状態と一致しなければ、AssertResourceState はデバッグメッセージを出力できます。
この API はデバッグ検証専用であり、リソースの実際のランタイム状態や GPU 状態に影響を与えることはありません。
コマンドリストのオプションのデバッグレイヤー設定を変更します。
| Type | D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE | in | 設定するデバッグパラメーターデータの種類を示す D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE の値を指定します。 |
| pData | void* | in | 設定するデバッグパラメーターデータへのポインター。このデータの解釈方法は、Type パラメーターに指定した D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE によって異なります。 |
| DataSize | DWORD | in | デバッグパラメーター pData のサイズをバイト単位で指定します。 |
戻り値
型: HRESULT
このメソッドは Direct3D 12 リターンコードのいずれかを返します。
解説(Remarks)
D3D12 デバッグレイヤーの一部のデバッグ動作は、デバッグパラメーターを設定することで変更できます。これにより、追加の検証を切り替えたり、実験的なデバッグ機能を有効にしたりできます。
ID3D12DebugCommandList1::SetDebugParameter は、関連付けられたコマンドリストのデバッグ設定にのみ影響します。デバイス全体のデバッグパラメーターについては、ID3D12DebugDevice1::SetDebugParameter メソッドを参照してください。
コマンドリストをリセットすると、デバッグパラメーターは既定値に戻ります。これは、コマンドリストのリセットが新しいコマンドリストの作成と同等に扱われるためです。
コマンドリストのオプションのデバッグレイヤー設定を取得します。
| Type | D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE | in | pData が指すメモリにコピーするデバッグパラメーターデータの種類を決定する D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE の値を指定します。 |
| pData | void* | out | デバッグパラメーターデータのコピーが書き込まれるメモリを指します。このデータの解釈方法は、Type パラメーターに指定した D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE によって異なります。 |
| DataSize | DWORD | in | pData が指すメモリバッファーのサイズ (バイト単位)。 |
戻り値
型: HRESULT
成功した場合は S_OK を返し、それ以外の場合は E_INVALIDARG を返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ID3D12DebugCommandList1 "{102CA951-311B-4B01-B11F-ECB83E061B37}"
#usecom global ID3D12DebugCommandList1 IID_ID3D12DebugCommandList1 "{}"
#comfunc global ID3D12DebugCommandList1_AssertResourceState 3 sptr,int,int
#comfunc global ID3D12DebugCommandList1_SetDebugParameter 4 int,sptr,int
#comfunc global ID3D12DebugCommandList1_GetDebugParameter 5 int,sptr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。