docs: 修正 API 文档准确性 (第四轮检查)

修复问题:
- containers: HashMap 实现描述修正
- debug: XE_LOG 宏参数顺序修正
- memory: ProxyAllocator 统计示例修正, PoolAllocator allocate size 检查描述
- resources: ResourceManager 缺失 UnloadGroup 方法
- rhi: D3D12 格式枚举名称修正, Texture Format 枚举补全, ResourceStates 补充
- threading: TaskGroup GetProgress/Wait/Cancel 实现限制说明
This commit is contained in:
2026-03-19 00:43:16 +08:00
parent 870cb3116e
commit 82cf147817
13 changed files with 41 additions and 21 deletions

View File

@@ -74,9 +74,12 @@
| `UnorderedAccess` | 无序访问 |
| `DepthWrite` | 深度写入 |
| `DepthRead` | 深度读取 |
| `NonPixelShaderResource` | 非像素着色器资源 |
| `PixelShaderResource` | 像素着色器资源 |
| `CopySrc` | 复制源 |
| `CopyDst` | 复制目标 |
| `Present` | 呈现状态 |
| `GenericRead` | 通用读取 |
## 使用示例

View File

@@ -28,7 +28,7 @@ O(1)
## 示例
```cpp
D3D12_RENDER_TARGET_VIEW_DESC desc = D3D12RenderTargetView::CreateDesc(Format::R8G8B8A8_UNORM);
D3D12_RENDER_TARGET_VIEW_DESC desc = D3D12RenderTargetView::CreateDesc(Format::R8G8B8A8_UNorm);
```
## 相关文档

View File

@@ -29,7 +29,7 @@ O(1)
## 示例
```cpp
D3D12_SHADER_RESOURCE_VIEW_DESC desc = D3D12ShaderResourceView::CreateDesc(Format::R8G8B8A8_UNORM);
D3D12_SHADER_RESOURCE_VIEW_DESC desc = D3D12ShaderResourceView::CreateDesc(Format::R8G8B8A8_UNorm);
```
## 相关文档

View File

@@ -27,7 +27,7 @@ O(1)
## 示例
```cpp
TextureDesc td = { TextureType::Texture2D, 1920, 1080, 1, Format::R8G8B8A8_UNORM };
TextureDesc td = { TextureType::Texture2D, 1920, 1080, 1, Format::R8G8B8A8_UNorm };
D3D12_RESOURCE_DESC d3d12Desc = ToD3D12(td);
```

View File

@@ -55,11 +55,26 @@
| 格式 | 描述 |
|------|------|
| `Format::Unknown` | 未知格式 |
| `Format::R8_UNorm` | 单通道 8 位归一化 |
| `Format::R8G8_UNorm` | 双通道 8 位归一化 |
| `Format::R8G8B8A8_UNorm` | 四通道 8 位归一化 |
| `Format::R16G16B16A16_Float` | 四通道 16 位浮点 |
| `Format::R32G32B32A32_Float` | 四通道 32 位浮点 |
| `Format::R16_Float` | 单通道 16 位浮点 |
| `Format::R32_Float` | 单通道 32 位浮点 |
| `Format::D16_UNorm` | 16 位深度 |
| `Format::D24_UNorm_S8_UInt` | 24 位深度 + 8 位模板 |
| `Format::D32_Float` | 32 位深度 |
| `Format::BC1_UNorm` | BC1 压缩 (DXT1) |
| `Format::BC2_UNorm` | BC2 压缩 (DXT2/3) |
| `Format::BC3_UNorm` | BC3 压缩 (DXT4/5) |
| `Format::BC4_UNorm` | BC4 压缩 |
| `Format::BC5_UNorm` | BC5 压缩 |
| `Format::BC6H_UF16` | BC6H 压缩 (UF16) |
| `Format::BC7_UNorm` | BC7 高质量压缩 |
| `Format::R32G32B32A32_UInt` | 四通道 32 位无符号整数 |
| `Format::R32_UInt` | 单通道 32 位无符号整数 |
## 使用示例