1. Epic GamesDeveloper
  3. UMovieGraphFileOutputNode

UMovieGraphFileOutputNode

The [UMovieGraphFileOutputNode](API\Plugins\MovieRenderPipelineCore\UMovieGraphFileOutputNode) node defines a output file format that MRQ may place produced render data into.

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

The UMovieGraphFileOutputNode node defines a output file format that MRQ may place produced render data into. At runtime, the individual pieces of render data will be generated by the Movie Graph Renderer, and then all data will be collected into a single datastructure by the FMovieGraphOutputMerger before being passed back into the main Movie Graph Pipeline. Once this happens, the CDOs deriving from UMovieGraphFileOutputNode will be given a pointer to the information for the whole frame, so they can decide what to do with it. There are potentially multiple output formats at once (such as exr and jpeg).

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

Syntax

UCLASS (MinimalAPI, Abstract)  
class UMovieGraphFileOutputNode : public UMovieGraphSettingNode

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieGraphFileOutputNode()

   Graph/Nodes/MovieGraphFileOutputNode.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bOverride_FileNameFormat uint8   Graph/Nodes/MovieGraphFileOutputNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
FileNameFormat FString What format string should the final files use? Can include folder prefixes, and format string ({shot_name}, etc.) Graph/Nodes/MovieGraphFileOutputNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="File Output"
  • Meta=(EditCondition="bOverride_FileNameFormat")

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool IsFinishedWritingToDisk()

 Returns whether this node has finished writing all of its files to disk yet. Graph/Nodes/MovieGraphFileOutputNode.h  

void OnAllFramesFinalized ( UMovieGraphPipeline* InPipeline,
TObjectPtr< UMovieGraphEvaluatedConfig >& InPrimaryJobEvaluatedGraph
)

 This is called when the pipeline has finished rendering all shots, and the sequence export process is finishing up. Graph/Nodes/MovieGraphFileOutputNode.h  

void OnAllFramesSubmitted ( UMovieGraphPipeline* InPipeline,
TObjectPtr< UMovieGraphEvaluatedConfig >& InPrimaryJobEvaluatedGraph
)

 This is called when the pipeline has finished rendering all shots, and the sequence export process has not begun yet. Graph/Nodes/MovieGraphFileOutputNode.h  

void OnAllShotFramesSubmitted ( UMovieGraphPipeline* InPipeline,
const UMoviePipelineExecutorShot* InShot,
TObjectPtr< UMovieGraphEvaluatedConfig >& InShotEvaluatedGraph,
const bool bFlushToDisk
)

 This is called when a shot has finished rendering its last frame, and the shot export process has not begun yet. Graph/Nodes/MovieGraphFileOutputNode.h  
This is called by the Game Thread containing the final output data for a given output frame. Graph/Nodes/MovieGraphFileOutputNode.h  

Overridden from UMovieGraphNode

Name Remarks Include Path Unreal Specifiers

virtual TArray< FMovieGraphPinProperties > GetInputPinProperties()

 Gets the properties for all input pins. Graph/Nodes/MovieGraphFileOutputNode.h  

virtual FText GetMenuCategory()

 Gets the category that the node belongs under. Graph/Nodes/MovieGraphFileOutputNode.h  

virtual TArray< FMovieGraphPinProperties > GetOutputPinProperties()

 Gets the properties for all output pins. Graph/Nodes/MovieGraphFileOutputNode.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool IsFinishedWritingToDiskImpl()

   Graph/Nodes/MovieGraphFileOutputNode.h  

virtual void OnAllFramesFinalizedImpl ( UMovieGraphPipeline* InPipeline,
TObjectPtr< UMovieGraphEvaluatedConfig >& InPrimaryJobEvaluatedGraph
)

   Graph/Nodes/MovieGraphFileOutputNode.h  

virtual void OnAllFramesSubmittedImpl ( UMovieGraphPipeline* InPipeline,
TObjectPtr< UMovieGraphEvaluatedConfig >& InPrimaryJobEvaluatedGraph
)

   Graph/Nodes/MovieGraphFileOutputNode.h  

virtual void OnAllShotFramesSubmittedImpl ( UMovieGraphPipeline* InPipeline,
const UMoviePipelineExecutorShot* InShot,
TObjectPtr< UMovieGraphEvaluatedConfig >& InShotEvaluatedGraph
)

   Graph/Nodes/MovieGraphFileOutputNode.h  

virtual void OnAllShotFramesSubmittedImpl ( UMovieGraphPipeline* InPipeline,
const UMoviePipelineExecutorShot* InShot,
TObjectPtr< UMovieGraphEvaluatedConfig >& InShotEvaluatedGraph,
const bool bFlushToDisk
)

   Graph/Nodes/MovieGraphFileOutputNode.h  

virtual void OnReceiveImageDataImpl ( UMovieGraphPipeline* InPipeline,
UE::MovieGraph::FMovieGraphOutputMergerFrame* InRawFrameData,
const TSet< FMovieGraphRenderDataIdentifier >& InMask
)

   Graph/Nodes/MovieGraphFileOutputNode.h  

virtual bool ShouldCropOverscanImpl()

 Returns whether any overscan should be automatically cropped from the image before compositing and output Graph/Nodes/MovieGraphFileOutputNode.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DisambiguateFilename ( FString& InOutFilenameFormatString,
const UE::MovieGraph::FMovieGraphOutputMergerFrame* InRawFrameData,
const UMovieGraphFileOutputNode* InParentNode,
const FMovieGraphPassData& InRenderData
)

 Updates InOutFilenameFormatString to include tokens (like {layer_name}) that will disambiguate the output if multiple outputs are attempting to write to the same file. Graph/Nodes/MovieGraphFileOutputNode.h  

static void DisambiguateFilename ( FString& InOutFilenameFormatString,
const UE::MovieGraph::FMovieGraphOutputMergerFrame* InRawFrameData,
const FName& InNodeName,
const FMovieGraphPassData& InRenderData
)

 Updates InOutFilenameFormatString to include tokens (like {layer_name}) that will disambiguate the output if multiple outputs are attempting to write to the same file. Graph/Nodes/MovieGraphFileOutputNode.h  

static TArray< FMovieGraphPassData > GetCompositedPasses ( UE::MovieGraph::FMovieGraphOutputMergerFrame* InRawFrameData
)

 Convenience function to get the list of active composite passes from render data. Graph/Nodes/MovieGraphFileOutputNode.h  

static int32 GetNumFileOutputNodes ( const UMovieGraphEvaluatedConfig& InEvaluatedConfig,
const FName& InBranchName
)

 Returns the number of evaluated (active) file nodes on the specified branch. Graph/Nodes/MovieGraphFileOutputNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page