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:
43
docs/api/threading/task-system/runonmainthread.md
Normal file
43
docs/api/threading/task-system/runonmainthread.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# TaskSystem::RunOnMainThread
|
||||
|
||||
```cpp
|
||||
void RunOnMainThread(std::function<void()>&& func)
|
||||
```
|
||||
|
||||
将任务提交到主线程队列。在主线程中调用 Update 时执行。
|
||||
|
||||
**参数:**
|
||||
- `func` - 要在主线程执行的函数
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**使用场景:**
|
||||
- 从工作线程回调需要更新 UI 或访问主线程资源。
|
||||
- 避免跨线程数据竞争。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
// 在工作线程中
|
||||
void WorkerThreadCode() {
|
||||
int result = HeavyCompute();
|
||||
|
||||
// 将结果发送到主线程更新 UI
|
||||
TaskSystem::Get().RunOnMainThread([result]() {
|
||||
UI.UpdateResult(result);
|
||||
});
|
||||
}
|
||||
|
||||
// 在主线程中
|
||||
while (running) {
|
||||
TaskSystem::Get().Update(); // 处理主线程任务
|
||||
RenderFrame();
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [TaskSystem 总览](task-system.md) - 返回类总览
|
||||
- [Update](update.md) - 处理主线程队列
|
||||
Reference in New Issue
Block a user