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,85 @@
# RHIDevice
**命名空间**: `XCEngine::RHI`
**类型**: `class` (abstract)
**描述**: RHI 渲染设备抽象接口,代表一个图形设备实例。
## 概述
`RHIDevice` 是 RHI 模块的核心接口之一,负责创建和管理所有 GPU 资源。每个 RHI 后端D3D12、OpenGL 等)都需要实现此接口。
## 公共方法
### 生命周期
| 方法 | 文档 |
|------|------|
| `Initialize` | [详细文档](initialize.md) |
| `Shutdown` | [详细文档](shutdown.md) |
### 资源创建
| 方法 | 文档 |
|------|------|
| `CreateBuffer` | [详细文档](create-buffer.md) |
| `CreateTexture` | [详细文档](create-texture.md) |
| `CreateSwapChain` | [详细文档](create-swap-chain.md) |
| `CreateCommandList` | [详细文档](create-command-list.md) |
| `CreateCommandQueue` | [详细文档](create-command-queue.md) |
| `CompileShader` | [详细文档](compile-shader.md) |
| `CreatePipelineState` | [详细文档](create-pipeline-state.md) |
| `CreateFence` | [详细文档](create-fence.md) |
| `CreateSampler` | [详细文档](create-sampler.md) |
### 设备信息
| 方法 | 文档 |
|------|------|
| `GetCapabilities` | [详细文档](get-capabilities.md) |
| `GetDeviceInfo` | [详细文档](get-device-info.md) |
| `GetNativeDevice` | [详细文档](get-native-device.md) |
## 使用示例
```cpp
// 创建 D3D12 设备
RHI::RHIDevice* device = RHI::RHIFactory::CreateRHIDevice(RHI::RHIType::D3D12);
// 配置设备描述
RHI::RHIDeviceDesc desc;
desc.windowHandle = hwnd;
desc.width = 1280;
desc.height = 720;
desc.appName = L"MyApp";
desc.enableDebugLayer = true;
// 初始化设备
if (device->Initialize(desc)) {
const RHI::RHICapabilities& caps = device->GetCapabilities();
if (caps.bSupportsRayTracing) {
// 设备支持光线追踪
}
const RHI::RHIDeviceInfo& info = device->GetDeviceInfo();
printf("GPU: %ls\n", info.description.c_str());
// 创建资源
RHI::BufferDesc bufferDesc;
bufferDesc.size = 1024;
bufferDesc.bufferType = (uint32_t)RHI::BufferType::Vertex;
RHI::RHIBuffer* buffer = device->CreateBuffer(bufferDesc);
device->Shutdown();
}
delete device;
```
## 相关文档
- [../../rhi.md](../rhi.md) - RHI 模块总览
- [RHIFactory](../factory/factory.md) - 设备工厂
- [RHICapabilities](../capabilities/capabilities.md) - 设备能力
- [RHITypes](../types/types.md) - 设备描述结构体