IDXGIFactory2::RegisterOcclusionStatusEvent メソッド (dxgi1_2.h)

イベント シグナリングを使用して、オクルージョン状態の変更の通知を受信するように登録します。

構文

HRESULT RegisterOcclusionStatusEvent(
  [in]  HANDLE hEvent,
  [out] DWORD  *pdwCookie
);

パラメーター

[in] hEvent

オクルージョン状態の変更の通知が発生したときにオペレーティング システムが設定するイベント オブジェクトへのハンドル。 CreateEvent 関数または OpenEvent 関数は、このハンドルを返します。

[out] pdwCookie

アプリケーションが IDXGIFactory2::UnregisterOcclusionStatus メソッドに渡して hEvent が指定する通知イベントを登録解除できるキー値へのポインター。

戻り値

RegisterOcclusionStatusEvent は次を返します。

• メソッドがイベントを正常に登録したかどうかをS_OKします。
• 操作を完了するためにメモリが使用できない場合は、E_OUTOFMEMORYします。
• hEventが有効なハンドルではないか、イベント ハンドルではない場合にDXGI_ERROR_INVALID_CALLします。
• DXGI_ERRORトピックで説明されているその他のエラー コード。

Windows 7 のプラットフォーム更新プログラム: Windows 7 用プラットフォーム更新プログラム がインストールされている Windows 7 または Windows Server 2008 R2 では、 RegisterOcclusionStatusEvent はE_NOTIMPLで失敗します。 Windows 7 のプラットフォーム更新プログラムの詳細については、「Windows 7 用プラットフォーム更新プログラム」を参照してください。

解説

同じイベント ハンドル で RegisterOcclusionStatusEvent を 複数回呼び出すと、 RegisterOcclusionStatusEvent は DXGI_ERROR_INVALID_CALLで失敗します。

異なるイベント ハンドル で RegisterOcclusionStatusEvent を 複数回呼び出すと、 RegisterOcclusionStatusEvent によってイベントが適切に登録されます。

要件

関連項目

IDXGIFactory2