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,24 @@
# D3D12Fence
**命名空间**: `XCEngine::RHI`
**描述**: DirectX 12 栅栏同步对象的 D3D12 实现,继承自 `RHIFence`
## 方法列表
| 方法 | 文档 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `Signal` | [详细文档](signal.md) |
| `Wait` | [详细文档](../../../threading/task-group/wait.md) |
| `GetCompletedValue` | [详细文档](get-completed-value.md) |
| `IsSignaled` | [详细文档](is-signaled.md) |
| `GetEventHandle` | [详细文档](get-event-handle.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetFence` | [详细文档](get-fence.md) |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [RHIFence](../../fence/fence.md) - 抽象栅栏接口

View File

@@ -0,0 +1,34 @@
# D3D12Fence::GetCompletedValue
## 函数签名
```cpp
uint64_t GetCompletedValue() const override
```
## 中文描述
获取 GPU 已完成的最新栅栏值。
## 返回值
`uint64_t` - 已完成的栅栏值
## 复杂度
O(1)
## 示例
```cpp
uint64_t completedValue = d3d12Fence->GetCompletedValue();
if (completedValue >= fenceValue) {
// 指定的栅栏值已完成
}
```
## 相关文档
- [D3D12Fence](fence.md) - 类总览
- [D3D12Fence::Signal](signal.md) - 信号栅栏
- [D3D12Fence::IsSignaled](is-signaled.md) - 检查是否已信号

View File

@@ -0,0 +1,31 @@
# D3D12Fence::GetEventHandle
## 函数签名
```cpp
void* GetEventHandle()
```
## 中文描述
获取用于 CPU 等待的 event 句柄。用于 `WaitForSingleObject` 等 API 进行阻塞等待。
## 返回值
`void*` - Win32 event 句柄
## 复杂度
O(1)
## 示例
```cpp
HANDLE eventHandle = static_cast<HANDLE>(d3d12Fence->GetEventHandle());
WaitForSingleObject(eventHandle, INFINITE);
```
## 相关文档
- [D3D12Fence](fence.md) - 类总览
- [D3D12Fence::Wait](../../../threading/task-group/wait.md) - 等待栅栏

View File

@@ -0,0 +1,30 @@
# D3D12Fence::GetFence
## 函数签名
```cpp
ID3D12Fence* GetFence() const
```
## 中文描述
获取底层 `ID3D12Fence` 接口指针。
## 返回值
`ID3D12Fence*` - D3D12 栅栏接口指针
## 复杂度
O(1)
## 示例
```cpp
ID3D12Fence* fence = d3d12Fence->GetFence();
```
## 相关文档
- [D3D12Fence](fence.md) - 类总览
- [D3D12Fence::GetNativeHandle](../../buffer/get-native-handle.md) - 获取原生句柄

View File

@@ -0,0 +1,33 @@
# D3D12Fence::IsSignaled
## 函数签名
```cpp
bool IsSignaled() const override
```
## 中文描述
检查当前栅栏值是否已达到 signal 值。
## 返回值
`bool` - 如果已完成则返回 `true`,否则返回 `false`
## 复杂度
O(1)
## 示例
```cpp
if (d3d12Fence->IsSignaled()) {
// 栅栏已完成,可以继续执行
}
```
## 相关文档
- [D3D12Fence](fence.md) - 类总览
- [D3D12Fence::GetCompletedValue](get-completed-value.md) - 获取完成值
- [D3D12Fence::Wait](../../../threading/task-group/wait.md) - 等待栅栏

View File

@@ -0,0 +1,46 @@
# D3D12Fence::Signal
## 函数签名
```cpp
void Signal() override
```
## 中文描述
将栅栏值设置为 GPU 当前 signaled 值,通常用于标记命令队列执行完成。
## 重载
| 版本 | 签名 |
|------|------|
| 无参数 | `void Signal()` |
| 带值 | `void Signal(uint64_t value)` |
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `value` | `uint64_t` | 要设置的栅栏值(仅带参数版本) |
## 返回值
## 复杂度
O(1)
## 示例
```cpp
d3d12Fence->Signal();
// 或指定值
d3d12Fence->Signal(1);
```
## 相关文档
- [D3D12Fence](fence.md) - 类总览
- [D3D12Fence::Wait](../../../threading/task-group/wait.md) - 等待栅栏
- [D3D12Fence::GetCompletedValue](get-completed-value.md) - 获取完成值