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
|
|
|
|
# ConsoleLogSink::Log
|
|
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
|
void Log(const LogEntry& entry) override
|
|
|
|
|
|
```
|
|
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
将日志输出到控制台。输出格式为 `[LEVEL] [CATEGORY] message\n`。
|
|
|
|
|
|
|
|
|
|
|
|
根据 `m_colorOutput` 设置决定是否使用 Windows 控制台颜色 API（仅 `_WIN32` 平台）。各日志级别颜色映射：
|
|
|
|
|
|
|
|
|
|
|
|
| 级别 | 颜色 |
|
|
|
|
|
|
|------|------|
|
|
|
|
|
|
| Verbose | 灰色（低亮度） |
|
|
|
|
|
|
| Debug | 青色（蓝+绿） |
|
|
|
|
|
|
| Info | 绿色 |
|
|
|
|
|
|
| Warning | 黄色（红+绿） |
|
|
|
|
|
|
| Error | 红色（高亮度） |
|
|
|
|
|
|
| Fatal | 洋红色（红+蓝+高亮度） |
|
|
|
|
|
|
|
|
|
|
|
|
如果日志级别低于设置的最小级别，则不输出。
|
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
|
|
|
|
|
|
|
|
|
|
**参数：**
|
2026-03-20 02:35:07 +08:00
|
|
|
|
- `entry` - 日志条目（参见 [LogEntry](../logentry/logentry.md)）
|
|
|
|
|
|
|
|
|
|
|
|
**线程安全：** ❌
|
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
|
|
|
|
|
|
|
|
|
|
**复杂度：** O(1)
|
|
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
**返回值：** 无
|
|
|
|
|
|
|
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
|
|
|
|
|
|
auto sink = std::make_unique<XCEngine::Debug::ConsoleLogSink>();
|
|
|
|
|
|
// Log 方法由 Logger 在内部调用，用户无需直接调用
|
|
|
|
|
|
XCEngine::Debug::Logger::Get().AddSink(std::move(sink));
|
|
|
|
|
|
XCEngine::Debug::Logger::Get().Info(XCEngine::Debug::LogCategory::General, "Hello console");
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
|
|
|
|
|
- [ConsoleLogSink 总览](consolelogsink.md) - 返回类总览
|
