Class VolumeStack

Holds the state of a Volume blending update. A global stack is available by default in VolumeManager but you can also create your own using CreateStack() if you need to update the manager with specific settings and store the results for later use.

Inheritance
object
VolumeStack
Implements
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public sealed class VolumeStack : IDisposable

Properties

isValid

Check if the stack is in valid state and can be used.

Declaration
public bool isValid { get; }
Property Value
Type Description
bool

Methods

Dispose()

Cleans up the content of this stack. Once a VolumeStack is disposed, it shouldn't be used anymore.

Declaration
public void Dispose()

GetComponent(Type)

Gets the current state of the VolumeComponent of the specified type in the stack.

Declaration
public VolumeComponent GetComponent(Type type)
Parameters
Type Name Description
Type type

The type of VolumeComponent to look for.
Returns
Type Description
VolumeComponent

The current state of the VolumeComponent of the specified type, or null if the type is invalid.

GetComponent<T>()

Gets the current state of the VolumeComponent of type T in the stack.

Declaration
public T GetComponent<T>() where T : VolumeComponent
Returns
Type Description
T

The current state of the VolumeComponent of type T in the stack.
Type Parameters
Name Description
T

A type of VolumeComponent.

Implements

Extension Methods