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

IDXGIKeyedMutex

COM
IID9d8e1289-d7b3-465f-8126-250e349af85d継承元IDXGIDeviceSubObject自前メソッド開始 vtbl8

公式ドキュメント

キー付きミューテックスを表します。これは、複数のデバイスで使用される共有リソースへの排他アクセスを可能にします。

解説(Remarks)

IDXGIKeyedMutex インターフェイスをサポートできるリソースを作成するには、IDXGIFactory1 が必要です。

IDXGIKeyedMutex は、リソースを共有する各デバイスごとに取得する必要があります。Direct3D 10.1 では、2 つ以上のデバイス間で共有されるこのようなリソースは、D3D10_RESOURCE_MISC_SHARED_KEYEDMUTEX フラグを使用して作成されます。Direct3D 11 では、2 つ以上のデバイス間で共有されるこのようなリソースは、D3D11_RESOURCE_MISC_SHARED_KEYEDMUTEX フラグを使用して作成されます。

キー付きミューテックスの作成については、IDXGIKeyedMutex::AcquireSync メソッドを参照してください。

メソッド 2

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

vtbl 8 HRESULT AcquireSync(ULONGLONG Key, DWORD dwMilliseconds)

キーを使用して、共有リソースへの排他的なレンダリングアクセスを取得します。

KeyULONGLONGinどのデバイスにアクセスを許可するかを示す値です。このメソッドは、現在サーフェスを所有しているデバイスが同じ値を使用して IDXGIKeyedMutex::ReleaseSync メソッドを呼び出したときに成功します。この値には任意の UINT64 値を指定できます。
dwMillisecondsDWORDinタイムアウト間隔をミリ秒単位で指定します。間隔が経過し、指定した Key を使用してキー付きミューテックスが解放されていない場合、このメソッドは戻ります。この値を 0 に設定すると、AcquireSync メソッドはキー付きミューテックスが解放されているかどうかをテストし、直ちに戻ります。この値を INFINITE に設定すると、タイムアウト間隔は経過しません。

戻り値

Type: HRESULT

成功した場合は S_OK を返します。

所有しているデバイスが同じ共有リソース上に別のキー付きミューテックスを作成しようとした場合、AcquireSyncE_FAIL を返します。

AcquireSync は、次の DWORD 定数を返すこともあります。したがって、これらの定数を明示的にチェックする必要があります。戻り値に対して SUCCEEDED マクロのみを使用して AcquireSync が成功したかどうかを判断すると、これらの定数を検出できません。

解説(Remarks)

AcquireSync メソッドは、複数のデバイス間で共有されるサーフェスに対するロックを作成し、一度に 1 つのデバイスのみがサーフェスにレンダリングできるようにします。このメソッドは、どのデバイスが現在サーフェスへの排他アクセスを持っているかを判断するためにキーを使用します。

D3D10_RESOURCE_MISC_FLAG 列挙型の D3D10_RESOURCE_MISC_SHARED_KEYEDMUTEX 値を使用してサーフェスを作成した場合は、サーフェスにレンダリングする前に AcquireSync メソッドを呼び出す必要があります。サーフェスへのレンダリングが完了したら、ReleaseSync メソッドを呼び出す必要があります。

共有リソースのキー付きミューテックスオブジェクトへの参照を取得するには、リソースの QueryInterface メソッドを呼び出し、IDXGIKeyedMutex インターフェイスの UUID を渡します。この参照の取得の詳細については、次のコード例を参照してください。

AcquireSync メソッドは、サーフェスの状態に応じて、次のようにキーを使用します。

キー付きミューテックスの取得

次のコード例は、共有リソースへのロックを取得する方法と、解放時にキーを指定する方法を示しています。


// pDesc はテクスチャの記述で既にセットアップされています。
pDesc.MiscFlags = D3D10_RESOURCE_MISC_SHARED_KEYEDMUTEX;

// 共有テクスチャリソースを作成します。
pD3D10DeviceD->CreateTexture2D(pDesc, NULL, pD3D10Texture);

// キー付きミューテックスへの参照を取得します。
pD3D10Texture->QueryInterface(_uuidof(IDXGIKeyedMutex), pDXGIKeyedMutex);

// リソースへのロックを取得します。
pDXGIKeyedMutex->AcquireSync(0, INFINITE);

// ロックを解放し、キーを指定します。
pDXGIKeyedMutex->ReleaseSync(1);
          
vtbl 9 HRESULT ReleaseSync(ULONGLONG Key)

キーを使用して、共有リソースへの排他的なレンダリングアクセスを解放します。

KeyULONGLONGinどのデバイスにアクセスを許可するかを示す値です。このメソッドは、現在サーフェスを所有しているデバイスが同じ値を使用して ReleaseSync メソッドを呼び出したときに成功します。この値には任意の UINT64 値を指定できます。

戻り値

Type: HRESULT

成功した場合は S_OK を返します。

デバイスが、有効でない、またはそのデバイスが所有していないキー付きミューテックスを解放しようとした場合、ReleaseSyncE_FAIL を返します。

解説(Remarks)

ReleaseSync メソッドは、複数のデバイス間で共有されるサーフェスに対するロックを解放します。このメソッドは、どのデバイスが現在サーフェスへの排他アクセスを持っているかを判断するためにキーを使用します。

D3D10_RESOURCE_MISC_FLAG 列挙型の D3D10_RESOURCE_MISC_SHARED_KEYEDMUTEX 値を使用してサーフェスを作成した場合は、サーフェスにレンダリングする前に IDXGIKeyedMutex::AcquireSync メソッドを呼び出す必要があります。サーフェスへのレンダリングが完了したら、ReleaseSync メソッドを呼び出す必要があります。

ReleaseSync メソッドを呼び出すと、共有リソースはレンダリングパイプラインから解除されます。

共有リソースのキー付きミューテックスオブジェクトへの参照を取得するには、リソースの QueryInterface メソッドを呼び出し、IDXGIKeyedMutex インターフェイスの UUID を渡します。この参照の取得の詳細については、次のコード例を参照してください。

キー付きミューテックスの取得

次のコード例は、共有リソースへのロックを取得する方法と、解放時にキーを指定する方法を示しています。


// pDesc はテクスチャの記述で既にセットアップされています。
pDesc.MiscFlags = D3D10_RESOURCE_MISC_SHARED_KEYEDMUTEX;

// 共有テクスチャリソースを作成します。
pD3D10DeviceD->CreateTexture2D(pDesc, NULL, pD3D10Texture);

// キー付きミューテックスへの参照を取得します。
pD3D10Texture->QueryInterface(_uuidof(IDXGIKeyedMutex), pDXGIKeyedMutex);

// リソースへのロックを取得します。
pDXGIKeyedMutex->AcquireSync(0, INFINITE);

// ロックを解放し、キーを指定します。
pDXGIKeyedMutex->ReleaseSync(1);
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDXGIKeyedMutex "{9D8E1289-D7B3-465F-8126-250E349AF85D}"
#usecom global IDXGIKeyedMutex IID_IDXGIKeyedMutex "{}"
#comfunc global IDXGIKeyedMutex_AcquireSync  8 int64,int
#comfunc global IDXGIKeyedMutex_ReleaseSync  9 int64
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。