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:
67
docs/api/rhi/d3d12/common/common.md
Normal file
67
docs/api/rhi/d3d12/common/common.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# D3D12Common
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: D3D12 通用辅助函数集合,提供描述符大小、屏障创建、格式支持检查等功能。**所有函数均为 inline 函数**。
|
||||
|
||||
## 函数列表
|
||||
|
||||
### 描述符大小
|
||||
|
||||
| 函数 | 描述 |
|
||||
|------|------|
|
||||
| `GetDescriptorHandleIncrementSize` | 获取描述符增量大小 |
|
||||
| `GetRTVDescriptorSize` | 获取 RTV 描述符大小 |
|
||||
| `GetDSVDescriptorSize` | 获取 DSV 描述符大小 |
|
||||
| `GetCBV_SRV_UAVDescriptorSize` | 获取 CBV/SRV/UAV 描述符大小 |
|
||||
| `GetSamplerDescriptorSize` | 获取 Sampler 描述符大小 |
|
||||
|
||||
### 屏障创建
|
||||
|
||||
| 函数 | 描述 |
|
||||
|------|------|
|
||||
| `CreateTransitionBarrier` | 创建资源状态转换屏障 |
|
||||
| `CreateUAVBarrier` | 创建 UAV 屏障 |
|
||||
| `CreateAliasingBarrier` | 创建别名化屏障 |
|
||||
|
||||
### 格式支持
|
||||
|
||||
| 函数 | 描述 |
|
||||
|------|------|
|
||||
| `CheckFormatSupport` | 检查格式支持 |
|
||||
| `IsRenderTargetFormatSupported` | 检查是否支持作为渲染目标 |
|
||||
| `IsDepthStencilFormatSupported` | 检查是否支持作为深度模板 |
|
||||
| `IsShaderResourceFormatSupported` | 检查 shader 是否可读取 |
|
||||
| `IsTextureFormatSupported` | 检查是否支持作为纹理 |
|
||||
|
||||
### 清除值创建
|
||||
|
||||
| 函数 | 描述 |
|
||||
|------|------|
|
||||
| `CreateRenderTargetClearValue` | 创建渲染目标清除值 |
|
||||
| `CreateDepthStencilClearValue` | 创建深度模板清除值 |
|
||||
|
||||
### 视口和裁剪矩形
|
||||
|
||||
| 函数 | 描述 |
|
||||
|------|------|
|
||||
| `CreateViewport` | 创建视口 |
|
||||
| `CreateScissorRect` | 创建裁剪矩形 |
|
||||
|
||||
### 缓冲区视图
|
||||
|
||||
| 函数 | 描述 |
|
||||
|------|------|
|
||||
| `CreateVertexBufferView` | 创建顶点缓冲区视图 |
|
||||
| `CreateIndexBufferView` | 创建索引缓冲区视图 |
|
||||
|
||||
### 描述符句柄运算
|
||||
|
||||
| 函数 | 描述 |
|
||||
|------|------|
|
||||
| `GetCPUDescriptorHandle` | 计算偏移后的 CPU 描述符句柄 |
|
||||
| `GetGPUDescriptorHandle` | 计算偏移后的 GPU 描述符句柄 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../overview.md)
|
||||
Reference in New Issue
Block a user