UCompositionGraphCaptureProtocol

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MovieSceneCapture

Header

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

Include

#include "Protocols/CompositionGraphCaptureProtocol.h"

Syntax

class UCompositionGraphCaptureProtocol : public UMovieSceneImageCaptureProtocolBase

Variables

Name Description

Public variable

bool

 

bCaptureFramesInHDR

Whether to capture the frames as HDR textures (*.exr format)

Public variable

bool

 

bDisableScreenPercentage

Whether to disable screen percentage

Public variable

TEnumAsByte< en...

 

CaptureGamut

The color gamut to use when storing HDR captured data.

Public variable

int32

 

HDRCompressionQuality

Compression Quality for HDR Frames (0 for no compression, 1 for default compression which can be slow)

Public variable

FCompositionGra...

 

IncludeRenderPasses

A list of render passes to include in the capture. Leave empty to export all available passes.

Public variable

FSoftObjectPath

 

PostProcessingMaterial

Custom post processing material to use for rendering

Constructors

Name Description

Public function

UCompositionGraphCaptureProtocol

(
    const FObjectInitializer& Init
)

Overridden from UMovieSceneCaptureProtocolBase

Name Description

Public function Virtual

void

 

CaptureFrameImpl

(
    const FFrameMetrics& FrameMetrics
)

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

Public function Virtual

void

 

FinalizeImpl()

Called when we have finished capturing

Public function Virtual Const

bool

 

HasFinishedProcessingImpl()

Check whether this protocol has any processing left to do, or whether it should be finalized.

Public function Virtual

void

 

OnLoadConfigImpl

(
    FMovieSceneCaptureSettings& InSett...
)

Called when this protocol has been loaded

Public function Virtual

void

 

OnReleaseConfigImpl

(
    FMovieSceneCaptureSettings& InSett...
)

Called when this protocol has been released

Public function Virtual

bool

 

SetupImpl()

~ UMovieSceneCaptureProtocolBase implementation

Public function Virtual

void

 

TickImpl()

Called on the main thread to do any additional processing