ID3D12GraphicsCommandList::ClearDepthStencilView メソッド (d3d12.h)

[アーティクル]
08/23/2023

深度ステンシルリソースをクリアします。

構文

void ClearDepthStencilView(
  [in] D3D12_CPU_DESCRIPTOR_HANDLE DepthStencilView,
  [in] D3D12_CLEAR_FLAGS           ClearFlags,
  [in] FLOAT                       Depth,
  [in] UINT8                       Stencil,
  [in] UINT                        NumRects,
  [in] const D3D12_RECT            *pRects
);

パラメーター

[in] DepthStencilView

種類: D3D12_CPU_DESCRIPTOR_HANDLE

深度ステンシルをクリアするためのヒープの開始を表す CPU 記述子ハンドルについて説明します。

[in] ClearFlags

種類: D3D12_CLEAR_FLAGS

ビットごとの OR 演算を使用して結合される D3D12_CLEAR_FLAGS 値の組み合わせ。結果の値は、クリアするデータの種類 (深度バッファー、ステンシルバッファー、またはその両方) を識別します。

[in] Depth

型: FLOAT

深度バッファーをクリアする値。この値は 0 から 1 の間でクランプされます。

[in] Stencil

種類: UINT8

ステンシルバッファーをクリアする値。

[in] NumRects

型: UINT

pRects パラメーターが指定する配列内の四角形の数。

[in] pRects

型: const D3D12_RECT*

クリアするリソースビューの四角形の D3D12_RECT 構造体の配列。 NULL の場合、ClearDepthStencilView はリソースビュー全体をクリアします。

戻り値

なし

解説

直接コマンドリストとバンドルコマンドリストのみがこの操作をサポートします。

ClearDepthStencilView を使用して、同じヒープメモリにエイリアスを設定するリソースを初期化できます。詳細については、「 CreatePlacedResource 」を参照してください。

ランタイムの検証

浮動小数点入力の場合、ランタイムは非正規化された値を 0 に設定します (NAN は保持されます)。

検証エラーが発生すると、 Close が呼び出され 、E_INVALIDARGが返されます。

デバッグレイヤー

入力色が非正規化されている場合、デバッグレイヤーはエラーを発行します。

ビューによって参照されるサブリソースが適切な状態でない場合、デバッグレイヤーはエラーを発行します。 ClearDepthStencilView の場合、状態はD3D12_RESOURCE_STATE_DEPTH_WRITE状態である必要があります。

例

D3D12Bundles サンプルでは、次のように ID3D12GraphicsCommandList::ClearDepthStencilView を使用します。

// Pipeline objects.
D3D12_VIEWPORT m_viewport;
ComPtr<IDXGISwapChain3> m_swapChain;
ComPtr<ID3D12Device> m_device;
ComPtr<ID3D12Resource> m_renderTargets[FrameCount];
ComPtr<ID3D12Resource> m_depthStencil;
ComPtr<ID3D12CommandAllocator> m_commandAllocator;
ComPtr<ID3D12GraphicsCommandList> m_commandList;
ComPtr<ID3D12CommandQueue> m_commandQueue;
ComPtr<ID3D12RootSignature >m_rootSignature;
ComPtr<ID3D12DescriptorHeap> m_rtvHeap;
ComPtr<ID3D12DescriptorHeap> m_cbvSrvHeap;
ComPtr<ID3D12DescriptorHeap> m_dsvHeap;
ComPtr<ID3D12DescriptorHeap> m_samplerHeap;
ComPtr<ID3D12PipelineState> m_pipelineState1;
ComPtr<ID3D12PipelineState> m_pipelineState2;
D3D12_RECT m_scissorRect;

void D3D12Bundles::PopulateCommandList(FrameResource* pFrameResource)
{
    // Command list allocators can only be reset when the associated
    // command lists have finished execution on the GPU; apps should use
    // fences to determine GPU execution progress.
    ThrowIfFailed(m_pCurrentFrameResource->m_commandAllocator->Reset());

    // However, when ExecuteCommandList() is called on a particular command
    // list, that command list can then be reset at any time and must be before
    // re-recording.
    ThrowIfFailed(m_commandList->Reset(m_pCurrentFrameResource->m_commandAllocator.Get(), m_pipelineState1.Get()));

    // Set necessary state.
    m_commandList->SetGraphicsRootSignature(m_rootSignature.Get());

    ID3D12DescriptorHeap* ppHeaps[] = { m_cbvSrvHeap.Get(), m_samplerHeap.Get() };
    m_commandList->SetDescriptorHeaps(_countof(ppHeaps), ppHeaps);

    m_commandList->RSSetViewports(1, &m_viewport);
    m_commandList->RSSetScissorRects(1, &m_scissorRect);

    // Indicate that the back buffer will be used as a render target.
    m_commandList->ResourceBarrier(1, &CD3DX12_RESOURCE_BARRIER::Transition(m_renderTargets[m_frameIndex].Get(), D3D12_RESOURCE_STATE_PRESENT, D3D12_RESOURCE_STATE_RENDER_TARGET));

    CD3DX12_CPU_DESCRIPTOR_HANDLE rtvHandle(m_rtvHeap->GetCPUDescriptorHandleForHeapStart(), m_frameIndex, m_rtvDescriptorSize);
    CD3DX12_CPU_DESCRIPTOR_HANDLE dsvHandle(m_dsvHeap->GetCPUDescriptorHandleForHeapStart());
    m_commandList->OMSetRenderTargets(1, &rtvHandle, FALSE, &dsvHandle);

    // Record commands.
    const float clearColor[] = { 0.0f, 0.2f, 0.4f, 1.0f };
    m_commandList->ClearRenderTargetView(rtvHandle, clearColor, 0, nullptr);
    m_commandList->ClearDepthStencilView(m_dsvHeap->GetCPUDescriptorHandleForHeapStart(), D3D12_CLEAR_FLAG_DEPTH, 1.0f, 0, 0, nullptr);

    if (UseBundles)
    {
        // Execute the prebuilt bundle.
        m_commandList->ExecuteBundle(pFrameResource->m_bundle.Get());
    }
    else
    {
        // Populate a new command list.
        pFrameResource->PopulateCommandList(m_commandList.Get(), m_pipelineState1.Get(), m_pipelineState2.Get(), m_currentFrameResourceIndex, m_numIndices, &m_indexBufferView,
            &m_vertexBufferView, m_cbvSrvHeap.Get(), m_cbvSrvDescriptorSize, m_samplerHeap.Get(), m_rootSignature.Get());
    }

    // Indicate that the back buffer will now be used to present.
    m_commandList->ResourceBarrier(1, &CD3DX12_RESOURCE_BARRIER::Transition(m_renderTargets[m_frameIndex].Get(), D3D12_RESOURCE_STATE_RENDER_TARGET, D3D12_RESOURCE_STATE_PRESENT));

    ThrowIfFailed(m_commandList->Close());
}

D3D12Multithreading サンプルでは、次のように ID3D12GraphicsCommandList::ClearDepthStencilView を使用します。

void FrameResource::Init()
{
    // Reset the command allocators and lists for the main thread.
    for (int i = 0; i < CommandListCount; i++)
    {
        ThrowIfFailed(m_commandAllocators[i]->Reset());
        ThrowIfFailed(m_commandLists[i]->Reset(m_commandAllocators[i].Get(), m_pipelineState.Get()));
    }

    // Clear the depth stencil buffer in preparation for rendering the shadow map.
    m_commandLists[CommandListPre]->ClearDepthStencilView(m_shadowDepthView, D3D12_CLEAR_FLAG_DEPTH, 1.0f, 0, 0, nullptr);

    // Reset the worker command allocators and lists.
    for (int i = 0; i < NumContexts; i++)
    {
        ThrowIfFailed(m_shadowCommandAllocators[i]->Reset());
        ThrowIfFailed(m_shadowCommandLists[i]->Reset(m_shadowCommandAllocators[i].Get(), m_pipelineStateShadowMap.Get()));

        ThrowIfFailed(m_sceneCommandAllocators[i]->Reset());
        ThrowIfFailed(m_sceneCommandLists[i]->Reset(m_sceneCommandAllocators[i].Get(), m_pipelineState.Get()));
    }
}

// Assemble the CommandListPre command list.
void D3D12Multithreading::BeginFrame()
{
    m_pCurrentFrameResource->Init();

    // Indicate that the back buffer will be used as a render target.
    m_pCurrentFrameResource->m_commandLists[CommandListPre]->ResourceBarrier(1, &CD3DX12_RESOURCE_BARRIER::Transition(m_renderTargets[m_frameIndex].Get(), D3D12_RESOURCE_STATE_PRESENT, D3D12_RESOURCE_STATE_RENDER_TARGET));

    // Clear the render target and depth stencil.
    const float clearColor[] = { 0.0f, 0.0f, 0.0f, 1.0f };
    CD3DX12_CPU_DESCRIPTOR_HANDLE rtvHandle(m_rtvHeap->GetCPUDescriptorHandleForHeapStart(), m_frameIndex, m_rtvDescriptorSize);
    m_pCurrentFrameResource->m_commandLists[CommandListPre]->ClearRenderTargetView(rtvHandle, clearColor, 0, nullptr);
    m_pCurrentFrameResource->m_commandLists[CommandListPre]->ClearDepthStencilView(m_dsvHeap->GetCPUDescriptorHandleForHeapStart(), D3D12_CLEAR_FLAG_DEPTH, 1.0f, 0, 0, nullptr);

    ThrowIfFailed(m_pCurrentFrameResource->m_commandLists[CommandListPre]->Close());
}

// Assemble the CommandListMid command list.
void D3D12Multithreading::MidFrame()
{
    // Transition our shadow map from the shadow pass to readable in the scene pass.
    m_pCurrentFrameResource->SwapBarriers();

    ThrowIfFailed(m_pCurrentFrameResource->m_commandLists[CommandListMid]->Close());
}

Direct3D 12 リファレンスのコード例を参照してください。

要件

要件	値
対象プラットフォーム	Windows
ヘッダー	d3d12.h
Library	D3d12.lib
[DLL]	D3d12.dll

こちらもご覧ください

ID3D12GraphicsCommandList

ID3D12GraphicsCommandList::ClearDepthStencilView メソッド (d3d12.h)

構文

パラメーター

戻り値

解説

ランタイムの検証

デバッグレイヤー

例

要件

こちらもご覧ください

フィードバック

フィードバック

その他のリソース

ID3D12GraphicsCommandList::ClearDepthStencilView メソッド (d3d12.h)

構文

パラメーター

戻り値

解説

ランタイムの検証

デバッグ レイヤー

例

要件

こちらもご覧ください

フィードバック

フィードバック

その他のリソース

デバッグレイヤー