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

ID3D12PipelineLibrary

COM
📘 Microsoft Learn (日本語) · English
IIDc64226a8-9201-46af-b4cc-53fb9ff7414f継承元ID3D12DeviceChild自前メソッド開始 vtbl8

公式ドキュメント

パイプラインライブラリを管理します。特に個々の PSO の読み込みと取得を行います。

解説(Remarks)

CreatePipelineLibrary の解説と例を参照してください。

メソッド 5

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

vtbl 8 HRESULT StorePipeline(LPWSTR pName, ID3D12PipelineState* pPipeline)

入力された PSO を、対応する名前とともに内部データベースに追加します。

pNameLPWSTRinoptionalライブラリ内で一意となる名前を指定します。上書きはサポートされていません。
pPipelineID3D12PipelineState*in追加する ID3D12PipelineState を指定します。

戻り値

型: HRESULT

このメソッドは HRESULT の成功コードまたはエラーコードを返します。名前が既に存在する場合は E_INVALIDARG、ライブラリ内に領域を確保できない場合は E_OUTOFMEMORY が返されます。

解説(Remarks)

CreatePipelineLibrary の解説と例を参照してください。

vtbl 9 HRESULT LoadGraphicsPipeline(LPWSTR pName, D3D12_GRAPHICS_PIPELINE_STATE_DESC* pDesc, GUID* riid, void** ppPipelineState)

要求された PSO をライブラリから取得します。

pNameLPWSTRinPSO の一意な名前です。
pDescD3D12_GRAPHICS_PIPELINE_STATE_DESC*in必要な PSO の記述を D3D12_GRAPHICS_PIPELINE_STATE_DESC 構造体で指定します。この入力記述は現在のライブラリデータベース内のデータと照合され、PSO の内容が重複しないように保存されます。
riidGUID*inID3D12PipelineState オブジェクトの REFIID を指定します。通常は、このパラメーターと次のパラメーターをマクロ IID_PPV_ARGS(&PSO1) で設定します（PSO1 はオブジェクトの名前です）。
ppPipelineStatevoid**out返される PSO を参照するポインターを指定します。

戻り値

型: HRESULT

このメソッドは HRESULT の成功コードまたはエラーコードを返します。名前が存在しない場合、または入力された記述がライブラリ内のデータと一致しない場合は E_INVALIDARG、返す PSO を確保できない場合は E_OUTOFMEMORY が返されることがあります。

解説(Remarks)

CreatePipelineLibrary の解説と例を参照してください。

vtbl 10 HRESULT LoadComputePipeline(LPWSTR pName, D3D12_COMPUTE_PIPELINE_STATE_DESC* pDesc, GUID* riid, void** ppPipelineState)

要求された PSO をライブラリから取得します。入力された記述は現在のライブラリデータベース内のデータと照合され、PSO の内容が重複しないように記憶されます。

pNameLPWSTRinPSO の一意な名前です。
pDescD3D12_COMPUTE_PIPELINE_STATE_DESC*in必要な PSO の記述を D3D12_COMPUTE_PIPELINE_STATE_DESC 構造体で指定します。この入力記述は現在のライブラリデータベース内のデータと照合され、PSO の内容が重複しないように保存されます。
riidGUID*inID3D12PipelineState オブジェクトの REFIID を指定します。通常は、このパラメーターと次のパラメーターをマクロ IID_PPV_ARGS(&PSO1) で設定します（PSO1 はオブジェクトの名前です）。
ppPipelineStatevoid**out返される PSO を参照するポインターを指定します。

戻り値

型: HRESULT

このメソッドは HRESULT の成功コードまたはエラーコードを返します。名前が存在しない場合、または入力された記述がライブラリ内のデータと一致しない場合は E_INVALIDARG、返す PSO を確保できない場合は E_OUTOFMEMORY が返されることがあります。

解説(Remarks)

CreatePipelineLibrary の解説と例を参照してください。

vtbl 11 UINT_PTR GetSerializedSize()

データベースの現在の内容をシリアル化するために必要なメモリ量を返します。

戻り値

型: SIZE_T

このメソッドは、必要なサイズ（バイト単位）を格納した SIZE_T を返します。

解説(Remarks)

CreatePipelineLibrary の解説と例を参照してください。

vtbl 12 HRESULT Serialize(void* pData, UINT_PTR DataSizeInBytes)

ライブラリの内容を指定されたメモリに書き込みます。書き込まれたデータは、後でランタイムに渡すことができます。

pDatavoid*outデータへのポインターを指定します。このメモリは、入力されたサイズまで読み取りおよび書き込みが可能である必要があります。このデータは保存しておき、後で CreatePipelineLibrary に渡すことができます。同一プロセスの将来のインスタンスや、他のプロセスでも利用できます。ただし、ランタイムまたはドライバーが更新されるとデータは無効になり、他のハードウェアやデバイスへの移植性はありません。
DataSizeInBytesUINT_PTRin指定するサイズは、少なくとも GetSerializedSize が返したサイズ以上である必要があります。

戻り値

型: HRESULT

このメソッドは HRESULT の成功コードまたはエラーコードを返します。指定されたバッファーのサイズが十分でない場合は E_INVALIDARG が返されます。

解説(Remarks)

CreatePipelineLibrary の解説と例を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ID3D12PipelineLibrary "{C64226A8-9201-46AF-B4CC-53FB9FF7414F}"
#usecom global ID3D12PipelineLibrary IID_ID3D12PipelineLibrary "{}"
#comfunc global ID3D12PipelineLibrary_StorePipeline         8 wstr,sptr
#comfunc global ID3D12PipelineLibrary_LoadGraphicsPipeline  9 wstr,var,var,sptr
#comfunc global ID3D12PipelineLibrary_LoadComputePipeline   10 wstr,var,var,sptr
#comfunc global ID3D12PipelineLibrary_GetSerializedSize     11
#comfunc global ID3D12PipelineLibrary_Serialize             12 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。