Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MovieSceneCapture > FMovieSceneCaptureSettings

Light Theme

Dark Theme

FMovieSceneCaptureSettings

Common movie-scene capture settings

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
bool	bAllowMovement	Whether to allow player movement whilst capturing
bool	bAllowTurning	Whether to allow player rotation whilst capturing
bool	bCinematicEngineScalability	Whether to enable cinematic engine scalability settings
bool	bCinematicMode	Whether to enable cinematic mode whilst capturing
bool	bEnableTextureStreaming	Whether to texture streaming should be enabled while capturing.
bool	bOverwriteExisting	Whether to overwrite existing files or not
bool	bShowHUD	Whether to show the in-game HUD whilst capturing
bool	bShowPlayer	Whether to show the local player whilst capturing
bool	bUseCustomFrameRate	Specify using the custom frame rate as opposed to the sequence's display rate
bool	bUsePathTracer	Whether to use the path tracer (if supported) to render the scene
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.
FFrameRate	CustomFrameRate	The custom frame rate at which to capture if "Use Custom Frame Rate" is enabled
FFrameRate	FrameRate	The sequence's frame rate at which to capture if "Use Custom Frame Rate" is not enabled
TSubclassOf< cl...	GameModeOverride	Optional game mode to override the map's default game mode with.
int32	HandleFrames	Number of frame handles to include for each shot
FString	MovieExtension	Filename extension for movies referenced in the XMLs/EDLs
FDirectoryPath	OutputDirectory	The directory to output the captured file(s) in
FString	OutputFormat	The format to use for the resulting filename.
int32	PathTracerSamplePerPixel	Number of sampler per pixel to be used when rendering the scene with the path tracer (if supported)
FCaptureResolut...	Resolution	The resolution at which to capture
uint8	ZeroPadFrameNumbers	How much to zero-pad frame numbers on filenames

Constructors

	Name	Description
	FMovieSceneCaptureSettings()

Functions

		Name	Description
	FFrameRate	GetFrameRate()	Get which frame rate to use

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss