unreal.MovieGraphRenderLayerSubsystem
¶
- class unreal.MovieGraphRenderLayerSubsystem(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
WorldSubsystem
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.
C++ Source:
Plugin: MovieRenderPipeline
Module: MovieRenderPipelineCore
File: MovieGraphRenderLayerSubsystem.h
- add_render_layer(render_layer) bool ¶
Adds a render layer to the system, which can later be made active by SetActiveRenderLayer*(). Returns true if the layer was added successfully, else false.
- Parameters:
render_layer (MovieGraphRenderLayer) –
- Return type:
- clear_active_render_layer() None ¶
Clears the currently active render layer and reverts its modifiers.
- get_active_render_layer() MovieGraphRenderLayer ¶
Gets the currently active render layer (the layer with its modifiers applied).
- Return type:
- classmethod get_from_world(world) MovieGraphRenderLayerSubsystem ¶
Get this subsystem for a specific world. Handy for use from Python.
- Parameters:
world (World) –
- Return type:
- get_render_layers() Array[MovieGraphRenderLayer] ¶
Gets all render layers which are currently tracked by the system.
- Return type:
- remove_render_layer(render_layer_name) None ¶
Removes the render layer with the given name. After removal it can no longer be made active with SetActiveRenderLayerBy*().
- Parameters:
render_layer_name (str) –
- set_active_render_layer_by_name(render_layer_name) None ¶
Applies the layer with the given name. The layer needs to have been registered with AddRenderLayer().
- Parameters:
render_layer_name (Name) –
- set_active_render_layer_by_obj(render_layer) None ¶
Applies the given layer. The layer does not need to have been registered with AddRenderLayer().
- Parameters:
render_layer (MovieGraphRenderLayer) –