docs: rebuild Debug API content

This commit is contained in:
2026-03-26 17:21:44 +08:00
parent 122495e581
commit 2e2316aa55
69 changed files with 2371 additions and 1092 deletions

View File

@@ -1,30 +1,36 @@
# RenderDocCapture::IsCapturing
查询当前状态。
查询当前是否处于 RenderDoc 抓帧状态。
```cpp
bool IsCapturing() const;
```
该方法声明于 `XCEngine/Debug/RenderDocCapture.h`,当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:**
如果 RenderDoc 尚未加载或 API 指针无效,当前实现返回 `false`。否则会调用底层 `IsFrameCapturing()`,并把非零结果解释为 `true`
**返回:** `bool` - 返回值语义详见头文件声明。
## 参数
**示例:**
- 无。
## 返回值
- `bool` - `true` 表示当前正在抓帧。
## 线程语义
- 无显式同步;通常与 [BeginCapture](BeginCapture.md) / [EndCapture](EndCapture.md) 在同一线程使用。
## 示例
```cpp
#include <XCEngine/Debug/RenderDocCapture.h>
void Example() {
XCEngine::Debug::RenderDocCapture object;
// 根据上下文补齐参数后调用 RenderDocCapture::IsCapturing(...)。
(void)object;
if (XCEngine::Debug::RenderDocCapture::Get().IsCapturing()) {
// ...
}
```
## 相关文档
- [返回类总览](RenderDocCapture.md)
- [返回模块目录](../Debug.md)
- [返回类总览](RenderDocCapture.md)
- [IsLoaded](IsLoaded.md)