Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineRenderPasses
The UMovieGraphImagePassBaseNode is an abstract base-class for render nodes that wish to create renders of the 3d scene. You are not required to inherit from this node (can inherit from UMovieGraphRenderPassNode), but this node provides a helpful set of functions and default values for constructing the required matrices and settings for viewport-like renders.
| Name | UMovieGraphImagePassBaseNode |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineRenderPasses/Public/Graph/Nodes/MovieGraphImagePassBaseNode.h |
| Include Path | #include "Graph/Nodes/MovieGraphImagePassBaseNode.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UMovieGraphImagePassBaseNode : public UMovieGraphRenderPassNode
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieGraphNode → UMovieGraphSettingNode → UMovieGraphRenderPassNode → UMovieGraphImagePassBaseNode
Derived Classes
- UMovieGraphDeferredPanoramicNode
- UMovieGraphDeferredRenderPassNode
- UMovieGraphObjectIdNode
- UMovieGraphPathTracerRenderPassNode
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieGraphImagePassBaseNode() |
Graph/Nodes/MovieGraphImagePassBaseNode.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DefaultDepthAsset | FString | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
| DefaultMotionVectorsAsset | FString | Graph/Nodes/MovieGraphImagePassBaseNode.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< FMoviePipelinePostProcessPass > GetAdditionalPostProcessMaterials() |
Get an array of user-added post-process materials for the render | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetAllowDenoiser() |
Should the denoiser be run on the resulting image (only has any effect with the Path Tracer) | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetAllowOCIO() |
Should the output file be allowed to apply an OCIO transform on this render? | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetAllowsCompositing() |
Whether this pass allows other passes to be composited on it. | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetAllowsShowFlagsCustomization() |
Whether this node allows changing the Show Flags in the details panel. | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual EAntiAliasingMethod GetAntiAliasingMethod() |
Which AA Method should be used? | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual TArray< uint32 > GetDefaultShowFlags() |
Gets any show flags that should be applied as defaults, before user changes are applied. | Graph/Nodes/MovieGraphImagePassBaseNode.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/MovieGraphImagePassBaseNode.h | |
virtual bool GetEnableHighResolutionTiling() |
Are we using high resolution tiling? | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetEnableHistoryPerTile() |
If using high resolution tiling, do we keep a unique scene view history for each tile? | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetEnablePageToSystemMemory() |
If using high resolution tiling, should each tile be paged to system memory after rendering? | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetForceLosslessCompression() |
Whether lossless compression must be forced on for this node. | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual int32 GetNumSpatialSamples() |
How many spatial samples should be rendered each frame? | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual int32 GetNumSpatialSamplesDuringWarmUp() |
How many spatial samples should be used during warm-up frames? | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetOverrideAntiAliasing() |
Should we override the anti-aliasing setting specified by the Project Settings? | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual FString GetPPMFileNameFormatString () |
Get the post-process material file name format string, if any. | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual int32 GetSeedOffset() |
Offset to apply to random number generator seed. | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual FEngineShowFlags GetShowFlags() |
Gets the show flags that should be active for this renderer. | Graph/Nodes/MovieGraphImagePassBaseNode.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/MovieGraphImagePassBaseNode.h | |
virtual float GetTileOverlapPercentage() |
If using high resolution tiling, what percentage of overlap should be used between tiles? 0-100 scale. | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual EViewModeIndex GetViewModeIndex() |
Gets the view mode index that should be active for this renderer. | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetWriteAllSamples() |
Should each individual sample rendered be written out for debugging? | Graph/Nodes/MovieGraphImagePassBaseNode.h | |
virtual bool GetWriteBeautyPassToDisk () |
Whether this node's beauty pass should be written to disk. | Graph/Nodes/MovieGraphImagePassBaseNode.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TUniquePtr< UE::MovieGraph::Rendering::FMovieGraphImagePassBase > CreateInstance() |
Graph/Nodes/MovieGraphImagePassBaseNode.h |
Overridden from UMovieGraphRenderPassNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GatherOutputPassesImpl
(
UMovieGraphEvaluatedConfig* InConfig, |
Graph/Nodes/MovieGraphImagePassBaseNode.h | ||
virtual int32 GetNumSceneViewsRenderedImpl() |
Graph/Nodes/MovieGraphImagePassBaseNode.h | ||
virtual void RenderImpl
(
const FMovieGraphTraversalContext& InFrameTraversalContext, |
Graph/Nodes/MovieGraphImagePassBaseNode.h | ||
virtual void SetupImpl
(
const FMovieGraphRenderPassSetupData& InSetupData |
Graph/Nodes/MovieGraphImagePassBaseNode.h | ||
virtual void TeardownImpl() |
Graph/Nodes/MovieGraphImagePassBaseNode.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddReferencedObjects
(
UObject* InThis, |
Graph/Nodes/MovieGraphImagePassBaseNode.h |