docs: rebuild Threading API content
This commit is contained in:
@@ -1,30 +1,25 @@
|
||||
# TaskSystem::GetWorkerThreadCount
|
||||
|
||||
获取相关状态或对象。
|
||||
返回当前记录的工作线程数。
|
||||
|
||||
```cpp
|
||||
uint32_t GetWorkerThreadCount() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现直接返回成员 `m_workerThreadCount`。
|
||||
|
||||
**返回:** `uint32_t` - 返回值语义详见头文件声明。
|
||||
## 返回值
|
||||
|
||||
**示例:**
|
||||
- 当前配置的工作线程数量。
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/TaskSystem.h>
|
||||
## 注意事项
|
||||
|
||||
void Example() {
|
||||
XCEngine::Threading::TaskSystem object;
|
||||
// 根据上下文补齐参数后调用 TaskSystem::GetWorkerThreadCount(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 在 [Initialize](Initialize.md) 之前,这个值默认是 `0`。
|
||||
- 这个值表示“初始化时决定的目标线程数”,不表示当前仍然活跃的线程数量。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](TaskSystem.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
- [返回类型总览](TaskSystem.md)
|
||||
- [Initialize](Initialize.md)
|
||||
|
||||
Reference in New Issue
Block a user