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:
82
docs/api/threading/task-group/task-group.md
Normal file
82
docs/api/threading/task-group/task-group.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# TaskGroup
|
||||
|
||||
**命名空间**: `XCEngine::Threading`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Threading/TaskGroup.h`
|
||||
|
||||
**描述**: 任务组管理类,用于组织多个任务并支持批量等待、进度跟踪和依赖管理。
|
||||
|
||||
## 概述
|
||||
|
||||
`TaskGroup` 提供了一种批量管理任务的机制。它允许添加多个任务、设置任务依赖关系、等待所有任务完成,并提供进度回调功能。
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 构造/析构
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `TaskGroup()` | 默认构造函数 |
|
||||
| `~TaskGroup()` | 析构函数 |
|
||||
|
||||
### 任务添加
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`AddTask(unique_ptr)`](addtask.md) | 添加任务对象 |
|
||||
| [`AddTask(callback)`](addtask.md) | 添加 lambda 任务 |
|
||||
|
||||
### 依赖管理
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`AddDependency`](adddependency.md) | 添加任务依赖关系 |
|
||||
|
||||
### 等待
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Wait`](wait.md) | 阻塞等待所有任务完成 |
|
||||
| [`WaitFor`](waitfor.md) | 超时等待 |
|
||||
|
||||
### 回调和状态
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`SetCompleteCallback`](setcompletecallback.md) | 设置完成回调 |
|
||||
| [`IsComplete`](iscomplete.md) | 检查所有任务是否完成 |
|
||||
| [`GetProgress`](getprogress.md) | 获取完成进度(0.0f ~ 1.0f) |
|
||||
| [`Cancel`](cancel.md) | 取消所有任务 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
TaskGroup* group = TaskSystem::Get().CreateTaskGroup();
|
||||
|
||||
// 添加多个任务
|
||||
uint64_t task1 = group->AddTask([]() { /* 任务1 */ });
|
||||
uint64_t task2 = group->AddTask([]() { /* 任务2 */ });
|
||||
|
||||
// 设置依赖:task3 等待 task1 完成
|
||||
uint64_t task3 = group->AddTask([]() { /* 任务3 */ });
|
||||
group->AddDependency(task3, task1);
|
||||
|
||||
// 设置完成回调
|
||||
group->SetCompleteCallback([]() {
|
||||
printf("All tasks completed!\n");
|
||||
});
|
||||
|
||||
// 等待完成
|
||||
group->Wait();
|
||||
|
||||
// 销毁
|
||||
TaskSystem::Get().DestroyTaskGroup(group);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ITask](../task/task.md) - 任务基类
|
||||
- [TaskSystem](../task-system/task-system.md) - 任务系统
|
||||
- [../threading/threading.md](../threading.md) - 模块总览
|
||||
Reference in New Issue
Block a user