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/descriptor-pool/descriptor-pool.md
Normal file
29
docs/api/rhi/descriptor-pool/descriptor-pool.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# RHIDescriptorPool
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**描述**: GPU 描述符堆池抽象接口,用于管理 GPU 描述符的分配和回收。
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 生命周期
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../threading/task-system/initialize.md) |
|
||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
||||
|
||||
### 属性访问
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
|
||||
| `GetDescriptorCount` | [详细文档](get-descriptor-count.md) |
|
||||
| `GetType` | [详细文档](../shader/get-type.md) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHIDevice](../device/device.md) - 创建设备
|
||||
19
docs/api/rhi/descriptor-pool/get-descriptor-count.md
Normal file
19
docs/api/rhi/descriptor-pool/get-descriptor-count.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# RHIDescriptorPool::GetDescriptorCount
|
||||
|
||||
```cpp
|
||||
virtual uint32_t GetDescriptorCount() const = 0;
|
||||
```
|
||||
|
||||
获取描述符数量。
|
||||
|
||||
**返回:** 描述符池中的描述符数量
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
uint32_t count = descriptorPool->GetDescriptorCount();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIDescriptorPool 总览](descriptor-pool.md) - 返回类总览
|
||||
41
docs/api/rhi/descriptor-pool/methods.md
Normal file
41
docs/api/rhi/descriptor-pool/methods.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# RHIDescriptorPool 方法
|
||||
|
||||
## Initialize
|
||||
|
||||
```cpp
|
||||
virtual bool Initialize(const DescriptorPoolDesc& desc) = 0;
|
||||
```
|
||||
|
||||
初始化描述符池。
|
||||
|
||||
## Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放描述符池资源。
|
||||
|
||||
## GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
|
||||
## GetDescriptorCount
|
||||
|
||||
```cpp
|
||||
virtual uint32_t GetDescriptorCount() const = 0;
|
||||
```
|
||||
|
||||
获取描述符数量。
|
||||
|
||||
## GetType
|
||||
|
||||
```cpp
|
||||
virtual DescriptorHeapType GetType() const = 0;
|
||||
```
|
||||
|
||||
获取堆类型。
|
||||
Reference in New Issue
Block a user