Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > RenderCore > IRenderCaptureProvider > IRenderCaptureProvider::CaptureFrame

Light Theme

Dark Theme

IRenderCaptureProvider::CaptureFrame

Capture the next full frame of rendering information.

Windows

MacOS

Linux

References

Module	RenderCore
Header	/Engine/Source/Runtime/RenderCore/Public/IRenderCaptureProvider.h
Include	#include "IRenderCaptureProvider.h"

Syntax

void CaptureFrame
(
    FViewport * InViewport,
    uint32 InFlags,
    FString const & InDestFileName
)

Remarks

Capture the next full frame of rendering information. Currently any capture details (number of frames etc.) must be set up by CVars exposed in the underlying capture tool. Call from main thread only.

Parameters

Parameter	Description
Viewport	The specific viewport to capture. (Optional).
bLaunch
DestFileName	The destination file name for saving the capture. (Optional).

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss