Files
XCEngine/docs/api/debug/debug.md
ssdfasd dc850d7739 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

2.1 KiB

Debug 模块概览

命名空间: XCEngine::Debug

类型: module

描述: XCEngine 的调试和日志模块,提供日志记录和性能分析功能。

概述

Debug 模块提供了一套完整的调试工具,包括日志系统和性能分析器。

模块内容

日志系统

组件 文件 描述
Logger Logger.h 日志记录器
ILogSink ILogSink.h 日志输出接口
ConsoleLogSink ConsoleLogSink.h 控制台输出
FileLogSink FileLogSink.h 文件输出
LogLevel LogLevel.h 日志级别枚举
LogCategory LogCategory.h 日志分类枚举
LogEntry LogEntry.h 日志条目结构

性能分析

组件 文件 描述
Profiler Profiler.h 性能分析器

日志级别

级别 描述
Verbose 详细调试信息
Debug 调试信息
Info 一般信息
Warning 警告信息
Error 错误信息
Fatal 致命错误

日志分类

分类 描述
General 通用
Rendering 渲染
Physics 物理
Audio 音频
Scripting 脚本
Network 网络
Memory 内存
Threading 线程
FileSystem 文件系统
Custom 自定义

使用示例

#include <XCEngine/Debug/Logger.h>

// 初始化日志系统
Logger::Get().Initialize();
Logger::Get().AddSink(std::make_unique<ConsoleLogSink>());
Logger::Get().AddSink(std::make_unique<FileLogSink>("app.log"));

// 设置日志级别
Logger::Get().SetMinimumLevel(LogLevel::Debug);

// 记录日志
XE_LOG(LogCategory::Rendering, LogLevel::Info, "Render started");

// 使用宏记录日志
if (condition) {
    XE_LOG(LogCategory::General, LogLevel::Error, "Something went wrong");
}

相关文档