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:
32
docs/api/rhi/factory/create-rhi-device-string.md
Normal file
32
docs/api/rhi/factory/create-rhi-device-string.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# RHIFactory::CreateRHIDevice (string)
|
||||
|
||||
```cpp
|
||||
static RHIDevice* CreateRHIDevice(const std::string& typeName);
|
||||
```
|
||||
|
||||
根据字符串名称创建 RHI 设备。
|
||||
|
||||
**参数:**
|
||||
- `typeName` - 后端类型名称字符串(不区分大小写)
|
||||
|
||||
**返回:** 新创建的设备指针,失败返回 `nullptr`
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**支持的类型名称:**
|
||||
- `"D3D12"` / `"d3d12"`
|
||||
- `"OpenGL"` / `"opengl"`
|
||||
- `"Vulkan"` / `"vulkan"`
|
||||
- `"Metal"` / `"metal"`
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
// 从配置文件读取后端类型
|
||||
std::string backendType = "D3D12";
|
||||
RHIDevice* device = RHIFactory::CreateRHIDevice(backendType);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFactory 总览](factory.md) - 返回类总览
|
||||
Reference in New Issue
Block a user