Files

ssdfasd dc850d7739 docs: 重构 API 文档结构并修正源码准确性

- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
  - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
  - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
  - core: 修复 types 链接错误
  - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
  - memory: 修复头文件路径, malloc vs operator new, 新增方法文档
  - resources: 修复 Shader/Texture 链接错误
  - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用

2026-03-19 00:22:30 +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