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
|
|
|
# Profiler::MarkEvent
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
void MarkEvent(const char* name, uint64_t timestamp, uint32_t threadId)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**状态：** 此方法目前为空实现，暂未功能。
|
|
|
|
|
|
|
|
|
|
在指定时间点标记一个事件。用于记录离散的瞬时事件，如 GPU 命令提交、状态切换等，通常用于多线程性能分析。
|
|
|
|
|
|
|
|
|
|
**参数：**
|
|
|
|
|
- `name` - 事件名称
|
|
|
|
|
- `timestamp` - 事件发生的时间戳（微秒）
|
|
|
|
|
- `threadId` - 事件所属的线程 ID
|
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
**返回：** `void`
|
|
|
|
|
|
|
|
|
|
**线程安全：** ✅ 线程安全
|
|
|
|
|
|
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)
|
|
|
|
|
|
|
|
|
|
**示例：**
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
#include <XCEngine/Debug/Profiler.h>
|
|
|
|
|
|
|
|
|
|
// 在多线程场景中标记事件
|
|
|
|
|
void WorkerThread() {
|
|
|
|
|
uint32_t tid = GetCurrentThreadId();
|
|
|
|
|
uint64_t ts = GetTickCount();
|
|
|
|
|
|
|
|
|
|
XCEngine::Debug::Profiler::Get().MarkEvent("TaskStarted", ts, tid);
|
|
|
|
|
DoWork();
|
|
|
|
|
XCEngine::Debug::Profiler::Get().MarkEvent("TaskCompleted", GetTickCount(), tid);
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
|
|
|
- [Profiler 总览](profiler.md) - 返回类总览
|
