UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
RenderCaptureInterface::FScopedCapture Class Reference

#include <RenderCaptureInterface.h>

Public Member Functions

RENDERCORE_API FScopedCapture (bool bEnable, TCHAR const *InEventName=nullptr, TCHAR const *InFileName=nullptr)
 
RENDERCORE_API FScopedCapture (bool bEnable, FRHICommandList *InRHICommandList, TCHAR const *InEventName=nullptr, TCHAR const *InFileName=nullptr)
 
RENDERCORE_API FScopedCapture (bool bEnable, FRDGBuilder &InGraphBuilder, TCHAR const *InEventName=nullptr, TCHAR const *InFileName=nullptr)
 
RENDERCORE_API ~FScopedCapture ()
 

Detailed Description

Helper for capturing within a scope. Handles both game and render thread. Fails gracefully if no IRenderCaptureProvider exists.

Constructor & Destructor Documentation

◆ FScopedCapture() [1/3]

RenderCaptureInterface::FScopedCapture::FScopedCapture ( bool  bEnable,
TCHAR const *  InEventName = nullptr,
TCHAR const *  InFileName = nullptr 
)

Use this constructor if not on rendering thread. Use bEnable to allow control over the capture frequency.

◆ FScopedCapture() [2/3]

RenderCaptureInterface::FScopedCapture::FScopedCapture ( bool  bEnable,
FRHICommandList InRHICommandList,
TCHAR const *  InEventName = nullptr,
TCHAR const *  InFileName = nullptr 
)

Use this constructor if on rendering thread. Use bEnable to allow control over the capture frequency.

◆ FScopedCapture() [3/3]

RenderCaptureInterface::FScopedCapture::FScopedCapture ( bool  bEnable,
FRDGBuilder InGraphBuilder,
TCHAR const *  InEventName = nullptr,
TCHAR const *  InFileName = nullptr 
)

Use this constructor if using RenderGraph to schedule work. Use bEnable to allow control over the capture frequency.

◆ ~FScopedCapture()

RenderCaptureInterface::FScopedCapture::~FScopedCapture ( )

The documentation for this class was generated from the following files: