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:
60
docs/api/threading/task-group/addtask.md
Normal file
60
docs/api/threading/task-group/addtask.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# TaskGroup::AddTask
|
||||
|
||||
添加任务到任务组。有两个重载版本。
|
||||
|
||||
## 重载 1: 添加 ITask 对象
|
||||
|
||||
```cpp
|
||||
uint64_t AddTask(std::unique_ptr<ITask> task)
|
||||
```
|
||||
|
||||
将一个已有的 ITask 对象添加到任务组。
|
||||
|
||||
**参数:**
|
||||
- `task` - 要添加的 unique_ptr 任务对象
|
||||
|
||||
**返回:** `uint64_t` - 分配的任务 ID
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 重载 2: 添加 lambda 任务
|
||||
|
||||
```cpp
|
||||
uint64_t AddTask(Callback&& func, TaskPriority priority = TaskPriority::Normal)
|
||||
```
|
||||
|
||||
将一个 lambda 函数包装为任务添加到任务组。
|
||||
|
||||
**参数:**
|
||||
- `func` - 要执行的可调用对象
|
||||
- `priority` - 任务优先级,默认 TaskPriority::Normal
|
||||
|
||||
**返回:** `uint64_t` - 分配的任务 ID
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
TaskGroup* group = TaskSystem::Get().CreateTaskGroup();
|
||||
|
||||
// 添加 lambda 任务
|
||||
uint64_t id1 = group->AddTask([]() {
|
||||
printf("Task A running\n");
|
||||
});
|
||||
|
||||
uint64_t id2 = group->AddTask([]() {
|
||||
printf("Task B running\n");
|
||||
}, TaskPriority::High);
|
||||
|
||||
// 添加自定义 ITask
|
||||
class MyTask : public ITask {
|
||||
public:
|
||||
void Execute() override { printf("Custom task\n"); }
|
||||
};
|
||||
uint64_t id3 = group->AddTask(std::make_unique<MyTask>());
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [TaskGroup 总览](task-group.md) - 返回类总览
|
||||
Reference in New Issue
Block a user