1. Epic GamesDeveloper
  3. UMoviePipeline

UMoviePipeline

Unreal Engine C++ API Reference > Plugins > MovieRenderPipelineCore

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable)  
class UMoviePipeline : public UMoviePipelineBase

Variables

  Type Name Description
Public variable bool bHasRenderedFirstViewThisFrame Used to track first-render submissions (for 3d renders) to set the correct flags on the renderer module.
Public variable IImageWriteQueue * ImageWriteQueue A debug image sequence writer in the event they want to dump every sample generated on its own.
Public variable TSharedPtr< FMoviePipelineOutputMerger, ESPMode::ThreadSafe > OutputBuilder This gathers all of the produced data for an output frame (which may come in async many frames later) before passing them onto the Output Containers.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddFrameToOutputMetadata ( const FString& ClipName,
const FString& ImageSequenceFileName,
const FMoviePipelineFrameOutputState& FrameOutputState,
const FString& Extension,
const bool bHasAlpha
)

  
Public function void

AddOutputFuture ( TFuture< bool >&& OutputFuture,
const MoviePipeline::FMoviePipelineOutputFutureData& InData
)

  
Public function void

CacheCameraOverscan ( int32 InCameraIndex,
float InCameraOverscan
)

 Caches the provided overscan value for the specified camera
Public function Const SettingType *  
Public function Const TArray< SettingType * >  
Public function Const TArray< UMoviePipelineSetting * >  
Public function Const const TArray< UMoviePipelineExecutorShot * > &  
Public function Const const MoviePipeline::FAudioState &  
Public function Const float

GetCachedCameraOverscan ( int32 InCameraIndex
)

 Gets any cached overscan for the specified camera, or 0 if no cached overscan was found
Public function Const UFunction BlueprintPure, Category UMoviePipelineExecutorJob *  
Public function Const int32  
Public function Const UFunction BlueprintPure, Category FDateTime Returns the time this movie pipeline was initialized at.
Public function Const UFunction BlueprintPure, Category FTimespan The offset that should be applied to the GetInitializationTime() when generating the {time} related filename tokens.
Public function FMoviePipelineOutputData  
Public function Const const FMovieSceneExportMetadata &  
Public function Const const FMoviePipelineFrameOutputState &  
Public function Const UFunction BlueprintPure, Category UMoviePipelinePrimaryConfig * Get the Primary Configuration used to render this shot.
Public function Const UFunction BlueprintPure, Category UTexture *  
Public function Const void

GetSidecarCameraData ( UMoviePipelineExecutorShot* InShot,
int32 InCameraIndex,
FMinimalViewInfo& OutViewInfo,
UCameraComponent** OutCameraComponent
)

  
Public function Const bool

GetSidecarCameraViewPoints ( UMoviePipelineExecutorShot* InShot,
TArray< FVector >& OutSidecarViewLocations,
TArray< FRotator >& OutSidecarViewRotations
)

  
Public function Const ULevelSequence *  
Public function Const bool

HasCachedCameraOverscan ( int32 InCameraIndex
)

 Gets whether there is a cached overscan value for the specified camera
Public function UFunction BlueprintCallable, Category void Initialize the movie pipeline with the specified settings. This kicks off the rendering process.
Public function Const bool  
Protected function Virtual UFunction BlueprintCallable, Category void This function should be called by the Executor when execution has finished (this should still be called in the event of an error)
Public function void

OnSampleRendered ( TUniquePtr< FImagePixelData >&& OutputSample
)

  
Public function void  
Public function void  
Public function Const void

ResolveFilenameFormatArguments ( const FString& InFormatString,
const TMap< FString, FString >& InFormatOverrides,
FString& OutFinalPath,
FMoviePipelineFormatArgs& OutFinalFormatArgs,
const FMoviePipelineFrameOutputState* InOutputState,
const int32 InFrameNumberOffset
)

 Resolves the provided InFormatString by converting {format_strings} into settings provided by the primary config.
Public function void

SetFlushDiskWritesPerShot ( const bool bFlushWrites
)

  
Public function UFunction BlueprintCallable, Category void

SetInitializationTime ( const FDateTime& InDateTime
)

 Override the time this movie pipeline was initialized at.
Public function void

SetPreviewTexture ( UTexture* InTexture
)

  
Public function void Allows initialization of some viewport-related arguments that aren't related to the job.
Public function void

WarnAboutAnimatedOverscan ( float InInitialOverscan
)

 Outputs a warning message regarding animated overscan to the MRQ log if one has not already been output

Overridden from UMoviePipelineBase

  Type Name Description
Public function Virtual Const EMovieRenderPipelineState  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

RequestShutdownImpl ( bool bIsError
)

  
Public function Virtual void

ShutdownImpl ( bool bError
)

  

Constants

Name Description
DefaultDebugWidgetAsset  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page