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:
2026-03-19 00:31:14 +08:00
parent dc850d7739
commit a9f882f233
54 changed files with 362 additions and 79 deletions

View File

@@ -41,7 +41,7 @@
| 方法 | 文档 |
|------|------|
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
| `Shutdown` | [详细文档](shutdown.md) |
### 其他

View File

@@ -40,6 +40,18 @@
| `maxAnisotropy` | `uint32_t` | 最大各向异性级别 |
| `maxColorAttachments` | `uint32_t` | 最大颜色附件数量 |
### 线宽和点大小
| 成员 | 类型 | 描述 |
|------|------|------|
| `minSmoothedLineWidth` | `float` | 最小平滑线宽 |
| `maxSmoothedLineWidth` | `float` | 最大平滑线宽 |
| `minPointSize` | `float` | 最小点大小 |
| `maxPointSize` | `float` | 最大点大小 |
| `maxPointSizeAA` | `float` | 抗锯齿最大点大小 |
| `maxLineWidth` | `float` | 最大线宽 |
| `maxLineWidthAA` | `float` | 抗锯齿最大线宽 |
### 版本信息
| 成员 | 类型 | 描述 |

View File

@@ -0,0 +1,20 @@
# RHICommandList::Clear
```cpp
virtual void Clear(float r, float g, float b, float a, uint32_t buffers) = 0;
```
清除渲染目标。
**参数:**
- `r` - 红色分量
- `g` - 绿色分量
- `b` - 蓝色分量
- `a` - Alpha 分量
- `buffers` - 要清除的缓冲区标志
**复杂度:** O(1)
## 相关文档
- [RHICommandList 总览](command-list.md) - 返回类总览

View File

@@ -0,0 +1,13 @@
# RHICommandList::Close
```cpp
virtual void Close() = 0;
```
关闭命令列表以执行。
**复杂度:** O(1)
## 相关文档
- [RHICommandList 总览](command-list.md) - 返回类总览

View File

@@ -12,8 +12,8 @@
| 方法 | 文档 |
|------|------|
| `Reset` | [详细文档](../../resources/resourcehandle/reset.md) |
| `Close` | [详细文档](../../core/filewriter/close.md) |
| `Reset` | [详细文档](reset.md) |
| `Close` | [详细文档](close.md) |
### 资源状态转换
@@ -61,7 +61,7 @@
| 方法 | 文档 |
|------|------|
| `Clear` | [详细文档](../../memory/linear-allocator/clear.md) |
| `Clear` | [详细文档](clear.md) |
| `ClearRenderTarget` | [详细文档](clear-render-target.md) |
| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) |

View File

@@ -0,0 +1,13 @@
# RHICommandList::Reset
```cpp
virtual void Reset() = 0;
```
重置命令列表以重新录制。
**复杂度:** O(1)
## 相关文档
- [RHICommandList 总览](command-list.md) - 返回类总览

View File

@@ -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)

View File

@@ -0,0 +1,15 @@
# RHICommandQueue::GetNativeHandle
```cpp
virtual void* GetNativeHandle() = 0;
```
获取原生 API 句柄。
**返回:** 原生命令队列句柄
**复杂度:** O(1)
## 相关文档
- [RHICommandQueue 总览](command-queue.md) - 返回类总览

View File

@@ -0,0 +1,15 @@
# RHICommandQueue::GetType
```cpp
virtual CommandQueueType GetType() const = 0;
```
获取命令队列类型。
**返回:** 命令队列类型枚举值
**复杂度:** O(1)
## 相关文档
- [RHICommandQueue 总览](command-queue.md) - 返回类总览

View File

@@ -0,0 +1,13 @@
# RHICommandQueue::Shutdown
```cpp
virtual void Shutdown() = 0;
```
关闭命令队列,释放所有相关资源。
**复杂度:** O(n) - 取决于管理的命令列表数量
## 相关文档
- [RHICommandQueue 总览](command-queue.md) - 返回类总览

View File

@@ -12,14 +12,14 @@
| 方法 | 文档 |
|------|------|
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
| `Shutdown` | [详细文档](shutdown.md) |
### 同步操作
| 方法 | 文档 |
|------|------|
| `Signal` | [详细文档](../command-queue/signal.md) |
| `Wait` | [详细文档](../../threading/task-group/wait.md) |
| `Wait` | [详细文档](methods.md) |
| `GetCompletedValue` | [详细文档](../command-queue/get-completed-value.md) |
| `IsSignaled` | [详细文档](is-signaled.md) |
@@ -27,7 +27,7 @@
| 方法 | 文档 |
|------|------|
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
## 使用示例

View File

@@ -0,0 +1,15 @@
# RHIFence::GetNativeHandle
```cpp
virtual void* GetNativeHandle() = 0;
```
获取原生 API 句柄。
**返回:** 原生栅栏句柄
**复杂度:** O(1)
## 相关文档
- [RHIFence 总览](fence.md) - 返回类总览

View File

@@ -0,0 +1,13 @@
# RHIFence::Shutdown
```cpp
virtual void Shutdown() = 0;
```
释放栅栏资源。
**复杂度:** O(1)
## 相关文档
- [RHIFence 总览](fence.md) - 返回类总览

View File

@@ -0,0 +1,15 @@
# RHIPipelineLayout::GetNativeHandle
```cpp
virtual void* GetNativeHandle() = 0;
```
获取原生 API 句柄。
**返回:** 原生管线布局句柄
**复杂度:** O(1)
## 相关文档
- [RHIPipelineLayout 总览](pipeline-layout.md) - 返回类总览

View File

@@ -0,0 +1,18 @@
# RHIPipelineLayout::Initialize
```cpp
virtual bool Initialize(const RHIPipelineLayoutDesc& desc) = 0;
```
初始化管线布局。
**参数:**
- `desc` - 管线布局描述符
**返回:** 成功返回 `true`,失败返回 `false`
**复杂度:** O(1)
## 相关文档
- [RHIPipelineLayout 总览](pipeline-layout.md) - 返回类总览

View File

@@ -12,14 +12,14 @@
| 方法 | 文档 |
|------|------|
| `Initialize` | [详细文档](../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
| `Initialize` | [详细文档](initialize.md) |
| `Shutdown` | [详细文档](shutdown.md) |
### 其他
| 方法 | 文档 |
|------|------|
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
## 相关文档

View File

@@ -0,0 +1,13 @@
# RHIPipelineLayout::Shutdown
```cpp
virtual void Shutdown() = 0;
```
释放管线布局资源。
**复杂度:** O(1)
## 相关文档
- [RHIPipelineLayout 总览](pipeline-layout.md) - 返回类总览

View File

@@ -0,0 +1,15 @@
# RHIPipelineState::GetNativeHandle
```cpp
virtual void* GetNativeHandle() = 0;
```
获取原生 API 句柄。
**返回:** 原生管线状态句柄
**复杂度:** O(1)
## 相关文档
- [RHIPipelineState 总览](pipeline-state.md) - 返回类总览

View File

@@ -0,0 +1,15 @@
# RHIPipelineState::GetType
```cpp
virtual PipelineType GetType() const = 0;
```
获取管线类型。
**返回:** 管线类型枚举值
**复杂度:** O(1)
## 相关文档
- [RHIPipelineState 总览](pipeline-state.md) - 返回类总览

View File

@@ -12,21 +12,21 @@
| 方法 | 文档 |
|------|------|
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
| `Shutdown` | [详细文档](shutdown.md) |
### 绑定/解绑
| 方法 | 文档 |
|------|------|
| `Bind` | [详细文档](../shader/bind.md) |
| `Unbind` | [详细文档](../shader/unbind.md) |
| `Bind` | [详细文档](methods.md) |
| `Unbind` | [详细文档](methods.md) |
### 属性访问
| 方法 | 文档 |
|------|------|
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
| `GetType` | [详细文档](../shader/get-type.md) |
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
| `GetType` | [详细文档](get-type.md) |
## 管线类型 (PipelineType)

View File

@@ -0,0 +1,13 @@
# RHIPipelineState::Shutdown
```cpp
virtual void Shutdown() = 0;
```
释放管线状态对象资源。
**复杂度:** O(1)
## 相关文档
- [RHIPipelineState 总览](pipeline-state.md) - 返回类总览

View File

@@ -0,0 +1,15 @@
# RHISampler::GetNativeHandle
```cpp
virtual void* GetNativeHandle() = 0;
```
获取原生 API 句柄。
**返回:** 原生采样器句柄
**复杂度:** O(1)
## 相关文档
- [RHISampler 总览](sampler.md) - 返回类总览

View File

@@ -12,20 +12,20 @@
| 方法 | 文档 |
|------|------|
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
| `Shutdown` | [详细文档](shutdown.md) |
### 绑定/解绑
| 方法 | 文档 |
|------|------|
| `Bind` | [详细文档](../shader/bind.md) |
| `Unbind` | [详细文档](../shader/unbind.md) |
| `Bind` | [详细文档](methods.md) |
| `Unbind` | [详细文档](methods.md) |
### 属性访问
| 方法 | 文档 |
|------|------|
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
| `GetID` | [详细文档](get-id.md) |
## 相关文档

View File

@@ -0,0 +1,13 @@
# RHISampler::Shutdown
```cpp
virtual void Shutdown() = 0;
```
释放采样器资源。
**复杂度:** O(1)
## 相关文档
- [RHISampler 总览](sampler.md) - 返回类总览

View File

@@ -43,13 +43,13 @@
| 方法 | 文档 |
|------|------|
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
| `Shutdown` | [详细文档](shutdown.md) |
### 其他
| 方法 | 文档 |
|------|------|
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
## 着色器类型 (ShaderType)

View File

@@ -0,0 +1,15 @@
# RHISwapChain::GetNativeHandle
```cpp
virtual void* GetNativeHandle() = 0;
```
获取原生 API 句柄。
**返回:** 原生交换链句柄
**复杂度:** O(1)
## 相关文档
- [RHISwapChain 总览](swap-chain.md) - 返回类总览

View File

@@ -0,0 +1,13 @@
# RHISwapChain::Shutdown
```cpp
virtual void Shutdown() = 0;
```
关闭交换链,释放所有相关资源。
**复杂度:** O(n) - 取决于管理的缓冲区数量
## 相关文档
- [RHISwapChain 总览](swap-chain.md) - 返回类总览

View File

@@ -12,7 +12,7 @@
| 方法 | 文档 |
|------|------|
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
| `Shutdown` | [详细文档](shutdown.md) |
### 交换链操作
@@ -21,7 +21,7 @@
| `GetCurrentBackBufferIndex` | [详细文档](get-current-back-buffer-index.md) |
| `GetCurrentBackBuffer` | [详细文档](get-current-back-buffer.md) |
| `Present` | [详细文档](present.md) |
| `Resize` | [详细文档](../../containers/array/resize.md) |
| `Resize` | [详细文档](methods.md) |
### 全屏模式
@@ -42,7 +42,7 @@
| 方法 | 文档 |
|------|------|
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
## 使用示例

View File

@@ -23,22 +23,22 @@
| 方法 | 文档 |
|------|------|
| `GetState` | [详细文档](../buffer/get-state.md) |
| `SetState` | [详细文档](../buffer/set-state.md) |
| `GetState` | [详细文档](get-state.md) |
| `SetState` | [详细文档](set-state.md) |
### 生命周期
| 方法 | 文档 |
|------|------|
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
| `Shutdown` | [详细文档](shutdown.md) |
### 其他
| 方法 | 文档 |
|------|------|
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
| `GetName` | [详细文档](../buffer/get-name.md) |
| `SetName` | [详细文档](../buffer/set-name.md) |
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
| `GetName` | [详细文档](get-name.md) |
| `SetName` | [详细文档](set-name.md) |
## 纹理类型 (TextureType)