docs: rebuild Debug API content
This commit is contained in:
@@ -1,32 +1,37 @@
|
||||
# Profiler::SetMarker
|
||||
|
||||
设置相关状态或配置。
|
||||
设置一个可视化 marker。
|
||||
|
||||
```cpp
|
||||
void SetMarker(const char* name, uint32_t color);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/Profiler.h`,当前页面用于固定 `Profiler` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `name` - 参数语义详见头文件声明。
|
||||
- `color` - 参数语义详见头文件声明。
|
||||
当前实现是空函数,不会保存 marker,也不会改变任何采样结果。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
从接口设计看,这更像是为后续调试 UI 或时间线着色预留的扩展点,而不是现阶段可依赖的功能。
|
||||
|
||||
**示例:**
|
||||
## 参数
|
||||
|
||||
- `name` - marker 名称。当前实现不会使用。
|
||||
- `color` - marker 颜色。当前实现不会使用。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 当前为空实现,无额外线程语义。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Profiler.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::Profiler object;
|
||||
// 根据上下文补齐参数后调用 Profiler::SetMarker(...)。
|
||||
(void)object;
|
||||
}
|
||||
XCEngine::Debug::Profiler::Get().SetMarker("ShadowPass", 0xff00ff00u);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Profiler.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](Profiler.md)
|
||||
- [MarkEvent](MarkEvent.md)
|
||||
|
||||
Reference in New Issue
Block a user