UFrameGrabberProtocol

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieSceneCapture

Header

/Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/FrameGrabberProtocol.h

Include

#include "Protocols/FrameGrabberProtocol.h"

Syntax

class UFrameGrabberProtocol : public UMovieSceneImageCaptureProtocolBase

Variables

Name Description

Public variable

EPixelFormat

 

DesiredPixelFormat

The pixel format we want to capture in

Public variable

uint32

 

RingBufferSize

The size of the render-target resolution surface ring-buffer

Constructors

Name Description

Public function

UFrameGrabberProtocol

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function Virtual

FFramePayloa...

 

GetFramePayload

(
    const FFrameMetrics& FrameMetrics
)

~ End UMovieSceneCaptureProtocolBase Implementation Retrieve an arbitrary set of data that relates to the specified frame metrics.

Protected function Virtual

void

 

ProcessFrame

(
    FCapturedFrameData Frame
)

Process a captured frame. This may be called on any thread.

Overridden from UMovieSceneCaptureProtocolBase

Name Description

Protected function Virtual

void

 

BeginFinalizeImpl()

Called when we have finished capturing and we should start finalizing the capture

Protected function Virtual

void

 

CaptureFrameImpl

(
    const FFrameMetrics& FrameMetrics
)

Instruct this protocol to capture a frame relating to the specified metrics

Protected function Virtual

void

 

FinalizeImpl()

Called when we have finished capturing

Protected function Virtual Const

bool

 

HasFinishedProcessingImpl()

~ UMovieSceneCaptureProtocolBase Implementation

Protected function Virtual

bool

 

SetupImpl()

Called once at the start of the capture process (before any warmup) to set up anything required for the capture.

Protected function Virtual

void

 

TickImpl()

Called on the main thread to do any additional processing
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss