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:
2026-03-19 00:22:30 +08:00
parent d0e16962c8
commit dc850d7739
1012 changed files with 26673 additions and 9222 deletions

View File

@@ -0,0 +1,20 @@
# D3D12DescriptorHeap::CreateDesc
```cpp
static D3D12_DESCRIPTOR_HEAP_DESC CreateDesc(DescriptorHeapType type, uint32_t numDescriptors, bool shaderVisible = false);
```
创建描述符堆描述(静态方法)。
**参数:**
- `type` - 描述符堆类型
- `numDescriptors` - 描述符数量
- `shaderVisible` - 是否对 Shader 可见
**返回:** D3D12 描述符堆描述
**复杂度:** O(1)
## 相关文档
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览

View File

@@ -0,0 +1,28 @@
# D3D12DescriptorHeap
**命名空间**: `XCEngine::RHI`
**描述**: DirectX 12 描述符堆的 D3D12 实现,继承自 `RHIDescriptorPool`
## 方法列表
| 方法 | 文档 |
|------|------|
| `Initialize` (params) | [详细文档](../../../threading/task-system/initialize.md) |
| `Initialize` (desc) | [详细文档](initialize-from-desc.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetDescriptorHeap` | [详细文档](get-descriptor-heap.md) |
| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) |
| `GetGPUDescriptorHandle` | [详细文档](get-gpu-descriptor-handle.md) |
| `GetDescriptorCount` | [详细文档](get-descriptor-count.md) |
| `GetType` | [详细文档](../../shader/get-type.md) |
| `GetDescriptorSize` | [详细文档](get-descriptor-size.md) |
| `GetCPUDescriptorHandleForHeapStart` | [详细文档](get-cpu-descriptor-handle-for-heap-start.md) |
| `GetGPUDescriptorHandleForHeapStart` | [详细文档](get-gpu-descriptor-handle-for-heap-start.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `CreateDesc` (static) | [详细文档](create-desc.md) |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [RHIDescriptorPool](../../descriptor-pool/descriptor-pool.md) - 抽象描述符池接口

View File

@@ -0,0 +1,15 @@
# D3D12DescriptorHeap::GetCPUDescriptorHandleForHeapStart
```cpp
D3D12_CPU_DESCRIPTOR_HANDLE GetCPUDescriptorHandleForHeapStart() const;
```
获取堆起始处的 CPU 描述符句柄。
**返回:** CPU 描述符句柄
**复杂度:** O(1)
## 相关文档
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览

View File

@@ -0,0 +1,18 @@
# D3D12DescriptorHeap::GetCPUDescriptorHandle
```cpp
CPUDescriptorHandle GetCPUDescriptorHandle(uint32_t index);
```
获取 CPU 描述符句柄。
**参数:**
- `index` - 描述符索引
**返回:** CPU 描述符句柄
**复杂度:** O(1)
## 相关文档
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览

View File

@@ -0,0 +1,15 @@
# D3D12DescriptorHeap::GetDescriptorCount
```cpp
uint32_t GetDescriptorCount() const override;
```
获取描述符数量。
**返回:** 描述符数量
**复杂度:** O(1)
## 相关文档
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览

View File

@@ -0,0 +1,15 @@
# D3D12DescriptorHeap::GetDescriptorHeap
```cpp
ID3D12DescriptorHeap* GetDescriptorHeap() const { return m_descriptorHeap.Get(); }
```
获取底层 D3D12 描述符堆接口。
**返回:** `ID3D12DescriptorHeap*`
**复杂度:** O(1)
## 相关文档
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览

View File

@@ -0,0 +1,15 @@
# D3D12DescriptorHeap::GetDescriptorSize
```cpp
uint32_t GetDescriptorSize() const { return m_descriptorSize; }
```
获取描述符大小。
**返回:** 描述符大小(字节)
**复杂度:** O(1)
## 相关文档
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览

View File

@@ -0,0 +1,15 @@
# D3D12DescriptorHeap::GetGPUDescriptorHandleForHeapStart
```cpp
D3D12_GPU_DESCRIPTOR_HANDLE GetGPUDescriptorHandleForHeapStart() const;
```
获取堆起始处的 GPU 描述符句柄。
**返回:** GPU 描述符句柄
**复杂度:** O(1)
## 相关文档
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览

View File

@@ -0,0 +1,18 @@
# D3D12DescriptorHeap::GetGPUDescriptorHandle
```cpp
GPUDescriptorHandle GetGPUDescriptorHandle(uint32_t index);
```
获取 GPU 描述符句柄。
**参数:**
- `index` - 描述符索引
**返回:** GPU 描述符句柄
**复杂度:** O(1)
## 相关文档
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览

View File

@@ -0,0 +1,18 @@
# D3D12DescriptorHeap::InitializeFromDesc
```cpp
bool Initialize(const DescriptorPoolDesc& desc) override;
```
从描述符初始化。
**参数:**
- `desc` - 描述符池描述
**返回:** 是否初始化成功
**复杂度:** O(n)
## 相关文档
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览