refactor api documentation structure
This commit is contained in:
32
docs/api/XCEngine/Debug/RenderDocCapture/GetCapture.md
Normal file
32
docs/api/XCEngine/Debug/RenderDocCapture/GetCapture.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# RenderDocCapture::GetCapture
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
bool GetCapture(uint32_t index, RenderDocCaptureInfo* info) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/RenderDocCapture.h`,当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `index` - 参数语义详见头文件声明。
|
||||
- `info` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/RenderDocCapture.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::RenderDocCapture object;
|
||||
// 根据上下文补齐参数后调用 RenderDocCapture::GetCapture(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](RenderDocCapture.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
Reference in New Issue
Block a user