refactor api documentation structure
This commit is contained in:
46
docs/api/XCEngine/Debug/RenderDocCapture/RenderDocCapture.md
Normal file
46
docs/api/XCEngine/Debug/RenderDocCapture/RenderDocCapture.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# RenderDocCapture
|
||||
|
||||
**命名空间**: `XCEngine::Debug`
|
||||
|
||||
**类型**: `class (singleton)`
|
||||
|
||||
**头文件**: `XCEngine/Debug/RenderDocCapture.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Debug` 子目录中的 `RenderDocCapture` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`RenderDocCapture.h` 是 `XCEngine/Debug` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `RenderDocCaptureInfo` | `struct` | 头文件中的公开声明。 |
|
||||
| `RenderDocCapture` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Get](Get.md) | 获取相关状态或对象。 |
|
||||
| [Initialize](Initialize.md) | 初始化内部状态。 |
|
||||
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
|
||||
| [SetDevice](SetDevice.md) | 设置相关状态或配置。 |
|
||||
| [SetWindow](SetWindow.md) | 设置相关状态或配置。 |
|
||||
| [IsLoaded](IsLoaded.md) | 查询当前状态。 |
|
||||
| [IsCapturing](IsCapturing.md) | 查询当前状态。 |
|
||||
| [GetNumCaptures](GetNumCaptures.md) | 获取相关状态或对象。 |
|
||||
| [GetCapture](GetCapture.md) | 获取相关状态或对象。 |
|
||||
| [BeginCapture](BeginCapture.md) | 公开方法,详见头文件声明。 |
|
||||
| [EndCapture](EndCapture.md) | 公开方法,详见头文件声明。 |
|
||||
| [TriggerCapture](TriggerCapture.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetCaptureFilePath](SetCaptureFilePath.md) | 设置相关状态或配置。 |
|
||||
| [SetCaptureComments](SetCaptureComments.md) | 设置相关状态或配置。 |
|
||||
| [SetCaptureOptionU32](SetCaptureOptionU32.md) | 设置相关状态或配置。 |
|
||||
| [LaunchReplayUI](LaunchReplayUI.md) | 公开方法,详见头文件声明。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Debug.md) - 返回 `Debug` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user