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
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
public float max
Field Value
Type Description
Single

min

The minimum value to clamp this parameter to.

Declaration
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)

See Also