IDirect3DCubeTexture9
COM公式ドキュメント
IDirect3DCubeTexture9 (d3d9.h) インターフェイス。アプリケーションは IDirect3DCubeTexture9 インターフェイスのメソッドを使用して、キューブテクスチャリソースを操作します。
解説(Remarks)
IDirect3DCubeTexture9 インターフェイスは、IDirect3DDevice9::CreateCubeTexture メソッド、または D3DXCreateCubeTexturexxx 関数のいずれかを呼び出して取得できます。
このインターフェイスは、IDirect3DBaseTexture9 インターフェイスから追加の機能を継承します。
また、すべての COM インターフェイスと同様に、IUnknown インターフェイスから追加の機能を継承します。
LPDIRECT3DCUBETEXTURE9 型および PDIRECT3DCubeTexture9 型は、IDirect3DCubeTexture9 インターフェイスへのポインターとして定義されています。
typedef struct IDirect3DCubeTexture9 *LPDIRECT3DCUBETEXTURE9, *PDIRECT3DCubeTexture9;
メソッド 5
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
IDirect3DCubeTexture9::GetLevelDesc メソッド (d3d9.h) は、指定したキューブテクスチャレベルの 1 つの面の記述を取得します。
| Level | DWORD | in | ミップマップされたキューブテクスチャのレベルを指定します。 |
| pDesc | D3DSURFACE_DESC* | inout | 指定したキューブテクスチャレベルの 1 つの面を記述する D3DSURFACE_DESC 構造体へのポインターです。 |
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。
解説(Remarks)
D3DSURFACE_DESC 構造体には Width メンバーと Height メンバーが含まれており、キューブ内の 1 つの面のサイズを表します。キューブ全体のサイズを求めるには、Width と Height の積に 6 (キューブの面の数) を掛けます。
IDirect3DCubeTexture9::GetCubeMapSurface メソッド (d3d9.h) は、キューブテクスチャマップのサーフェスを取得します。
| FaceType | D3DCUBEMAP_FACES | in | キューブマップの面を識別する D3DCUBEMAP_FACES 列挙型のメンバーです。 |
| Level | DWORD | in | ミップマップされたキューブテクスチャのレベルを指定します。 |
| ppCubeMapSurface | IDirect3DSurface9** | out | 返されるキューブテクスチャマップのサーフェスを表す IDirect3DSurface9 インターフェイスへのポインターのアドレスです。 |
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。
解説(Remarks)
このメソッドを呼び出すと、IDirect3DSurface9 インターフェイスの内部参照カウントが増加します。この IDirect3DSurface9 インターフェイスの使用を終えた後に IUnknown::Release を呼び出さないと、メモリリークが発生します。
IDirect3DCubeTexture9::LockRect メソッド (d3d9.h) は、キューブテクスチャリソース上の矩形をロックします。
| FaceType | D3DCUBEMAP_FACES | in | キューブマップの面を識別する D3DCUBEMAP_FACES 列挙型のメンバーです。 |
| Level | DWORD | in | ミップマップされたキューブテクスチャのレベルを指定します。 |
| pLockedRect | D3DLOCKED_RECT* | inout | ロックする領域を記述する D3DLOCKED_RECT 構造体へのポインターです。 |
| pRect | RECT* | in | ロックする矩形へのポインターです。RECT 構造体へのポインターで指定します。このパラメーターに NULL を指定すると、ダーティ領域はキューブテクスチャ全体に拡張されます。 |
| Flags | DWORD | in | 実行するロックの種類を表すロックフラグ (0 個以上) の組み合わせです。このメソッドで有効なフラグは次のとおりです。 D3DLOCK_DISCARD を使用する場合、部分矩形を指定することはできません。フラグの説明については、D3DLOCK を参照してください。 |
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。引数のいずれかが無効な場合は D3DERR_INVALIDCALL が返されます。
解説(Remarks)
パフォーマンス上の理由から、ダーティ領域はテクスチャのレベル 0 に対してのみ記録されます。D3DLOCK_NO_DIRTY_UPDATE または D3DLOCK_READONLY を指定せずに IDirect3DCubeTexture9::LockRect を呼び出すと、ダーティ領域が自動的に記録されます。詳細については、IDirect3DDevice9::UpdateTexture を参照してください。
D3DPOOL_DEFAULT で作成されたキューブテクスチャはロックできません。ビデオメモリ内に作成されたキューブテクスチャは、USAGE_DYNAMIC を指定して作成された場合にロックできます。
深度ステンシルテクスチャでロック可能な唯一のフォーマットは D3DFMT_D16_LOCKABLE です。
IDirect3DCubeTexture9::UnlockRect メソッド (d3d9.h) は、キューブテクスチャリソース上の矩形のロックを解除します。
| FaceType | D3DCUBEMAP_FACES | in | キューブマップの面を識別する D3DCUBEMAP_FACES 列挙型のメンバーです。 |
| Level | DWORD | in | ミップマップされたキューブテクスチャのレベルを指定します。 |
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。
IDirect3DCubeTexture9::AddDirtyRect は、キューブテクスチャリソースにダーティ領域を追加します。
| FaceType | D3DCUBEMAP_FACES | in | キューブマップの面を識別する D3DCUBEMAP_FACES 列挙型のメンバーです。 |
| pDirtyRect | RECT* | in | ダーティ領域を指定する RECT 構造体へのポインターです。NULL を指定すると、ダーティ領域はキューブテクスチャ全体に拡張されます。 |
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。
解説(Remarks)
パフォーマンス上の理由から、ダーティ領域はテクスチャのレベル 0 に対してのみ記録されます。サブレベルについては、対応する (スケーリングされた) 矩形またはボックスもダーティであると見なされます。D3DLOCK_NO_DIRTY_UPDATE または D3DLOCK_READONLY を指定せずに IDirect3DCubeTexture9::LockRect を呼び出すと、ダーティ領域が自動的に記録されます。また、IDirect3DDevice9::UpdateSurface の転送先サーフェスも自動的にダーティとしてマークされます。
D3DLOCK_NO_DIRTY_UPDATE を使用してダーティ領域を明示的に指定することで、IDirect3DDevice9::UpdateTexture の効率を高めることができます。この方法により、アプリケーションはリソース上のダーティ領域を指定して、コピーされるリソースの範囲を最適化できます。ただし、アライメントの最適化のためにダーティ領域が拡張される場合があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IDirect3DCubeTexture9 "{FFF32F81-D953-473A-9223-93D652ABA93F}" #usecom global IDirect3DCubeTexture9 IID_IDirect3DCubeTexture9 "{}" #comfunc global IDirect3DCubeTexture9_GetLevelDesc 17 int,var #comfunc global IDirect3DCubeTexture9_GetCubeMapSurface 18 int,int,sptr #comfunc global IDirect3DCubeTexture9_LockRect 19 int,int,var,var,int #comfunc global IDirect3DCubeTexture9_UnlockRect 20 int,int #comfunc global IDirect3DCubeTexture9_AddDirtyRect 21 int,var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IDirect3DCubeTexture9 "{FFF32F81-D953-473A-9223-93D652ABA93F}" #usecom global IDirect3DCubeTexture9 IID_IDirect3DCubeTexture9 "{}" #comfunc global IDirect3DCubeTexture9_GetLevelDesc 17 int,sptr #comfunc global IDirect3DCubeTexture9_GetCubeMapSurface 18 int,int,sptr #comfunc global IDirect3DCubeTexture9_LockRect 19 int,int,sptr,sptr,int #comfunc global IDirect3DCubeTexture9_UnlockRect 20 int,int #comfunc global IDirect3DCubeTexture9_AddDirtyRect 21 int,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。