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

37 lines
707 B
Markdown
Raw Normal View History

2026-03-26 16:45:24 +08:00
# RenderDocCapture::IsCapturing
2026-03-26 17:21:44 +08:00
查询当前是否处于 RenderDoc 抓帧状态。
2026-03-26 16:45:24 +08:00
```cpp
bool IsCapturing() const;
```
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 尚未加载或 API 指针无效,当前实现返回 `false`。否则会调用底层 `IsFrameCapturing()`,并把非零结果解释为 `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
- 无。
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
## 返回值
- `bool` - `true` 表示当前正在抓帧。
## 线程语义
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
- 无显式同步;通常与 [BeginCapture](BeginCapture.md) / [EndCapture](EndCapture.md) 在同一线程使用。
## 示例
```cpp
if (XCEngine::Debug::RenderDocCapture::Get().IsCapturing()) {
// ...
2026-03-26 16:45:24 +08:00
}
```
## 相关文档
2026-03-26 17:21:44 +08:00
- [返回类型总览](RenderDocCapture.md)
- [IsLoaded](IsLoaded.md)