docs.unity3d.com
    Show / Hide Table of Contents

    Class FloatRangeParameter

    A VolumeParameter that holds a Vector2 value holding a range of two float values clamped between a minimum and a maximum value.

    Inheritance
    Object
    VolumeParameter
    VolumeParameter<Vector2>
    FloatRangeParameter
    Inherited Members
    VolumeParameter<Vector2>.m_Value
    VolumeParameter<Vector2>.Override(Vector2)
    VolumeParameter<Vector2>.SetValue(VolumeParameter)
    VolumeParameter<Vector2>.GetHashCode()
    VolumeParameter<Vector2>.ToString()
    VolumeParameter<Vector2>.Equals(VolumeParameter<Vector2>)
    VolumeParameter<Vector2>.Equals(Object)
    VolumeParameter.k_DebuggerDisplay
    VolumeParameter.m_OverrideState
    VolumeParameter.overrideState
    VolumeParameter.GetValue<T>()
    VolumeParameter.OnEnable()
    VolumeParameter.OnDisable()
    VolumeParameter.IsObjectParameter(Type)
    VolumeParameter.Release()
    Namespace: UnityEngine.Rendering
    Syntax
    [Serializable]
    public class FloatRangeParameter : VolumeParameter<Vector2>, IEquatable<VolumeParameter<Vector2>>

    Constructors

    FloatRangeParameter(Vector2, Single, Single, Boolean)

    Creates a new FloatRangeParameter instance.

    Declaration
    public FloatRangeParameter(Vector2 value, float min, float max, bool overrideState = false)
    Parameters
    Type Name Description
    Vector2 value

    The initial value to store in the parameter.

    Single min

    The minimum value to clamp the parameter to

    Single max

    The maximum value to clamp the parameter to.

    Boolean overrideState

    The initial override state for the parameter.

    Fields

    max

    The maximum value to clamp this parameter to.

    Declaration
    [NonSerialized]
    public float max
    Field Value
    Type Description
    Single

    min

    The minimum value to clamp this parameter to.

    Declaration
    [NonSerialized]
    public float min
    Field Value
    Type Description
    Single

    Properties

    value

    The value that this parameter stores.

    Declaration
    public override Vector2 value { get; set; }
    Property Value
    Type Description
    Vector2
    Overrides
    UnityEngine.Rendering.VolumeParameter<UnityEngine.Vector2>.value
    Remarks

    You can override this property to define custom behaviors when the value is changed.

    Methods

    Interp(Vector2, Vector2, Single)

    Interpolates between two Vector2 values.

    Declaration
    public override void Interp(Vector2 from, Vector2 to, float t)
    Parameters
    Type Name Description
    Vector2 from

    The start value

    Vector2 to

    The end value

    Single t

    The interpolation factor in range [0,1]

    Overrides
    UnityEngine.Rendering.VolumeParameter<UnityEngine.Vector2>.Interp(UnityEngine.Vector2, UnityEngine.Vector2, System.Single)

    Extension Methods

    ReflectionUtils.Invoke(Object, String, Object[])
    ReflectionUtils.SetField(Object, String, Object)
    ReflectionUtils.GetField(Object, String)
    ReflectionUtils.GetFields(Object)

    See Also

    FloatParameter
    MinFloatParameter
    MaxFloatParameter
    ClampedFloatParameter
    NoInterpFloatParameter
    NoInterpMinFloatParameter
    NoInterpMaxFloatParameter
    NoInterpClampedFloatParameter
    NoInterpFloatRangeParameter
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023