Class Color4

Readonly a

Readonly b

Readonly g

Readonly r

Static black

Static blue

Static clay

Static gray

Static green

Static orange

Static purple

Static red

Static transparent

Static white

Static yellow

rgb

• get rgb(): Vec3

• Ignoring this color's alpha component, returns a vector with components, $$\begin{pmatrix} \colorbox{#F44}{\tt r} \ \colorbox{#4F4}{\tt g} \ \colorbox{#44F}{\tt b} \end{pmatrix}$$

  Returns Vec3

asHSV

• asHSV(): Vec3

• Converts to (hue, saturation, value). See also https://en.wikipedia.org/wiki/HSL_and_HSV#General_approach

  The resultant hue is represented in radians and is thus in $[0, 2\pi]$.

  Returns Vec3

eq

• eq(other): boolean

• Parameters

  • other: undefined | null | Color4

  Returns boolean

  true if this and other are approximately equal.

mix

• mix(other, fractionTo): Color4

• If fractionTo is not in the range $[0, 1]$, it will be clamped to the nearest number in that range. For example, a.mix(b, -1) is equivalent to a.mix(b, 0).

  Parameters

  • other: Color4

  • fractionTo: number

  Returns Color4

  a color fractionTo of the way from this color to other.

  Example

  Color4.ofRGB(1, 0, 0).mix(Color4.ofRGB(0, 1, 0), 0.1) // -> Color4(0.9, 0.1, 0)
  Copy

relativeLuminance

• relativeLuminance(): number

• Returns the relative luminance of this color in the sRGB color space.

  Ignores the alpha component.

  Returns number

toHexString

• toHexString(): string

• Returns string

  a hexadecimal color string representation of this, in the form #rrggbbaa.

  Example

  Color4.red.toHexString(); // -> #ff0000ff
  Copy

toString

• toString(): string

• Returns string

Static average

• average(colors): Color4

• Parameters

  • colors: Color4[]

  Returns Color4

  the component-wise average of colors, or Color4.transparent if colors is empty.

Static contrastRatio

• contrastRatio(colorA, colorB): number

• Returns the contrast ratio between colorA and colorB.

  Parameters

  • colorA: Color4

  • colorB: Color4

  Returns number

Static fromHSV

• fromHSV(hue, saturation, value): Color4

• Creates a new Color4 from a representation in $HSV$.

  Algorithm.

  Note that hue must be given in radians. While non-standard, this is consistent with asHSV.

  hue and value should range from 0 to 1.

  Parameters

  • hue: number

    $H \in [0, 2\pi]$

  • saturation: number

    $S_V \in [0, 1]$

  • value: number

    $V \in [0, 1]$

  Returns Color4

Static fromHex

• fromHex(hexString): Color4

• Parameters

  • hexString: string

  Returns Color4

Static fromRGBVector

• fromRGBVector(rgb, alpha?): Color4

• Equivalent to ofRGB(rgb.x, rgb.y, rgb.z).

  All components should be in the range [0, 1] (0 to 1 inclusive).

  Parameters

  • rgb: Vec3

  • Optional alpha: number

  Returns Color4

Static fromString

• fromString(text): Color4

• Like fromHex, but can handle additional colors if an HTMLCanvasElement is available.

  Parameters

  • text: string

  Returns Color4

Static ofRGB

• ofRGB(red, green, blue): Color4

• Create a color from red, green, blue components. The color is fully opaque (a = 1.0).

  Each component should be in the range [0, 1].

  Parameters

  • red: number

  • green: number

  • blue: number

  Returns Color4

Static ofRGBA

• ofRGBA(red, green, blue, alpha): Color4

• Parameters

  • red: number

  • green: number

  • blue: number

  • alpha: number

  Returns Color4