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

924 B

RenderDocCapture::EndCapture

结束当前正在进行的 RenderDoc 抓帧。

bool EndCapture();

行为说明

当前实现会先检查:

  • RenderDoc 是否已加载。
  • 当前是否确实处于抓帧状态。

如果任一条件不成立,会记录警告并返回 false。条件成立时会调用:

m_api->EndFrameCapture(m_device, m_window);

参数

  • 无。

返回值

  • bool - true 表示已发出结束抓帧请求;false 表示当前没有可结束的抓帧。

线程语义

  • 应与 BeginCapture 在同一渲染工作流中配对调用。

示例

if (XCEngine::Debug::RenderDocCapture::Get().EndCapture()) {
    XCEngine::Debug::Logger::Get().Info(
        XCEngine::Debug::LogCategory::RenderDoc,
        "Capture ended"
    );
}

相关文档