Class HueSaturationValue

The HueSaturationValue class implements a color in the hue-saturation-value colorspace. The color can be converted to and from an SRGBColor.

Index

Constructors

Properties

hue saturation value

Methods

add doAdd doMultiply multiply toColor toLinearColor toRGB toSRGBColor toString withColor

Constructors

constructor

new HueSaturationValue(
    hue?: number,
    saturation?: number,
    value?: number,
): HueSaturationValue
Parameters
- Optionalhue: number
- Optionalsaturation: number
- Optionalvalue: number
Returns HueSaturationValue

Properties

hue

hue: number

The hue component.

saturation

saturation: number

The satuartion component.

value

value: number

The value component.

Methods

add

add(hue: number, saturation: number, value: number): HueSaturationValue
Adds the given HueSaturationValue to this one and returns the result.
Parameters
- hue: number
  The hue component to add.
- saturation: number
  The saturation component to add.
- value: number
  The value component to add.
Returns HueSaturationValue
The resulting HueSaturationValue.

doAdd

doAdd(hue: number, saturation: number, value: number): HueSaturationValue
Adds the given HueSaturationValue to this one.
Parameters
- hue: number
  The hue component to add.
- saturation: number
  The saturation component to add.
- value: number
  The value component to add.
Returns HueSaturationValue
The current HueSaturationValue instance.

doMultiply

doMultiply(hue: number, saturation: number, value: number): HueSaturationValue
Multiplies the current hue, saturation, and value by the provided values.
Parameters
- hue: number
  The multiplier for the hue component.
- saturation: number
  The multiplier for the saturation component.
- value: number
  The multiplier for the value component.
Returns HueSaturationValue
The updated HueSaturationValue instance.

multiply

multiply(hue: number, saturation: number, value: number): HueSaturationValue
Multiplies the given values with this one and returns the result as a copy.
Parameters
- hue: number
  The hue component to multiply.
- saturation: number
  The saturation component to multiply.
- value: number
  The value component to multiply.
Returns HueSaturationValue
The resulting HueSaturationValue.

toColor

toColor(): Color

Converts the HueSaturationValue color into RGB color space as Color.

Returns Color
Color.

Note
No further color-space transformation is done. The HSV values of this instance are assumed to be in the same color-space as the resulting color value.

toLinearColor

toLinearColor(): LinearColor

Converts the HueSaturationValue color into RGB color space as LinearColor.

Returns LinearColor
LinearColor.

Note
No further color-space transformation is done. The HSV values of this instance are assumed to be in the same color-space as the resulting color value.

toRGB

toRGB(): { b: number; g: number; r: number }

Converts the HueSaturationValue color into RGB color space.

Returns { b: number; g: number; r: number }
Color in RGB color space.

toSRGBColor

toSRGBColor(): SRGBColor

Converts the HueSaturationValue color into RGB color space as SRGBColor.

Returns SRGBColor
SRGBColor.

Note
No further color-space transformation is done. The HSV values of this instance are assumed to be in the same color-space as the resulting color value.

toString

toString(): string

Returns string

`Static`withColor

withColor(
color: Immutable<Color> | Immutable<SRGBColor> | Immutable<LinearColor>,
): HueSaturationValue
Converts the color to a HueSaturationValue representation.
Parameters
- color: Immutable<Color> | Immutable<SRGBColor> | Immutable<LinearColor>
  The input Color, SRGBColor or LinearColor.
Returns HueSaturationValue
The srgbColor represented in HSV colorspace.