ID3D11Debug

デバッグインターフェイスは、デバッグ設定の制御とパイプラインステートの検証を行います。デバッグレイヤーが有効な場合にのみ使用できます。(ID3D11Debug)

このインターフェイスは、ID3D11Device に対して IUnknown::QueryInterface を呼び出して取得します。

デバッグレイヤーの詳細については、デバッグレイヤーを参照してください。

Windows Phone 8: この API はサポートされています。

デバッグ機能のオン/オフを切り替えるフラグのビットフィールドを設定します。(ID3D11Debug.SetFeatureMask)

型: HRESULT

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

以下の機能マスクフラグのいずれかを設定すると、後述のレンダリング操作メソッドの呼び出し時に追加の処理が行われます。

D3D11_DEBUG_FEATURE_FINISH_PER_RENDER_OP (0x2)	アプリケーションは、GPU がレンダリング操作の処理を完了するまで待機してから処理を続行します。
D3D11_DEBUG_FEATURE_FLUSH_PER_RENDER_OP (0x1)	ランタイムが追加で ID3D11DeviceContext::Flush を呼び出します。
D3D11_DEBUG_FEATURE_PRESENT_PER_RENDER_OP (0x4)	ランタイムが IDXGISwapChain::Present を呼び出します。レンダーバッファーの表示は、事前に呼び出した ID3D11Debug::SetSwapChain および ID3D11Debug::SetPresentPerRenderOpDelay で設定された内容に従って行われます。

これらの機能マスクフラグは、次のレンダリング操作メソッドに適用されます。

• ID3D11DeviceContext::Draw
• ID3D11DeviceContext::DrawIndexed
• ID3D11DeviceContext::DrawInstanced
• ID3D11DeviceContext::DrawIndexedInstanced
• ID3D11DeviceContext::DrawAuto
• ID3D11DeviceContext::ClearRenderTargetView
• ID3D11DeviceContext::ClearDepthStencilView
• ID3D11DeviceContext::CopySubresourceRegion
• ID3D11DeviceContext::CopyResource
• ID3D11DeviceContext::UpdateSubresource
• ID3D11DeviceContext::GenerateMips
• ID3D11DeviceContext::ResolveSubresource

次の機能マスクフラグを設定すると、IDXGIDevice2::OfferResources メソッドおよび IDXGIDevice2::ReclaimResources メソッドの動作を制御でき、テストやデバッグに役立ちます。

D3D11_DEBUG_FEATURE_ALWAYS_DISCARD_OFFERED_RESOURCE (0x8)	このフラグが有効な状態で IDXGIDevice2::OfferResources を呼び出してリソースを提供すると、その内容は常に破棄されます。再要求時にリソースの内容を再生成するコードパスをテストするために、このフラグを使用します。このフラグを D3D11_DEBUG_FEATURE_NEVER_DISCARD_OFFERED_RESOURCE と組み合わせて使用することはできません。
D3D11_DEBUG_FEATURE_NEVER_DISCARD_OFFERED_RESOURCE (0x10)	このフラグが有効な状態で IDXGIDevice2::OfferResources を呼び出してリソースを提供すると、その内容は決して破棄されません。再要求時にリソースの内容を再生成する必要がないコードパスをテストするために、このフラグを使用します。このフラグを D3D11_DEBUG_FEATURE_ALWAYS_DISCARD_OFFERED_RESOURCE と組み合わせて使用することはできません。

IDXGIDevice2::OfferResources メソッドおよび IDXGIDevice2::ReclaimResources メソッドの動作は、システム全体のメモリ負荷に依存します。そのため、内容が失われて再生成が必要になる状況は、ほとんどのアプリケーションでは発生しにくいものです。上記の Direct3D デバッグレイヤーの新しいオプションを使用すると、その状況を一貫して再現し、コードパスをテストできます。

次のフラグは Direct3D 11.1 ランタイムでサポートされます。

D3D11_DEBUG_FEATURE_AVOID_BEHAVIOR_CHANGING_DEBUG_AIDS (0x40)

以下の既定のデバッグ動作を無効にします。

デバッグレイヤーが有効な場合、アプリケーションの問題を明らかにするために特定の動作が行われます。D3D11_DEBUG_FEATURE_AVOID_BEHAVIOR_CHANGING_DEBUG_AIDS 機能マスクフラグを設定すると、次の既定のデバッグ動作を伴わずにデバッグレイヤーを有効にできます。

• アプリケーションが ID3D11DeviceContext1::DiscardView を呼び出すと、ランタイムがリソースをランダムな色で塗りつぶします。
• アプリケーションが部分表示のパラメーターを指定して IDXGISwapChain1::Present1 を呼び出すと、ランタイムが部分表示の情報を無視します。

次のフラグは Direct3D 11.2 ランタイムでサポートされます。

D3D11_DEBUG_FEATURE_DISABLE_TILED_RESOURCE_MAPPING_TRACKING_AND_VALIDATION (0x80)

以下の既定のデバッグ動作を無効にします。

既定では (つまり D3D11_DEBUG_FEATURE_DISABLE_TILED_RESOURCE_MAPPING_TRACKING_AND_VALIDATION を設定しない場合)、デバッグレイヤーはデバイスコンテキストで実行されるすべての操作 (描画やコピーなど) について、バインドされているタイル化リソースのすべてのタイルマッピングが適切に使用されているかを検証します。使用するタイル化リソースのサイズによっては、この検証はプロセッサへの負荷が高く、処理が遅くなる場合があります。アプリケーションでは、最初はタイル化リソースのタイルマッピング検証を有効にして実行し、呼び出しパターンが安全であると判断できた時点で、D3D11_DEBUG_FEATURE_DISABLE_TILED_RESOURCE_MAPPING_TRACKING_AND_VALIDATION を設定して検証を無効にするとよいでしょう。

タイル化リソースの作成時に D3D11_DEBUG_FEATURE_DISABLE_TILED_RESOURCE_MAPPING_TRACKING_AND_VALIDATION が設定されていた場合、デバッグレイヤーはそのリソースの存続期間全体にわたってタイルマッピングの追跡を一切行いません。また、タイル化リソースを伴うデバイスコンテキストのメソッド呼び出し (描画やコピーの呼び出しなど) の時点で D3D11_DEBUG_FEATURE_DISABLE_TILED_RESOURCE_MAPPING_TRACKING_AND_VALIDATION が設定されている場合、デバッグレイヤーはその呼び出しにおけるタイルマッピングの検証をすべてスキップします。

どのデバッグ機能がオンまたはオフになっているかを示すフラグのビットフィールドを取得します。(ID3D11Debug.GetFeatureMask)

型: UINT

ビットごとの OR 演算で組み合わされた機能マスクフラグのマスクです。フラグが指定されている場合はその機能がオンに、指定されていない場合はオフに設定されています。指定可能な機能マスクフラグの一覧については、ID3D11Debug::SetFeatureMask を参照してください。

IDXGISwapChain::Present の呼び出し後にスリープするミリ秒数を設定します。

型: HRESULT

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

アプリケーションがスリープするのは、機能マスクに D3D11_DEBUG_FEATURE_PRESENT_PER_RENDER_OP が設定されている場合のみです。このフラグが設定されていない場合、ミリ秒数は設定されるものの無視され、アプリケーションはスリープしません。このメソッドが一度も呼び出されない場合は、既定値として 10ms が使用されます。

IDXGISwapChain::Present の呼び出し後にスリープするミリ秒数を取得します。

型: UINT

Present の呼び出し後にスリープするミリ秒数です。

この値は ID3D11Debug::SetPresentPerRenderOpDelay で設定します。

ランタイムが IDXGISwapChain::Present を自動的に呼び出す際に使用するスワップチェーンを設定します。

型: HRESULT

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

このメソッドで設定したスワップチェーンは、機能マスクに D3D11_DEBUG_FEATURE_PRESENT_PER_RENDER_OP が設定されている場合にのみ使用されます。

ランタイムが IDXGISwapChain::Present を自動的に呼び出す際に使用するスワップチェーンを取得します。

型: HRESULT

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

このメソッドで取得したスワップチェーンは、機能マスクに D3D11_DEBUG_FEATURE_PRESENT_PER_RENDER_OP が設定されている場合にのみ使用されます。

描画パイプラインのステートが有効かどうかを確認します。

型: HRESULT

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

描画メソッド (ID3D11DeviceContext::Draw など) を呼び出す前に検証を行ってください。検証にはデバッグレイヤーが必要です。

デバイスオブジェクトの存続期間に関する情報を報告します。

型: HRESULT

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

ReportLiveDeviceObjects は、Flags の値を使用して、デバイスオブジェクトの存続期間について報告する情報量を決定します。

ディスパッチパイプラインのステートが有効かどうかを検証します。

型: HRESULT

このメソッドは、Direct3D 11 のリターンコードのトピックで説明されているリターンコードのいずれかを返します。

ディスパッチメソッド (ID3D11DeviceContext::Dispatch など) を呼び出す前に、このメソッドを使用してください。検証にはデバッグレイヤーが必要です。

#define global IID_ID3D11Debug "{79CF2233-7536-4948-9D36-1E4692DC5760}"
#usecom global ID3D11Debug IID_ID3D11Debug "{}"
#comfunc global ID3D11Debug_SetFeatureMask              3 int
#comfunc global ID3D11Debug_GetFeatureMask              4
#comfunc global ID3D11Debug_SetPresentPerRenderOpDelay  5 int
#comfunc global ID3D11Debug_GetPresentPerRenderOpDelay  6
#comfunc global ID3D11Debug_SetSwapChain                7 sptr
#comfunc global ID3D11Debug_GetSwapChain                8 sptr
#comfunc global ID3D11Debug_ValidateContext             9 sptr
#comfunc global ID3D11Debug_ReportLiveDeviceObjects     10 int
#comfunc global ID3D11Debug_ValidateContextForDispatch  11 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。