ID3D12GraphicsCommandList ::ClearRenderTargetView, méthode (d3d12.h)

Article
03/02/2024

Définit tous les éléments d’une cible de rendu sur une seule valeur.

Syntaxe

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

Paramètres

[in] RenderTargetView

Type : D3D12_CPU_DESCRIPTOR_HANDLE

Spécifie une structure D3D12_CPU_DESCRIPTOR_HANDLE qui décrit le handle de descripteur de processeur qui représente le début du tas pour la cible de rendu à effacer.

[in] ColorRGBA

Type : const FLOAT[4]

Tableau à 4 composants qui représente la couleur avec laquelle remplir la cible de rendu.

[in] NumRects

Type : UINT

Nombre de rectangles dans le tableau spécifié par le paramètre pRects .

[in] pRects

Type : const D3D12_RECT*

Tableau de structures D3D12_RECT pour effacer les rectangles de l’affichage des ressources. Si la valeur est NULL, ClearRenderTargetView efface l’ensemble de l’affichage des ressources.

Valeur de retour

None

Remarques

ClearRenderTargetView peut être utilisé pour initialiser des ressources qui alias la même mémoire de tas. Pour plus d’informations , consultez CreatePlacedResource .

Validation du runtime

Pour les entrées à virgule flottante, le runtime définit les valeurs dénormalisées sur 0 (tout en conservant les NAN).

L’échec de la validation entraîne le retour de l’appel à Fermer E_INVALIDARG.

Couche de débogage

La couche de débogage génère des erreurs si les couleurs d’entrée sont dénormalisées.

La couche de débogage génère une erreur si les sous-ressources référencées par la vue ne sont pas dans l’état approprié. Pour ClearRenderTargetView, l’état doit être D3D12_RESOURCE_STATE_RENDER_TARGET.

Exemples

L’exemple D3D12HelloTriangle utilise ID3D12GraphicsCommandList ::ClearRenderTargetView comme suit :

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’exemple D3D12Multithreading utilise ID3D12GraphicsCommandList ::ClearRenderTargetView comme suit :

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

Consultez l’exemple de code dans la référence D3D12.

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	d3d12.h
Bibliothèque	D3d12.lib
DLL	D3d12.dll

Voir aussi

ID3D12GraphicsCommandList

Partager via