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
Namespace: UnityEngine.Rendering
Syntax
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
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 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.

See Also