docs: rebuild Debug API content
This commit is contained in:
@@ -1,29 +1,35 @@
|
||||
# RenderDocCapture::Get
|
||||
|
||||
获取相关状态或对象。
|
||||
获取进程级全局 `RenderDocCapture` 实例。
|
||||
|
||||
```cpp
|
||||
static RenderDocCapture& Get();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/RenderDocCapture.h`,当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现使用函数内静态对象保存单例。`Get()` 本身不会加载 RenderDoc,也不会自动设置 `device` 或 `window`。
|
||||
|
||||
**返回:** `RenderDocCapture&` - 返回值语义详见头文件声明。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- `RenderDocCapture&` - 全局 RenderDoc 封装对象引用。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 单例构造由 C++ 保证线程安全;后续抓帧 API 仍建议在主线程统一使用。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/RenderDocCapture.h>
|
||||
|
||||
void Example() {
|
||||
auto& instance = XCEngine::Debug::RenderDocCapture::Get();
|
||||
(void)instance;
|
||||
}
|
||||
auto& capture = XCEngine::Debug::RenderDocCapture::Get();
|
||||
capture.Initialize(nullptr, hwnd);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](RenderDocCapture.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](RenderDocCapture.md)
|
||||
- [Initialize](Initialize.md)
|
||||
|
||||
Reference in New Issue
Block a user