ホーム › Graphics.Direct3D9 › IDirect3DTexture9

IDirect3DTexture9

COM

📘 Microsoft Learn (日本語) · English

IID85c31227-3de5-4f00-9b3a-f11ac38c18b5継承元IDirect3DBaseTexture9自前メソッド開始 vtbl17

公式ドキュメント

IDirect3DTexture9 (d3d9.h) インターフェイスは、アプリケーションがテクスチャリソースを操作するために使用します。

解説(Remarks)

IDirect3DTexture9 インターフェイスは、IDirect3DDevice9::CreateTexture メソッド、または D3DXCreateTexturexxx 関数のいずれかを呼び出すことで取得できます。

このインターフェイスは、IDirect3DBaseTexture9 インターフェイスから追加の機能を継承します。

このインターフェイスは、すべての COM インターフェイスと同様に IUnknown インターフェイスを継承します。

LPDIRECT3DTEXTURE9 型および PDIRECT3DTEXTURE9 型は、IDirect3DTexture9 インターフェイスへのポインターとして定義されています。


typedef struct IDirect3DTexture9 *LPDIRECT3DTEXTURE9, *PDIRECT3DTEXTURE9;

メソッド 5

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

vtbl 17 HRESULT GetLevelDesc(DWORD Level, D3DSURFACE_DESC* pDesc)

IDirect3DTexture9::GetLevelDesc (d3d9.h) メソッドは、テクスチャリソースのレベル記述を取得します。

Level	DWORD	in	テクスチャリソースのレベルを指定します。このメソッドは、このパラメーターで指定されたレベルのサーフェス記述を返します。
pDesc	D3DSURFACE_DESC*	inout	返されるレベルを記述する D3DSURFACE_DESC 構造体へのポインターです。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。引数のいずれかが無効な場合は D3DERR_INVALIDCALL が返されます。

vtbl 18 HRESULT GetSurfaceLevel(DWORD Level, IDirect3DSurface9** ppSurfaceLevel)

IDirect3DTexture9::GetSurfaceLevel (d3d9.h) メソッドは、指定したテクスチャサーフェスレベルを取得します。

Level	DWORD	in	テクスチャリソースのレベルを指定します。このメソッドは、このパラメーターで指定されたレベルのサーフェスを返します。最上位のサーフェスは 0 で示されます。
ppSurfaceLevel	IDirect3DSurface9**	out	返されるサーフェスを表す IDirect3DSurface9 インターフェイスへのポインターのアドレスです。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。

解説(Remarks)

このメソッドを呼び出すと、IDirect3DSurface9 インターフェイスの内部参照カウントが増加します。この IDirect3DSurface9 インターフェイスの使用を終えた後に IUnknown::Release を呼び出さないと、メモリリークが発生します。

vtbl 19 HRESULT LockRect(DWORD Level, D3DLOCKED_RECT* pLockedRect, RECT* pRect, DWORD Flags)

IDirect3DTexture9::LockRect (d3d9.h) メソッドは、テクスチャリソース上の矩形をロックします。

Level	DWORD	in	ロックするテクスチャリソースのレベルを指定します。
pLockedRect	D3DLOCKED_RECT*	inout	ロックされた領域を記述する D3DLOCKED_RECT 構造体へのポインターです。
pRect	RECT*	in	ロックする矩形へのポインターです。RECT 構造体へのポインターで指定します。このパラメーターに NULL を指定すると、ダーティ領域がテクスチャ全体に拡張されます。
Flags	DWORD	in	実行するロックの種類を表す 0 個以上のロックフラグの組み合わせです。このメソッドで有効なフラグは次のとおりです。 D3DLOCK_DISCARD D3DLOCK_NO_DIRTY_UPDATE D3DLOCK_NOSYSLOCK D3DLOCK_READONLY D3DLOCK_DISCARD を使用する場合、部分矩形を指定することはできません。フラグの説明については、D3DLOCK を参照してください。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。

解説(Remarks)

D3DPOOL_DEFAULT で作成されたテクスチャはロックできません。ビデオメモリ上に作成されたテクスチャは、USAGE_DYNAMIC を指定して作成された場合にロック可能です。

パフォーマンス上の理由から、ダーティ領域はテクスチャのレベル 0 に対してのみ記録されます。IDirect3DTexture9::LockRect が D3DLOCK_NO_DIRTY_UPDATE または D3DLOCK_READONLY を指定せずに呼び出された場合、ダーティ領域は自動的に記録されます。詳細については、IDirect3DDevice9::UpdateTexture を参照してください。

深度ステンシルテクスチャでロック可能な唯一のフォーマットは D3DLOCK_D16_LOCKABLE です。

ビデオメモリテクスチャはロックできず、IDirect3DDevice9::UpdateSurface または IDirect3DDevice9::UpdateTexture を呼び出して変更する必要があります。ただし、Direct3D 9 が認識しない一部の独自ドライバーピクセルフォーマットは例外で、これらはロックできます。

このメソッドは、D3DUSAGE_RENDERTARGET を指定して作成されたテクスチャリソースからデータを取得できません。そのようなテクスチャは D3DPOOL_DEFAULT メモリに割り当てられる必要があり、そのためロックできないからです。この場合は代わりに IDirect3DDevice9::GetRenderTargetData を使用して、テクスチャデータをデバイスメモリからシステムメモリへコピーしてください。

vtbl 20 HRESULT UnlockRect(DWORD Level)

IDirect3DTexture9::UnlockRect (d3d9.h) メソッドは、テクスチャリソース上の矩形のロックを解除します。

Level

DWORD

ロックを解除するテクスチャリソースのレベルを指定します。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。

vtbl 21 HRESULT AddDirtyRect(RECT* pDirtyRect)

IDirect3DTexture9::AddDirtyRect (d3d9.h) メソッドは、テクスチャリソースにダーティ領域を追加します。

pDirtyRect

RECT*

追加するダーティ領域を指定する RECT 構造体へのポインターです。NULL を指定すると、ダーティ領域がテクスチャ全体に拡張されます。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。失敗した場合、戻り値は D3DERR_INVALIDCALL になることがあります。

解説(Remarks)

パフォーマンス上の理由から、ダーティ領域はテクスチャのレベル 0 に対してのみ記録されます。サブレベルについては、対応する (スケーリングされた) 矩形またはボックスも同様にダーティであるとみなされます。IDirect3DTexture9::LockRect が D3DLOCK_NO_DIRTY_UPDATE または D3DLOCK_READONLY を指定せずに呼び出された場合、ダーティ領域は自動的に記録されます。また、IDirect3DDevice9::UpdateSurface のコピー先サーフェスも自動的にダーティとしてマークされます。

D3DLOCK_NO_DIRTY_UPDATE を使用してダーティ領域を明示的に指定すると、IDirect3DDevice9::UpdateTexture の効率を高めることができます。この方法により、アプリケーションはリソース上のダーティ領域を指定して、リソースのどの部分をコピーするかを最適化できます。ただし、アライメントの最適化のためにダーティ領域が拡張される場合があります。

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