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:
67
docs/api/rhi/command-queue/command-queue.md
Normal file
67
docs/api/rhi/command-queue/command-queue.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# RHICommandQueue
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**描述**: GPU 命令队列抽象接口,负责提交和执行命令列表,以及 GPU/CPU 同步。
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 生命周期
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
||||
|
||||
### 命令执行
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `ExecuteCommandLists` | [详细文档](execute-command-lists.md) |
|
||||
| `Signal` | [详细文档](signal.md) |
|
||||
| `Wait` | [详细文档](../../threading/task-group/wait.md) |
|
||||
| `GetCompletedValue` | [详细文档](get-completed-value.md) |
|
||||
| `WaitForIdle` | [详细文档](wait-for-idle.md) |
|
||||
|
||||
### 属性访问
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetType` | [详细文档](../shader/get-type.md) |
|
||||
| `GetTimestampFrequency` | [详细文档](get-timestamp-frequency.md) |
|
||||
|
||||
### 其他
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
|
||||
|
||||
## 命令队列类型 (CommandQueueType)
|
||||
|
||||
| 枚举值 | 描述 |
|
||||
|--------|------|
|
||||
| `Direct` | 直接队列,用于图形和计算命令 |
|
||||
| `Compute` | 计算队列,专门用于计算着色器 |
|
||||
| `Copy` | 复制队列,专门用于资源复制 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
CommandQueueDesc queueDesc;
|
||||
queueDesc.queueType = (uint32_t)CommandQueueType::Direct;
|
||||
RHICommandQueue* commandQueue = device->CreateCommandQueue(queueDesc);
|
||||
|
||||
FenceDesc fenceDesc;
|
||||
RHIFence* fence = device->CreateFence(fenceDesc);
|
||||
|
||||
commandQueue->ExecuteCommandLists(1, (void**)&commandList);
|
||||
commandQueue->Signal(fence, 1);
|
||||
fence->Wait(1);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHICommandList](../command-list/command-list.md) - 命令列表
|
||||
- [RHIFence](../fence/fence.md) - 同步栅栏
|
||||
Reference in New Issue
Block a user