docs: rebuild Debug API content

This commit is contained in:
2026-03-26 17:21:44 +08:00
parent 122495e581
commit 2e2316aa55
69 changed files with 2371 additions and 1092 deletions

View File

@@ -1,30 +1,48 @@
# RenderDocCapture::EndCapture
公开方法,详见头文件声明
结束当前正在进行的 RenderDoc 抓帧
```cpp
bool EndCapture();
```
该方法声明于 `XCEngine/Debug/RenderDocCapture.h`,当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:** 无。
当前实现会先检查:
**返回:** `bool` - 返回值语义详见头文件声明
- RenderDoc 是否已加载
- 当前是否确实处于抓帧状态。
**示例:**
如果任一条件不成立,会记录警告并返回 `false`。条件成立时会调用:
```cpp
#include <XCEngine/Debug/RenderDocCapture.h>
m_api->EndFrameCapture(m_device, m_window);
```
void Example() {
XCEngine::Debug::RenderDocCapture object;
// 根据上下文补齐参数后调用 RenderDocCapture::EndCapture(...)
(void)object;
## 参数
-
## 返回值
- `bool` - `true` 表示已发出结束抓帧请求;`false` 表示当前没有可结束的抓帧。
## 线程语义
- 应与 [BeginCapture](BeginCapture.md) 在同一渲染工作流中配对调用。
## 示例
```cpp
if (XCEngine::Debug::RenderDocCapture::Get().EndCapture()) {
XCEngine::Debug::Logger::Get().Info(
XCEngine::Debug::LogCategory::RenderDoc,
"Capture ended"
);
}
```
## 相关文档
- [返回类总览](RenderDocCapture.md)
- [返回模块目录](../Debug.md)
- [返回类总览](RenderDocCapture.md)
- [BeginCapture](BeginCapture.md)