1. Epic GamesDeveloper
  3. UMovieGraphPathTracerRenderPassNode

UMovieGraphPathTracerRenderPassNode

A render node which uses the path tracer.

API > API/Plugins > API/Plugins/MovieRenderPipelineRenderPasses

A render node which uses the path tracer.

   
Name UMovieGraphPathTracerRenderPassNode
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineRenderPasses/Public/Graph/Nodes/MovieGraphPathTracerPassNode.h
Include Path #include "Graph/Nodes/MovieGraphPathTracerPassNode.h"

Syntax

UCLASS (MinimalAPI)  
class UMovieGraphPathTracerRenderPassNode : public UMovieGraphImagePassBaseNode

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieGraphPathTracerRenderPassNode()

   Graph/Nodes/MovieGraphPathTracerPassNode.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AdditionalPostProcessMaterials TArray< FMoviePipelinePostProcessPass > An array of additional post-processing materials to run after the frame is rendered. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Post Process Materials"
  • Meta=(EditCondition="bOverride_AdditionalPostProcessMaterials")
bAllocateHistoryPerTile bool If enabled, a FSceneViewStateInterface is allocated for each tile in the high resolution image. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="High Resolution Tiling"
  • Meta=(EditCondition="bOverride_bAllocateHistoryPerTile")
bAllowOCIO bool Allow the output file OpenColorIO transform to be used on this render. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Post Processing"
  • Meta=(EditCondition="bOverride_bAllowOCIO")
bDisableToneCurve bool If true, the tone curve will be disabled for this render pass. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Post Processing"
  • Meta=(EditCondition="bOverride_bDisableToneCurve")
bEnableDenoiser bool If true the resulting image will be denoised at the end of each set of Spatial Samples. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Denoiser"
  • Meta=(EditCondition="bOverride_bEnableDenoiser")
bEnableHighResolutionTiling bool If true, the render will be done using a "tiled" render, which can overcome size limitations of GPUs but comes with a significant number of limitations. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="High Resolution Tiling"
  • Meta=(EditCondition="bOverride_bEnableHighResolutionTiling")
bEnableReferenceMotionBlur bool When enabled, the path tracer will blend all spatial and temporal samples prior to the denoising and will disable post-processed motion blur. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(UIMin=1, ClampMin=1)
  • Category="Reference Motion Blur"
  • Meta=(EditCondition="bOverride_bEnableReferenceMotionBlur")
bIncludeBeautyRenderInOutput bool Whether the main beauty pass should be written to disk. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Post Process Materials"
  • Meta=(EditCondition="bOverride_bIncludeBeautyRenderInOutput")
bLightingComponents_IncludeDiffuse bool Whether the render should include diffuse lighting contributions. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Lighting Components"
  • DisplayName="Diffuse"
  • Meta=(EditCondition="bOverride_bLightingComponents_IncludeDiffuse")
bLightingComponents_IncludeEmissive bool Whether the render should include directly visible emissive components. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Lighting Components"
  • DisplayName="Emissive"
  • Meta=(EditCondition="bOverride_bLightingComponents_IncludeEmissive")
bLightingComponents_IncludeIndirectDiffuse bool Whether the render should include indirect diffuse lighting contributions. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Lighting Components"
  • DisplayName="Indirect Diffuse"
  • Meta=(EditCondition="bOverride_bLightingComponents_IncludeIndirectDiffuse")
bLightingComponents_IncludeIndirectSpecular bool Whether the render should include indirect specular lighting contributions. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Lighting Components"
  • DisplayName="Indirect Specular"
  • Meta=(EditCondition="bOverride_bLightingComponents_IncludeIndirectSpecular")
bLightingComponents_IncludeIndirectVolume bool Whether the render should include indirect volume lighting contributions. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Lighting Components"
  • DisplayName="Indirect Volume"
  • Meta=(EditCondition="bOverride_bLightingComponents_IncludeIndirectVolume")
bLightingComponents_IncludeSpecular bool Whether the render should include specular lighting contributions. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Lighting Components"
  • DisplayName="Specular"
  • Meta=(EditCondition="bOverride_bLightingComponents_IncludeSpecular")
bLightingComponents_IncludeVolume bool Whether the render should include volume lighting contributions. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Lighting Components"
  • DisplayName="Volume"
  • Meta=(EditCondition="bOverride_bLightingComponents_IncludeVolume")
bOverride_AdditionalPostProcessMaterials uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bAllocateHistoryPerTile uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bAllowOCIO uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bDisableToneCurve uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bEnableDenoiser uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bEnableHighResolutionTiling uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bEnableReferenceMotionBlur uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bIncludeBeautyRenderInOutput uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bLightingComponents_IncludeDiffuse uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bLightingComponents_IncludeEmissive uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bLightingComponents_IncludeIndirectDiffuse uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bLightingComponents_IncludeIndirectSpecular uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bLightingComponents_IncludeIndirectVolume uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bLightingComponents_IncludeSpecular uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bLightingComponents_IncludeVolume uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bPageToSystemMemory uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bWriteAllSamples uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_DenoiserType uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_FrameCount uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_OverlapPercentage uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_PPMFileNameFormat uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_SeedOffset uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_SpatialSampleCount uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_TileCount uint8   Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bPageToSystemMemory bool Experimental Feature: When enabled, after each tile is rendered, MRQ will download the per-tile image history back to system RAM, and then the next time the tile is rendered on the subsequent frame the data is transfered from sytem memory back to GPU memory for use. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="High Resolution Tiling"
  • Meta=(EditCondition="bOverride_bPageToSystemMemory")
bWriteAllSamples bool Debug Feature. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Sampling"
  • AdvancedDisplay
  • DisplayName="Write All Samples (Debug)"
  • Meta=(EditCondition="bOverride_bWriteAllsamples")
DenoiserType EMovieGraphPathTracerDenoiserType Select which type of denoiser to use when the denoiser is enabled. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Denoiser"
  • Meta=(EditCondition="bOverride_DenoiserType")
FrameCount int32 The number of frames to consider when using temporal-based denoisers. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(UIMin=0, ClampMin=0, UIMax=3)
  • Category="Denoiser"
OverlapPercentage float Rendering effects such as Depth of Field may produce different results near the edge of a tile (as it cannot sample outside of the tile itself), so this setting allows you to create an overlapped region between tiles. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="High Resolution Tiling"
  • Meta=(EditCondition="bOverride_OverlapPercentage", UIMin="0", UIMax="50", ClampMin="0", ClampMax="50")
PPMFileNameFormat FString If specified, overrides the output node's file name format, and uses this file name format for Post Process Material passes instead. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Post Process Materials"
  • DisplayName="PPM File Name Format"
  • Meta=(EditCondition="bOverride_PPMFileNameFormat")
SeedOffset int32 Offset to apply to random number generator seed. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • BlueprintReadWrite
  • Category="Sampling"
  • AdvancedDisplay
  • Meta=(EditCondition="bOverride_SeedOffset")
SpatialSampleCount int32 How many sub-pixel jitter renders should we do per temporal sample? This can be used to achieve high sample counts without Temporal Sub-Sampling (allowing high sample counts without motion blur being enabled), but we generally recommend using Temporal Sub-Samples when possible. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(UIMin=1, ClampMin=1)
  • Category="Sampling"
  • Meta=(EditCondition="bOverride_SpatialSampleCount")
TileCount int32 If bEnableHighResolutionTiling is enabled, what is the tile count that the screen should be broken into. Graph/Nodes/MovieGraphPathTracerPassNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="High Resolution Tiling"
  • Meta=(EditCondition="bOverride_TileCount", UIMin="1", ClampMin="1", UIMax="16")

Protected

Name Type Remarks Include Path Unreal Specifiers
bOriginalProgressDisplayCvarValue bool The original value of the "r.PathTracing.ProgressDisplay" cvar before the render starts. Graph/Nodes/MovieGraphPathTracerPassNode.h  
OriginalDenoiserType int32 The original value of the "r.PathTracing.SpatialDenoiser.Type" cvar before the render starts. Graph/Nodes/MovieGraphPathTracerPassNode.h  
OriginalFrameCountCvarValue int32 The original value of the "r.NFOR.FrameCount" cvar before the render starts. Graph/Nodes/MovieGraphPathTracerPassNode.h  

Functions

Public

Overridden from UMovieGraphImagePassBaseNode

Name Remarks Include Path Unreal Specifiers
  Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual TArray< FMoviePipelinePostProcessPass > GetAdditionalPostProcessMaterials()

 Get an array of user-added post-process materials for the render Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual bool GetAllowDenoiser()

 Should the denoiser be run on the resulting image (only has any effect with the Path Tracer) Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual bool GetAllowOCIO()

 Should the output file be allowed to apply an OCIO transform on this render? Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual bool GetDisableToneCurve()

 Should the tone curve be disabled while rendering? Allows for linear values in exrs but changes the look of the final image. Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual bool GetEnableHighResolutionTiling()

 Are we using high resolution tiling? Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual bool GetEnableHistoryPerTile()

 If using high resolution tiling, do we keep a unique scene view history for each tile? Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual bool GetEnablePageToSystemMemory()

 If using high resolution tiling, should each tile be paged to system memory after rendering? Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual int32 GetNumSpatialSamples()

 How many spatial samples should be rendered each frame? Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual int32 GetNumSpatialSamplesDuringWarmUp()

 How many spatial samples should be used during warm-up frames? Graph/Nodes/MovieGraphPathTracerPassNode.h  
Get the post-process material file name format string, if any. Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual int32 GetSeedOffset()

 Offset to apply to random number generator seed. Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual FEngineShowFlags GetShowFlags()

 Gets the show flags that should be active for this renderer. Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual FIntPoint GetTileCount()

 If using high resolution tiling, how many tiles are being rendered? If not using tiling should be (1, 1). Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual float GetTileOverlapPercentage()

 If using high resolution tiling, what percentage of overlap should be used between tiles? 0-100 scale. Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual bool GetWriteAllSamples()

 Should each individual sample rendered be written out for debugging? Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual bool GetWriteBeautyPassToDisk ()

 Whether this node's beauty pass should be written to disk. Graph/Nodes/MovieGraphPathTracerPassNode.h  

Overridden from UMovieGraphRenderPassNode

Name Remarks Include Path Unreal Specifiers

virtual void SetupImpl ( const FMovieGraphRenderPassSetupData& InSetupData
)

   Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual void TeardownImpl()

   Graph/Nodes/MovieGraphPathTracerPassNode.h  

Overridden from UMovieGraphSettingNode

Name Remarks Include Path Unreal Specifiers

virtual void GetFormatResolveArgs ( FMovieGraphResolveArgs& OutMergedFormatArgs,
const FMovieGraphRenderDataIdentifier& InRenderDataIdentifier
) const

   Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual void ResolveTokenContainingProperties ( TFunction< void(FString&)>& ResolveFunc,
const FMovieGraphTokenResolveContext& InContext
)

   Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual void UpdateTelemetry ( FMoviePipelineShotRenderTelemetry* InTelemetry
) const

   Graph/Nodes/MovieGraphPathTracerPassNode.h  

Overridden from UMovieGraphNode

Name Remarks Include Path Unreal Specifiers

virtual FSlateIcon GetIconAndTint ( FLinearColor& OutColor
) const

   Graph/Nodes/MovieGraphPathTracerPassNode.h  

virtual FText GetNodeTitle ( const bool bGetDescriptive
) const

   Graph/Nodes/MovieGraphPathTracerPassNode.h  

Protected

Overridden from UMovieGraphImagePassBaseNode

Name Remarks Include Path Unreal Specifiers

virtual EViewModeIndex GetViewModeIndex()

 Gets the view mode index that should be active for this renderer. Graph/Nodes/MovieGraphPathTracerPassNode.h  

Overridden from UMovieGraphRenderPassNode

Name Remarks Include Path Unreal Specifiers

virtual int32 GetCoolingDownFrameCount()

   Graph/Nodes/MovieGraphPathTracerPassNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page