#include <MovieSceneCaptureSettings.h>

Public Member Functions
MOVIESCENECAPTURE_API	FMovieSceneCaptureSettings ()

FFrameRate	GetFrameRate () const

Public Attributes
FDirectoryPath	OutputDirectory

TSubclassOf< class AGameModeBase >	GameModeOverride

FString	OutputFormat

bool	bOverwriteExisting

bool	bUseRelativeFrameNumbers

int32	HandleFrames

FString	MovieExtension

uint8	ZeroPadFrameNumbers

FFrameRate	FrameRate

bool	bUseCustomFrameRate

FFrameRate	CustomFrameRate

FCaptureResolution	Resolution

bool	bEnableTextureStreaming

bool	bCinematicEngineScalability

bool	bCinematicMode

bool	bAllowMovement

bool	bAllowTurning

bool	bShowPlayer

bool	bShowHUD

bool	bUsePathTracer

int32	PathTracerSamplePerPixel

Detailed Description

Common movie-scene capture settings

Constructor & Destructor Documentation

◆ FMovieSceneCaptureSettings()

FMovieSceneCaptureSettings::FMovieSceneCaptureSettings ( )

Member Function Documentation

◆ GetFrameRate()

FFrameRate FMovieSceneCaptureSettings::GetFrameRate ( ) const

inline

Get which frame rate to use

Member Data Documentation

◆ bAllowMovement

bool FMovieSceneCaptureSettings::bAllowMovement

Whether to allow player movement whilst capturing

◆ bAllowTurning

bool FMovieSceneCaptureSettings::bAllowTurning

Whether to allow player rotation whilst capturing

◆ bCinematicEngineScalability

bool FMovieSceneCaptureSettings::bCinematicEngineScalability

Whether to enable cinematic engine scalability settings

◆ bCinematicMode

bool FMovieSceneCaptureSettings::bCinematicMode

Whether to enable cinematic mode whilst capturing

◆ bEnableTextureStreaming

bool FMovieSceneCaptureSettings::bEnableTextureStreaming

Whether to texture streaming should be enabled while capturing. Turning off texture streaming may cause much more memory to be used, but also reduces the chance of blurry textures in your captured video.

◆ bOverwriteExisting

bool FMovieSceneCaptureSettings::bOverwriteExisting

Whether to overwrite existing files or not

◆ bShowHUD

bool FMovieSceneCaptureSettings::bShowHUD

Whether to show the in-game HUD whilst capturing

◆ bShowPlayer

bool FMovieSceneCaptureSettings::bShowPlayer

Whether to show the local player whilst capturing

◆ bUseCustomFrameRate

bool FMovieSceneCaptureSettings::bUseCustomFrameRate

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

◆ bUsePathTracer

bool FMovieSceneCaptureSettings::bUsePathTracer

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

◆ bUseRelativeFrameNumbers

bool FMovieSceneCaptureSettings::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.

◆ CustomFrameRate

FFrameRate FMovieSceneCaptureSettings::CustomFrameRate

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

◆ FrameRate

FFrameRate FMovieSceneCaptureSettings::FrameRate

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

◆ GameModeOverride

TSubclassOf<class AGameModeBase> FMovieSceneCaptureSettings::GameModeOverride

Optional game mode to override the map's default game mode with. This can be useful if the game's normal mode displays UI elements or loading screens that you don't want captured.

◆ HandleFrames

int32 FMovieSceneCaptureSettings::HandleFrames

Number of frame handles to include for each shot

◆ MovieExtension

FString FMovieSceneCaptureSettings::MovieExtension

Filename extension for movies referenced in the XMLs/EDLs

◆ OutputDirectory

FDirectoryPath FMovieSceneCaptureSettings::OutputDirectory

The directory to output the captured file(s) in

◆ OutputFormat

FString FMovieSceneCaptureSettings::OutputFormat

The format to use for the resulting filename. Extension will be added automatically. Any tokens of the form {token} will be replaced with the corresponding value: {fps} - The captured framerate {frame} - The current frame number (only relevant for image sequences) {width} - The width of the captured frames {height} - The height of the captured frames {world} - The name of the current world {quality} - The image compression quality setting {material} - The material/render pass {shot} - The name of the level sequence asset shot being played {sequence} - The name of the level sequence asset being played {camera} - The name of the current camera {date} - The date in the format of {year}.{month}.{day} {year} - The current year {month} - The current month {day} - The current day {time} - The current time in the format of hours.minutes.seconds

◆ PathTracerSamplePerPixel

int32 FMovieSceneCaptureSettings::PathTracerSamplePerPixel

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

◆ Resolution

FCaptureResolution FMovieSceneCaptureSettings::Resolution

The resolution at which to capture

◆ ZeroPadFrameNumbers

uint8 FMovieSceneCaptureSettings::ZeroPadFrameNumbers

How much to zero-pad frame numbers on filenames

The documentation for this struct was generated from the following files:

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

Public Member Functions

Public Attributes