Struct ColorHSV

Represents a color in the form of Hue, Saturation, Value, Alpha.

System.IEquatable<ColorHSV>
System.IFormattable
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
public struct ColorHSV : IEquatable<ColorHSV>, IFormattable

Constructors

ColorHSV(Single, Single, Single, Single)

Initializes a new instance of the ColorHSV struct.

Declaration
public ColorHSV(float h, float s, float v, float a)
Parameters
System.Single h

The hue.
System.Single s

The saturation.
System.Single v

The value.
System.Single a

The alpha.

Fields

A

The alpha component of the color.

Declaration
public float A
Field Value
System.Single

H

The Hue of the color.

Declaration
public float H
Field Value
System.Single

S

The Saturation of the color.

Declaration
public float S
Field Value
System.Single

V

The Value of the color.

Declaration
public float V
Field Value
System.Single

Methods

Equals(ColorHSV)

Declaration
public bool Equals(ColorHSV other)
Parameters
ColorHSV other

Returns
System.Boolean

Implements
System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

Overrides
System.ValueType.Equals(System.Object)

FromColor(Color)

Converts the color into a HSV color.

Declaration
public static ColorHSV FromColor(Color color)
Parameters
Color color

The color.
Returns
ColorHSV

A HSV color

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

Overrides
System.ValueType.GetHashCode()

ToColor()

Converts the color into a three component vector.

Declaration
public Color ToColor()
Returns
Color

A three component vector containing the red, green, and blue components of the color.

ToString()

Returns a System.String that represents this instance.

Declaration
public override string ToString()
Returns
System.String

A System.String that represents this instance.
Overrides
System.ValueType.ToString()

ToString(IFormatProvider)

Returns a System.String that represents this instance.

Declaration
public string ToString(IFormatProvider formatProvider)
Parameters
System.IFormatProvider formatProvider

The format provider.
Returns
System.String

A System.String that represents this instance.

ToString(String)

Returns a System.String that represents this instance.

Declaration
public string ToString(string format)
Parameters
System.String format

The format.
Returns
System.String

A System.String that represents this instance.

ToString(String, IFormatProvider)

Returns a System.String that represents this instance.

Declaration
public string ToString(string format, IFormatProvider formatProvider)
Parameters
System.String format

The format.
System.IFormatProvider formatProvider

The format provider.
Returns
System.String

A System.String that represents this instance.
Implements
System.IFormattable.ToString(System.String, System.IFormatProvider)

Extension Methods