Class VolumeManager
A global manager that tracks all the Volumes in the currently loaded Scenes and does all the interpolation work.
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public sealed class VolumeManagerProperties
| Name | Description |
|---|---|
| baseComponentTypeArray | The current list of all available types that derive from VolumeComponent. |
| baseComponentTypes | The current list of all available types that derive from VolumeComponent. |
| instance | The current singleton instance of VolumeManager. |
| stack | A reference to the main VolumeStack. |
Methods
| Name | Description |
|---|---|
| CheckBaseTypes() | Checks the state of the base type library. This is only used in the editor to handle entering and exiting of play mode and domain reload. |
| CheckStack(VolumeStack) | Checks the state of a given stack. This is only used in the editor to handle entering and exiting of play mode and domain reload. |
| CreateStack() | Creates and returns a new VolumeStack to use when you need to store the result of the Volume blending pass in a separate stack. |
| DestroyStack(VolumeStack) | Destroy a Volume Stack |
| GetVolumes(LayerMask) | Get all volumes on a given layer mask sorted by influence. |
| IsComponentActiveInMask<T>(LayerMask) | Checks if a VolumeComponent is active in a given LayerMask. |
| Register(Volume, int) | Registers a new Volume in the manager. Unity does this automatically when a new Volume is enabled, or its layer changes, but you can use this function to force-register a Volume that is currently disabled. |
| ResetMainStack() | Resets the main stack to be the default one. Call this function if you've assigned the main stack to something other than the default one. |
| Unregister(Volume, int) | Unregisters a Volume from the manager. Unity does this automatically when a Volume is disabled or goes out of scope, but you can use this function to force-unregister a Volume that you added manually while it was disabled. |
| Update(VolumeStack, Transform, LayerMask) | Updates the Volume manager and stores the result in a custom VolumeStack. |
| Update(Transform, LayerMask) | Updates the global state of the Volume manager. Unity usually calls this once per Camera in the Update loop before rendering happens. |