docs.unity3d.com
    Show / Hide Table of Contents

    Class ClampedFloatParameter

    A VolumeParameter that holds a float value clamped between a minimum and a maximum value.

    Inheritance
    Object
    VolumeParameter
    VolumeParameter<Single>
    FloatParameter
    ClampedFloatParameter
    Inherited Members
    FloatParameter.Interp(Single, Single, Single)
    VolumeParameter<Single>.m_Value
    VolumeParameter<Single>.Override(Single)
    VolumeParameter<Single>.SetValue(VolumeParameter)
    VolumeParameter<Single>.GetHashCode()
    VolumeParameter<Single>.ToString()
    VolumeParameter<Single>.Equals(VolumeParameter<Single>)
    VolumeParameter<Single>.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 ClampedFloatParameter : FloatParameter, IEquatable<VolumeParameter<float>>

    Constructors

    ClampedFloatParameter(Single, Single, Single, Boolean)

    Creates a new ClampedFloatParameter instance.

    Declaration
    public ClampedFloatParameter(float value, float min, float max, bool overrideState = false)
    Parameters
    Type Name Description
    Single 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 float value { get; set; }
    Property Value
    Type Description
    Single
    Overrides
    UnityEngine.Rendering.VolumeParameter<System.Single>.value
    Remarks

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

    Extension Methods

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

    See Also

    FloatParameter
    MinFloatParameter
    MaxFloatParameter
    FloatRangeParameter
    NoInterpFloatParameter
    NoInterpMinFloatParameter
    NoInterpMaxFloatParameter
    NoInterpClampedFloatParameter
    NoInterpFloatRangeParameter
    Back to top
    Terms of use
    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