UUserDefinedImageCaptureProtocol

A blueprintable capture protocol tailored to capturing and exporting frames as images

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieSceneCapture

Header

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

Include

#include "Protocols/UserDefinedCaptureProtocol.h"

Syntax

class UUserDefinedImageCaptureProtocol : public UUserDefinedCaptureProtocol

Remarks

A blueprintable capture protocol tailored to capturing and exporting frames as images

Variables

Name Description

Public variable

bool

 

bEnableCompression

Whether to save images with compression or not. Not supported for bitmaps.

Public variable

int32

 

CompressionQuality

The compression quality for the image type.

Public variable

EDesiredImageFo...

 

Format

The image format to save as

Constructors

Name Description

Public function

UUserDefinedImageCaptureProtocol

(
    const FObjectInitializer& ObjInit
)

Functions

Name Description

Public function

FString

 

GenerateFilenameForBuffer

(
    UTexture* Buffer,
    const FCapturedPixelsID& StreamID
)

Generate a filename for the specified buffer using this protocol's file name formatter

Public function

FString

 

GenerateFilenameForCurrentFrame()

Generate a filename for the current frame using this protocol's file name formatter

Public function

void

 

OnFileWritten()

~ End UMovieSceneCaptureProtocolBase implementation Called on the main thread when an async operation dispatched from this class has completed (either successfully or otherwise)

Public function

void

 

WriteImageToDisk

(
    const FCapturedPixels& PixelData,
    const FCapturedPixelsID& StreamID,
    const FFrameMetrics& FrameMetrics,
    bool bCopyImageData
)

Generate a filename for the current frame using this protocol's file name formatter

Overridden from UMovieSceneCaptureProtocolBase

Name Description

Protected function Virtual

void

 

OnLoadConfigImpl

(
    FMovieSceneCaptureSettings& InSett...
)

Called when this protocol has been loaded

Protected function Virtual

void

 

OnReleaseConfigImpl

(
    FMovieSceneCaptureSettings& InSett...
)

~ Begin UMovieSceneCaptureProtocolBase implementation
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss