Direct3D 11 でのデバイス削除シナリオの処理

[アーティクル]
07/13/2023

このトピックでは、グラフィックスアダプターが削除または再初期化されたときに Direct3D と DXGI デバイスインターフェイスチェーンを再作成する方法について説明します。

DirectX 9 では、D3D デバイスが非動作状態になったときに、アプリケーションが "デバイス喪失" 状態に見舞われることがあります。たとえば、全画面 Direct3D 9 アプリケーションがフォーカスを失うと、Direct3D デバイスは "喪失" 状態になります。喪失したデバイスを使って描画しようとしても、エラー表示なしで失敗します。 Direct3D 11 では、仮想グラフィックスデバイスインターフェイスを使って、複数のプログラムが同一の物理グラフィックスデバイスを共有することができるため、アプリが Direct3D デバイスをコントロールできなくなることはなくなっています。ただし、それでもグラフィックスアダプターが使用できなくなったり、逆に使用できるようになったりすることはありえます。次に例を示します。

グラフィックスドライバーがアップグレードされた場合。
システムのグラフィックスアダプターが省電力モードから性能重視モードに変わった場合。
グラフィックスデバイスが応答を停止してリセットされた場合。
グラフィックスアダプターが物理的に接続された場合、または取り外された場合。

このような状況になると、DXGI はエラーコードを返して、Direct3D デバイスの再起動とデバイスリソースの再作成が必要であることを知らせます。このチュートリアルでは、グラフィックスアダプターのリセット、削除、変更という事態が生じた場合に、Direct3D 11 アプリとゲームがそれを検出して対応できるようにする方法について説明します。コード例は、Microsoft Visual Studio 2015 に付属する DirectX 11 アプリ (ユニバーサル Windows) テンプレートから採用しています。

手順

ステップ 1:

レンダリングループにデバイス削除エラーのチェックを加えます。 IDXGISwapChain::Present (または Present1 など) を呼び出して、フレームを表示します。次に、DXGI_ERROR_DEVICE_REMOVED または DXGI_ERROR_DEVICE_RESET が返されたかどうかをチェックします。

まず、テンプレートは DXGI スワップチェーンから返された HRESULT を保存します。

HRESULT hr = m_swapChain->Present(1, 0);

その他のフレーム表示作業の面倒をすべてみた後、テンプレートはデバイス削除エラーをチェックします。必要な場合は、デバイス削除状態を処理するメソッドを呼び出します。

// If the device was removed either by a disconnection or a driver upgrade, we
// must recreate all device resources.
if (hr == DXGI_ERROR_DEVICE_REMOVED || hr == DXGI_ERROR_DEVICE_RESET)
{
    HandleDeviceLost();
}
else
{
    DX::ThrowIfFailed(hr);
}

手順 2:

また、ウィンドウサイズの変更に対応する箇所にも、デバイス削除エラーのチェックを加えます。これは、いくつかの理由から DXGI_ERROR_DEVICE_REMOVED または DXGI_ERROR_DEVICE_RESET のチェックに適した場所です。

スワップチェーンのサイズを変更するには、土台となる DXGI アダプターを呼び出す必要があり、その際にデバイス削除エラーが返される可能性があります。
異なるグラフィックスデバイスに接続されたモニターにアプリが移動された可能性があります。
グラフィックスデバイスが削除またはリセットされると、多くの場合、デスクトップの解像度が変わり、その結果ウィンドウサイズが変わります。

テンプレートは、ResizeBuffers から返された HRESULT を確認します。

// If the swap chain already exists, resize it.
HRESULT hr = m_swapChain->ResizeBuffers(
    2, // Double-buffered swap chain.
    static_cast<UINT>(m_d3dRenderTargetSize.Width),
    static_cast<UINT>(m_d3dRenderTargetSize.Height),
    DXGI_FORMAT_B8G8R8A8_UNORM,
    0
    );

if (hr == DXGI_ERROR_DEVICE_REMOVED || hr == DXGI_ERROR_DEVICE_RESET)
{
    // If the device was removed for any reason, a new device and swap chain will need to be created.
    HandleDeviceLost();

    // Everything is set up now. Do not continue execution of this method. HandleDeviceLost will reenter this method 
    // and correctly set up the new device.
    return;
}
else
{
    DX::ThrowIfFailed(hr);
}

手順 3:

DXGI_ERROR_DEVICE_REMOVED エラーを受け取ったアプリは、常に Direct3D デバイスを再初期化し、デバイス依存リソースを再作成する必要があります。以前の Direct3D デバイスを使って作成したグラフィックスデバイスリソースに対する参照はすべて解放します。このようなリソースは無効になっているため、スワップチェーンに対する参照はすべて、新しいスワップチェーンを作成する前に解放する必要があります。

HandleDeviceLost メソッドは、スワップチェーンを解放し、アプリコンポーネントに対してデバイスリソースを解放するよう通知します。

m_swapChain = nullptr;

if (m_deviceNotify != nullptr)
{
    // Notify the renderers that device resources need to be released.
    // This ensures all references to the existing swap chain are released so that a new one can be created.
    m_deviceNotify->OnDeviceLost();
}

続いて、新しいスワップチェーンを作成し、デバイス管理クラスによって制御されるデバイス依存リソースを再初期化します。

// Create the new device and swap chain.
CreateDeviceResources();
m_d2dContext->SetDpi(m_dpi, m_dpi);
CreateWindowSizeDependentResources();

デバイスとスワップチェーンが再確立された後、アプリコンポーネントに対してデバイス依存リソースを再初期化するよう通知します。

// Create the new device and swap chain.
CreateDeviceResources();
m_d2dContext->SetDpi(m_dpi, m_dpi);
CreateWindowSizeDependentResources();

if (m_deviceNotify != nullptr)
{
    // Notify the renderers that resources can now be created again.
    m_deviceNotify->OnDeviceRestored();
}

HandleDeviceLost メソッドが終了すると、制御はレンダリングループに戻り、処理が続行されて次のフレームが描画されます。

注釈

デバイス削除エラーの原因の調査

DXGI デバイス削除エラーが繰り返し発生する場合は、アプリケーションのグラフィックスコードが描画ルーチン内で無効な状態を作り出している可能性があります。また、ハードウェア障害やグラフィックスドライバーのバグが原因の可能性もあります。デバイス削除エラーの原因を調査するには、Direct3D デバイスを解放する前に ID3D11Device::GetDeviceRemovedReason を呼び出します。このメソッドは、デバイス削除エラーの理由を示す 6 種類の DXGI エラーコードの 1 つを返します。

DXGI_ERROR_DEVICE_HUNG: アプリが送信したグラフィックスコマンドの組み合わせが無効であったため、グラフィックスドライバーが応答を停止しました。このエラーが繰り返し発生する場合は、デバイスがハングする原因はアプリにあり、デバッグの必要があることを示している可能性が高くなります。
DXGI_ERROR_DEVICE_REMOVED: グラフィックスデバイスが物理的に取り外されたか、電源が切られたか、ドライバーのアップグレードが発生しました。このエラーはときどき起こることであり、異常ではありません。アプリまたはゲームは、このトピックで説明しているようにデバイスリソースを再作成する必要があります。
DXGI_ERROR_DEVICE_RESET: コマンドの形式が無効であるためにグラフィックスデバイスが失敗しました。このエラーが繰り返し発生する場合は、コードが無効な描画コマンドを送っている可能性があります。
DXGI_ERROR_DRIVER_INTERNAL_ERROR: グラフィックスドライバーでエラーが発生して、デバイスをリセットしました。
DXGI_ERROR_INVALID_CALL: アプリケーションが無効なパラメーターデータを指定しました。このエラーが 1 回でも発生する場合は、デバイス削除状態の原因がアプリのコードにあり、デバッグの必要があることを意味しています。
S_OK: 現在のグラフィックスデバイスを無効にすることなく、グラフィックスデバイスの使用が許可または禁止されたり、リセットされたときに返されます。たとえば、このエラーコードは、アプリが Windows Advanced Rasterization Platform (WARP) を使っていて、ハードウェアアダプターが利用可能になった場合に返されます。

次のコードは、DXGI_ERROR_DEVICE_REMOVED エラーコードを取得して、それをデバッグコンソールに出力します。次のコードを HandleDeviceLost メソッドの先頭に挿入します。

    HRESULT reason = m_d3dDevice->GetDeviceRemovedReason();

#if defined(_DEBUG)
    wchar_t outString[100];
    size_t size = 100;
    swprintf_s(outString, size, L"Device removed! DXGI_ERROR code: 0x%X\n", reason);
    OutputDebugStringW(outString);
#endif

詳しくは、「GetDeviceRemovedReason」および「DXGI_ERROR」をご覧ください。

デバイスの削除完了処理のテスト

Visual Studio の開発者コマンドプロンプトでは、Visual Studio グラフィックス診断に関連する Direct3D イベントのキャプチャと再生を行うコマンドラインツール "dxcap" がサポートされます。アプリの実行中はコマンドラインオプション "-forcetdr" を使って、GPU タイムアウトの検出と回復イベントを強制できるため、DXGI_ERROR_DEVICE_REMOVED がトリガーされ、エラー処理コードをテストできます。

注 DXCap とそのサポート DLL は、Windows 10 向けグラフィックスツール (Windows SDK では配布されなくなりました) の一部として system32/syswow64 にインストールされます。代わりに、オプションの OS コンポーネントであるオンデマンドのグラフィックスツール機能を通じて提供され、Windows 10 でグラフィックスツールを有効にして使うにはこれをインストールする必要があります。 Windows 10 向けグラフィックスツールをインストールする方法について詳しくは、https://msdn.microsoft.com/library/mt125501.aspx#InstallGraphicsTools をご覧ください。