ID3D12GraphicsCommandList::Reset 方法 (d3d12.h)

将命令列表重置回其初始状态,就像刚刚创建新命令列表一样。

语法

HRESULT Reset(
  [in]           ID3D12CommandAllocator *pAllocator,
  [in, optional] ID3D12PipelineState    *pInitialState
);

参数

[in] pAllocator

类型:ID3D12CommandAllocator*

指向设备从中创建命令列表的 ID3D12CommandAllocator 对象的指针。

[in, optional] pInitialState

类型:ID3D12PipelineState*

指向 ID3D12PipelineState 对象的指针,该对象包含命令列表的初始管道状态。 这是可选的,可以为 NULL。 如果为 NULL,运行时将设置虚拟初始管道状态,以便驱动程序不必处理未定义的状态。 这一开销较低,尤其是对于命令列表,记录命令列表的总体成本可能会使一个初始状态设置的成本相形见绌。 因此,如果初始管道状态参数不方便,则设置初始管道状态参数的成本很少。

另一方面,对于捆绑包,尝试设置初始状态参数可能更有意义,因为捆绑包整体可能更小,可以经常重复使用。

返回值

类型:HRESULT

如果成功,则返回 S_OK;否则,返回以下值之一:

  • 如果命令列表在发出 重置 调用时未处于“关闭”状态,或者超出每个设备的限制,则 E_FAIL
  • 如果操作系统内存不足,E_OUTOFMEMORY
  • E_INVALIDARG 如果分配器当前正与处于“记录”状态的另一个命令列表一起使用,或者指定的分配器是使用错误的类型创建的。
有关其他可能的返回值,请参阅 Direct3D 12 返回代码

言论

通过使用 重置,可以在没有任何分配的情况下重复使用命令列表跟踪结构。 与 ID3D12CommandAllocator::Reset不同,在命令列表仍在执行时,可以调用 重置

可以将 重置 用于直接命令列表和捆绑包。

传递给 Reset 的命令分配器不能与任何其他当前录制的命令列表相关联。 分配器类型、直接命令列表或捆绑包必须与正在创建的命令列表的类型匹配。

如果捆绑包未指定资源堆,则无法更改绑定描述符表。 无论哪种方式,捆绑包都无法更改捆绑包中的资源堆。 如果为捆绑指定堆,堆必须与调用的“parent”命令列表的堆匹配。

运行时验证

在应用调用 重置之前,命令列表必须处于“已关闭”状态。 如果命令列表未处于“已关闭”状态,重置 将失败。
注意 如果调用 ID3D12GraphicsCommandList::Close 失败,则永远无法重置命令列表。 调用 重置 将导致返回 ID3D12GraphicsCommandList::Close 返回相同的错误。
 
重置 成功后,命令列表将处于“录制”状态。 如果重置 会导致在创建设备时指定的最大并发录制命令列表限制超出,则重置 将失败。

应用必须指定命令列表分配器。 运行时将确保分配器永远不会同时与多个录制命令列表相关联。

对于尚未提交的命令列表引用的捆绑包,重置 失败。

调试层

如果调试层无法证明命令列表没有未完成的执行,调试层还将跟踪图形处理单元(GPU)进度并发出错误。

例子

D3D12HelloTriangle 示例使用 ID3D12GraphicsCommandList::Reset,如下所示:

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

请参阅 D3D12 参考中的 示例代码。

要求

要求 价值
目标平台 窗户
标头 d3d12.h
D3d12.lib
DLL D3d12.dll

另请参阅

ID3D12CommandAllocator::Reset

ID3D12Device::CreateCommandList

ID3D12GraphicsCommandList