docs: 修正 API 文档准确性 (第三轮检查)
修复问题: - containers: HashMap include 路径修复 - core: RefCounted 析构函数访问级别, Event::begin/end 返回值说明 - memory: LinearAllocator::GetMarker 返回偏移量非指针 - resources: LoadAsync 示例使用不存在的模板方法 - rhi: OpenGL 链接错误, ShaderType 枚举缺失8个类型, 链接修复 - threading: SpinLock STL 兼容方法说明, Mutex const 方法说明
This commit is contained in:
@@ -79,7 +79,7 @@
|
|||||||
## 使用示例
|
## 使用示例
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
#include "Containers/HashMap.h"
|
#include <XCEngine/Containers/HashMap.h>
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
|
|
||||||
int main() {
|
int main() {
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ Iterator begin();
|
|||||||
|
|
||||||
返回订阅列表的开始迭代器,用于范围for循环遍历所有订阅的回调。
|
返回订阅列表的开始迭代器,用于范围for循环遍历所有订阅的回调。
|
||||||
|
|
||||||
**返回:** `Iterator` - 指向第一个监听器的迭代器
|
**返回:** `Iterator` - 指向第一个监听器的迭代器(等价于 `std::vector<Listener>::iterator`)
|
||||||
|
|
||||||
**复杂度:** O(1)
|
**复杂度:** O(1)
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ Iterator end();
|
|||||||
|
|
||||||
返回订阅列表的结束迭代器,用于范围for循环遍历所有订阅的回调。
|
返回订阅列表的结束迭代器,用于范围for循环遍历所有订阅的回调。
|
||||||
|
|
||||||
**返回:** `Iterator` - 指向末尾的迭代器
|
**返回:** `Iterator` - 指向末尾的迭代器(等价于 `std::vector<Listener>::iterator`)
|
||||||
|
|
||||||
**复杂度:** O(1)
|
**复杂度:** O(1)
|
||||||
|
|
||||||
|
|||||||
@@ -17,7 +17,7 @@
|
|||||||
| 方法 | 描述 |
|
| 方法 | 描述 |
|
||||||
|------|------|
|
|------|------|
|
||||||
| `RefCounted()` | 构造函数,初始引用计数为 1 |
|
| `RefCounted()` | 构造函数,初始引用计数为 1 |
|
||||||
| `protected virtual ~RefCounted()` | 虚析构函数(受保护,不允许直接删除) |
|
| `virtual ~RefCounted()` | 虚析构函数 |
|
||||||
|
|
||||||
### 引用计数
|
### 引用计数
|
||||||
|
|
||||||
|
|||||||
@@ -4,11 +4,13 @@
|
|||||||
void* GetMarker() const;
|
void* GetMarker() const;
|
||||||
```
|
```
|
||||||
|
|
||||||
获取当前分配位置的标记。标记是一个指向当前偏移量的指针,可用于 `SetMarker` 恢复到该位置。此方法用于实现临时分配的撤销功能。
|
获取当前分配位置的标记。标记是内部偏移量(`m_offset`)的快照,可用于 `SetMarker` 恢复到该位置。此方法用于实现临时分配的撤销功能。
|
||||||
|
|
||||||
**参数:** 无
|
**参数:** 无
|
||||||
|
|
||||||
**返回:** 当前分配位置的指针标记
|
**返回:** 当前位置标记(偏移量值),类型为 `void*`
|
||||||
|
|
||||||
|
**注意:** 返回值是偏移量数值,不是指针。将其传给 `SetMarker` 可恢复到此分配位置。
|
||||||
|
|
||||||
**复杂度:** O(1)
|
**复杂度:** O(1)
|
||||||
|
|
||||||
|
|||||||
@@ -67,9 +67,12 @@ ResourceHandle<Mesh> mesh = ResourceManager::Get().Load<Mesh>("models/player.fbx
|
|||||||
ResourceHandle<Material> mat = ResourceManager::Get().Load<Material>("materials/player.mat");
|
ResourceHandle<Material> mat = ResourceManager::Get().Load<Material>("materials/player.mat");
|
||||||
|
|
||||||
// 异步加载
|
// 异步加载
|
||||||
ResourceManager::Get().LoadAsync<Texture>("textures/terrain.png",
|
ResourceManager::Get().LoadAsync("textures/terrain.png", ResourceType::Texture,
|
||||||
[](ResourceHandle<Texture> tex) {
|
[](LoadResult result) {
|
||||||
// 加载完成回调
|
if (result.success) {
|
||||||
|
ResourceHandle<Texture> tex(result.resource);
|
||||||
|
// 加载完成回调
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// 释放资源
|
// 释放资源
|
||||||
|
|||||||
@@ -81,7 +81,7 @@
|
|||||||
|
|
||||||
| 方法 | 文档 |
|
| 方法 | 文档 |
|
||||||
|------|------|
|
|------|------|
|
||||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
| `Shutdown` | [详细文档](methods.md) |
|
||||||
|
|
||||||
## 使用示例
|
## 使用示例
|
||||||
|
|
||||||
|
|||||||
@@ -8,8 +8,6 @@
|
|||||||
|
|
||||||
| 方法 | 文档 |
|
| 方法 | 文档 |
|
||||||
|------|------|
|
|------|------|
|
||||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
|
||||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
|
||||||
| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) |
|
| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) |
|
||||||
|
|
||||||
## 相关文档
|
## 相关文档
|
||||||
|
|||||||
@@ -12,16 +12,16 @@
|
|||||||
|
|
||||||
| 方法 | 文档 |
|
| 方法 | 文档 |
|
||||||
|------|------|
|
|------|------|
|
||||||
| `Initialize` | [详细文档](../../threading/task-system/initialize.md) |
|
| `Initialize` | [详细文档](methods.md) |
|
||||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
| `Shutdown` | [详细文档](methods.md) |
|
||||||
|
|
||||||
### 属性访问
|
### 属性访问
|
||||||
|
|
||||||
| 方法 | 文档 |
|
| 方法 | 文档 |
|
||||||
|------|------|
|
|------|------|
|
||||||
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
|
| `GetNativeHandle` | [详细文档](methods.md) |
|
||||||
| `GetDescriptorCount` | [详细文档](get-descriptor-count.md) |
|
| `GetDescriptorCount` | [详细文档](get-descriptor-count.md) |
|
||||||
| `GetType` | [详细文档](../shader/get-type.md) |
|
| `GetType` | [详细文档](methods.md) |
|
||||||
|
|
||||||
## 相关文档
|
## 相关文档
|
||||||
|
|
||||||
|
|||||||
@@ -114,7 +114,7 @@ delete device;
|
|||||||
## 后端文档
|
## 后端文档
|
||||||
|
|
||||||
- [D3D12 后端](d3d12/overview.md) - DirectX 12 实现详情
|
- [D3D12 后端](d3d12/overview.md) - DirectX 12 实现详情
|
||||||
- [OpenGL 后端](d3d12/overview.md) - OpenGL 实现详情
|
- [OpenGL 后端](opengl/overview.md) - OpenGL 实现详情
|
||||||
|
|
||||||
## 相关文档
|
## 相关文档
|
||||||
|
|
||||||
|
|||||||
@@ -55,9 +55,17 @@
|
|||||||
|
|
||||||
| 枚举值 | 描述 |
|
| 枚举值 | 描述 |
|
||||||
|--------|------|
|
|--------|------|
|
||||||
| `Vertex` | 顶点着色器 |
|
| `ShaderType::Vertex` | 顶点着色器 |
|
||||||
| `Fragment` | 片元着色器 |
|
| `ShaderType::Fragment` | 片元着色器 |
|
||||||
| `Compute` | 计算着色器 |
|
| `ShaderType::Geometry` | 几何着色器 |
|
||||||
|
| `ShaderType::Compute` | 计算着色器 |
|
||||||
|
| `ShaderType::TessControl` | 曲面细分控制着色器 |
|
||||||
|
| `ShaderType::TessEvaluation` | 曲面细分评估着色器 |
|
||||||
|
| `ShaderType::Hull` | Hull 着色器 (D3D12) |
|
||||||
|
| `ShaderType::Domain` | Domain 着色器 (D3D12) |
|
||||||
|
| `ShaderType::Amplification` | 放大着色器 (Mesh Shader) |
|
||||||
|
| `ShaderType::Mesh` | Mesh 着色器 |
|
||||||
|
| `ShaderType::Library` | 着色器库 |
|
||||||
|
|
||||||
## 使用示例
|
## 使用示例
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@
|
|||||||
|
|
||||||
## STL 兼容方法
|
## STL 兼容方法
|
||||||
|
|
||||||
支持 `lock()`、`unlock()`、`try_lock()` 以兼容 STL 的 lockable 概念。
|
支持 `lock()`, `unlock()`, `try_lock()` 以兼容 STL 的 lockable 概念(**注意**:这些方法为 const 成员函数)。
|
||||||
|
|
||||||
## 使用示例
|
## 使用示例
|
||||||
|
|
||||||
|
|||||||
@@ -20,6 +20,10 @@
|
|||||||
| [`Unlock`](unlock.md) | 释放锁 |
|
| [`Unlock`](unlock.md) | 释放锁 |
|
||||||
| [`TryLock`](trylock.md) | 尝试获取锁(非阻塞) |
|
| [`TryLock`](trylock.md) | 尝试获取锁(非阻塞) |
|
||||||
|
|
||||||
|
## STL 兼容方法
|
||||||
|
|
||||||
|
支持 `lock()`, `unlock()`, `try_lock()` 以兼容 STL 的 lockable 概念。
|
||||||
|
|
||||||
## 使用示例
|
## 使用示例
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
|
|||||||
Reference in New Issue
Block a user