Navigation
API > API/Runtime > API/Runtime/MovieSceneCapture
Common movie-scene capture settings
| Name | FMovieSceneCaptureSettings |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieSceneCapture/Public/MovieSceneCaptureSettings.h |
| Include Path | #include "MovieSceneCaptureSettings.h" |
Syntax
USTRUCT (BlueprintType )
struct FMovieSceneCaptureSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneCaptureSettings() |
MovieSceneCaptureSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAllowMovement | bool | Whether to allow player movement whilst capturing | MovieSceneCaptureSettings.h |
|
| bAllowTurning | bool | Whether to allow player rotation whilst capturing | MovieSceneCaptureSettings.h |
|
| bCinematicEngineScalability | bool | Whether to enable cinematic engine scalability settings | MovieSceneCaptureSettings.h |
|
| bCinematicMode | bool | Whether to enable cinematic mode whilst capturing | MovieSceneCaptureSettings.h |
|
| bEnableTextureStreaming | bool | Whether to texture streaming should be enabled while capturing. | MovieSceneCaptureSettings.h |
|
| bOverwriteExisting | bool | Whether to overwrite existing files or not | MovieSceneCaptureSettings.h |
|
| bShowHUD | bool | Whether to show the in-game HUD whilst capturing | MovieSceneCaptureSettings.h |
|
| bShowPlayer | bool | Whether to show the local player whilst capturing | MovieSceneCaptureSettings.h |
|
| bUseCustomFrameRate | bool | Specify using the custom frame rate as opposed to the sequence's display rate | MovieSceneCaptureSettings.h |
|
| bUsePathTracer | bool | Whether to use the path tracer (if supported) to render the scene | MovieSceneCaptureSettings.h |
|
| bUseRelativeFrameNumbers | bool | True if frame numbers in the output files should be relative to zero, rather than the actual frame numbers in the originating animation content. | MovieSceneCaptureSettings.h |
|
| CustomFrameRate | FFrameRate | The custom frame rate at which to capture if "Use Custom Frame Rate" is enabled | MovieSceneCaptureSettings.h |
|
| FrameRate | FFrameRate | The sequence's frame rate at which to capture if "Use Custom Frame Rate" is not enabled | MovieSceneCaptureSettings.h |
|
| GameModeOverride | TSubclassOf< class AGameModeBase > | Optional game mode to override the map's default game mode with. | MovieSceneCaptureSettings.h |
|
| HandleFrames | int32 | Number of frame handles to include for each shot | MovieSceneCaptureSettings.h |
|
| MovieExtension | FString | Filename extension for movies referenced in the XMLs/EDLs | MovieSceneCaptureSettings.h |
|
| OutputDirectory | FDirectoryPath | The directory to output the captured file(s) in | MovieSceneCaptureSettings.h |
|
| OutputFormat | FString | The format to use for the resulting filename. | MovieSceneCaptureSettings.h |
|
| PathTracerSamplePerPixel | int32 | Number of sampler per pixel to be used when rendering the scene with the path tracer (if supported) | MovieSceneCaptureSettings.h |
|
| Resolution | FCaptureResolution | The resolution at which to capture | MovieSceneCaptureSettings.h |
|
| ZeroPadFrameNumbers | uint8 | How much to zero-pad frame numbers on filenames | MovieSceneCaptureSettings.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFrameRate GetFrameRate() |
Get which frame rate to use | MovieSceneCaptureSettings.h |