Files

ssdfasd a9f882f233 docs: 修正 API 文档准确性 (第二轮检查)

修复的问题:
- math: 修复 Quaternion::Normalize 链接错误
- containers: HashMap 迭代器示例使用不存在的 cbegin/cend，删除冗余构造函数声明
- core: RefCounted 析构函数访问级别修正 (protected)
- debug: LogLevelToString 示例返回值大小写修正
- memory: 修正 LinearAllocator::Reallocate 返回 nullptr，ProxyAllocator 统计描述，头文件路径 IAllocator.h -> Allocator.h
- resources: Texture::Create mipLevels 参数描述修正
- rhi: 修复多处链接错误，新增缺失的方法文档
- threading: TaskSystem 配置项未实现状态标注，Wait 方法空实现标注

2026-03-19 00:31:14 +08:00

2.7 KiB

Raw Blame History

RHICommandList

命名空间: XCEngine::RHI

类型: class (abstract)

描述: GPU 命令列表抽象接口，用于录制和执行 GPU 命令。

公共方法

命令录制控制

方法	文档
`Reset`	详细文档
`Close`	详细文档

资源状态转换

方法	文档
`TransitionBarrier`	详细文档

渲染状态设置

方法	文档
`SetPipelineState`	详细文档
`SetPrimitiveTopology`	详细文档
`SetViewport`	详细文档
`SetViewports`	详细文档
`SetScissorRect`	详细文档
`SetScissorRects`	详细文档
`SetRenderTargets`	详细文档

深度/混合状态

方法	文档
`SetDepthStencilState`	详细文档
`SetStencilRef`	详细文档
`SetBlendState`	详细文档
`SetBlendFactor`	详细文档

顶点/索引缓冲

方法	文档
`SetVertexBuffer`	详细文档
`SetVertexBuffers`	详细文档
`SetIndexBuffer`	详细文档

绘制命令

方法	文档
`Draw`	详细文档
`DrawIndexed`	详细文档

清除命令

方法	文档
`Clear`	详细文档
`ClearRenderTarget`	详细文档
`ClearDepthStencil`	详细文档

资源复制

方法	文档
`CopyResource`	详细文档

计算着色器

方法	文档
`Dispatch`	详细文档

生命周期

方法	文档
`Shutdown`	详细文档

使用示例

commandList->Reset();
commandList->SetPipelineState(pipelineState);
commandList->SetPrimitiveTopology(PrimitiveTopology::TriangleList);
commandList->SetViewport(viewport);
commandList->SetRenderTargets(1, &renderTarget, depthStencil);
commandList->DrawIndexed(indexCount, 1, 0, 0, 0);
commandList->Close();
commandQueue->ExecuteCommandLists(1, (void**)&commandList);

2.7 KiB Raw Blame History

RHICommandList

公共方法

命令录制控制

资源状态转换

渲染状态设置

深度/混合状态

顶点/索引缓冲

绘制命令

清除命令

资源复制

计算着色器

生命周期

使用示例

相关文档

2.7 KiB

Raw Blame History