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
|
|
|
# RHICommandList
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
|
|
|
|
|
|
**类型**: `class` (abstract)
|
|
|
|
|
|
|
|
|
|
**描述**: GPU 命令列表抽象接口，用于录制和执行 GPU 命令。
|
|
|
|
|
|
|
|
|
|
## 公共方法
|
|
|
|
|
|
2026-03-19 02:01:18 +08:00
|
|
|
| 方法 | 描述 |
|
|
|
|
|
|------|------|
|
|
|
|
|
| [`Reset`](reset.md) | 重置命令列表 |
|
|
|
|
|
| [`Close`](close.md) | 关闭命令列表 |
|
|
|
|
|
| [`TransitionBarrier`](transition-barrier.md) | 资源状态转换 |
|
|
|
|
|
| [`SetPipelineState`](set-pipeline-state.md) | 设置管线状态 |
|
|
|
|
|
| [`SetPrimitiveTopology`](set-primitive-topology.md) | 设置图元拓扑 |
|
|
|
|
|
| [`SetViewport`](set-viewport.md) | 设置视口 |
|
|
|
|
|
| [`SetViewports`](set-viewports.md) | 设置多个视口 |
|
|
|
|
|
| [`SetScissorRect`](set-scissor-rect.md) | 设置裁剪矩形 |
|
|
|
|
|
| [`SetScissorRects`](set-scissor-rects.md) | 设置多个裁剪矩形 |
|
|
|
|
|
| [`SetRenderTargets`](set-render-targets.md) | 设置渲染目标 |
|
|
|
|
|
| [`SetDepthStencilState`](set-depth-stencil-state.md) | 设置深度模板状态 |
|
|
|
|
|
| [`SetStencilRef`](set-stencil-ref.md) | 设置模板引用值 |
|
|
|
|
|
| [`SetBlendState`](set-blend-state.md) | 设置混合状态 |
|
|
|
|
|
| [`SetBlendFactor`](set-blend-factor.md) | 设置混合因子 |
|
|
|
|
|
| [`SetVertexBuffer`](set-vertex-buffer.md) | 设置顶点缓冲 |
|
|
|
|
|
| [`SetVertexBuffers`](set-vertex-buffers.md) | 设置多个顶点缓冲 |
|
|
|
|
|
| [`SetIndexBuffer`](set-index-buffer.md) | 设置索引缓冲 |
|
|
|
|
|
| [`Draw`](draw.md) | 绘制 |
|
|
|
|
|
| [`DrawIndexed`](draw-indexed.md) | 索引绘制 |
|
|
|
|
|
| [`Clear`](clear.md) | 清除 |
|
|
|
|
|
| [`ClearRenderTarget`](clear-render-target.md) | 清除渲染目标 |
|
|
|
|
|
| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度模板 |
|
|
|
|
|
| [`CopyResource`](copy-resource.md) | 复制资源 |
|
|
|
|
|
| [`Dispatch`](dispatch.md) | 分发计算任务 |
|
|
|
|
|
| [`Shutdown`](shutdown.md) | 关闭并释放资源 |
|
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
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
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);
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
|
|
|
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
|
|
|
|
- [RHICommandQueue](../command-queue/command-queue.md) - 命令队列
|
