docs: rebuild Debug API content
This commit is contained in:
@@ -1,30 +1,34 @@
|
||||
# RenderDocCapture::GetNumCaptures
|
||||
|
||||
获取相关状态或对象。
|
||||
查询当前可访问的 capture 数量。
|
||||
|
||||
```cpp
|
||||
uint32_t GetNumCaptures() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/RenderDocCapture.h`,当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
如果 RenderDoc 尚未加载,当前实现返回 `0`。否则直接转发到底层 `GetNumCaptures()`。
|
||||
|
||||
**返回:** `uint32_t` - 返回值语义详见头文件声明。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- `uint32_t` - 当前 capture 数量;RenderDoc 未加载时为 `0`。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 无显式同步;通常在主线程诊断阶段调用。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/RenderDocCapture.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::RenderDocCapture object;
|
||||
// 根据上下文补齐参数后调用 RenderDocCapture::GetNumCaptures(...)。
|
||||
(void)object;
|
||||
}
|
||||
uint32_t count = XCEngine::Debug::RenderDocCapture::Get().GetNumCaptures();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](RenderDocCapture.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](RenderDocCapture.md)
|
||||
- [GetCapture](GetCapture.md)
|
||||
|
||||
Reference in New Issue
Block a user