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,46 @@
# D3D12Screenshot::Capture
## 函数签名
```cpp
static bool Capture(ID3D12Device* device,
ID3D12CommandQueue* commandQueue,
ID3D12Resource* renderTarget,
const char* filename,
uint32_t width,
uint32_t height)
```
## 中文描述
从渲染目标捕获截图并保存为文件。
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `device` | `ID3D12Device*` | D3D12 设备指针 |
| `commandQueue` | `ID3D12CommandQueue*` | 命令队列指针 |
| `renderTarget` | `ID3D12Resource*` | 渲染目标资源 |
| `filename` | `const char*` | 保存文件名 |
| `width` | `uint32_t` | 宽度 |
| `height` | `uint32_t` | 高度 |
## 返回值
`bool` - 捕获是否成功
## 复杂度
O(n) - 取决于纹理大小
## 示例
```cpp
D3D12Screenshot::Capture(device, commandQueue, renderTarget, "screenshot.png", width, height);
```
## 相关文档
- [D3D12Screenshot](screenshot.md) - 类总览
- [D3D12Screenshot::CopyToReadbackAndSave](copy-to-readback-and-save.md) - 复制到回读缓冲并保存

View File

@@ -0,0 +1,46 @@
# D3D12Screenshot::CopyToReadbackAndSave
## 函数签名
```cpp
static bool CopyToReadbackAndSave(ID3D12Device* device,
ID3D12CommandQueue* commandQueue,
ID3D12Resource* renderTarget,
const char* filename,
uint32_t width,
uint32_t height)
```
## 中文描述
复制渲染目标到回读缓冲区并保存为图片文件。
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `device` | `ID3D12Device*` | D3D12 设备指针 |
| `commandQueue` | `ID3D12CommandQueue*` | 命令队列指针 |
| `renderTarget` | `ID3D12Resource*` | 渲染目标资源 |
| `filename` | `const char*` | 保存文件名 |
| `width` | `uint32_t` | 宽度 |
| `height` | `uint32_t` | 高度 |
## 返回值
`bool` - 操作是否成功
## 复杂度
O(n) - 取决于纹理大小
## 示例
```cpp
D3D12Screenshot::CopyToReadbackAndSave(device, commandQueue, renderTarget, "screenshot.png", width, height);
```
## 相关文档
- [D3D12Screenshot](screenshot.md) - 类总览
- [D3D12Screenshot::Capture](capture.md) - 捕获截图

View File

@@ -0,0 +1,16 @@
# D3D12Screenshot
**命名空间**: `XCEngine::RHI`
**描述**: D3D12 截图工具类,提供屏幕截图捕获功能。**所有方法均为静态方法**。
## 方法列表
| 方法 | 文档 |
|------|------|
| `Capture` | [详细文档](capture.md) |
| `CopyToReadbackAndSave` | [详细文档](copy-to-readback-and-save.md) |
## 相关文档
- [D3D12 后端总览](../overview.md)