ホーム › Graphics.Direct3D › ID3DInclude

ID3DInclude

COM

📘 Microsoft Learn (日本語) · English

自前メソッド開始 vtbl0

公式ドキュメント

ID3DInclude は、シェーダーのオープンおよびクローズについてユーザーがオーバーライド可能なメソッドをアプリケーションから呼び出せるようにするために、ユーザーが実装する include インターフェイスです

解説(Remarks)

このインターフェイスを使用するには、ID3DInclude を継承したインターフェイスを作成し、各メソッドに独自の動作を実装します。

メソッド 2

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

vtbl 0 HRESULT Open(D3D_INCLUDE_TYPE IncludeType, LPSTR pFileName, void* pParentData, void** ppData, DWORD* pBytes)

シェーダーの内容を開いて読み取るための、ユーザー実装のメソッド

IncludeType	D3D_INCLUDE_TYPE	in	#include ファイルの場所を示す D3D_INCLUDE_TYPE 型の値です。
pFileName	LPSTR	in	#include ファイルの名前です。
pParentData	void*	in	#include ファイルを含むコンテナーへのポインターです。コンパイラーは pParentData に NULL を渡す場合があります。詳細については、Compile an Effect (Direct3D 11) の「Searching for Include Files」セクションを参照してください。
ppData	void**	inout	include ディレクティブを含むバッファーへのポインターです。このポインターは ID3DInclude::Close を呼び出すまで有効です。
pBytes	DWORD*	inout	Open が ppData に返すバイト数へのポインターです。

戻り値

型: HRESULT

ユーザーが実装するこのメソッドは S_OK を返す必要があります。Open が #include ファイルの読み取りに失敗した場合、Open の呼び出し元となったアプリケーションプログラミングインターフェイス (API) も失敗します。この失敗は、次のいずれかの状況で発生します。

高レベルシェーダー言語 (HLSL) シェーダーが D3D10CompileShader*** 関数のいずれかで失敗する。
エフェクトが D3D10CreateEffect*** 関数のいずれかで失敗する。

vtbl 1 HRESULT Close(void* pData)

シェーダーを閉じるための、ユーザー実装のメソッド

pData

void*

include ディレクティブを含むバッファーへのポインターです。これは、対応する ID3DInclude::Open の呼び出しが返したポインターです。

戻り値

型: HRESULT

ユーザーが実装する Close メソッドは S_OK を返す必要があります。Close が #include ファイルのクローズに失敗した場合、Close の呼び出し元となったアプリケーションプログラミングインターフェイス (API) も失敗します。この失敗は、次のいずれかの状況で発生します。

高レベルシェーダー言語 (HLSL) シェーダーが D3D10CompileShader*** 関数のいずれかで失敗する。
エフェクトが D3D10CreateEffect*** 関数のいずれかで失敗する。

解説(Remarks)

ID3DInclude::Open が成功した場合、ID3DInclude インターフェイスを使用する API が復帰する前に、Close が必ず呼び出されます。

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