ホーム › Graphics.Direct3D9 › IDirect3DResource9

IDirect3DResource9

COM

📘 Microsoft Learn (日本語) · English

IID05eec05d-8f7d-4362-b999-d1baf357c704継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IDirect3DResource9 (d3d9.h) インターフェイスは、アプリケーションがリソースを照会および準備するために使用します。

解説(Remarks)

テクスチャリソースを作成するには、次のいずれかのメソッドを呼び出します。

ジオメトリ指向のリソースを作成するには、次のいずれかのメソッドを呼び出します。

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

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


    typedef struct IDirect3DResource9 *LPDIRECT3DRESOURCE9, *PDIRECT3DRESOURCE9;

メソッド 8

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

vtbl 3 HRESULT GetDevice(IDirect3DDevice9** ppDevice)

IDirect3DResource9::GetDevice (d3d9.h) メソッドは、リソースに関連付けられたデバイスを取得します。

ppDevice

IDirect3DDevice9**

out

照会が成功した場合にデバイスポインターが格納される、IDirect3DDevice9 インターフェイスへのポインターのアドレスです。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドを使用すると、所有元のデバイスオブジェクトをたどることができます。

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

vtbl 4 HRESULT SetPrivateData(GUID* refguid, void* pData, DWORD SizeOfData, DWORD Flags)

IDirect3DResource9::SetPrivateData (d3d9.h) メソッドは、Direct3D ではなくアプリケーションが使用することを目的としたデータをリソースに関連付けます。

refguid

GUID*

設定するプライベートデータを識別するグローバル一意識別子への参照です。

pData

void*

リソースに関連付けるデータが格納されたバッファーへのポインターです。

SizeOfData

DWORD

pData のバッファーのサイズ (バイト単位) です。

Flags

DWORD

渡されるデータの種類を示す値、またはリソースが変更されたときにデータを無効化すべきであることをアプリケーションに示す値です。

項目

説明

(なし)

フラグを指定しない場合、Direct3D はバッファー内のデータを保持するメモリを割り当て、そのデータを新しいバッファーにコピーします。Direct3D が割り当てたバッファーは、適切なタイミングで自動的に解放されます。

D3DSPD_IUNKNOWN

pData のデータは IUnknown インターフェイスへのポインターです。 SizeOfData には IUnknown へのポインターのサイズ、すなわち sizeof(IUnknown*) を設定する必要があります。プライベートデータが破棄されるとき、Direct3D は pData を通じて IUnknown を自動的に呼び出します。プライベートデータは、同じ GUID を指定した IDirect3DResource9::SetPrivateData の後続の呼び出し、IDirect3DResource9::FreePrivateData の後続の呼び出し、または IDirect3D9 オブジェクトが解放されたときに破棄されます。詳細については「解説」を参照してください。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。失敗した場合、戻り値は次のいずれかになることがあります: D3DERR_INVALIDCALL、E_OUTOFMEMORY。

解説(Remarks)

Direct3D は pData のメモリを管理しません。このバッファーが動的に割り当てられたものである場合、そのメモリを解放するのは呼び出し元アプリケーションの責任です。

vtbl 5 HRESULT GetPrivateData(GUID* refguid, void* pData, DWORD* pSizeOfData)

IDirect3DResource9::GetPrivateData (d3d9.h) メソッドは、リソースに関連付けられたプライベートデータを、指定されたバッファーにコピーします。

refguid	GUID*	in	取得するプライベートデータを識別するグローバル一意識別子です。
pData	void*	inout	呼び出しが成功した場合に、要求されたプライベートデータが格納される、あらかじめ割り当てられたバッファーへのポインターです。このバッファーの割り当てと解放は、このメソッドを呼び出すアプリケーションの責任です。このパラメーターが NULL の場合、このメソッドは pSizeOfData にバッファーサイズを返します。
pSizeOfData	DWORD*	inout	pData のバッファーのサイズ (バイト単位) へのポインターです。この値がプライベートデータの実際のサイズより小さい場合 (0 など)、メソッドはこのパラメーターに必要なバッファーサイズを設定し、D3DERR_MOREDATA を返します。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。失敗した場合、戻り値は次のいずれかになることがあります: D3DERR_INVALIDCALL、D3DERR_MOREDATA、D3DERR_NOTFOUND。

解説(Remarks)

このメソッドは、次のインターフェイスに継承されます。

IDirect3DResource9,

IDirect3DBaseTexture9,

IDirect3DCubeTexture9,

IDirect3DTexture9,

IDirect3DVolumeTexture9,

IDirect3DIndexBuffer9,

IDirect3DVertexBuffer9。

返されるデータが、D3DSPD_IUNKNOWN フラグ付きの SetPrivateData によって以前に設定された IUnknown またはその派生クラスへのポインターである場合、プライベートデータが返される前にそのインターフェイスの参照カウントが増加します。

vtbl 6 HRESULT FreePrivateData(GUID* refguid)

IDirect3DResource9::FreePrivateData (d3d9.h) メソッドは、このリソースに関連付けられた指定のプライベートデータを解放します。

refguid

GUID*

解放するプライベートデータを識別するグローバル一意識別子への参照です。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。失敗した場合、戻り値は次のいずれかになることがあります: D3DERR_INVALIDCALL、D3DERR_NOTFOUND。

解説(Remarks)

リソースが解放されるとき、Direct3D はこのメソッドを自動的に呼び出します。

vtbl 7 DWORD SetPriority(DWORD PriorityNew)

IDirect3DResource9::SetPriority (d3d9.h) メソッドは、スケジューリングの目的でリソースの優先度を割り当てます。

PriorityNew

DWORD

リソースに割り当てる優先度です。

Direct3D 9 と Windows Vista 用 Direct3D 9 との違い

優先度には任意の DWORD 値を指定できます。Windows Vista 用の Direct3D 9 では、あらかじめ定義された値 D3D9_RESOURCE_PRIORITY もサポートされます。

戻り値

型: DWORD

リソースの以前の優先度の値を返します。

解説(Remarks)

このメソッドは、管理対象リソース (D3DPOOL_MANAGED フラグを指定して作成されたリソース) の優先度を変更するために使用します。管理対象外のリソースに対しては 0 を返します。

優先度は、管理対象リソースをメモリから削除するタイミングを決定するために使用されます。低い優先度が割り当てられたリソースは、高い優先度のリソースよりも先に削除されます。2 つのリソースの優先度が同じ場合は、より最近使用されたリソースがメモリに保持され、もう一方が削除されます。管理対象リソースの既定の優先度は 0 です。

Windows Vista のみ - このメソッドを IDirect3D9Ex インターフェイスを使用して呼び出した場合、D3DPOOL_DEFAULT フラグを指定して作成されたリソースのみが影響を受けます。

vtbl 8 DWORD GetPriority()

IDirect3DResource9::GetPriority (d3d9.h) メソッドは、このリソースの優先度を取得します。

戻り値

型: DWORD

リソースの優先度を示す DWORD 値を返します。

解説(Remarks)

IDirect3DResource9::GetPriority は、管理対象リソースの優先度制御に使用します。管理対象外のリソースに対しては 0 を返します。

vtbl 9 void PreLoad()

IDirect3DResource9::PreLoad (d3d9.h) メソッドは、管理対象リソースをあらかじめ読み込みます。

解説(Remarks)

このメソッドを呼び出すことは、アプリケーションがまもなくこの管理対象リソースを必要とすることを示します。管理対象外のリソースに対しては効果がありません。

IDirect3DResource9::PreLoad は、1 フレームで使用されるリソースがビデオメモリに同時に収まる量を超える「スラッシング」状態を検出します。そのような状況では、IDirect3DResource9::PreLoad は何も行わずに終了します。

vtbl 10 D3DRESOURCETYPE GetType()

IDirect3DResource9::GetType (d3d9.h) メソッドは、リソースの型を返します。

戻り値

型: D3DRESOURCETYPE

リソースの型を示す、D3DRESOURCETYPE 列挙型のメンバーを返します。

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