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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
# RHIDevice
|
|
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
|
|
|
|
|
|
|
|
**类型**: `class` (abstract)
|
|
|
|
|
|
|
2026-03-20 02:35:45 +08:00
|
|
|
|
**头文件**: `XCEngine/RHI/RHIDevice.h`
|
|
|
|
|
|
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
**描述**: RHI 渲染设备抽象接口,代表一个图形设备实例。
|
|
|
|
|
|
|
|
|
|
|
|
## 概述
|
|
|
|
|
|
|
|
|
|
|
|
`RHIDevice` 是 RHI 模块的核心接口之一,负责创建和管理所有 GPU 资源。每个 RHI 后端(D3D12、OpenGL 等)都需要实现此接口。
|
|
|
|
|
|
|
|
|
|
|
|
## 公共方法
|
|
|
|
|
|
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| 方法 | 描述 |
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
|------|------|
|
fix(rhi): Fix RHI abstraction layer API docs per api-skill.md template
- Rename texture/dtor.md to destructor.md per template spec
- Remove duplicate non-hyphenated fence docs (getnativehandle.md, issignaled.md, getcompletedvalue.md)
- Fix template field issues:
- swap-chain, command-queue: 类型 now uses 'class (abstract)'
- sampler: 头文件 now uses full path 'XCEngine/RHI/RHISampler.h'
- types: 类型 fixed from 'structs' to 'struct'
- enums: 类型 fixed from 'enums' to 'enum class'
- Fix include paths in command-queue and pipeline-layout code examples
- Create missing constructor/destructor docs for 11 classes:
buffer, texture, shader, device, command-list, command-queue,
fence, sampler, swap-chain, pipeline-state, pipeline-layout
- Update class overview pages to include constructor/destructor entries
2026-03-22 03:07:41 +08:00
|
|
|
|
| [`RHIDevice`](constructor.md) | 默认构造函数 |
|
|
|
|
|
|
| [`~RHIDevice`](destructor.md) | 虚析构函数 |
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| [`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) | 创建命令队列 |
|
2026-03-26 01:58:45 +08:00
|
|
|
|
| [`CreateShader`](create-shader.md) | 创建着色器 |
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| [`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) | 获取原生设备 |
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
|
|
```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();
|
2026-03-20 02:35:45 +08:00
|
|
|
|
printf("GPU: %ls\n", info.renderer.c_str());
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
|
|
|
|
|
|
// 创建资源
|
|
|
|
|
|
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) - 设备描述结构体
|