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:
24
docs/api/rhi/opengl/command-queue/command-queue.md
Normal file
24
docs/api/rhi/opengl/command-queue/command-queue.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# OpenGLCommandQueue
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: OpenGL 命令队列实现,继承自 `RHICommandQueue`。
|
||||
|
||||
## 方法列表
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `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) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGL 后端总览](../overview.md)
|
||||
- [RHICommandQueue](../../command-queue/command-queue.md) - 抽象命令队列接口
|
||||
22
docs/api/rhi/opengl/command-queue/execute-command-lists.md
Normal file
22
docs/api/rhi/opengl/command-queue/execute-command-lists.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# OpenGLCommandQueue::ExecuteCommandLists
|
||||
|
||||
```cpp
|
||||
void ExecuteCommandLists(uint32_t count, void** lists)
|
||||
```
|
||||
|
||||
执行命令列表。
|
||||
|
||||
**参数:**
|
||||
- `count` - 命令列表数量
|
||||
- `lists` - 命令列表指针数组
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
void* lists[] = { commandList };
|
||||
commandQueue->ExecuteCommandLists(1, lists);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLCommandQueue](command-queue.md) - 返回类总览
|
||||
19
docs/api/rhi/opengl/command-queue/get-completed-value.md
Normal file
19
docs/api/rhi/opengl/command-queue/get-completed-value.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLCommandQueue::GetCompletedValue
|
||||
|
||||
```cpp
|
||||
uint64_t GetCompletedValue()
|
||||
```
|
||||
|
||||
获取已完成的值。
|
||||
|
||||
**返回:** 已完成的围栏值
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
uint64_t value = commandQueue->GetCompletedValue();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLCommandQueue](command-queue.md) - 返回类总览
|
||||
19
docs/api/rhi/opengl/command-queue/get-timestamp-frequency.md
Normal file
19
docs/api/rhi/opengl/command-queue/get-timestamp-frequency.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLCommandQueue::GetTimestampFrequency
|
||||
|
||||
```cpp
|
||||
uint64_t GetTimestampFrequency() const
|
||||
```
|
||||
|
||||
获取时间戳频率。
|
||||
|
||||
**返回:** 时间戳频率(Hz)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
uint64_t frequency = commandQueue->GetTimestampFrequency();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLCommandQueue](command-queue.md) - 返回类总览
|
||||
21
docs/api/rhi/opengl/command-queue/signal.md
Normal file
21
docs/api/rhi/opengl/command-queue/signal.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# OpenGLCommandQueue::Signal
|
||||
|
||||
```cpp
|
||||
void Signal(RHIFence* fence, uint64_t value)
|
||||
```
|
||||
|
||||
发送信号。
|
||||
|
||||
**参数:**
|
||||
- `fence` - 围栏指针
|
||||
- `value` - 信号值
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
commandQueue->Signal(fence, 1);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLCommandQueue](command-queue.md) - 返回类总览
|
||||
17
docs/api/rhi/opengl/command-queue/wait-for-idle.md
Normal file
17
docs/api/rhi/opengl/command-queue/wait-for-idle.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# OpenGLCommandQueue::WaitForIdle
|
||||
|
||||
```cpp
|
||||
void WaitForIdle()
|
||||
```
|
||||
|
||||
等待命令队列空闲。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
commandQueue->WaitForIdle();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLCommandQueue](command-queue.md) - 返回类总览
|
||||
Reference in New Issue
Block a user