docs: rebuild Debug API content
This commit is contained in:
@@ -1,30 +1,37 @@
|
||||
# Profiler::BeginFrame
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
标记一帧 profiling 周期的开始。
|
||||
|
||||
```cpp
|
||||
void BeginFrame();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/Profiler.h`,当前页面用于固定 `Profiler` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现只记录当前微秒时间到内部 `m_frameStartTime`,不会创建样本,也不会清空已有数据。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
这说明它目前更像是为后续“按帧汇总”能力预留入口,而不是已经完整实现的帧级 profiler 边界。
|
||||
|
||||
**示例:**
|
||||
## 参数
|
||||
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 无同步保护;建议在主线程或统一的 profiling 线程中调用。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Profiler.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::Profiler object;
|
||||
// 根据上下文补齐参数后调用 Profiler::BeginFrame(...)。
|
||||
(void)object;
|
||||
}
|
||||
auto& profiler = XCEngine::Debug::Profiler::Get();
|
||||
profiler.BeginFrame();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Profiler.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](Profiler.md)
|
||||
- [EndFrame](EndFrame.md)
|
||||
|
||||
Reference in New Issue
Block a user