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:
70
docs/api/rhi/capabilities/capabilities.md
Normal file
70
docs/api/rhi/capabilities/capabilities.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# RHICapabilities
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**描述**: GPU 设备能力结构体,描述了当前图形设备支持的各种功能和限制。
|
||||
|
||||
## 公共成员
|
||||
|
||||
### 特性支持
|
||||
|
||||
| 成员 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `bSupportsRayTracing` | `bool` | 支持光线追踪 |
|
||||
| `bSupportsMeshShaders` | `bool` | 支持 Mesh 着色器 |
|
||||
| `bSupportsExplicitMultiThreading` | `bool` | 支持显式多线程 |
|
||||
| `bSupportsGeometryShaders` | `bool` | 支持几何着色器 |
|
||||
| `bSupportsTessellation` | `bool` | 支持曲面细分 |
|
||||
| `bSupportsComputeShaders` | `bool` | 支持计算着色器 |
|
||||
| `bSupportsDepthBoundsTest` | `bool` | 支持深度范围测试 |
|
||||
| `bSupportsAlphaToCoverage` | `bool` | 支持 Alpha 到覆盖 |
|
||||
| `bSupportsIndependentBlend` | `bool` | 支持独立混合 |
|
||||
| `bSupportsLogicOps` | `bool` | 支持逻辑操作 |
|
||||
| `bSupportsMultiViewport` | `bool` | 支持多视口 |
|
||||
| `bSupportsConservativeRasterization` | `bool` | 支持保守光栅化 |
|
||||
| `bSupportsProgrammableSamplePositions` | `bool` | 支持可编程采样位置 |
|
||||
|
||||
### 资源限制
|
||||
|
||||
| 成员 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `maxTexture2DSize` | `uint32_t` | 最大 2D 纹理尺寸 |
|
||||
| `maxTexture3DSize` | `uint32_t` | 最大 3D 纹理尺寸 |
|
||||
| `maxTextureCubeSize` | `uint32_t` | 最大立方体贴图尺寸 |
|
||||
| `maxRenderTargets` | `uint32_t` | 最大渲染目标数量 |
|
||||
| `maxViewports` | `uint32_t` | 最大视口数量 |
|
||||
| `maxVertexAttribs` | `uint32_t` | 最大顶点属性数量 |
|
||||
| `maxConstantBufferSize` | `uint32_t` | 最大常量缓冲大小 |
|
||||
| `maxAnisotropy` | `uint32_t` | 最大各向异性级别 |
|
||||
| `maxColorAttachments` | `uint32_t` | 最大颜色附件数量 |
|
||||
|
||||
### 版本信息
|
||||
|
||||
| 成员 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `majorVersion` | `int` | 主版本号 |
|
||||
| `minorVersion` | `int` | 次版本号 |
|
||||
| `shaderModel` | `std::string` | 着色器模型版本 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
const RHICapabilities& caps = device->GetCapabilities();
|
||||
|
||||
if (caps.bSupportsRayTracing) {
|
||||
// 启用光线追踪功能
|
||||
}
|
||||
|
||||
if (caps.bSupportsComputeShaders) {
|
||||
// 启用计算着色器
|
||||
}
|
||||
|
||||
uint32_t textureSize = std::min(requestedSize, caps.maxTexture2DSize);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHIDevice](../device/device.md) - 设备对象
|
||||
Reference in New Issue
Block a user