1. Epic GamesDeveloper
  3. UUserDefinedImageCaptureProtocol

UUserDefinedImageCaptureProtocol

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

API > API/Runtime > API/Runtime/MovieSceneCapture

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

   
Name UUserDefinedImageCaptureProtocol
Type class
Header File /Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/UserDefinedCaptureProtocol.h
Include Path #include "Protocols/UserDefinedCaptureProtocol.h"

Syntax

UCLASS (Abstract, Config=EditorPerProjectUserSettings, Blueprintable,  
       Meta=(DisplayName="Capture Protocol"), MinimalAPI)  
class UUserDefinedImageCaptureProtocol : public UUserDefinedCaptureProtocol

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UUserDefinedImageCaptureProtocol ( const FObjectInitializer& ObjInit
)

   Protocols/UserDefinedCaptureProtocol.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnableCompression bool Whether to save images with compression or not. Not supported for bitmaps. Protocols/UserDefinedCaptureProtocol.h
  • Config
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Capture
  • Meta=(InlineEditConditionToggle)
CompressionQuality int32 The compression quality for the image type. Protocols/UserDefinedCaptureProtocol.h
  • Config
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Capture
  • Meta=(EditCondition=bEnableCompression)
Format EDesiredImageFormat The image format to save as Protocols/UserDefinedCaptureProtocol.h
  • Config
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Capture

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString GenerateFilenameForBuffer ( UTexture* Buffer,
const FCapturedPixelsID& StreamID
)

 Generate a filename for the specified buffer using this protocol's file name formatter Protocols/UserDefinedCaptureProtocol.h
  • BlueprintCallable
  • Category=Capture

FString GenerateFilenameForCurrentFrame()

 Generate a filename for the current frame using this protocol's file name formatter Protocols/UserDefinedCaptureProtocol.h
  • BlueprintCallable
  • Category=Capture

void OnFileWritten()

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

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 Protocols/UserDefinedCaptureProtocol.h
  • BlueprintCallable
  • Category=Capture

Protected

Overridden from UMovieSceneCaptureProtocolBase

Name Remarks Include Path Unreal Specifiers

virtual void OnLoadConfigImpl ( FMovieSceneCaptureSettings& InSettings
)

 Called when this protocol has been loaded Protocols/UserDefinedCaptureProtocol.h  

virtual void OnReleaseConfigImpl ( FMovieSceneCaptureSettings& InSettings
)

 ~ Begin UMovieSceneCaptureProtocolBase implementation Protocols/UserDefinedCaptureProtocol.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page