2026-03-18 17:49:22 +08:00
|
|
|
|
# LogEntry
|
|
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::Debug`
|
|
|
|
|
|
|
|
|
|
|
|
**类型**: `struct`
|
|
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
**头文件**: `XCEngine/Debug/LogEntry.h`
|
|
|
|
|
|
|
2026-03-18 17:49:22 +08:00
|
|
|
|
**描述**: 日志条目结构体，包含单条日志的所有信息。
|
|
|
|
|
|
|
|
|
|
|
|
## 概述
|
|
|
|
|
|
|
|
|
|
|
|
`LogEntry` 是日志系统的核心数据结构，每次日志记录都生成一个 `LogEntry` 并分发给所有注册的 Sink。
|
|
|
|
|
|
|
|
|
|
|
|
## 结构体成员
|
|
|
|
|
|
|
|
|
|
|
|
| 成员 | 类型 | 描述 |
|
|
|
|
|
|
|------|------|------|
|
|
|
|
|
|
| `level` | `LogLevel` | 日志级别 |
|
|
|
|
|
|
| `category` | `LogCategory` | 日志分类 |
|
|
|
|
|
|
| `message` | `Containers::String` | 日志消息内容 |
|
|
|
|
|
|
| `file` | `Containers::String` | 源代码文件路径 |
|
|
|
|
|
|
| `line` | `int32_t` | 源代码行号 |
|
|
|
|
|
|
| `function` | `Containers::String` | 函数名称 |
|
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
|
|
|
|
| `timestamp` | `uint64_t` | 时间戳（秒，Unix 时间戳） |
|
2026-03-18 17:49:22 +08:00
|
|
|
|
| `threadId` | `uint32_t` | 线程 ID |
|
|
|
|
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
|
class MySink : public ILogSink {
|
|
|
|
|
|
public:
|
|
|
|
|
|
void Log(const LogEntry& entry) override {
|
|
|
|
|
|
printf("[%llu][%u] %s::%s: %s\n",
|
|
|
|
|
|
(unsigned long long)entry.timestamp,
|
|
|
|
|
|
(unsigned)entry.threadId,
|
|
|
|
|
|
LogCategoryToString(entry.category),
|
|
|
|
|
|
LogLevelToString(entry.level),
|
|
|
|
|
|
entry.message.CStr());
|
|
|
|
|
|
}
|
|
|
|
|
|
void Flush() override { }
|
|
|
|
|
|
};
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
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
|
|
|
|
- [Debug 模块总览](../debug.md) - 返回模块总览
|
|
|
|
|
|
- [ILogSink](../ilogsink/ilogsink.md) - 日志输出接口
|
|
|
|
|
|
- [Logger](../logger/logger.md) - 日志记录器
|
