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

38 lines
742 B
Markdown
Raw Normal View History

2026-03-26 16:45:24 +08:00
# Profiler::SetMarker
2026-03-26 17:21:44 +08:00
设置一个可视化 marker。
2026-03-26 16:45:24 +08:00
```cpp
void SetMarker(const char* name, uint32_t color);
```
2026-03-26 17:21:44 +08:00
## 行为说明
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
当前实现是空函数,不会保存 marker也不会改变任何采样结果。
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
从接口设计看,这更像是为后续调试 UI 或时间线着色预留的扩展点,而不是现阶段可依赖的功能。
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
- `name` - marker 名称。当前实现不会使用。
- `color` - marker 颜色。当前实现不会使用。
## 返回值
- 无。
## 线程语义
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
- 当前为空实现,无额外线程语义。
## 示例
```cpp
XCEngine::Debug::Profiler::Get().SetMarker("ShadowPass", 0xff00ff00u);
2026-03-26 16:45:24 +08:00
```
## 相关文档
2026-03-26 17:21:44 +08:00
- [返回类型总览](Profiler.md)
- [MarkEvent](MarkEvent.md)