docs: rebuild Threading API content
This commit is contained in:
@@ -1,30 +1,32 @@
|
||||
# TaskGroup::GetProgress
|
||||
|
||||
获取相关状态或对象。
|
||||
返回任务组当前完成进度。
|
||||
|
||||
```cpp
|
||||
float GetProgress() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Threading/TaskGroup.h`,当前页面用于固定 `TaskGroup` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现逻辑是:
|
||||
|
||||
**返回:** `float` - 返回值语义详见头文件声明。
|
||||
- 如果任务总数为 `0`,返回 `1.0f`。
|
||||
- 否则返回 `m_completedCount / m_tasks.size()`。
|
||||
|
||||
**示例:**
|
||||
## 返回值
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/TaskGroup.h>
|
||||
- 取值范围目标上应在 `0.0f` 到 `1.0f` 之间。
|
||||
|
||||
void Example() {
|
||||
XCEngine::Threading::TaskGroup object;
|
||||
// 根据上下文补齐参数后调用 TaskGroup::GetProgress(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
## 当前实现限制
|
||||
|
||||
- 当前源码里 `m_completedCount` 没有任何递增路径。
|
||||
- 因此:
|
||||
- 空任务组返回 `1.0f`
|
||||
- 只要添加过任务,当前几乎总是返回 `0.0f`
|
||||
- 这个进度值当前不能反映真实执行进度。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](TaskGroup.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
- [返回类型总览](TaskGroup.md)
|
||||
- [IsComplete](IsComplete.md)
|
||||
- [WaitFor](WaitFor.md)
|
||||
|
||||
Reference in New Issue
Block a user