docs: rebuild Debug API content
This commit is contained in:
@@ -1,30 +1,36 @@
|
||||
# RenderDocCapture::IsLoaded
|
||||
|
||||
查询当前状态。
|
||||
查询 RenderDoc 是否已成功加载。
|
||||
|
||||
```cpp
|
||||
bool IsLoaded() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/RenderDocCapture.h`,当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
这是一个内联查询函数,直接返回内部布尔值 `m_isLoaded`。它不验证 `device`、`window` 或当前是否处于抓帧状态,因此“已加载”只表示 RenderDoc API 已获取成功。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- `bool` - `true` 表示 RenderDoc DLL 和 API 已可用。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 只读查询;当前实现没有额外同步。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/RenderDocCapture.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::RenderDocCapture object;
|
||||
// 根据上下文补齐参数后调用 RenderDocCapture::IsLoaded(...)。
|
||||
(void)object;
|
||||
if (!XCEngine::Debug::RenderDocCapture::Get().IsLoaded()) {
|
||||
// RenderDoc unavailable
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](RenderDocCapture.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](RenderDocCapture.md)
|
||||
- [Initialize](Initialize.md)
|
||||
|
||||
Reference in New Issue
Block a user