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,31 +1,36 @@
# RenderDocCapture::SetCaptureFilePath
设置相关状态或配置
设置 capture 文件路径模板
```cpp
void SetCaptureFilePath(const char* path);
```
该方法声明于 `XCEngine/Debug/RenderDocCapture.h`,当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:**
- `path` - 参数语义详见头文件声明。
如果 RenderDoc 尚未加载,当前实现直接返回。否则会把 `path` 转发给底层 `SetCaptureFilePathTemplate`
**返回:** `void` - 无返回值
这个路径通常在抓帧前配置,用于决定生成的 `.rdc` 文件落到哪里,以及以什么名前缀生成
**示例:**
## 参数
- `path` - capture 文件路径模板。
## 返回值
- 无。
## 线程语义
- 建议在开始抓帧前完成配置。
## 示例
```cpp
#include <XCEngine/Debug/RenderDocCapture.h>
void Example() {
XCEngine::Debug::RenderDocCapture object;
// 根据上下文补齐参数后调用 RenderDocCapture::SetCaptureFilePath(...)。
(void)object;
}
XCEngine::Debug::RenderDocCapture::Get().SetCaptureFilePath(".\\triangle_frame30");
```
## 相关文档
- [返回类总览](RenderDocCapture.md)
- [返回模块目录](../Debug.md)
- [返回类总览](RenderDocCapture.md)
- [SetCaptureComments](SetCaptureComments.md)