Class VolumeComponent

The base class for all the components that can be part of a VolumeProfile. The Volume framework automatically handles and interpolates any VolumeParameter members found in this class.

Inheritance

object

Object

ScriptableObject

VolumeComponent

ProbeVolumesOptions

Implements

IApplyRevertPropertyContextMenuItemProvider

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering

Assembly: Unity.RenderPipelines.Core.Runtime.dll

Syntax

[Serializable]
public class VolumeComponent : ScriptableObject, IApplyRevertPropertyContextMenuItemProvider

Examples

using UnityEngine.Rendering;

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

Fields

Name	Description
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.

Properties

Name	Description
displayName	The name displayed in the component header. If you do not set a name, Unity generates one from the class name automatically.
parameters	A read-only collection of all the VolumeParameters defined in this class.

Methods

Name	Description
AnyPropertiesIsOverridden()	Returns true if any of the volume properites has been overridden.
GetHashCode()	A custom hashing function that Unity uses to compare the state of parameters.
GetSourceName(Component)
GetSourceTerm()
OnDestroy()	Unity calls this method before the object is destroyed.
OnDisable()	Unity calls this method when the object goes out of scope.
OnEnable()	Unity calls this method when it loads the class.
Override(VolumeComponent, float)	Interpolates a VolumeComponent with this component by an interpolation factor and puts the result back into the given VolumeComponent.
Release()	Releases all the allocated resources.
SetAllOverridesTo(bool)	Sets the state of all the overrides on this component to a given value.
TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)
TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

Extension Methods

AnalyticsUtils.ToNestedColumnWithDefault<T>(T, T, bool)

AnalyticsUtils.ToNestedColumn<T>(T, bool)