docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录 - 重命名 index.md 为 main.md - 修正所有模块文档中的错误: - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式 - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节 - core: 修复 types 链接错误 - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI - memory: 修复头文件路径, malloc vs operator new, 新增方法文档 - resources: 修复 Shader/Texture 链接错误 - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接 - 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
33
docs/api/debug/profiler/setmarker.md
Normal file
33
docs/api/debug/profiler/setmarker.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Profiler::SetMarker
|
||||
|
||||
```cpp
|
||||
void SetMarker(const char* name, uint32_t color)
|
||||
```
|
||||
|
||||
**状态:** 此方法目前为空实现,暂未功能。
|
||||
|
||||
在 Chrome Tracing 时间线上设置一个标记点,用于标记特定位置或状态。标记会显示为一条垂直线,便于在性能图中定位关键事件。
|
||||
|
||||
**参数:**
|
||||
- `name` - 标记名称
|
||||
- `color` - 标记颜色(ABGR 格式)
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Profiler.h>
|
||||
|
||||
void OnVBlank() {
|
||||
XCEngine::Debug::Profiler::Get().SetMarker("VBlank", 0xFF00FF00); // 绿色
|
||||
}
|
||||
|
||||
void OnRenderComplete() {
|
||||
XCEngine::Debug::Profiler::Get().SetMarker("FrameRendered", 0xFFFF0000); // 红色
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Profiler 总览](profiler.md) - 返回类总览
|
||||
Reference in New Issue
Block a user