Class ColorParameter

A VolumeParameter that holds a Color value.

Inheritance

Object

VolumeParameter

VolumeParameter<Color>

ColorParameter

Inherited Members

VolumeParameter<Color>.m_Value

VolumeParameter<Color>.value

VolumeParameter<Color>.Override(Color)

VolumeParameter<Color>.SetValue(VolumeParameter)

VolumeParameter<Color>.GetHashCode()

VolumeParameter<Color>.ToString()

VolumeParameter<Color>.Equals(VolumeParameter<Color>)

VolumeParameter<Color>.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 ColorParameter : VolumeParameter<Color>, IEquatable<VolumeParameter<Color>>

Constructors

ColorParameter(Color, Boolean)

Creates a new ColorParameter instance.

Declaration

public ColorParameter(Color value, bool overrideState = false)

Parameters

Type	Name	Description
Color	value	The initial value to store in the parameter.
Boolean	overrideState	The initial override state for the parameter.

ColorParameter(Color, Boolean, Boolean, Boolean, Boolean)

Creates a new ColorParameter instance.

Declaration

public ColorParameter(Color value, bool hdr, bool showAlpha, bool showEyeDropper, bool overrideState = false)

Parameters

Type	Name	Description
Color	value	The initial value to store in the parameter.
Boolean	hdr	Specifies whether the color is HDR or not.
Boolean	showAlpha	Specifies whether you can edit the alpha channel in the Inspector or not.
Boolean	showEyeDropper	Specifies whether the eye dropper is visible in the editor or not.
Boolean	overrideState	The initial override state for the parameter.

Fields

hdr

Is this color HDR?

Declaration

[NonSerialized]
public bool hdr

Field Value

Type	Description
Boolean

showAlpha

Should the alpha channel be editable in the editor?

Declaration

[NonSerialized]
public bool showAlpha

Field Value

Type	Description
Boolean

showEyeDropper

Should the eye dropper be visible in the editor?

Declaration

[NonSerialized]
public bool showEyeDropper

Field Value

Type	Description
Boolean

Methods

Interp(Color, Color, Single)

Interpolates between two Color values.

Declaration

public override void Interp(Color from, Color to, float t)

Parameters

Type	Name	Description
Color	from	The start value.
Color	to	The end value.
Single	t	The interpolation factor in range [0,1].

Overrides

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

Remarks

For performance reasons, this function interpolates the RGBA channels directly.

Extension Methods

ReflectionUtils.Invoke(Object, String, Object[])

ReflectionUtils.SetField(Object, String, Object)

ReflectionUtils.GetField(Object, String)

ReflectionUtils.GetFields(Object)

See Also

NoInterpColorParameter