Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
A simplified configuration for Movie Render Queue jobs. Provides a pared-down set of rendering options that generates a UMovieGraphConfig just-in-time before rendering. This allows most users to configure renders without touching Presets or Graphs, while still using the full graph pipeline under the hood.
| Name | UMoviePipelineBasicConfig |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineBasicConfig.h |
| Include Path | #include "MoviePipelineBasicConfig.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UMoviePipelineBasicConfig : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineBasicConfig
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMoviePipelineBasicConfig() |
MoviePipelineBasicConfig.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bOverride_BurnInClass | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_bUseDeferredRenderer | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_bUsePathTracedRenderer | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_CustomEndFrame | uint8 | Whether to override the sequence's playback range end. | MoviePipelineBasicConfig.h |
|
| bOverride_CustomStartFrame | uint8 | Whether to override the sequence's playback range start. | MoviePipelineBasicConfig.h |
|
| bOverride_DeferredAntiAliasingMethod | uint8 | Whether to override the project's anti-aliasing method. | MoviePipelineBasicConfig.h |
|
| bOverride_DeferredSpatialSampleCount | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_EnabledOutputTypes | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_FileNameFormat | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_NumWarmUpFrames | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_OutputDirectory | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_OutputResolution | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_PathTracedDenoiserType | uint8 | Whether to enable the path traced denoiser. For shots, this overrides the job's denoiser setting. | MoviePipelineBasicConfig.h |
|
| bOverride_PathTracedSpatialSampleCount | uint8 | MoviePipelineBasicConfig.h |
|
|
| bOverride_TemporalSampleCount | uint8 | MoviePipelineBasicConfig.h |
|
|
| BurnInClass | FSoftClassPath | The burn-in widget class to use on all output types that support burn-in. | MoviePipelineBasicConfig.h |
|
| bUseDeferredRenderer | bool | Whether the deferred renderer should be enabled. | MoviePipelineBasicConfig.h |
|
| bUsePathTracedRenderer | bool | Whether the path tracer should be enabled. | MoviePipelineBasicConfig.h |
|
| CustomEndFrame | int32 | A custom end frame, overriding the sequence's playback range end. | MoviePipelineBasicConfig.h |
|
| CustomStartFrame | int32 | A custom start frame, overriding the sequence's playback range start. | MoviePipelineBasicConfig.h |
|
| DeferredAntiAliasingMethod | TEnumAsByte< EAntiAliasingMethod > | Anti-aliasing method for the Deferred Renderer. | MoviePipelineBasicConfig.h |
|
| DeferredSpatialSampleCount | int32 | Spatial sample count for the Deferred Renderer. | MoviePipelineBasicConfig.h |
|
| EnabledOutputTypes | TArray< TSoftClassPtr< UMovieGraphFileOutputNode > > | The output types that rendered media should be saved to. | MoviePipelineBasicConfig.h |
|
| FileNameFormat | FString | The format string for file names. | MoviePipelineBasicConfig.h |
|
| NumWarmUpFrames | int32 | The number of frames to run (without producing output) at the start of each shot to warm up systems like Niagara, Chaos, etc. | MoviePipelineBasicConfig.h |
|
| OutputDirectory | FDirectoryPath | The directory all the output files are relative to. | MoviePipelineBasicConfig.h |
|
| OutputResolution | FMovieGraphNamedResolution | The resolution that output files are exported at. | MoviePipelineBasicConfig.h |
|
| PathTracedDenoiserType | EMoviePipelineBasicDenoiserType | If denoising is enabled, this specifies the specific denoiser that path tracer results should be passed to. | MoviePipelineBasicConfig.h |
|
| PathTracedSpatialSampleCount | int32 | Spatial sample count for the Path Traced Renderer. | MoviePipelineBasicConfig.h |
|
| TemporalSampleCount | int32 | The number of temporal sub-samples per output frame. Higher values will reduce temporal aliasing. | MoviePipelineBasicConfig.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnforceInvariants () |
Enforce minimum-valid-state invariants: | MoviePipelineBasicConfig.h | |
bool HasAnyOverrides() |
Returns true if at least one bOverride_* flag is set on this config. | MoviePipelineBasicConfig.h | |
void MergeOverrides
(
const UMoviePipelineBasicConfig* InShotOverrides, |
Merge a shot's basic config with this config, providing the result in "OutMerged". | MoviePipelineBasicConfig.h |
Public Virtual
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
MoviePipelineBasicConfig.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UMovieGraphConfig * GenerateGraph
(
UMoviePipelineBasicConfig* InConfig, |
Generate a UMovieGraphConfig from this config (or a merged config). | MoviePipelineBasicConfig.h | |
static const UMoviePipelineBasicConfig * GetSavedDefault() |
Return the user's saved default Basic config, or nullptr if none exists. | MoviePipelineBasicConfig.h | |
static void SaveAsDefault
(
const UMoviePipelineBasicConfig* InConfig |
Save InConfig as the user's default Basic config (persisted to a local uasset in the project). | MoviePipelineBasicConfig.h |