1. Epic GamesDeveloper
  3. UMoviePipelinePrimaryConfig

UMoviePipelinePrimaryConfig

This class describes the main configuration for a Movie Render Pipeline.

Unreal Engine C++ API Reference > Plugins > MovieRenderPipelineCore

Inheritance Hierarchy

References

   
Module MovieRenderPipelineCore
Header /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelinePrimaryConfig.h
Include #include "MoviePipelinePrimaryConfig.h"

Syntax

UCLASS&40;Blueprintable&41;  
class UMoviePipelinePrimaryConfig : public UMoviePipelineConfigBase

Remarks

This class describes the main configuration for a Movie Render Pipeline. Only settings that apply to the entire output should be stored here, anything that is changed on a per-shot basis should be stored inside of UMovieRenderShotConfig instead.

THIS CLASS SHOULD BE IMMUTABLE ONCE PASSED TO THE PIPELINE FOR PROCESSING. (Otherwise you will be modifying the instance that exists in the UI)

Variables

  Type Name Description
Public variable UProperty instanced TMap< FString, TObjectPtr< UMoviePipelineShotConfig > > PerShotConfigMapping A mapping of Shot Name -> Shot Config to use for rendering specific shots with specific configs.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void

AddTransientSettingByClass ( const UClass* InSettingClass
)

  
Public function Const UFunction BlueprintCallable, Category TArray< UMoviePipelineSetting * >

GetAllSettings ( const bool bIncludeDisabledSettings,
const bool bIncludeTransientSettings
)

  
Public function Const UMoviePipelineShotConfig *

GetConfigForShot ( const FString& ShotName
)

 Returns a pointer to the config specified for the shot, otherwise the default for this pipeline.
Public function Const UFunction BlueprintCallable, Category FFrameRate

GetEffectiveFrameRate ( const ULevelSequence* InSequence
)

 Returns the frame rate override from the Primary Configuration (if any) or the Sequence frame rate if no override is specified.
Public function Const TRange< FFrameNumber >  
Public function Const void

GetFormatArguments ( FMoviePipelineFormatArgs& InOutFormatArgs,
const bool bIncludeAllSettings
)

  
Public function Const TArray< UMoviePipelineOutputBase * >  
Public function Const UFunction BlueprintCallable, Category TArray< UMoviePipelineSetting * >  
Public function UFunction BlueprintCallable, Category void Initializes a single instance of every setting so that even non-user-configured settings have a chance to apply their default values.

Overridden from UMoviePipelineConfigBase

  Type Name Description
Protected function Virtual Const bool  
Public function Virtual void Copy this configuration from another existing configuration.
Public function Virtual Const TArray< UMoviePipelineSetting * > Returns an array of all settings in this config that the user has added via the UI or via Scripting.
Protected function Virtual void  
Protected function Virtual void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page