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.
Namespace: UnityEditor.MARS.Simulation.Rendering
Syntax
public class CompositeRenderModule : IModuleDependency<SimulationSceneModule>, IModuleBehaviorCallbacksMethods
AddView(ScriptableObject)
Add a viewport to use the composite render module using the viewport's base ScriptableObject
Declaration
public void AddView(ScriptableObject scriptableObject)Parameters
| Type | Name | Description |
|---|---|---|
| ScriptableObject | scriptableObject | The viewport to add the composite to. |
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. |
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. |
Events
BeforeBackgroundCameraRender
Event callback for before composite cameras render in the Composite Render Context
Declaration
public event Action<CompositeRenderContext> BeforeBackgroundCameraRenderEvent Type
| Type | Description |
|---|---|
| Action<CompositeRenderContext> |