1. Epic GamesDeveloper
  3. UMovieGraphBlueprintLibrary

UMovieGraphBlueprintLibrary

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

   
Name UMovieGraphBlueprintLibrary
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/MovieGraphBlueprintLibrary.h
Include Path #include "Graph/MovieGraphBlueprintLibrary.h"

Syntax

UCLASS (MinimalAPI, Meta=(ScriptName="MovieGraphLibrary"))  
class UMovieGraphBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FIntPoint GetBackbufferResolution ( UMovieGraphEvaluatedConfig* InEvaluatedGraph,
float DefaultOverscan,
float CameraAspectRatio
)

 Gets the resolution that frames will actually be rendered at in MRG, which includes factors such as overscan and tiling Graph/MovieGraphBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Graph"

static float GetCompletionPercentage ( const UMovieGraphPipeline* InPipeline
)

 Gets the completion percent of the Pipeline in 0-1 Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static float GetCurrentAperture ( const UMovieGraphPipeline* InMovieGraphPipeline,
int32 InCameraIndex
)

 Gets the aperture for the camera currently in use. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static UCineCameraComponent * GetCurrentCineCamera ( const UMovieGraphPipeline* InMovieGraphPipeline,
int32 InCameraIndex
)

 Gets the currently active cine camera, or nullptr if one was not found. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static UMoviePipelineExecutorShot * GetCurrentExecutorShot ( const UMovieGraphPipeline* InMoviePipeline
)

 Gets the current shot being rendered by the graph (could be nullptr if rendering hasn't started or has moved to Finalize!) Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static float GetCurrentFocalLength ( const UMovieGraphPipeline* InMovieGraphPipeline,
int32 InCameraIndex
)

 Gets the focal length for the camera currently in use. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static float GetCurrentFocusDistance ( const UMovieGraphPipeline* InMovieGraphPipeline,
int32 InCameraIndex
)

 Gets the focus distance for the camera currently in use. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static void GetCurrentSegmentName ( const UMovieGraphPipeline* InMovieGraphPipeline,
FText& OutOuterName,
FText& OutInnerName
)

 Gets the name of the segment (shot) currently being rendered. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static EMovieRenderShotState GetCurrentSegmentState ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the state of the segment (shot) currently being rendered. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FMoviePipelineSegmentWorkMetrics GetCurrentSegmentWorkMetrics ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the work metrics for the segment (shot) that is currently being rendered. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FFrameNumber GetCurrentShotFrameNumber ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the frame number of the current render at the shot level. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FTimecode GetCurrentShotTimecode ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the timecode of the current render at the shot level. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static int32 GetCurrentVersionNumber ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Retrieves the cached version number calculated for the current shot, which depends on where the version token was used in the File Name Output ie: If {version} comes before {shot_name} then all shots will use the same version number, but if it comes afterwards then each shot may have a different version (which is the highest number found of that particular shot). Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FIntPoint GetDesiredOutputResolution ( UMovieGraphEvaluatedConfig* InEvaluatedGraph,
float CameraAspectRatio
)

 Gets the desired output resolution for the movie render graph as specified by the user. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Graph"
If InNode is valid, inspects the provided OutputsettingNode to determine if it wants to override the Frame Rate, and if so, returns the overwritten frame rate. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Graph"

static FIntPoint GetEffectiveOutputResolution ( UMovieGraphEvaluatedConfig* InEvaluatedGraph,
float DefaultOverscan
)

 In case of overscan percentage being higher than 0, additional pixels are rendered. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Graph"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use GetOverscannedResolution instead")

static bool GetEstimatedTimeRemaining ( const UMovieGraphPipeline* InMovieGraphPipeline,
FTimespan& OutEstimate
)

 Get the estimated amount of time remaining for the current pipeline. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FText GetJobAuthor ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the author of the current job, or the logged in user's username if the job has no specified author. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FDateTime GetJobInitializationTime ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the time the job was initialized. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FText GetJobName ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the name of the current job. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static void GetOverallOutputFrames ( const UMovieGraphPipeline* InMovieGraphPipeline,
int32& OutCurrentIndex,
int32& OutTotalCount
)

 Determines the overall current frame number and total number of frames. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static void GetOverallSegmentCounts ( const UMovieGraphPipeline* InMovieGraphPipeline,
int32& OutCurrentIndex,
int32& OutTotalCount
)

 Gets the number of segments (shots) that will be rendered. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FIntRect GetOverscanCropRectangle ( UMovieGraphEvaluatedConfig* InEvaluatedGraph,
float DefaultOverscan,
float CameraAspectRatio
)

 Gets a rectangle that will crop out any overscan applied to the scene. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Graph"

static FIntPoint GetOverscannedResolution ( UMovieGraphEvaluatedConfig* InEvaluatedGraph,
float DefaultOverscan,
float CameraAspectRatio
)

 Gets the desired output resolution scaled by any configured overscan for the movie render graph Graph/MovieGraphBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Graph"

static EMovieRenderPipelineState GetPipelineState ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Get the current state of the specified pipeline. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FFrameNumber GetRootFrameNumber ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the frame number of the current render at the root (sequence) level. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FTimecode GetRootTimecode ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the timecode of the current render at the root (sequence) level. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static bool IsNamedResolutionValid ( const FName& InResolutionProfileName
)

 Utility function for checking if a given resolution profile name is valid, since NamedResolutionFromProfile will throw a kismet exception, but blueprints can't actually try/catch them. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FMovieGraphNamedResolution NamedResolutionFromProfile ( const FName& InResolutionProfileName
)

 Create a Named Resolution from the profile name. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FMovieGraphNamedResolution NamedResolutionFromSize ( const int32 InResX,
const int32 InResY
)

 Create a Named Resolution from the given resolution. Given named resolution will be named "Custom". Graph/MovieGraphBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Graph"

static FString ResolveFilenameFormatArguments ( const FString& InFormatString,
const FMovieGraphFilenameResolveParams& InParams,
FMovieGraphResolveArgs& OutMergedFormatArgs
)

 Takes a Movie Graph format string (in the form of {token}), a list of parameters (which normally come from the running UMovieGraphPipeline) and resolves them into a file path. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Graph"

static FString ResolveFormatArguments ( const FString& InFormatString,
const FMovieGraphFilenameResolveParams& InParams,
FMovieGraphResolveArgs& OutMergedFormatArgs
)

 Functions identically to ResolveFilenameFormatArguments(), with the exception that this variation does not resolve the format string to a file path (any non-path format string can be provided). Graph/MovieGraphBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Graph"

static int32 ResolveVersionNumber ( FMovieGraphFilenameResolveParams InParams,
const bool bGetNextVersion
)

 If the version number is explicitly specified on the Output Setting node, returns that. Graph/MovieGraphBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Graph"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page