docs: rebuild Threading API content
This commit is contained in:
@@ -1,30 +1,31 @@
|
||||
# TaskSystem::CreateTaskGroup
|
||||
|
||||
创建新对象或资源。
|
||||
创建一个新的任务组对象。
|
||||
|
||||
```cpp
|
||||
TaskGroup* CreateTaskGroup();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现会:
|
||||
|
||||
**返回:** `TaskGroup*` - 返回值语义详见头文件声明。
|
||||
1. 通过 `new TaskGroup()` 分配一个任务组。
|
||||
2. 在 `m_groupMutex` 保护下把该指针加入 `m_taskGroups`。
|
||||
3. 返回这个裸指针。
|
||||
|
||||
**示例:**
|
||||
## 返回值
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/TaskSystem.h>
|
||||
- 新创建的 `TaskGroup*`。
|
||||
|
||||
void Example() {
|
||||
XCEngine::Threading::TaskSystem object;
|
||||
// 根据上下文补齐参数后调用 TaskSystem::CreateTaskGroup(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
## 当前实现限制
|
||||
|
||||
- 当前只是在系统内部登记这个指针,并没有让任务组自动接入任务调度。
|
||||
- 返回裸指针意味着所有权由调用方显式管理。
|
||||
- 当前 [Shutdown](Shutdown.md) 不会自动销毁这些任务组。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](TaskSystem.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
- [返回类型总览](TaskSystem.md)
|
||||
- [TaskGroup](../TaskGroup/TaskGroup.md)
|
||||
- [DestroyTaskGroup](DestroyTaskGroup.md)
|
||||
|
||||
Reference in New Issue
Block a user