docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class VolumeParameter

    The base class for all parameters types stored in a VolumeComponent.

    Inheritance
    object
    VolumeParameter
    VolumeParameter<T>
    Implements
    ICloneable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Rendering
    Assembly: Unity.RenderPipelines.Core.Runtime.dll
    Syntax
    public abstract class VolumeParameter : ICloneable

    Fields

    Name Description
    k_DebuggerDisplay

    A beautified string for debugger output. This is set on a DebuggerDisplay on every parameter types.

    m_OverrideState

    The current override state for this parameter. The Volume system considers overriden parameters for blending, and ignores non-overriden ones.

    Properties

    Name Description
    overrideState

    The current override state for this parameter. The Volume system considers overriden parameters for blending, and ignores non-overriden ones.

    Methods

    Name Description
    Clone()

    Clones the current instance of the VolumeParameter

    GetValue<T>()

    Casts and gets the typed value of this parameter.

    IsObjectParameter(Type)

    Checks if a given type is an ObjectParameter<T>.

    OnDisable()

    Unity calls this method when the parent VolumeComponent goes out of scope.

    OnEnable()

    Unity calls this method when the parent VolumeComponent loads.

    Release()

    Override this method to free all allocated resources

    SetValue(VolumeParameter)

    Sets the value of this parameter to the value in parameter.

    Extension Methods

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

    See Also

    VolumeParameter<T>
    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)