IDirect3DStateBlock9
COM公式ドキュメント
IDirect3DStateBlock9 (d3d9.h) インターフェイスは、アプリケーションがレンダーステートをカプセル化するために使用します。
解説(Remarks)
このインターフェイスは、パイプラインステートの保存と復元に使用できます。また、現在のステートをキャプチャーするためにも使用できます。
LPDIRECT3DSTATEBLOCK9 型および PDIRECT3DSTATEBLOCK9 型は、IDirect3DStateBlock9 インターフェイスへのポインターとして定義されています。
typedef struct IDirect3DStateBlock9 *LPDIRECT3DSTATEBLOCK9, *PDIRECT3DSTATEBLOCK9;
メソッド 3
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
IDirect3DStateBlock9::GetDevice (d3d9.h) メソッドは、デバイスを取得します。
| ppDevice | IDirect3DDevice9** | out | 返される IDirect3DDevice9 インターフェイスへのポインターです。 |
戻り値
型: HRESULT
メソッドが成功した場合の戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。
IDirect3DStateBlock9::Capture (d3d9.h) メソッドは、ステートブロックに含まれるステートの現在の値をキャプチャーします。
戻り値
型: HRESULT
メソッドが成功した場合の戻り値は D3D_OK です。レコードモード中はキャプチャーを実行できないためメソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。
解説(Remarks)
Capture メソッドは、既存のステートブロック内のステートについて現在の値をキャプチャーします。デバイスのステート全体をキャプチャーするわけではありません。次に例を示します。
IDirect3DStateBlock9* pStateBlock = NULL;
pd3dDevice->BeginStateBlock();
// Add the ZENABLE state to the stateblock
pd3dDevice->SetRenderState ( D3DRS_ZENABLE, D3DZB_TRUE );
pd3dDevice->EndStateBlock ( &pStateBlock );
// Change the current value that is stored in the state block
pd3dDevice->SetRenderState ( D3DRS_ZENABLE, D3DZB_FALSE );
pStateBlock->Capture();
pStateBlock->Release();
空のステートブロックを作成して Capture メソッドを呼び出しても、ステートが 1 つも設定されていなければ何も行われません。
Capture メソッドは、ステートブロックの作成後に明示的または暗黙的に作成されたライトの情報はキャプチャーしません。
IDirect3DStateBlock9::Apply (d3d9.h) メソッドは、ステートブロックを現在のデバイスステートに適用します。
戻り値
型: HRESULT
メソッドが成功した場合の戻り値は D3D_OK です。レコードモード中にメソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IDirect3DStateBlock9 "{B07C4FE5-310D-4BA8-A23C-4F0F206F218B}"
#usecom global IDirect3DStateBlock9 IID_IDirect3DStateBlock9 "{}"
#comfunc global IDirect3DStateBlock9_GetDevice 3 sptr
#comfunc global IDirect3DStateBlock9_Capture 4
#comfunc global IDirect3DStateBlock9_Apply 5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。