ホーム › Graphics.Direct3D12 › ID3D12ShaderCacheSession

ID3D12ShaderCacheSession

COM

📘 Microsoft Learn (日本語) · English

IID28e2495d-0f64-4ae4-a6ec-129255dc49a8継承元ID3D12DeviceChild自前メソッド開始 vtbl8

公式ドキュメント

シェーダーキャッシュセッションを表します。

メソッド 4

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

vtbl 8 HRESULT FindValue(void* pKey, DWORD KeySize, void* pValue, DWORD* pValueSize)

指定されたキーと完全に一致するキーを持つエントリをキャッシュから検索します。

pKey	void*	in	検索するエントリのキー。
KeySize	DWORD	in	キーのサイズ (バイト単位)。
pValue	void*	out	キャッシュされたエントリを受け取るメモリブロックへのポインター。
pValueSize	DWORD*	inout	キャッシュされたエントリのサイズ (バイト単位) を受け取る UINT へのポインター。

戻り値

型: HRESULT

関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

戻り値	説明
DXGI_ERROR_CACHE_HASH_COLLISION	指定されたキーと同じハッシュを持つエントリは存在しますが、キーが完全には一致しません。
DXGI_ERROR_NOT_FOUND	エントリが存在しません。

vtbl 9 HRESULT StoreValue(void* pKey, DWORD KeySize, void* pValue, DWORD ValueSize)

キャッシュにエントリを追加します。

pKey	void*	in	追加するエントリのキー。
KeySize	DWORD	in	キーのサイズ (バイト単位)。
pValue	void*	in	追加するエントリを格納したメモリブロックへのポインター。
ValueSize	DWORD	in	追加するエントリのサイズ (バイト単位)。

戻り値

型: HRESULT

関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

戻り値	説明
DXGI_ERROR_ALREADY_EXISTS	同じキーを持つエントリが既に存在します。
DXGI_ERROR_CACHE_HASH_COLLISION	指定されたキーと同じハッシュを持つエントリは存在しますが、キーが一致しません。
DXGI_ERROR_CACHE_FULL	このエントリを追加すると、キャッシュが最大サイズを超えてしまいます。

vtbl 10 void SetDeleteOnDestroy()

特定のキャッシュに対応するすべてのキャッシュセッションオブジェクトが破棄されたときに、そのキャッシュをクリアします。

解説(Remarks)

ディスクキャッシュは、次のいずれかの方法でクリアできます。

明示的にクリアする方法: セッションオブジェクトに対して SetDeleteOnDestroy を呼び出し、その後セッションを解放します。
明示的にクリアする方法 (開発者モード): ID3D12Device9::ShaderCacheControl を D3D12_SHADER_CACHE_KIND_FLAG_APPLICATION_MANAGED とともに呼び出します。
暗黙的にクリアされる方法: キャッシュの作成時に使用したバージョンと一致しないバージョンでセッションオブジェクトを作成します。
外部からクリアされる方法: ディスククリーンアップユーティリティがキャッシュを列挙してクリアします。ただし、D3D12_SHADER_CACHE_FLAG_USE_WORKING_DIR フラグを指定して作成されたキャッシュでは発生しません。
手動でクリアする方法: D3D12_SHADER_CACHE_FLAG_USE_WORKING_DIR キャッシュについて、ディスク上に保存されたファイル (*.idx、*.val、*.lock) を削除します。作業ディレクトリの外部に保存されているキャッシュに対して、アプリケーションがこれを試みるべきではありません。

vtbl 11 D3D12_SHADER_CACHE_SESSION_DESC GetDesc()

キャッシュセッションの作成に使用された記述を取得します。

戻り値

キャッシュセッションの作成に使用された記述を表す D3D12_SHADER_CACHE_SESSION_DESC 構造体。

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