ID3D12GraphicsCommandList::Metode ClearRenderTargetView (d3d12.h)

Mengatur semua elemen dalam target render ke satu nilai.

Sintaks

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

Parameter

[in] RenderTargetView

Jenis: D3D12_CPU_DESCRIPTOR_HANDLE

Menentukan struktur D3D12_CPU_DESCRIPTOR_HANDLE yang menjelaskan handel deskriptor CPU yang mewakili awal heap agar target render dihapus.

[in] ColorRGBA

Jenis: const FLOAT[4]

Array 4 komponen yang mewakili warna untuk mengisi target render.

[in] NumRects

Jenis: UINT

Jumlah persegi panjang dalam array yang ditentukan parameter pRects .

[in] pRects

Jenis: const D3D12_RECT*

Array struktur D3D12_RECT untuk persegi panjang dalam tampilan sumber daya untuk dihapus. Jika NULL, ClearRenderTargetView akan menghapus seluruh tampilan sumber daya.

Nilai kembali

Tidak ada

Keterangan

ClearRenderTargetView dapat digunakan untuk menginisialisasi sumber daya yang alias memori timbunan yang sama. Lihat CreatePlacedResource untuk detail selengkapnya.

Validasi runtime

Untuk input floating-point, runtime akan mengatur nilai yang didenormalisasi ke 0 (sambil mempertahankan NAN).

Kegagalan validasi akan mengakibatkan panggilan ke Tutupmengembalikan E_INVALIDARG.

Lapisan debug

Lapisan debug akan mengeluarkan kesalahan jika warna input dinormalisasi.

Lapisan debug akan mengeluarkan kesalahan jika subsumber daya yang direferensikan oleh tampilan tidak dalam status yang sesuai. Untuk ClearRenderTargetView, statusnya harus D3D12_RESOURCE_STATE_RENDER_TARGET.

Contoh

Sampel D3D12HelloTriangle menggunakan ID3D12GraphicsCommandList::ClearRenderTargetView sebagai berikut:

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

Sampel D3D12Multithreading menggunakan ID3D12GraphicsCommandList::ClearRenderTargetView sebagai berikut:

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

Lihat Contoh Kode di Referensi D3D12.

Persyaratan

Persyaratan	Nilai
Target Platform	Windows
Header	d3d12.h
Pustaka	D3d12.lib
DLL	D3d12.dll

Lihat juga

ID3D12GraphicsCommandList