Files
XCEngine/docs/api/XCEngine/Debug/RenderDocCapture/SetCaptureComments.md

864 B
Raw Blame History

RenderDocCapture::SetCaptureComments

设置 capture 注释文本。

void SetCaptureComments(const char* comments);

行为说明

如果 RenderDoc 尚未加载,当前实现直接返回。否则会调用:

m_api->SetCaptureFileComments(nullptr, comments);

这意味着 XCEngine 当前没有显式指定 capture 文件路径,而是把 nullptr 传给 RenderDoc。注释最终如何关联到具体 capture取决于 RenderDoc 对该调用形式的处理。

参数

  • comments - 注释文本。

返回值

  • 无。

线程语义

  • 无显式同步;通常在抓帧前后由主线程调用。

示例

XCEngine::Debug::RenderDocCapture::Get().SetCaptureComments("Frame 30 validation capture");

相关文档