Class VolumeComponent

The base class for all components that can be part of a VolumeProfile. This class serves as the foundation for creating and managing volume components in Unity's volume system, enabling the handling of various VolumeParameter types in a unified way.

Inheritance
object
Object
ScriptableObject
VolumeComponent
ProbeVolumesOptions
Implements
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.GetEntityId()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
[Serializable]
public class VolumeComponent : ScriptableObject, IApplyRevertPropertyContextMenuItemProvider
Remarks

The VolumeComponent class is automatically integrated into the volume framework, which handles interpolation and blending of VolumeParameter members at runtime. It ensures that parameter values can be adjusted and smoothly transitioned based on different factors, such as render pipeline settings, quality settings, or user-defined parameters.

 Due to the need to store multiple <xref href="UnityEngine.Rendering.VolumeParameter%601" data-throw-if-not-resolved="false"></xref> types in a single collection,
 this base class provides a mechanism to handle them generically. It allows for easy management and
 manipulation of parameters of varying types, ensuring consistency across different volume components.

 - Stores and manages a collection of <xref href="UnityEngine.Rendering.VolumeParameter" data-throw-if-not-resolved="false"></xref> objects..
 - Integrates seamlessly into <xref href="UnityEngine.Rendering.VolumeProfile" data-throw-if-not-resolved="false"></xref> for enhanced control over rendering and post-processing effects.
Examples

You can create a custom volume component by inheriting from this base class and defining your own. VolumeParameter fields. The VolumeManager will handle the interpolation and blending for you. 

using UnityEngine.Rendering;

[Serializable, VolumeComponentMenuForRenderPipeline("Custom/Example Component")]
public class ExampleComponent : VolumeComponent
{
public ClampedFloatParameter intensity = new ClampedFloatParameter(0f, 0f, 1f);
}

In the example above, the custom component `ExampleComponent` extends `VolumeComponent` and defines a parameter (`intensity`) that can be manipulated within the volume framework. The `ClampedFloatParameter` is a type of VolumeParameter<T> that ensures the value remains within a specified range.

Fields

active

The active state of the set of parameters defined in this class. You can use this to quickly turn on or off all the overrides at once.

Declaration
public bool active
Field Value
Type Description
bool

Properties

displayName

The name displayed in the component header. If you do not set a name, Unity generates one from the class name automatically.

Declaration
public string displayName { get; protected set; }
Property Value
Type Description
string

parameters

A read-only collection of all the VolumeParameters defined in this class.

Declaration
public ReadOnlyCollection<VolumeParameter> parameters { get; }
Property Value
Type Description
ReadOnlyCollection<VolumeParameter>

Methods

AnyPropertiesIsOverridden()

Returns true if any of the volume properites has been overridden.

Declaration
public bool AnyPropertiesIsOverridden()
Returns
Type Description
bool

True if any of the volume properites has been overridden.

GetHashCode()

A custom hashing function that Unity uses to compare the state of parameters.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A computed hash code for the current instance.
Overrides
UnityEngine.Object.GetHashCode()

GetSourceName(Component)

Declaration
public string GetSourceName(Component comp)
Parameters
Type Name Description
Component comp
Returns
Type Description
string

GetSourceTerm()

Declaration
public string GetSourceTerm()
Returns
Type Description
string

OnDestroy()

Unity calls this method before the object is destroyed.

Declaration
protected virtual void OnDestroy()

OnDisable()

Unity calls this method when the object goes out of scope.

Declaration
protected virtual void OnDisable()

OnEnable()

Unity calls this method when it loads the class.

Declaration
protected virtual void OnEnable()
Remarks

If you want to override this method, you must call base.OnEnable().

Override(VolumeComponent, float)

Interpolates a VolumeComponent with this component by an interpolation factor and puts the result back into the given VolumeComponent.

Declaration
public virtual void Override(VolumeComponent state, float interpFactor)
Parameters
Type Name Description
VolumeComponent state

The internal component to interpolate from. You must store the result of the interpolation in this same component.
float interpFactor

The interpolation factor in range [0,1].
Remarks

You can override this method to do your own blending. Either loop through the parameters list or reference direct fields. You should only use SetValue(VolumeParameter) to set parameter values and not assign directly to the state object. you should also manually check overrideState before you set any values.

Examples

Below is the default implementation for blending:

public virtual void Override(VolumeComponent state, float interpFactor)
{
    int count = parameters.Count;

for (int i = 0; i < count; i++)
{
    var stateParam = state.parameters[i];
    var toParam = parameters[i];

    if (toParam.overrideState)
    {
        // Keep track of the override state to ensure that state will be reset on next frame (and for debugging purpose)
        stateParam.overrideState = toParam.overrideState;
        stateParam.Interp(stateParam, toParam, interpFactor);
    }
}



}

Release()

Releases all the allocated resources.

Declaration
public void Release()

SetAllOverridesTo(bool)

Sets the state of all the overrides on this component to a given value.

Declaration
public void SetAllOverridesTo(bool state)
Parameters
Type Name Description
bool state

The value to set the state of the overrides to.

TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

Declaration
public bool TryGetApplyMethodForFieldName(SerializedProperty property, out Action<SerializedProperty> applyMethod)
Parameters
Type Name Description
SerializedProperty property
Action<SerializedProperty> applyMethod
Returns
Type Description
bool

TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

Declaration
public bool TryGetRevertMethodForFieldName(SerializedProperty property, out Action<SerializedProperty> revertMethod)
Parameters
Type Name Description
SerializedProperty property
Action<SerializedProperty> revertMethod
Returns
Type Description
bool

Implements

Extension Methods