Metodo ID3D12GraphicsCommandList::ClearRenderTargetView (d3d12.h)

Articolo
03/05/2024

Imposta tutti gli elementi di una destinazione di rendering su un valore.

Sintassi

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

Parametri

[in] RenderTargetView

Tipo: D3D12_CPU_DESCRIPTOR_HANDLE

Specifica una struttura D3D12_CPU_DESCRIPTOR_HANDLE che descrive l'handle del descrittore della CPU che rappresenta l'inizio dell'heap per la destinazione di rendering da cancellare.

[in] ColorRGBA

Tipo: const FLOAT[4]

Matrice a 4 componenti che rappresenta il colore con cui riempire la destinazione di rendering.

[in] NumRects

Tipo: UINT

Numero di rettangoli nella matrice specificati dal parametro pRects .

[in] pRects

Tipo: const D3D12_RECT*

Matrice di strutture D3D12_RECT per i rettangoli nella visualizzazione risorse da cancellare. Se NULL, ClearRenderTargetView cancella l'intera visualizzazione risorse.

Valore restituito

nessuno

Osservazioni

ClearRenderTargetView può essere usato per inizializzare le risorse che aliasano la stessa memoria heap. Per altri dettagli, vedere CreatePlacedResource .

Convalida del runtime

Per gli input a virgola mobile, il runtime imposterà i valori denormalizzati su 0 (mantenendo al tempo stesso nan).

L'errore di convalida genererà la chiamata a Chiudi restituendo E_INVALIDARG.

Livello di debug

Il livello di debug genera errori se i colori di input vengono denormalizzati.

Il livello di debug genera un errore se le sottorisorse a cui fa riferimento la vista non sono nello stato appropriato. Per ClearRenderTargetView, lo stato deve essere D3D12_RESOURCE_STATE_RENDER_TARGET.

Esempio

L'esempio D3D12HelloTriangle usa ID3D12GraphicsCommandList::ClearRenderTargetView come indicato di seguito:

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

L'esempio D3D12Multithreading usa ID3D12GraphicsCommandList::ClearRenderTargetView come segue:

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

Vedere Codice di esempio nel riferimento D3D12.

Requisiti

Requisito	Valore
Piattaforma di destinazione	Windows
Intestazione	d3d12.h
Libreria	D3d12.lib
DLL	D3d12.dll

Vedi anche

ID3D12GraphicsCommandList

Condividi tramite