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:
78
docs/api/rhi/enums/enums.md
Normal file
78
docs/api/rhi/enums/enums.md
Normal file
@@ -0,0 +1,78 @@
|
||||
# RHIEnums
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `enums`
|
||||
|
||||
**描述**: RHI 模块中使用的所有枚举类型汇总。
|
||||
|
||||
## 主要枚举
|
||||
|
||||
### 着色器
|
||||
|
||||
| 枚举 | 描述 |
|
||||
|------|------|
|
||||
| `ShaderType` | 着色器类型 |
|
||||
| `ShaderVisibility` | 着色器可见性 |
|
||||
|
||||
### 渲染状态
|
||||
|
||||
| 枚举 | 描述 |
|
||||
|------|------|
|
||||
| `CullMode` | 背面剔除模式 |
|
||||
| `FillMode` | 填充模式 |
|
||||
| `BlendOp` | 混合操作 |
|
||||
| `BlendFactor` | 混合因子 |
|
||||
| `ComparisonFunc` | 比较函数 |
|
||||
| `StencilOp` | 模板操作 |
|
||||
| `PrimitiveTopology` | 图元拓扑 |
|
||||
|
||||
### 纹理和采样
|
||||
|
||||
| 枚举 | 描述 |
|
||||
|------|------|
|
||||
| `TextureType` | 纹理类型 |
|
||||
| `Format` | 纹理/缓冲区格式 |
|
||||
| `FilterMode` | 采样器过滤模式 |
|
||||
| `TextureAddressMode` | 纹理寻址模式 |
|
||||
| `BorderColor` | 边框颜色 |
|
||||
|
||||
### 资源和缓冲
|
||||
|
||||
| 枚举 | 描述 |
|
||||
|------|------|
|
||||
| `BufferType` | 缓冲区类型 |
|
||||
| `ResourceStates` | 资源状态 |
|
||||
| `HeapType` | 内存堆类型 |
|
||||
| `DescriptorType` | 描述符类型 |
|
||||
| `DescriptorHeapType` | 描述符堆类型 |
|
||||
|
||||
### 命令和管线
|
||||
|
||||
| 枚举 | 描述 |
|
||||
|------|------|
|
||||
| `CommandQueueType` | 命令队列类型 |
|
||||
| `PipelineType` | 管线类型 |
|
||||
| `LoadAction` | 加载操作 |
|
||||
| `StoreAction` | 存储操作 |
|
||||
| `PresentFlags` | 呈现标志 |
|
||||
|
||||
### 查询和同步
|
||||
|
||||
| 枚举 | 描述 |
|
||||
|------|------|
|
||||
| `QueryType` | 查询类型 |
|
||||
| `RootParameterType` | 根参数类型 |
|
||||
|
||||
### 其他
|
||||
|
||||
| 枚举 | 描述 |
|
||||
|------|------|
|
||||
| `LogicOp` | 逻辑操作 |
|
||||
| `ColorWriteMask` | 颜色写入掩码 |
|
||||
| `RHIType` | RHI 后端类型 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHITypes](../types/types.md) - 结构体类型汇总
|
||||
Reference in New Issue
Block a user