xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update core and debug API docs

Browse Source
This commit is contained in:
ssdfasd
2026-03-20 02:35:07 +08:00
parent 0c073db4e8
commit e165dbea1c
73 changed files with 743 additions and 391 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/api/debug/profiler/profiler.md
View File

@@ -4,31 +4,28 @@
**类型**: `class` (singleton)
**头文件**: `XCEngine/Debug/Profiler.h`
**描述**: 性能分析器单例，用于测量代码块执行时间并支持 Chrome Tracing 格式导出。
## 概述
`Profiler` 是 XCEngine 的性能分析工具。它通过栈式记录和采样方式跟踪函数执行时间，支持导出为 Chrome Tracing 格式（可通过 Chrome 的 `chrome://tracing` 查看）。
## 单例访问
| 方法 | 描述 |
|------|------|
| `static Profiler& Get()` | 获取单例实例 |
## 公共方法
| 方法 | 描述 |
|------|------|
| `void Initialize()` | [初始化性能分析器](initialize.md) |
| `void Shutdown()` | [关闭性能分析器](shutdown.md) |
| `void BeginProfile(const char* name)` | [开始一个性能分析块](beginprofile.md) |
| `void EndProfile()` | [结束当前性能分析块](endprofile.md) |
| `void BeginFrame()` | [开始一帧的分析](beginframe.md) |
| `void EndFrame()` | [结束一帧的分析](endframe.md) |
| `void MarkEvent(const char* name, uint64_t timestamp, uint32_t threadId)` | [标记一个事件点](markevent.md) |
| `void SetMarker(const char* name, uint32_t color)` | [设置帧标记](setmarker.md) |
| `void ExportChromeTracing(const Containers::String& filePath)` | [导出为 Chrome Tracing JSON 格式](exportchrometracing.md) |
| [`Get`](get.md) | 获取单例实例 |
| [`Initialize`](initialize.md) | 初始化性能分析器 |
| [`Shutdown`](shutdown.md) | 关闭性能分析器 |
| [`BeginProfile`](beginprofile.md) | 开始一个性能分析块 |
| [`EndProfile`](endprofile.md) | 结束当前性能分析块 |
| [`BeginFrame`](beginframe.md) | 开始一帧的分析 |
| [`EndFrame`](endframe.md) | 结束一帧的分析 |
| [`MarkEvent`](markevent.md) | 标记一个事件点 |
| [`SetMarker`](setmarker.md) | 设置帧标记 |
| [`ExportChromeTracing`](exportchrometracing.md) | 导出为 Chrome Tracing JSON 格式 |
## 宏定义