IDirect3DSurface9
COM公式ドキュメント
IDirect3DSurface9 (d3d9.h) インターフェイスは、アプリケーションがサーフェスを問い合わせたり準備したりするために使用します。
解説(Remarks)
LPDIRECT3DSURFACE9 型および PDIRECT3DSURFACE9 型は、IDirect3DSurface9 インターフェイスへのポインターとして定義されています。
typedef struct IDirect3DSurface9 *LPDIRECT3DSURFACE9, *PDIRECT3DSURFACE9;
メソッド 6
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
IDirect3DSurface9::GetContainer (d3d9.h) メソッドは、親であるキューブテクスチャまたはテクスチャ (ミップマップ) オブジェクトへのアクセスを提供します。
| riid | GUID* | in | 要求するコンテナーの参照識別子です。 |
| ppContainer | void** | inout | クエリが成功した場合に、コンテナーへのポインターが格納されるポインターのアドレスです。「解説」を参照してください。 |
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。
解説(Remarks)
サーフェスが CreateRenderTarget、CreateOffscreenPlainSurface、または CreateDepthStencilSurface で作成された場合、そのサーフェスはスタンドアロンとみなされます。この場合、GetContainer はサーフェスの作成に使用された Direct3D デバイスを返します。
呼び出しが成功すると、コンテナーの参照カウントが 1 つ増加します。
以下は、ミップサーフェスの親テクスチャを取得する例です。
// Assumes pSurface is a valid IDirect3DSurface9 pointer
void *pContainer = NULL;
IDirect3DTexture9 *pTexture = NULL;
HRESULT hr = pSurface->GetContainer(IID_IDirect3DTexture9, &pContainer);
if (SUCCEEDED(hr) && pContainer)
{
pTexture = (IDirect3DTexture9 *)pContainer;
}
IDirect3DSurface9::GetDesc (d3d9.h) メソッドは、サーフェスの記述を取得します。
| pDesc | D3DSURFACE_DESC* | inout | サーフェスを記述する D3DSURFACE_DESC 構造体へのポインターです。 |
戻り値
IDirect3DSurface9::LockRect (d3d9.h) メソッドは、サーフェス上の矩形をロックします。
| pLockedRect | D3DLOCKED_RECT* | inout | ロックされた領域を記述する D3DLOCKED_RECT 構造体へのポインターです。 |
| pRect | RECT* | in | ロックする矩形へのポインターです。RECT 構造体へのポインターで指定します。このパラメーターに NULL を指定すると、ダーティリージョンがサーフェス全体に拡張されます。 |
| Flags | DWORD | in | 実行するロックの種類を示す、0 個以上のロックフラグの組み合わせです。このメソッドで有効なフラグは次のとおりです。 D3DLOCK_DISCARD を使用する場合、部分矩形を指定することはできません。フラグの説明については、D3DLOCK を参照してください。 |
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。
メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL または D3DERR_WASSTILLDRAWING になることがあります。
解説(Remarks)
D3DLOCK_DONOTWAIT フラグが指定されていて、ドライバーがサーフェスをすぐにロックできない場合、IDirect3DSurface9::LockRect は D3DERR_WASSTILLDRAWING を返します。これにより、アプリケーションはドライバーがサーフェスをロックするのを待つ間、CPU サイクルを利用できます。
深度ステンシルサーフェスでロック可能な唯一のフォーマットは D3DFMT_D16_LOCKABLE です。D3DFORMAT を参照してください。
パフォーマンス上の理由から、ダーティリージョンはテクスチャのレベル 0 に対してのみ記録されます。ダーティリージョンは、IDirect3DSurface9::LockRect が D3DLOCK_NO_DIRTY_UPDATE または D3DLOCK_READONLY を指定せずに呼び出されたときに自動的に記録されます。詳細については、IDirect3DDevice9::UpdateTexture を参照してください。
マルチサンプルのバックバッファーはロックできません。
このメソッドは、D3DUSAGE_RENDERTARGET で作成されたテクスチャリソースに含まれるサーフェスからデータを取得できません。そのようなテクスチャは D3DPOOL_DEFAULT メモリに割り当てられる必要があり、ロックできないためです。この場合は、代わりに IDirect3DDevice9::GetRenderTargetData を使用して、テクスチャデータをデバイスメモリからシステムメモリへコピーしてください。
IDirect3DSurface9::UnlockRect (d3d9.h) メソッドは、サーフェス上の矩形のロックを解除します。
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。
IDirect3DSurface9::GetDC (d3d9.h) メソッドは、デバイスコンテキストを取得します。
| phdc | HDC* | inout | サーフェスのデバイスコンテキストへのポインターです。 |
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。引数が無効な場合は D3DERR_INVALIDCALL が返されます。
解説(Remarks)
次の制限が適用されます。
- IDirect3DSurface9::GetDC は、D3DFMT_R5G6B5、D3DFMT_X1R5G5B5、D3DFMT_R8G8B8、D3DFMT_X8R8G8B8 のフォーマットでのみ有効です。アルファを含むフォーマットはサポートされません。GDI の実装ではアルファチャンネルに対する動作が明確に定義されていないためです。フォーマットの詳細については、D3DFORMAT を参照してください。
- 1 つのサーフェスにつき、同時に返せるデバイスコンテキストは 1 つだけです。
- サーフェスが既にロックされている場合、IDirect3DSurface9::GetDC は失敗します。サーフェスがミップマップまたはキューブマップのメンバーである場合、他のミップマップまたはキューブマップのメンバーがロックされていると IDirect3DSurface9::GetDC は失敗します。
- レンダーターゲットがロック可能として作成されていない限り (バックバッファーの場合は D3DPRESENTFLAG_LOCKABLE_BACKBUFFER フラグ付きで作成されていない限り)、IDirect3DSurface9::GetDC はレンダーターゲットに対して失敗します。
- IDirect3DDevice9::CreateOffscreenPlainSurface で作成されていないサーフェスの場合、IDirect3DSurface9::GetDC は既定プール (D3DPOOL_DEFAULT) のサーフェスに対して失敗します。ただし、そのサーフェスが動的 (D3DUSAGE_DYNAMIC) であるか、ロック可能なレンダーターゲットである場合を除きます。
- IDirect3DSurface9::GetDC は D3DPOOL_SCRATCH のサーフェスに対して失敗します。
| IDirect3DCubeTexture9 | IDirect3DCubeTexture9::LockRect |
| IDirect3DDevice9 | IDirect3DDevice9::ColorFill |
| IDirect3DDevice9::StretchRect | |
| IDirect3DDevice9::UpdateSurface | |
| IDirect3DDevice9::UpdateTexture | |
| IDirect3DSurface9 | IDirect3DSurface9::LockRect |
| IDirect3DSwapChain9 | IDirect3DSwapChain9::Present * |
| IDirect3DTexture9 | IDirect3DTexture9::LockRect |
- (そのサーフェスを含むスワップチェーンに対して)
IDirect3DSurface9::GetDC は暗黙的なロックを引き起こします。デバイスコンテキストを後で使用するために保持しないでください。解放するには IDirect3DSurface9::ReleaseDC を呼び出します。
ミップマップやキューブマップの各レベルに対して IDirect3DSurface9::GetDC/IDirect3DSurface9::ReleaseDC を呼び出すことは有効です。ただし、最上位レベル以外のすべてのミップレベルではこれらの呼び出しは低速であり、それらのミップレベルに対する GDI 操作はアクセラレートされません。
hdc は Win32 および GDI の機能へのアクセスを提供します。
IDirect3DSurface9::ReleaseDC (d3d9.h) メソッドは、デバイスコンテキストハンドルを解放します。
| hdc | HDC | in | デバイスコンテキストのハンドルです。 |
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は D3D_OK です。引数が無効な場合は D3DERR_INVALIDCALL が返されます。
解説(Remarks)
hdc は Windows のリソースです。Windows が利用可能なリソースのプールに戻せるよう、使用後は解放する必要があります。
このメソッドは、IDirect3DSurface9::GetDC が返したデバイスコンテキストのみを解放します。それ以外の場合、このメソッドは失敗します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IDirect3DSurface9 "{0CFBAF3A-9FF6-429A-99B3-A2796AF8B89B}" #usecom global IDirect3DSurface9 IID_IDirect3DSurface9 "{}" #comfunc global IDirect3DSurface9_GetContainer 11 var,sptr #comfunc global IDirect3DSurface9_GetDesc 12 var #comfunc global IDirect3DSurface9_LockRect 13 var,var,int #comfunc global IDirect3DSurface9_UnlockRect 14 #comfunc global IDirect3DSurface9_GetDC 15 sptr #comfunc global IDirect3DSurface9_ReleaseDC 16 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IDirect3DSurface9 "{0CFBAF3A-9FF6-429A-99B3-A2796AF8B89B}" #usecom global IDirect3DSurface9 IID_IDirect3DSurface9 "{}" #comfunc global IDirect3DSurface9_GetContainer 11 sptr,sptr #comfunc global IDirect3DSurface9_GetDesc 12 sptr #comfunc global IDirect3DSurface9_LockRect 13 sptr,sptr,int #comfunc global IDirect3DSurface9_UnlockRect 14 #comfunc global IDirect3DSurface9_GetDC 15 sptr #comfunc global IDirect3DSurface9_ReleaseDC 16 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。