FMovieSceneCaptureSettings

Common movie-scene capture settings

Choose your operating system:

Windows

macOS

Linux

References

Module

MovieSceneCapture

Header

/Engine/Source/Runtime/MovieSceneCapture/Public/MovieSceneCaptureSettings.h

Include

#include "MovieSceneCaptureSettings.h"

Syntax

struct FMovieSceneCaptureSettings

Remarks

Common movie-scene capture settings

Variables

Name Description

Public variable

bool

 

bAllowMovement

Whether to allow player movement whilst capturing

Public variable

bool

 

bAllowTurning

Whether to allow player rotation whilst capturing

Public variable

bool

 

bCinematicEngineScalability

Whether to enable cinematic engine scalability settings

Public variable

bool

 

bCinematicMode

Whether to enable cinematic mode whilst capturing

Public variable

bool

 

bEnableTextureStreaming

Whether to texture streaming should be enabled while capturing.

Public variable

bool

 

bOverwriteExisting

Whether to overwrite existing files or not

Public variable

bool

 

bShowHUD

Whether to show the in-game HUD whilst capturing

Public variable

bool

 

bShowPlayer

Whether to show the local player whilst capturing

Public variable

bool

 

bUseCustomFrameRate

Specify using the custom frame rate as opposed to the sequence's display rate

Public variable

bool

 

bUsePathTracer

Whether to use the path tracer (if supported) to render the scene

Public variable

bool

 

bUseRelativeFrameNumbers

True if frame numbers in the output files should be relative to zero, rather than the actual frame numbers in the originating animation content.

Public variable

FFrameRate

 

CustomFrameRate

The custom frame rate at which to capture if "Use Custom Frame Rate" is enabled

Public variable

FFrameRate

 

FrameRate

The sequence's frame rate at which to capture if "Use Custom Frame Rate" is not enabled

Public variable

TSubclassOf< cl...

 

GameModeOverride

Optional game mode to override the map's default game mode with.

Public variable

int32

 

HandleFrames

Number of frame handles to include for each shot

Public variable

FString

 

MovieExtension

Filename extension for movies referenced in the XMLs/EDLs

Public variable

FDirectoryPath

 

OutputDirectory

The directory to output the captured file(s) in

Public variable

FString

 

OutputFormat

The format to use for the resulting filename.

Public variable

int32

 

PathTracerSamplePerPixel

Number of sampler per pixel to be used when rendering the scene with the path tracer (if supported)

Public variable

FCaptureResolut...

 

Resolution

The resolution at which to capture

Public variable

uint8

 

ZeroPadFrameNumbers

How much to zero-pad frame numbers on filenames

Constructors

Name Description

Public function

FMovieSceneCaptureSettings()

Functions

Name Description

Public function Const

FFrameRate

 

GetFrameRate()

Get which frame rate to use