Win32 API 日本語リファレンス
ホーム › Graphics.Dxgi › IDXGISurface

IDXGISurface

COM
📘 Microsoft Learn (日本語) · English
IIDcafcb56c-6ac3-4889-bf47-9e23bbd260ec継承元IDXGIDeviceSubObject自前メソッド開始 vtbl8

公式ドキュメント

IDXGISurface インターフェイスは、イメージデータオブジェクト用のメソッドを実装します。

解説(Remarks)

イメージデータオブジェクトは、一般にサーフェスと呼ばれるメモリ上の 2 次元領域です。出力からサーフェスを取得するには、IDXGIOutput::GetDisplaySurfaceData を呼び出します。

Direct3D 12 より前のランタイムは、サーフェスを表す Direct3D リソースオブジェクトを作成する際に、IDXGISurface インターフェイスを自動的に作成します。IDXGISurface インターフェイスは Direct3D 12 ではサポートされていません。たとえば、2D テクスチャを作成するために ID3D11Device::CreateTexture2D または ID3D10Device::CreateTexture2D を呼び出すと、ランタイムは IDXGISurface インターフェイスを作成します。2D テクスチャのサーフェスを表す IDXGISurface インターフェイスを取得するには、ID3D11Texture2D::QueryInterface または ID3D10Texture2D::QueryInterface を呼び出します。この呼び出しでは、IDXGISurface の識別子を渡す必要があります。2D テクスチャが単一の MIP マップレベルのみを持ち、テクスチャの配列で構成されていない場合、QueryInterface は成功し、IDXGISurface インターフェイスポインターへのポインターを返します。それ以外の場合、QueryInterface は失敗し、IDXGISurface へのポインターを返しません。

メソッド 3

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

vtbl 8 HRESULT GetDesc(DXGI_SURFACE_DESC* pDesc)

サーフェスの記述を取得します。

pDescDXGI_SURFACE_DESC*outサーフェスの記述へのポインター (DXGI_SURFACE_DESC を参照)。

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合は、DXGI_ERROR トピックで説明されているエラーコードのいずれかを返します。

vtbl 9 HRESULT Map(DXGI_MAPPED_RECT* pLockedRect, DXGI_MAP_FLAGS MapFlags)

サーフェスに格納されているデータへのポインターを取得し、サーフェスへの GPU アクセスを拒否します。

pLockedRectDXGI_MAPPED_RECT*outサーフェスデータへのポインター (DXGI_MAPPED_RECT を参照)。
MapFlagsDXGI_MAP_FLAGSin

CPU の読み取り/書き込みフラグ。これらのフラグは論理 OR で組み合わせることができます。

  • DXGI_MAP_READ - CPU の読み取りアクセスを許可します。
  • DXGI_MAP_WRITE - CPU の書き込みアクセスを許可します。
  • DXGI_MAP_DISCARD - マップ時にリソースの以前の内容を破棄します。

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合は、DXGI_ERROR トピックで説明されているエラーコードのいずれかを返します。

解説(Remarks)

CPU からサーフェスにアクセスするには IDXGISurface::Map を使用します。マップしたサーフェスを解放して GPU アクセスを許可するには、IDXGISurface::Unmap を呼び出します。

vtbl 10 HRESULT Unmap()

IDXGISurface::Map で取得したサーフェスへのポインターを無効化し、リソースへの GPU アクセスを再度有効にします。

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合は、DXGI_ERROR トピックで説明されているエラーコードのいずれかを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDXGISurface "{CAFCB56C-6AC3-4889-BF47-9E23BBD260EC}"
#usecom global IDXGISurface IID_IDXGISurface "{}"
#comfunc global IDXGISurface_GetDesc  8 var
#comfunc global IDXGISurface_Map      9 var,int
#comfunc global IDXGISurface_Unmap    10
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。