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:
2026-03-19 00:22:30 +08:00
parent d0e16962c8
commit dc850d7739
1012 changed files with 26673 additions and 9222 deletions

View File

@@ -0,0 +1,25 @@
# OpenGLFence
**命名空间**: `XCEngine::RHI`
**描述**: OpenGL 栅栏同步实现,继承自 `RHIFence`
## 方法列表
| 方法 | 文档 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `Signal` | [详细文档](signal.md) |
| `Wait` | [详细文档](../../../threading/task-group/wait.md) |
| `Reset` | [详细文档](../../../resources/resourcehandle/reset.md) |
| `IsSignaled` | [详细文档](is-signaled.md) |
| `GetStatus` | [详细文档](get-status.md) |
| `GetCompletedValue` | [详细文档](get-completed-value.md) |
| `GetCurrentValue` | [详细文档](get-current-value.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
## 相关文档
- [OpenGL 后端总览](../overview.md)
- [RHIFence](../../fence/fence.md) - 抽象栅栏接口

View File

@@ -0,0 +1,19 @@
# OpenGLFence::GetCompletedValue
```cpp
uint64_t GetCompletedValue() const override
```
获取已完成的最大栅栏值。
**返回:** `uint64_t` - 已完成的栅栏值
**示例:**
```cpp
uint64_t completed = fence.GetCompletedValue();
```
## 相关文档
- [OpenGLFence](fence.md) - 返回类总览

View File

@@ -0,0 +1,19 @@
# OpenGLFence::GetCurrentValue
```cpp
uint64_t GetCurrentValue() const
```
获取栅栏的当前值。
**返回:** `uint64_t` - 当前栅栏值
**示例:**
```cpp
uint64_t current = fence.GetCurrentValue();
```
## 相关文档
- [OpenGLFence](fence.md) - 返回类总览

View File

@@ -0,0 +1,25 @@
# OpenGLFence::GetStatus
```cpp
FenceStatus GetStatus() const
```
获取栅栏的当前状态。
**返回:** `FenceStatus` - 栅栏状态,可能的值:
- `FenceStatus::Signaled` - 栅栏已signaled
- `FenceStatus::Unsignaled` - 栅栏未signaled
- `FenceStatus::Error` - 发生错误
**示例:**
```cpp
FenceStatus status = fence.GetStatus();
if (status == FenceStatus::Signaled) {
// 操作已完成
}
```
## 相关文档
- [OpenGLFence](fence.md) - 返回类总览

View File

@@ -0,0 +1,21 @@
# OpenGLFence::IsSignaled
```cpp
bool IsSignaled() const override
```
检查栅栏是否处于 signaled 状态。
**返回:** `bool` - 如果栅栏已signaled返回 true否则返回 false
**示例:**
```cpp
if (fence.IsSignaled()) {
// 可以安全地继续执行
}
```
## 相关文档
- [OpenGLFence](fence.md) - 返回类总览

View File

@@ -0,0 +1,20 @@
# OpenGLFence::Signal
```cpp
void Signal() override
void Signal(uint64_t value) override
```
将栅栏设置为 signaled 状态,通知等待的线程操作完成。
**示例:**
```cpp
OpenGLFence fence;
fence.Initialize(false);
fence.Signal();
```
## 相关文档
- [OpenGLFence](fence.md) - 返回类总览