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: Unity.MARS
Syntax
public class CompositeRenderModule : IModuleDependency<SimulationSceneModule>, IModuleBehaviorCallbacks, IModule

Methods

AddView(ScriptableObject)

Declaration
public void AddView(ScriptableObject scriptableObject)
Parameters
Type Name Description
ScriptableObject scriptableObject

ConnectDependency(SimulationSceneModule)

Declaration
public void ConnectDependency(SimulationSceneModule dependency)
Parameters
Type Name Description
SimulationSceneModule dependency
Implements

GetActiveCompositeRenderModule(out CompositeRenderModule)

Get the active Composite Render Module for the Module Loader Core

Declaration
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.

LoadModule()

Declaration
public void LoadModule()
Implements

OnBehaviorAwake()

Declaration
public void OnBehaviorAwake()
Implements

OnBehaviorDestroy()

Declaration
public void OnBehaviorDestroy()
Implements

OnBehaviorDisable()

Declaration
public void OnBehaviorDisable()
Implements

OnBehaviorEnable()

Declaration
public void OnBehaviorEnable()
Implements

OnBehaviorStart()

Declaration
public void OnBehaviorStart()
Implements

OnBehaviorUpdate()

Declaration
public void OnBehaviorUpdate()
Implements

RemoveView(ScriptableObject)

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

Declaration
public void RemoveView(ScriptableObject scriptableObject)
Parameters
Type Name Description
ScriptableObject scriptableObject

ScriptableObject to be removed.

TryGetCompositeRenderContext(ScriptableObject, out CompositeRenderContext)

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

Declaration
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.

UnloadModule()

Declaration
public void UnloadModule()
Implements

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>