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 个断裂引用
This commit is contained in:
102
docs/api/rhi/command-list/command-list.md
Normal file
102
docs/api/rhi/command-list/command-list.md
Normal file
@@ -0,0 +1,102 @@
|
||||
# RHICommandList
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**描述**: GPU 命令列表抽象接口,用于录制和执行 GPU 命令。
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 命令录制控制
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Reset` | [详细文档](../../resources/resourcehandle/reset.md) |
|
||||
| `Close` | [详细文档](../../core/filewriter/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` | [详细文档](../../memory/linear-allocator/clear.md) |
|
||||
| `ClearRenderTarget` | [详细文档](clear-render-target.md) |
|
||||
| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) |
|
||||
|
||||
### 资源复制
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `CopyResource` | [详细文档](copy-resource.md) |
|
||||
|
||||
### 计算着色器
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Dispatch` | [详细文档](dispatch.md) |
|
||||
|
||||
### 生命周期
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```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) - 命令队列
|
||||
Reference in New Issue
Block a user