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:
15
docs/api/rhi/pipeline-layout/get-native-handle.md
Normal file
15
docs/api/rhi/pipeline-layout/get-native-handle.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIPipelineLayout::GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
|
||||
**返回:** 原生管线布局句柄
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIPipelineLayout 总览](pipeline-layout.md) - 返回类总览
|
||||
18
docs/api/rhi/pipeline-layout/initialize.md
Normal file
18
docs/api/rhi/pipeline-layout/initialize.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# RHIPipelineLayout::Initialize
|
||||
|
||||
```cpp
|
||||
virtual bool Initialize(const RHIPipelineLayoutDesc& desc) = 0;
|
||||
```
|
||||
|
||||
初始化管线布局。
|
||||
|
||||
**参数:**
|
||||
- `desc` - 管线布局描述符
|
||||
|
||||
**返回:** 成功返回 `true`,失败返回 `false`
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIPipelineLayout 总览](pipeline-layout.md) - 返回类总览
|
||||
@@ -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) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
|
||||
13
docs/api/rhi/pipeline-layout/shutdown.md
Normal file
13
docs/api/rhi/pipeline-layout/shutdown.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# RHIPipelineLayout::Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放管线布局资源。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIPipelineLayout 总览](pipeline-layout.md) - 返回类总览
|
||||
Reference in New Issue
Block a user