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,47 @@
# RHIFactory
**命名空间**: `XCEngine::RHI`
**类型**: `class` (static)
**描述**: RHI 设备工厂,用于创建不同图形 API 后端的渲染设备。
## 概述
`RHIFactory` 是静态工厂类,提供统一的接口来创建不同后端的 `RHIDevice` 实例。通过 `RHIType` 枚举指定要创建的后端类型。
## 公共方法
| 方法 | 文档 |
|------|------|
| `CreateRHIDevice(RHIType)` | [详细文档](create-rhi-device-type.md) |
| `CreateRHIDevice(std::string)` | [详细文档](create-rhi-device-string.md) |
## 类型映射
| RHIType | typeName 参数值 |
|----------|-----------------|
| `RHIType::D3D12` | `"D3D12"` |
| `RHIType::OpenGL` | `"OpenGL"` |
| `RHIType::Vulkan` | `"Vulkan"` |
| `RHIType::Metal` | `"Metal"` |
## 使用示例
```cpp
// 方法1使用枚举创建
RHIDevice* d3d12Device = RHIFactory::CreateRHIDevice(RHIType::D3D12);
// 方法2使用字符串创建
RHIDevice* glDevice = RHIFactory::CreateRHIDevice("OpenGL");
// 方法3根据配置选择
std::string backend = "D3D12";
RHIDevice* device = RHIFactory::CreateRHIDevice(backend);
```
## 相关文档
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
- [RHIDevice](../device/device.md) - 渲染设备
- [RHIEnums](../enums/enums.md) - RHIType 枚举定义