2026-03-18 17:49:22 +08:00
|
|
|
|
# RHIFactory
|
|
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
|
|
|
2026-03-20 02:35:45 +08:00
|
|
|
|
**类型**: `class` (static methods only)
|
|
|
|
|
|
|
|
|
|
|
|
**头文件**: `XCEngine/RHI/RHIFactory.h`
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
|
|
**描述**: RHI 设备工厂，用于创建不同图形 API 后端的渲染设备。
|
|
|
|
|
|
|
|
|
|
|
|
## 概述
|
|
|
|
|
|
|
|
|
|
|
|
`RHIFactory` 是静态工厂类，提供统一的接口来创建不同后端的 `RHIDevice` 实例。通过 `RHIType` 枚举指定要创建的后端类型。
|
|
|
|
|
|
|
|
|
|
|
|
## 公共方法
|
|
|
|
|
|
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| 方法 | 描述 |
|
2026-03-18 17:49:22 +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
|
|
|
|
| [`~RHIFactory`](destructor.md) | 虚析构函数 |
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| [`CreateRHIDevice(RHIType)`](create-rhi-device-type.md) | 使用枚举类型创建 RHI 设备 |
|
|
|
|
|
|
| [`CreateRHIDevice(std::string)`](create-rhi-device-string.md) | 使用字符串创建 RHI 设备 |
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
|
|
## 类型映射
|
|
|
|
|
|
|
|
|
|
|
|
| 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：根据配置选择
|
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
|
|
|
|
std::string backend = "D3D12";
|
2026-03-18 17:49:22 +08:00
|
|
|
|
RHIDevice* device = RHIFactory::CreateRHIDevice(backend);
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
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/rhi.md](../rhi.md) - RHI 模块总览
|
|
|
|
|
|
- [RHIDevice](../device/device.md) - 渲染设备
|
|
|
|
|
|
- [RHIEnums](../enums/enums.md) - RHIType 枚举定义
|
