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 > MovieSceneCapture > FFrameGrabber

Light Theme

Dark Theme

FFrameGrabber

Class responsible for resolving render target data for a specific viewport in an efficient manner Internally, the class uses a fixed array of resolution surfaces, and dispatches rendering commands to resolve the viewport render target into a specific index into this array.

Windows

MacOS

Linux

References

Module	MovieSceneCapture
Header	/Engine/Source/Runtime/MovieSceneCapture/Public/FrameGrabber.h
Include	#include "FrameGrabber.h"

Syntax

class FFrameGrabber

Remarks

Class responsible for resolving render target data for a specific viewport in an efficient manner Internally, the class uses a fixed array of resolution surfaces, and dispatches rendering commands to resolve the viewport render target into a specific index into this array. This means we can resolve the render target data without having to wait, or flush rendering commands.

Constructors

	Name	Description
	FFrameGrabber ( TSharedRef< FSceneViewport > Viewpo..., FIntPoint DesiredBufferSize, EPixelFormat InPixelFormat, uint32 NumSurfaces )	Construct this frame grabber

Destructors

	Name	Description
	~FFrameGrabber()	Destructor

Functions

	Name	Description
void	CaptureThisFrame ( FFramePayloadPtr Payload )	Instruct the frame grabber capture this frame, when it receives an event from slate
TArray< FCap...	GetCapturedFrames()	Retrieve any frames we may have captured
bool	HasOutstandingFrames()	Check whether we have any outstanding frames or not
bool	IsCapturingFrames()	Check whether we're capturing frames or not
void	OnBackBufferReadyToPresentCallback ( SWindow& SlateWindow, const FTexture2DRHIRef& BackBuffer )	Callback for when a backbuffer is ready for reading (called on render thread)
void	OnFrameReady ( int32 SurfaceIndex, FColor* ColorBuffer, int32 Width, int32 Height )	Called when the specified surface index has been locked for reading with the render target data (called on render thread)
void	Shutdown()	Shut down this grabber, ensuring that any threaded operations are finished
void	StartCapturingFrames()	Instruct the frame grabber to start capturing frames
void	StopCapturingFrames()	Stop capturing frames

Enums

	Name	Description
	EFrameGrabberState	The current state of the grabber

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

Take our survey

Dismiss