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:
46
docs/api/rhi/fence/fence.md
Normal file
46
docs/api/rhi/fence/fence.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# RHIFence
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**描述**: GPU 同步栅栏抽象接口,用于 GPU/CPU 同步和跨队列同步。
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 生命周期
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
||||
|
||||
### 同步操作
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Signal` | [详细文档](../command-queue/signal.md) |
|
||||
| `Wait` | [详细文档](../../threading/task-group/wait.md) |
|
||||
| `GetCompletedValue` | [详细文档](../command-queue/get-completed-value.md) |
|
||||
| `IsSignaled` | [详细文档](is-signaled.md) |
|
||||
|
||||
### 其他
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
FenceDesc desc;
|
||||
desc.initialValue = 0;
|
||||
RHIFence* fence = device->CreateFence(desc);
|
||||
|
||||
commandQueue->Signal(fence, 1);
|
||||
fence->Wait(1);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHICommandQueue](../command-queue/command-queue.md) - 命令队列
|
||||
19
docs/api/rhi/fence/get-completed-value.md
Normal file
19
docs/api/rhi/fence/get-completed-value.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# RHIFence::GetCompletedValue
|
||||
|
||||
```cpp
|
||||
virtual uint64_t GetCompletedValue() const = 0;
|
||||
```
|
||||
|
||||
获取已完成信号值。
|
||||
|
||||
**返回:** 已完成的信号值
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
uint64_t value = fence->GetCompletedValue();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFence 总览](fence.md) - 返回类总览
|
||||
21
docs/api/rhi/fence/is-signaled.md
Normal file
21
docs/api/rhi/fence/is-signaled.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# RHIFence::IsSignaled
|
||||
|
||||
```cpp
|
||||
virtual bool IsSignaled() const = 0;
|
||||
```
|
||||
|
||||
检查栅栏是否被信号触发。
|
||||
|
||||
**返回:** 如果栅栏已被信号触发返回 true
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
if (fence->IsSignaled()) {
|
||||
// 栅栏已完成
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFence 总览](fence.md) - 返回类总览
|
||||
50
docs/api/rhi/fence/methods.md
Normal file
50
docs/api/rhi/fence/methods.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# RHIFence 方法
|
||||
|
||||
## Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放栅栏资源。
|
||||
|
||||
## Signal
|
||||
|
||||
```cpp
|
||||
virtual void Signal() = 0;
|
||||
virtual void Signal(uint64_t value) = 0;
|
||||
```
|
||||
|
||||
信号通知(值为 1)或指定值。
|
||||
|
||||
## Wait
|
||||
|
||||
```cpp
|
||||
virtual void Wait(uint64_t value) = 0;
|
||||
```
|
||||
|
||||
等待指定值。
|
||||
|
||||
## GetCompletedValue
|
||||
|
||||
```cpp
|
||||
virtual uint64_t GetCompletedValue() const = 0;
|
||||
```
|
||||
|
||||
获取已完成的值。
|
||||
|
||||
## IsSignaled
|
||||
|
||||
```cpp
|
||||
virtual bool IsSignaled() const = 0;
|
||||
```
|
||||
|
||||
检查是否已信号通知。
|
||||
|
||||
## GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
22
docs/api/rhi/fence/signal.md
Normal file
22
docs/api/rhi/fence/signal.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# RHIFence::Signal
|
||||
|
||||
```cpp
|
||||
virtual void Signal() = 0;
|
||||
virtual void Signal(uint64_t value) = 0;
|
||||
```
|
||||
|
||||
向栅栏发送信号。
|
||||
|
||||
**参数:**
|
||||
- `value` - 信号值(重载版本)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
fence->Signal();
|
||||
fence->Signal(1);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFence 总览](fence.md) - 返回类总览
|
||||
Reference in New Issue
Block a user