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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
# TaskSystemConfig
|
|
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::Threading`
|
|
|
|
|
|
|
|
|
|
|
|
**类型**: `struct`
|
|
|
|
|
|
|
|
|
|
|
|
**头文件**: `XCEngine/Threading/TaskSystemConfig.h`
|
|
|
|
|
|
|
|
|
|
|
|
**描述**: 任务系统配置结构体，用于初始化 TaskSystem 的行为参数。
|
|
|
|
|
|
|
|
|
|
|
|
## 结构体成员
|
|
|
|
|
|
|
|
|
|
|
|
| 成员 | 类型 | 描述 | 默认值 |
|
|
|
|
|
|
|------|------|------|--------|
|
docs: fix naming conventions across threading, math, memory, core, and debug modules
threading/:
- Rename 19 camelCase method files to hyphenated names
- task-system: createtaskgroup→create-task-group, etc.
- tasksystemconfig: enabletaskprofiling→enable-task-profiling, etc.
- thread: getcurrentid→get-current-id, etc.
- task: addref→add-ref, getid→get-id, etc.
math/:
- Rename underscore operator files to hyphenated
- vector3: operator_add→operator-add, etc.
- matrix4: gettranslation→get-translation, etc.
- vector4: tovector3→to-vector3, constructor_vector3→constructor-vector3
- sphere: sphere_constructor→sphere-constructor, etc.
memory/:
- Remove duplicate memorymanager/ folder (kept manager/ which was correct)
core/:
- filewriter: Consolidate ctor-default.md and ctor-file.md into constructor.md
- Rename dtor.md→destructor.md
debug/:
- filelogsink: Rename construct.md→constructor.md, ~filelogsink.md→destructor.md
All overview pages updated with new file references.
2026-03-22 23:09:29 +08:00
|
|
|
|
| [`workerThreadCount`](worker-thread-count.md) | `uint32_t` | 工作线程数量（0=自动检测 CPU 核心数） | 0 |
|
|
|
|
|
|
| [`enableTaskProfiling`](enable-task-profiling.md) | `bool` | 启用任务性能分析（当前未使用） | true |
|
|
|
|
|
|
| [`stealTasks`](steal-tasks.md) | `bool` | 启用工作窃取（当前未实现） | true |
|
|
|
|
|
|
| [`maxTaskQueueSize`](max-task-queue-size.md) | `uint32_t` | 最大任务队列大小（当前未强制限制） | 1024 |
|
|
|
|
|
|
| [`threadStackSize`](thread-stack-size.md) | `uint32_t` | 线程栈大小（当前未使用，0=系统默认） | 0 |
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
|
TaskSystemConfig config;
|
|
|
|
|
|
config.workerThreadCount = std::thread::hardware_concurrency();
|
|
|
|
|
|
config.enableTaskProfiling = true;
|
|
|
|
|
|
config.stealTasks = true;
|
|
|
|
|
|
config.maxTaskQueueSize = 2048;
|
|
|
|
|
|
|
|
|
|
|
|
TaskSystem::Get().Initialize(config);
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
|
|
|
|
|
- [TaskSystem](../task-system/task-system.md) - 任务系统
|
|
|
|
|
|
- [../threading/threading.md](../threading.md) - 模块总览
|
