Метод ID3D12GraphicsCommandList::ClearRenderTargetView (d3d12.h)

Статья
08/23/2023

Задает для всех элементов в целевом объекте отрисовки одно значение.

Синтаксис

void ClearRenderTargetView(
  [in] D3D12_CPU_DESCRIPTOR_HANDLE RenderTargetView,
  [in] const FLOAT [4]             ColorRGBA,
  [in] UINT                        NumRects,
  [in] const D3D12_RECT            *pRects
);

Параметры

[in] RenderTargetView

Тип: D3D12_CPU_DESCRIPTOR_HANDLE

Задает структуру D3D12_CPU_DESCRIPTOR_HANDLE, описывающую дескриптор ЦП, представляющий начало кучи для очистки целевого объекта отрисовки.

[in] ColorRGBA

Тип: const FLOAT[4]

Массив из 4 компонентов, представляющий цвет для заполнения целевого объекта отрисовки.

[in] NumRects

Тип: UINT

Количество прямоугольников в массиве, указанное параметром pRects .

[in] pRects

Тип: const D3D12_RECT*

Массив D3D12_RECT структур для очищенных прямоугольников в представлении ресурсов. Если значение РАВНО NULL, ClearRenderTargetView очищает все представление ресурсов.

Возвращаемое значение

None

Remarks

ClearRenderTargetView можно использовать для инициализации ресурсов с псевдонимом одной и той же памяти кучи. Дополнительные сведения см. в разделе CreatePlacedResource .

Проверка среды выполнения

Для входных данных с плавающей запятой среда выполнения установит денормализованные значения равным 0 (с сохранением nan).

Сбой проверки приведет к вызову Закрыть , возвращая E_INVALIDARG.

Уровень отладки

Уровень отладки будет выдавать ошибки, если входные цвета денормализованы.

Уровень отладки выдаст ошибку, если подресурсы, на которые ссылается представление, не находятся в соответствующем состоянии. Для ClearRenderTargetView состояние должно быть D3D12_RESOURCE_STATE_RENDER_TARGET.

Примеры

В примере D3D12HelloTriangle используется ID3D12GraphicsCommandList::ClearRenderTargetView следующим образом:

D3D12_VIEWPORT m_viewport;
D3D12_RECT m_scissorRect;
ComPtr<IDXGISwapChain3> m_swapChain;
ComPtr<ID3D12Device> m_device;
ComPtr<ID3D12Resource> m_renderTargets[FrameCount];
ComPtr<ID3D12CommandAllocator> m_commandAllocator;
ComPtr<ID3D12CommandQueue> m_commandQueue;
ComPtr<ID3D12RootSignature> m_rootSignature;
ComPtr<ID3D12DescriptorHeap> m_rtvHeap;
ComPtr<ID3D12PipelineState> m_pipelineState;
ComPtr<ID3D12GraphicsCommandList> m_commandList;
UINT m_rtvDescriptorSize;

void D3D12HelloTriangle::PopulateCommandList()
{
    // 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_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_commandAllocator.Get(), m_pipelineState.Get()));

    // Set necessary state.
    m_commandList->SetGraphicsRootSignature(m_rootSignature.Get());
    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);
    m_commandList->OMSetRenderTargets(1, &rtvHandle, FALSE, nullptr);

    // Record commands.
    const float clearColor[] = { 0.0f, 0.2f, 0.4f, 1.0f };
    m_commandList->ClearRenderTargetView(rtvHandle, clearColor, 0, nullptr);
    m_commandList->IASetPrimitiveTopology(D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST);
    m_commandList->IASetVertexBuffers(0, 1, &m_vertexBufferView);
    m_commandList->DrawInstanced(3, 1, 0, 0);

    // 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::ClearRenderTargetView следующим образом:

// Frame resources.
FrameResource* m_frameResources[FrameCount];
FrameResource* m_pCurrentFrameResource;
int m_currentFrameResourceIndex;

// 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());
}

См . пример кода в справочнике по D3D12.

Требования

Требование	Значение
Целевая платформа	Windows
Header	d3d12.h
Библиотека	D3d12.lib
DLL	D3d12.dll

См. также раздел

ID3D12GraphicsCommandList

Поделиться через