2026-03-18 17:49:22 +08:00
|
|
|
|
# TaskGroup
|
|
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::Threading`
|
|
|
|
|
|
|
|
|
|
|
|
**类型**: `class`
|
|
|
|
|
|
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
**头文件**: `XCEngine/Threading/TaskGroup.h`
|
|
|
|
|
|
|
2026-03-20 02:35:24 +08:00
|
|
|
|
**描述**: 管理一组相关任务的执行和同步
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
|
|
## 概述
|
|
|
|
|
|
|
2026-03-20 02:35:24 +08:00
|
|
|
|
TaskGroup 用于将多个相关任务组织在一起,统一管理它们的执行和同步。任务组内的任务可以声明依赖关系,确保任务按照正确的顺序执行。支持任务优先级设置、完成回调、进度查询和取消操作。
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:24 +08:00
|
|
|
|
主要功能:
|
|
|
|
|
|
- 添加任务(ITask 对象或函数回调)
|
|
|
|
|
|
- 声明任务间依赖关系
|
|
|
|
|
|
- 等待所有任务完成
|
|
|
|
|
|
- 设置完成回调
|
|
|
|
|
|
- 查询完成进度
|
|
|
|
|
|
- 取消未执行的任务
|
2026-03-19 00:49:08 +08:00
|
|
|
|
|
2026-03-18 17:49:22 +08:00
|
|
|
|
## 公共方法
|
|
|
|
|
|
|
|
|
|
|
|
| 方法 | 描述 |
|
|
|
|
|
|
|------|------|
|
refactor: improve test infrastructure and fix OpenGL GLAD initialization
- Rename D3D12Enum.h to D3D12Enums.h for naming consistency
- Fix OpenGL unit test GLAD initialization by using gladLoadGL()
instead of gladLoadGLLoader(wglGetProcAddress) for fallback support
- Migrate remaining tests to use gtest_discover_tests for granular
test discovery (math, core, containers, memory, threading, debug,
components, scene, resources, input, opengl)
- Remove obsolete TEST_RESOURCES_DIR and copy_directory commands
from OpenGL unit test CMakeLists (minimal/Res doesn't exist)
- Update TEST_SPEC.md with performance metrics and per-module
build/test commands for faster development workflow
- Update CMake path references to use lowercase paths
2026-03-23 00:43:02 +08:00
|
|
|
|
| [`Task()`](constructor.md) | 默认构造函数 |
|
|
|
|
|
|
| [`~Task()`](destructor.md) | 析构函数 |
|
2026-03-20 02:35:24 +08:00
|
|
|
|
| [`AddTask`](add-task.md) | 添加任务到组(支持 ITask 或 Callback) |
|
|
|
|
|
|
| [`AddDependency`](add-dependency.md) | 添加任务依赖关系 |
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
| [`Wait`](wait.md) | 阻塞等待所有任务完成 |
|
2026-03-20 02:35:24 +08:00
|
|
|
|
| [`WaitFor`](wait-for.md) | 等待指定超时时间 |
|
|
|
|
|
|
| [`SetCompleteCallback`](set-complete-callback.md) | 设置完成回调函数 |
|
|
|
|
|
|
| [`IsComplete`](is-complete.md) | 检查所有任务是否完成 |
|
|
|
|
|
|
| [`GetProgress`](get-progress.md) | 获取任务组完成进度 |
|
|
|
|
|
|
| [`Cancel`](cancel.md) | 取消所有未执行的任务 |
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
|
|
```cpp
|
2026-03-20 02:35:24 +08:00
|
|
|
|
#include "XCEngine/Threading/TaskGroup.h"
|
|
|
|
|
|
#include "XCEngine/Threading/Task.h"
|
|
|
|
|
|
#include <iostream>
|
|
|
|
|
|
|
|
|
|
|
|
using namespace XCEngine::Threading;
|
|
|
|
|
|
|
|
|
|
|
|
class MyTask : public ITask {
|
|
|
|
|
|
public:
|
|
|
|
|
|
explicit MyTask(const std::string& name) : m_name(name) {}
|
|
|
|
|
|
|
|
|
|
|
|
void Execute() override {
|
|
|
|
|
|
std::cout << "Task " << m_name << " executing\n";
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void OnComplete() override {
|
|
|
|
|
|
std::cout << "Task " << m_name << " completed\n";
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
std::string m_name;
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
int main() {
|
|
|
|
|
|
TaskGroup group;
|
|
|
|
|
|
|
|
|
|
|
|
uint64_t task1 = group.AddTask(std::make_unique<MyTask>("Task1"));
|
|
|
|
|
|
uint64_t task2 = group.AddTask([]() {
|
|
|
|
|
|
std::cout << "Lambda task executing\n";
|
|
|
|
|
|
}, TaskPriority::High);
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:24 +08:00
|
|
|
|
group.AddDependency(task2, task1);
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:24 +08:00
|
|
|
|
group.SetCompleteCallback([]() {
|
|
|
|
|
|
std::cout << "All tasks completed!\n";
|
|
|
|
|
|
});
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:24 +08:00
|
|
|
|
group.Wait();
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:24 +08:00
|
|
|
|
std::cout << "Progress: " << group.GetProgress() * 100 << "%\n";
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:24 +08:00
|
|
|
|
return 0;
|
|
|
|
|
|
}
|
2026-03-18 17:49:22 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
2026-03-20 02:35:24 +08:00
|
|
|
|
- [ITask](../task/task.md) - 任务接口基类
|
|
|
|
|
|
- [TaskSystem](../task-system/task-system.md) - 任务调度系统
|