docs: rebuild Threading API content

This commit is contained in:
2026-03-26 20:59:59 +08:00
parent 9a2d77b81d
commit 8f486611d5
78 changed files with 1648 additions and 1061 deletions

View File

@@ -1,31 +1,31 @@
# TaskSystem::RunOnMainThread
公开方法,详见头文件声明
把一个回调排入主线程执行队列
```cpp
void RunOnMainThread(std::function<void()>&& func);
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:**
- `func` - 参数语义详见头文件声明。
当前实现会在 `m_queueMutex` 保护下把回调追加到 `m_mainThreadQueue`
**返回:** `void` - 无返回值
这些回调不会立即执行,而是等待 [Update](Update.md) 被调用时再统一消费
**示例:**
## 参数
```cpp
#include <XCEngine/Threading/TaskSystem.h>
- `func` - 需要在主线程执行的回调。
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::RunOnMainThread(...)
(void)object;
}
```
## 返回值
-
## 注意事项
- 当前实现本身不检查调用线程是否为主线程;“主线程”只是通过谁来调用 [Update](Update.md) 约定出来的。
- 当前没有队列容量限制,也没有通知等待主线程的机制。
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)
- [返回类总览](TaskSystem.md)
- [Update](Update.md)