ID3D12Device5
COM公式ドキュメント
仮想アダプターを表します。このインターフェイスは ID3D12Device4 を拡張したものです。
メソッド 8
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
アプリケーション定義のコールバックに関連付けられた有効期間トラッカーを作成します。追跡対象オブジェクトの有効期間が変化すると、そのコールバックに通知が送られます。
| pOwner | ID3D12LifetimeOwner* | in | アプリケーション定義のコールバックを表す ID3D12LifetimeOwner インターフェイスへのポインターです。 |
| riid | GUID* | in | ppvTracker で返されるインターフェイスのインターフェイス識別子 (IID) への参照です。 |
| ppvTracker | void** | out | 作成されたオブジェクトの要求されたインターフェイスポインターを受け取るメモリブロックへのポインターです。 |
RemoveDevice を呼び出すと、GPU デバイスで問題が発生してこれ以上使用できないことを Direct3D 12 ランタイムに通知できます。
解説(Remarks)
デバイスの削除ではすべてのフェンスが UINT64_MAX にシグナルされるため、イベントを使ってデバイス削除用のコールバックを作成できます。
HANDLE deviceRemovedEvent = CreateEventW(NULL, FALSE, FALSE, NULL);
assert(deviceRemovedEvent != NULL);
_deviceFence->SetEventOnCompletion(UINT64_MAX, deviceRemoved);
HANDLE waitHandle;
RegisterWaitForSingleObject(
&waitHandle,
deviceRemovedEvent,
OnDeviceRemoved,
_device.Get(), // Pass the device as our context
INFINITE, // No timeout
0 // No flags
);
void OnDeviceRemoved(PVOID context, BOOLEAN)
{
ID3D12Device* removedDevice = (ID3D12Device*)context;
HRESULT removedReason = removedDevice->GetDeviceRemovedReason();
// Perform app-specific device removed operation, such as logging or inspecting DRED output
}
利用可能なメタコマンドに関するリフレクションメタデータを照会します。
| pNumMetaCommands | DWORD* | inout | 照会するメタコマンドの数を格納した UINT へのポインターです。pDescs が nullptr でない限り、このフィールドが pDescs 配列のサイズを決定します。 |
| pDescs | D3D12_META_COMMAND_DESC* | outoptional | 利用可能なメタコマンドの説明を格納する D3D12_META_COMMAND_DESC の配列への省略可能なポインターです。nullptr を渡すと、利用可能なメタコマンドの数が pNumMetaCommands に返されます。 |
戻り値
指定したメタコマンドのパラメーターに関するリフレクションメタデータを照会します。
| CommandId | GUID* | in | パラメーターを pParameterDescs に返したいメタコマンドのグローバル一意識別子 (GUID) への参照です。 |
| Stage | D3D12_META_COMMAND_PARAMETER_STAGE | in | 照会に含めたいパラメーターのステージを指定する D3D12_META_COMMAND_PARAMETER_STAGE です。 |
| pTotalStructureSizeInBytes | DWORD* | outoptional | メタコマンドの作成・初期化・実行時に渡す、パラメーター値を格納した構造体のサイズを受け取る UINT への省略可能なポインターです。 |
| pParameterCount | DWORD* | inout | 照会するパラメーターの数を格納した UINT へのポインターです。pParameterDescs が nullptr でない限り、このフィールドが pParameterDescs 配列のサイズを決定します。 |
| pParameterDescs | D3D12_META_COMMAND_PARAMETER_DESC* | outoptional | パラメーターの説明を格納する D3D12_META_COMMAND_PARAMETER_DESC の配列への省略可能なポインターです。nullptr を渡すと、パラメーター数が pParameterCount に返されます。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
指定したメタコマンドのインスタンスを作成します。
| CommandId | GUID* | in | インスタンス化したいメタコマンドのグローバル一意識別子 (GUID) への参照です。 |
| NodeMask | DWORD | in | 単一アダプター構成では 0 を設定します。複数のアダプターノードがある場合は、メタコマンドを適用するノード (デバイスの物理アダプターの 1 つ) を示すビットを設定します。マスクの各ビットが 1 つのノードに対応します。設定できるビットは 1 つだけです。マルチアダプターシステムを参照してください。 |
| pCreationParametersData | void* | inoptional | メタコマンドを作成するためのパラメーター値を格納した定数構造体への省略可能なポインターです。 |
| CreationParametersDataSizeInBytes | UINT_PTR | in | pCreationParametersData が指定されている場合はそれが指す構造体のサイズを、指定されていない場合は 0 を格納した SIZE_T です。 |
| riid | GUID* | in | ppMetaCommand に返してほしいインターフェイスのグローバル一意識別子 (GUID) への参照です。通常は ID3D12MetaCommand の GUID を指定します。 |
| ppMetaCommand | void** | out | メタコマンドへのポインターを受け取るメモリブロックへのポインターです。これは、作成されたメタコマンドを表す ID3D12MetaCommand へのポインターのアドレスです。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
| 戻り値 | 説明 |
|---|---|
| 現在のハードウェアは、要求されたアルゴリズムをサポートしていません。 |
ID3D12StateObject を作成します。
| pDesc | D3D12_STATE_OBJECT_DESC* | in | 作成するステートオブジェクトの記述です。 |
| riid | GUID* | in | 作成するインターフェイスの GUID です。__uuidof(ID3D12StateObject) を使用します。 |
| ppStateObject | void** | out | 返されるステートオブジェクトです。 |
戻り値
成功した場合は S_OK を返します。それ以外の場合は次のいずれかの値を返します。
- 入力パラメーターのいずれかが無効な場合は E_INVALIDARG。
- ハンドルを作成するための十分なメモリがない場合は E_OUTOFMEMORY。
- Direct3D 12 のリターンコードのトピックで説明されているその他のエラーコード。
高速化構造 (acceleration structure) をビルドするために必要なリソース要件をドライバーに照会します。
| pDesc | D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_INPUTS* | in | 高速化構造のビルドの記述です。この構造体は BuildRaytracingAccelerationStructure と共通です。詳細については、D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_INPUTS を参照してください。 実装は、この構造体および入れ子になった構造体内のすべての CPU パラメーターを参照できます。ただし、D3D12_RAYTRACING_GEOMETRY_TRIANGLES_DESC の省略可能な transform のように、ポインターが NULL かどうかを確認する場合を除き、GPU 仮想アドレスを参照・逆参照することはできません。言い換えると、高速化構造のリソース要件の計算は、実際のジオメトリデータ (頂点位置など) には依存せず、三角形の数やインスタンスの数といった全体的な性質のみに依存します。 |
| pInfo | D3D12_RAYTRACING_ACCELERATION_STRUCTURE_PREBUILD_INFO* | out | 照会の結果です (D3D12_RAYTRACING_ACCELERATION_STRUCTURE_PREBUILD_INFO 構造体で返されます)。 |
解説(Remarks)
入力となる高速化構造の記述は、BuildRaytracingAccelerationStructure に渡すものと同じです。この関数の結果により、アプリケーションは同じジオメトリに対して BuildRaytracingAccelerationStructure に適切な量の出力用ストレージとスクラッチストレージを与えることができます。
ビルドは、GetAccelerationStructurePrebuildInfo に渡した構成と全体としては同じでありながら、ジオメトリ数やインスタンス数、あるいは各ジオメトリ内の頂点数・インデックス数・AABB 数が同数か少ない構成で行うこともできます。この場合、GetRaytracingAccelerationStructurePrebuildInfo に渡した元のサイズに基づいて報告されたストレージ要件は有効なままです。実際のビルドで消費される領域はそれより少なくなることはあっても、多くなることはありません。これは、高速化構造に対して保守的に大きめのストレージを確保しておいて構わないアプリケーションのシナリオで便利です。
このメソッドがコマンドリストではなくデバイスのインターフェイスに用意されているのは、ドライバーが、実際の頂点データやインデックスデータなどを含む GPU メモリへのポインターを逆参照することなく、呼び出しのうち CPU から参照可能な部分だけを見て高速化構造のビルドに必要なリソース要件を計算できるはずだ、という前提によるものです。
シリアル化されたデータ (D3D12_RAYTRACING_ACCELERATION_STRUCTURE_COPY_MODE_SERIALIZE モードで CopyRaytracingAccelerationStructure を呼び出した結果得られる、シリアル化されたレイトレーシング高速化構造など) が現在のデバイス/ドライバーと互換性があるかどうかを報告します。
| SerializedDataType | D3D12_SERIALIZED_DATA_TYPE | in | シリアル化されたデータの種類です。詳細については、D3D12_SERIALIZED_DATA_TYPE を参照してください。 |
| pIdentifierToCheck | D3D12_SERIALIZED_DATA_DRIVER_MATCHING_IDENTIFIER* | in | ドライバーとの照合を行う、シリアル化されたデータのヘッダーに含まれる識別子です。詳細については、D3D12_SERIALIZED_DATA_DRIVER_MATCHING_IDENTIFIER を参照してください。 |
戻り値
返される互換性のステータスです。詳細については、D3D12_DRIVER_MATCHING_IDENTIFIER_STATUS を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ID3D12Device5 "{8B4F173B-2FEA-4B80-8F58-4307191AB95D}" #usecom global ID3D12Device5 IID_ID3D12Device5 "{}" #comfunc global ID3D12Device5_CreateLifetimeTracker 57 sptr,var,sptr #comfunc global ID3D12Device5_RemoveDevice 58 #comfunc global ID3D12Device5_EnumerateMetaCommands 59 var,var #comfunc global ID3D12Device5_EnumerateMetaCommandParameters 60 var,int,var,var,var #comfunc global ID3D12Device5_CreateMetaCommand 61 var,int,sptr,sptr,var,sptr #comfunc global ID3D12Device5_CreateStateObject 62 var,var,sptr #comfunc global ID3D12Device5_GetRaytracingAccelerationStructurePrebuildInfo 63 var,var #comfunc global ID3D12Device5_CheckDriverMatchingIdentifier 64 int,var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ID3D12Device5 "{8B4F173B-2FEA-4B80-8F58-4307191AB95D}" #usecom global ID3D12Device5 IID_ID3D12Device5 "{}" #comfunc global ID3D12Device5_CreateLifetimeTracker 57 sptr,sptr,sptr #comfunc global ID3D12Device5_RemoveDevice 58 #comfunc global ID3D12Device5_EnumerateMetaCommands 59 sptr,sptr #comfunc global ID3D12Device5_EnumerateMetaCommandParameters 60 sptr,int,sptr,sptr,sptr #comfunc global ID3D12Device5_CreateMetaCommand 61 sptr,int,sptr,sptr,sptr,sptr #comfunc global ID3D12Device5_CreateStateObject 62 sptr,sptr,sptr #comfunc global ID3D12Device5_GetRaytracingAccelerationStructurePrebuildInfo 63 sptr,sptr #comfunc global ID3D12Device5_CheckDriverMatchingIdentifier 64 int,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。