docs: 修正 API 文档准确性 (第二轮检查)
修复的问题: - math: 修复 Quaternion::Normalize 链接错误 - containers: HashMap 迭代器示例使用不存在的 cbegin/cend,删除冗余构造函数声明 - core: RefCounted 析构函数访问级别修正 (protected) - debug: LogLevelToString 示例返回值大小写修正 - memory: 修正 LinearAllocator::Reallocate 返回 nullptr,ProxyAllocator 统计描述,头文件路径 IAllocator.h -> Allocator.h - resources: Texture::Create mipLevels 参数描述修正 - rhi: 修复多处链接错误,新增缺失的方法文档 - threading: TaskSystem 配置项未实现状态标注,Wait 方法空实现标注
This commit is contained in:
@@ -12,7 +12,7 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
||||
| `Shutdown` | [详细文档](shutdown.md) |
|
||||
|
||||
### 命令执行
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|------|------|
|
||||
| `ExecuteCommandLists` | [详细文档](execute-command-lists.md) |
|
||||
| `Signal` | [详细文档](signal.md) |
|
||||
| `Wait` | [详细文档](../../threading/task-group/wait.md) |
|
||||
| `Wait` | [详细文档](methods.md) |
|
||||
| `GetCompletedValue` | [详细文档](get-completed-value.md) |
|
||||
| `WaitForIdle` | [详细文档](wait-for-idle.md) |
|
||||
|
||||
@@ -28,14 +28,14 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetType` | [详细文档](../shader/get-type.md) |
|
||||
| `GetType` | [详细文档](get-type.md) |
|
||||
| `GetTimestampFrequency` | [详细文档](get-timestamp-frequency.md) |
|
||||
|
||||
### 其他
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
|
||||
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
|
||||
|
||||
## 命令队列类型 (CommandQueueType)
|
||||
|
||||
|
||||
15
docs/api/rhi/command-queue/get-native-handle.md
Normal file
15
docs/api/rhi/command-queue/get-native-handle.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHICommandQueue::GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
|
||||
**返回:** 原生命令队列句柄
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHICommandQueue 总览](command-queue.md) - 返回类总览
|
||||
15
docs/api/rhi/command-queue/get-type.md
Normal file
15
docs/api/rhi/command-queue/get-type.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHICommandQueue::GetType
|
||||
|
||||
```cpp
|
||||
virtual CommandQueueType GetType() const = 0;
|
||||
```
|
||||
|
||||
获取命令队列类型。
|
||||
|
||||
**返回:** 命令队列类型枚举值
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHICommandQueue 总览](command-queue.md) - 返回类总览
|
||||
13
docs/api/rhi/command-queue/shutdown.md
Normal file
13
docs/api/rhi/command-queue/shutdown.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# RHICommandQueue::Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
关闭命令队列,释放所有相关资源。
|
||||
|
||||
**复杂度:** O(n) - 取决于管理的命令列表数量
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHICommandQueue 总览](command-queue.md) - 返回类总览
|
||||
Reference in New Issue
Block a user