UCinePrestreamingGraphNode

A Movie Render Graph output node that records virtual texture page requests and Nanite geometry requests during rendering, then saves them as [UCinePrestreamingData](API\Plugins\CinematicPrestreaming\UCinePrestreamingData) assets.

API > API/Plugins > API/Plugins/CinematicPrestreamingEditor

A Movie Render Graph output node that records virtual texture page requests and Nanite geometry requests during rendering, then saves them as UCinePrestreamingData assets. These assets can be used at runtime to pre-stream content before it is needed during cinematic playback.

This node provides the same recording functionality as UCinePrestreamingRecorderSetting (the Movie Render Queue version), but integrates with the Movie Render Graph pipeline instead.

Note: Because delegates are registered lazily on the first completed output frame, the very first output frame's streaming requests are not captured. This is acceptable because warmup frames precede actual output frames and pre-establish the streaming state.

   
Name UCinePrestreamingGraphNode
Type class
Header File /Engine/Plugins/MovieScene/CinematicPrestreaming/Source/CinematicPrestreamingEditor/Public/CinePrestreamingGraphNode.h
Include Path #include "CinePrestreamingGraphNode.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UCinePrestreamingGraphNode : public UMovieGraphFileOutputNode

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCinePrestreamingGraphNode()

   CinePrestreamingGraphNode.h  

Structs

Name Remarks
FCollectedData  
FFrameData Per-frame collected data structures (same layout as MRQ recorder)

Constants

Name Type Remarks Include Path
ActivePipeline TWeakObjectPtr< UMovieGraphPipeline > The pipeline generates many CDO instances throughout execution. CinePrestreamingGraphNode.h
BeginFrameDelegate FDelegateHandle   CinePrestreamingGraphNode.h
bShowFlagsDisabled bool   CinePrestreamingGraphNode.h
EndFrameRTDelegate FDelegateHandle   CinePrestreamingGraphNode.h
PrevActiveShotIndex int32   CinePrestreamingGraphNode.h
SegmentData TArray< FCollectedData > Pre-allocated once to avoid reallocation while the render thread may be writing. CinePrestreamingGraphNode.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDisableAdvanceRenderFeatures bool Disable rendering features not required to generate prestreaming data (lighting, post processing, etc.). CinePrestreamingGraphNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Optimizations"
bMergeFrames bool Enable merging of frame data. CinePrestreamingGraphNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Optimizations"
bModifyTargetSequence bool Automatically add the generated prestreaming track to the target sequence. CinePrestreamingGraphNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Post Process"
bNanite bool Enable capture of Nanite geometry requests. CinePrestreamingGraphNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Record"
bVirtualTextures bool Enable capture of virtual texture page requests. CinePrestreamingGraphNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Record"
EndFrame int32 Last frame to include in the recorded asset. CinePrestreamingGraphNode.h
  • BlueprintReadWrite
  • Category="Settings"
  • Meta=(UIMin="0", ClampMin="0")
FrameCountMergeThreshold int32 Maximum number of frames to merge data across. CinePrestreamingGraphNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Optimizations"
  • Meta=(EditCondition="bMergeFrames", UIMin="1", ClampMin="1")
NaniteRequestMergeThreshold int32 Threshold of Nanite page requests. Frames are merged until this threshold is reached. CinePrestreamingGraphNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Optimizations"
  • Meta=(EditCondition="bNanite && bMergeFrames", UIMin="1", ClampMin="1")
OnGenerateData FOnCinePrestreamingGenerateData Broadcast after asset generation completes, with the generated data. CinePrestreamingGraphNode.h
  • BlueprintAssignable
PackageDirectory FDirectoryPath Specifies the content browser directory where generated assets will be placed. CinePrestreamingGraphNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Settings"
  • Meta=(ContentDir)
StartFrame int32 First frame to include in the recorded asset. Frames before this index are dropped. CinePrestreamingGraphNode.h
  • BlueprintReadWrite
  • Category="Settings"
  • Meta=(UIMin="0", ClampMin="0")
VirtualTextureRequestMergeThreshold int32 Threshold of virtual texture page requests. Frames are merged until this threshold is reached. CinePrestreamingGraphNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Optimizations"
  • Meta=(EditCondition="bVirtualTextures && bMergeFrames", UIMin="1", ClampMin="1")

Functions

Public

Public Virtual

Overridden from UMovieGraphNode

Name Remarks Include Path Unreal Specifiers

virtual EMovieGraphBranchRestriction GetBranchRestriction()

   CinePrestreamingGraphNode.h  

virtual FText GetKeywords()

   CinePrestreamingGraphNode.h  

virtual FText GetMenuCategory()

   CinePrestreamingGraphNode.h  

virtual FText GetNodeTitle ( const bool bGetDescriptive
) const

   CinePrestreamingGraphNode.h  

virtual FLinearColor GetNodeTitleColor()

   CinePrestreamingGraphNode.h  

Protected Virtual

Overridden from UMovieGraphFileOutputNode

Name Remarks Include Path Unreal Specifiers

virtual bool IsFinishedWritingToDiskImpl()

   CinePrestreamingGraphNode.h  

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

   CinePrestreamingGraphNode.h  

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

   CinePrestreamingGraphNode.h  

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

   CinePrestreamingGraphNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page