Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
The primary means of controlling render layers in MRQ. Render layers can be added/registered with the subsystem, then made active in order to view them. Collections and modifiers can also be viewed, but they do not need to be added to the subsystem ahead of time.
| Name | UMovieGraphRenderLayerSubsystem |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/MovieGraphRenderLayerSubsystem.h |
| Include Path | #include "Graph/MovieGraphRenderLayerSubsystem.h" |
Syntax
UCLASS ()
class UMovieGraphRenderLayerSubsystem : public UWorldSubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UWorldSubsystem → UMovieGraphRenderLayerSubsystem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieGraphRenderLayerSubsystem() |
Graph/MovieGraphRenderLayerSubsystem.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveRenderLayer | TObjectPtr< UMovieGraphRenderLayer > | The render layer that currently has its modifiers applied. | Graph/MovieGraphRenderLayerSubsystem.h |
|
| RenderLayers | TArray< TObjectPtr< UMovieGraphRenderLayer > > | Render layers which have been added/registered with the subsystem. These can be found by name. | Graph/MovieGraphRenderLayerSubsystem.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddRenderLayer
(
UMovieGraphRenderLayer* RenderLayer |
Adds a render layer to the system, which can later be made active by SetActiveRenderLayer*(). | Graph/MovieGraphRenderLayerSubsystem.h |
|
void ClearActiveRenderLayer() |
Clears the currently active render layer and reverts its modifiers. | Graph/MovieGraphRenderLayerSubsystem.h |
|
UMovieGraphRenderLayer * GetActiveRenderLayer() |
Gets the currently active render layer (the layer with its modifiers applied). | Graph/MovieGraphRenderLayerSubsystem.h |
|
const TArray< UMovieGraphRenderLayer * > & GetRenderLayers() |
Gets all render layers which are currently tracked by the system. | Graph/MovieGraphRenderLayerSubsystem.h |
|
void RemoveRenderLayer
(
const FString& RenderLayerName |
Removes the render layer with the given name. | Graph/MovieGraphRenderLayerSubsystem.h |
|
void Reset() |
Clear out all tracked render layers and collections. | Graph/MovieGraphRenderLayerSubsystem.h |
|
void SetActiveRenderLayerByName
(
const FName& RenderLayerName |
Applies the layer with the given name. | Graph/MovieGraphRenderLayerSubsystem.h |
|
void SetActiveRenderLayerByObj
(
UMovieGraphRenderLayer* RenderLayer |
Applies the given layer. | Graph/MovieGraphRenderLayerSubsystem.h |
|
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
Graph/MovieGraphRenderLayerSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
Graph/MovieGraphRenderLayerSubsystem.h | ||
virtual bool ShouldCreateSubsystem
(
UObject* Outer |
Graph/MovieGraphRenderLayerSubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UMovieGraphRenderLayerSubsystem * GetFromWorld
(
const UWorld* World |
Get this subsystem for a specific world. Handy for use from Python. | Graph/MovieGraphRenderLayerSubsystem.h |
|