Método ID3D12GraphicsCommandList::ClearRenderTargetView (d3d12.h)

Establece todos los elementos de un destino de representación en un valor.

Sintaxis

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

Parámetros

[in] RenderTargetView

Tipo: D3D12_CPU_DESCRIPTOR_HANDLE

Especifica una estructura de D3D12_CPU_DESCRIPTOR_HANDLE que describe el identificador del descriptor de CPU que representa el inicio del montón para que se borre el destino de representación.

[in] ColorRGBA

Tipo: const FLOAT[4]

Matriz de 4 componentes que representa el color con el que rellenar el destino de representación.

[in] NumRects

Tipo: UINT

Número de rectángulos de la matriz que especifica el parámetro pRects .

[in] pRects

Tipo: const D3D12_RECT*

Matriz de estructuras de D3D12_RECT para los rectángulos de la vista de recursos que se van a borrar. Si es NULL, ClearRenderTargetView borra toda la vista de recursos.

Valor devuelto

None

Observaciones

ClearRenderTargetView se puede usar para inicializar recursos que alias la misma memoria del montón. Consulte CreatePlacedResource para obtener más detalles.

Validación en tiempo de ejecución

En el caso de las entradas de punto flotante, el tiempo de ejecución establecerá valores desnormalizados en 0 (al tiempo que conserva los NAN).

El error de validación provocará la llamada a Close devolviendo E_INVALIDARG.

Capa de depuración

La capa de depuración emitirá errores si los colores de entrada están desnormalizados.

La capa de depuración emitirá un error si los subrecursos a los que hace referencia la vista no están en el estado adecuado. Para ClearRenderTargetView, el estado debe ser D3D12_RESOURCE_STATE_RENDER_TARGET.

Ejemplos

El ejemplo D3D12HelloTriangle usa ID3D12GraphicsCommandList::ClearRenderTargetView de la siguiente manera:

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

El ejemplo D3D12Multithreading usa ID3D12GraphicsCommandList::ClearRenderTargetView de la siguiente manera:

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

Vea Código de ejemplo en la referencia D3D12.

Requisitos

Requisito	Value
Plataforma de destino	Windows
Encabezado	d3d12.h
Library	D3d12.lib
Archivo DLL	D3d12.dll

Consulte también

ID3D12GraphicsCommandList