Files
XCEngine/docs/api/XCEngine/Debug/RenderDocCapture/LaunchReplayUI.md

41 lines
947 B
Markdown
Raw Normal View History

2026-03-26 16:45:24 +08:00
# RenderDocCapture::LaunchReplayUI
2026-03-26 17:21:44 +08:00
请求启动 RenderDoc Replay UI。
2026-03-26 16:45:24 +08:00
```cpp
bool LaunchReplayUI(uint32_t connect = 1, const char* cmdline = nullptr);
```
2026-03-26 17:21:44 +08:00
## 行为说明
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
如果 RenderDoc 尚未加载,当前实现会记录警告并返回 `false`。否则会直接调用底层 `LaunchReplayUI(connect, cmdline)` 并返回 `true`
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
- 底层 RenderDoc 函数本身没有返回值。
- 因此 XCEngine 无法确认 Replay UI 最终是否真的成功启动。
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
## 参数
- `connect` - 是否尝试连接到目标实例。
- `cmdline` - 传给 Replay UI 的可选命令行。
## 返回值
- `bool` - `true` 表示已发出启动请求;`false` 表示 RenderDoc 未加载。
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
## 线程语义
- 建议在工具线程或主线程的诊断分支中调用。
## 示例
```cpp
XCEngine::Debug::RenderDocCapture::Get().LaunchReplayUI();
2026-03-26 16:45:24 +08:00
```
## 相关文档
2026-03-26 17:21:44 +08:00
- [返回类型总览](RenderDocCapture.md)
- [GetCapture](GetCapture.md)