ホーム › Graphics.Direct3D12 › ID3D12Object

ID3D12Object

COM

📘 Microsoft Learn (日本語) · English

IIDc4fec28f-7966-4e95-9f94-f431cb56c3b8継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ID3D12Device および ID3D12DeviceChild の継承元となるインターフェイスです。プライベートデータの関連付けと、オブジェクト名の注釈付けを行うメソッドを提供します。

メソッド 4

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

vtbl 3 HRESULT GetPrivateData(GUID* guid, DWORD* pDataSize, void* pData)

デバイスオブジェクトからアプリケーション定義のデータを取得します。

guid	GUID*	in	データに関連付けられている GUID です。
pDataSize	DWORD*	inout	変数へのポインターです。入力時には pData が指すバッファーのサイズ (バイト単位) を格納し、出力時には GetPrivateData が取得したデータのサイズ (バイト単位) を格納します。
pData	void*	outoptional	デバイスオブジェクトからのデータを受け取るメモリブロックへのポインターです。データを保持できる十分な大きさのバッファーサイズを pDataSize が指している場合に、データが書き込まれます。

戻り値

型: HRESULT

このメソッドは Direct3D 12 リターンコードのいずれかを返します。

解説(Remarks)

返されるデータが、以前に SetPrivateDataInterface によって設定された IUnknown (またはその派生クラス) へのポインターである場合、そのインターフェイスの参照カウントはプライベートデータが返される前にインクリメントされます。

vtbl 4 HRESULT SetPrivateData(GUID* guid, DWORD DataSize, void* pData)

アプリケーション定義のデータをデバイスオブジェクトに設定し、そのデータをアプリケーション定義の GUID に関連付けます。

guid	GUID*	in	データに関連付ける GUID です。
DataSize	DWORD	in	データのサイズ (バイト単位) です。
pData	void*	inoptional	このデバイスオブジェクトとともに格納するデータを含むメモリブロックへのポインターです。pData が NULL の場合、DataSize も 0 でなければならず、guid で指定された GUID に以前関連付けられていたデータは破棄されます。

戻り値

型: HRESULT

このメソッドは Direct3D 12 リターンコードのいずれかを返します。

解説(Remarks)

ASCII の名前を指定して WKPDID_D3DDebugObjectName とともに ID3D12Object::SetPrivateData を呼び出す Direct3D 11 のデバッグオブジェクト命名方式を使用するのではなく、 UNICODE の名前を指定して ID3D12Object::SetName を呼び出してください。

vtbl 5 HRESULT SetPrivateDataInterface(GUID* guid, IUnknown* pData)

IUnknown から派生したインターフェイスをデバイスオブジェクトに関連付け、そのインターフェイスをアプリケーション定義の GUID に関連付けます。

guid	GUID*	in	インターフェイスに関連付ける GUID です。
pData	IUnknown*	inoptional	デバイスオブジェクトに関連付ける IUnknown 派生インターフェイスへのポインターです。設定時に参照カウントがインクリメントされ、ID3D12Object が破棄されたとき、または同じ GUID を指定した SetPrivateData もしくは SetPrivateDataInterface の呼び出しによってデータが上書きされたときにデクリメントされます。

戻り値

型: HRESULT

このメソッドは Direct3D 12 リターンコードのいずれかを返します。

vtbl 6 HRESULT SetName(LPWSTR Name)

デバイスオブジェクトに名前を関連付けます。この名前はデバッグ診断やツールで使用されます。

Name

LPWSTR

デバイスオブジェクトに関連付ける名前を含む、NULL 終端の UNICODE 文字列です。

戻り値

型: HRESULT

このメソッドは Direct3D 12 リターンコードのいずれかを返します。

解説(Remarks)

このメソッドは UNICODE の名前を受け取ります。

なお、これは WKPDID_D3DDebugObjectNameW を指定した ID3D12Object::SetPrivateData の単なる便宜的なラッパーです。したがって、SetName で設定した名前は、同じ GUID を指定した ID3D12Object::GetPrivateData で取得できます。さらに D3D12 では、WKPDID_D3DDebugObjectName GUID を直接使用することで、名前にナロー文字列を使用することもサポートされています。

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