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:
29
docs/api/rhi/d3d12/query-heap/get-count.md
Normal file
29
docs/api/rhi/d3d12/query-heap/get-count.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# D3D12QueryHeap::GetCount
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
uint32_t GetCount() const
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
获取查询堆中的查询数量。
|
||||
|
||||
## 返回值
|
||||
|
||||
`uint32_t` - 查询数量
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
uint32_t count = d3d12QueryHeap->GetCount();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12QueryHeap](query-heap.md) - 类总览
|
||||
29
docs/api/rhi/d3d12/query-heap/get-query-heap.md
Normal file
29
docs/api/rhi/d3d12/query-heap/get-query-heap.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# D3D12QueryHeap::GetQueryHeap
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
ID3D12QueryHeap* GetQueryHeap() const
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
获取底层 `ID3D12QueryHeap` 接口指针。
|
||||
|
||||
## 返回值
|
||||
|
||||
`ID3D12QueryHeap*` - D3D12 查询堆接口指针
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
ID3D12QueryHeap* queryHeap = d3d12QueryHeap->GetQueryHeap();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12QueryHeap](query-heap.md) - 类总览
|
||||
20
docs/api/rhi/d3d12/query-heap/query-heap.md
Normal file
20
docs/api/rhi/d3d12/query-heap/query-heap.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# D3D12QueryHeap
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: DirectX 12 查询堆的 D3D12 实现。
|
||||
|
||||
## 方法列表
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `GetQueryHeap` | [详细文档](get-query-heap.md) |
|
||||
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
|
||||
| `GetType` | [详细文档](../../shader/get-type.md) |
|
||||
| `GetCount` | [详细文档](get-count.md) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../overview.md)
|
||||
Reference in New Issue
Block a user