Class CompositeRenderModule

Module that manages the composite render context for all active views. This allows the composting of multiple scenes with different render settings in a view.

Inheritance
Object
CompositeRenderModule
Namespace: UnityEditor.MARS.Simulation.Rendering
Syntax
[ModuleOrder(1073741825)]
[ModuleUnloadOrder(1073741823)]
[MovedFrom("Unity.MARS")]
public class CompositeRenderModule : IModuleDependency<SimulationSceneModule>, IModule

Methods

AddView(ScriptableObject)

Obsolete - Adds a view to the composite render module.

Declaration
[Obsolete("AddView(scriptableObject) is obsolete, use CreateCompositeContext(camera)")]
public void AddView(ScriptableObject scriptableObject)
Parameters
Type Name Description
ScriptableObject scriptableObject

ScriptableObject to add.

GetActiveCompositeRenderModule(out CompositeRenderModule)

Get the active Composite Render Module for the Module Loader Core.

Declaration
[Obsolete("GetActiveCompositeRenderModule is obsolete, use 'ModuleLoaderCore.instance.GetModule<CompositeRenderModule>()'")]
public static bool GetActiveCompositeRenderModule(out CompositeRenderModule compositeRenderModule)
Parameters
Type Name Description
CompositeRenderModule compositeRenderModule

The active Composite Render Module.
Returns
Type Description
Boolean

True if there is a loaded Composite Render Module.

RemoveView(ScriptableObject)

Obsolete - Removes a view from being used in the composite render module and disposes of the CompositeRenderContext for that view.

Declaration
[Obsolete("RemoveView(scriptableObject) is obsolete, use DisposeCompositeContext(camera)")]
public void RemoveView(ScriptableObject scriptableObject)
Parameters
Type Name Description
ScriptableObject scriptableObject

ScriptableObject to be removed.

TryGetCompositeRenderContext(Camera, out CompositeRenderContext)

Try to get a Composite Render Context from the camera that is rendering the context.

Declaration
public bool TryGetCompositeRenderContext(Camera camera, out CompositeRenderContext context)
Parameters
Type Name Description
Camera camera

Camera rendering the context we are trying to find.
CompositeRenderContext context

The Composite Render Context associated with the camera.
Returns
Type Description
Boolean

Returns True if there is a context associated with the camera.

TryGetCompositeRenderContext(ScriptableObject, out CompositeRenderContext)

Obsolete - Try to get a Composite Render Context associated with the Scriptable Object from the active Composite Render Module.

Declaration
[Obsolete("TryGetCompositeRenderContext is obsolete, first get the 'CompositeRenderModule' instance from the 'ModuleLoaderCore' the call 'TryGetCompositeRenderContext(camera, out context)'")]
public static bool TryGetCompositeRenderContext(ScriptableObject scriptableObject, out CompositeRenderContext context)
Parameters
Type Name Description
ScriptableObject scriptableObject

Scriptable object we want the context for.
CompositeRenderContext context

The Composite Render Context associated with the scriptable object.
Returns
Type Description
Boolean

Returns True if there is a context associated with the scriptable object.

Events

BeforeBackgroundCameraRender

Event callback for before composite cameras render in the Composite Render Context

Declaration
public event Action<CompositeRenderContext> BeforeBackgroundCameraRender
Event Type
Type Description
Action<CompositeRenderContext>

Explicit Interface Implementations

IModule.LoadModule()

Declaration
void IModule.LoadModule()
Implements

IModule.UnloadModule()

Declaration
void IModule.UnloadModule()
Implements

IModuleDependency<SimulationSceneModule>.ConnectDependency(SimulationSceneModule)

Declaration
void IModuleDependency<SimulationSceneModule>.ConnectDependency(SimulationSceneModule dependency)
Parameters
Type Name Description
SimulationSceneModule dependency
Implements