Files
XCEngine/docs/api/XCEngine/Debug/Profiler/BeginFrame.md

38 lines
689 B
Markdown
Raw Normal View History

2026-03-26 16:45:24 +08:00
# Profiler::BeginFrame
2026-03-26 17:21:44 +08:00
标记一帧 profiling 周期的开始。
2026-03-26 16:45:24 +08:00
```cpp
void BeginFrame();
```
2026-03-26 17:21:44 +08:00
## 行为说明
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
当前实现只记录当前微秒时间到内部 `m_frameStartTime`,不会创建样本,也不会清空已有数据。
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
这说明它目前更像是为后续“按帧汇总”能力预留入口,而不是已经完整实现的帧级 profiler 边界。
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
## 参数
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
- 无。
## 返回值
- 无。
## 线程语义
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
- 无同步保护;建议在主线程或统一的 profiling 线程中调用。
## 示例
```cpp
auto& profiler = XCEngine::Debug::Profiler::Get();
profiler.BeginFrame();
2026-03-26 16:45:24 +08:00
```
## 相关文档
2026-03-26 17:21:44 +08:00
- [返回类型总览](Profiler.md)
- [EndFrame](EndFrame.md)