Class Color4

Readonlya

Readonlyb

Readonlyg

Readonlyr

Staticblack

Staticblue

Staticclay

Staticgray

Staticgreen

Staticorange

Staticpurple

Staticred

Statictransparent

Staticwhite

Staticyellow

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: undefined | null | Color4): boolean

• Parameters

  • other: undefined | null | Color4

  Returns boolean

  true if this and other are approximately equal.

mix

• mix(other: Color4, fractionTo: number): 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

withAlpha

• withAlpha(a: number): Color4

• Returns a new color with a different opacity.

  Parameters

  • a: number

  Returns Color4

Staticaverage

• average(colors: Color4[]): Color4

• Parameters

  • colors: Color4[]

  Returns Color4

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

StaticcontrastRatio

• contrastRatio(colorA: Color4, colorB: Color4): number

• Returns the contrast ratio between colorA and colorB.

  Parameters

  • colorA: Color4
  • colorB: Color4

  Returns number

StaticfromHex

• fromHex(hexString: string): Color4

• Creates a Color4 from a three or four-component hexadecimal color string.

  Example:

  import { Color4 } from '@js-draw/math';
  console.log(Color4.fromHex('#ff0'));
  

  Parameters

  • hexString: string

  Returns Color4

StaticfromHSV

• fromHSV(hue: number, saturation: number, value: number): 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

StaticfromRGBArray

• fromRGBArray(
      array: number[] | Uint8Array | Uint8ClampedArray,
      maxValue?: number,
  ): Color4

• Creates a color from an RGB (or RGBA) array.

  This is similar to ofRGB and ofRGBA, but, by default, takes values that range from 0 to 255.

  If the array values instead range from 0-1, pass maxValue as 1.

  Parameters

  • array: number[] | Uint8Array | Uint8ClampedArray
  • maxValue: number = 255

  Returns Color4

StaticfromRGBVector

• fromRGBVector(rgb: Vec3, alpha?: number): 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
  • Optionalalpha: number

  Returns Color4

StaticfromString

• fromString(text: string): Color4

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

  Parameters

  • text: string

  Returns Color4

StaticofRGB

• ofRGB(red: number, green: number, blue: number): 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

StaticofRGBA

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

• Creates a color from red, green, blue, and transparency components. Each component should be in the range $[0, 1]$.

  Parameters

  • red: number
  • green: number
  • blue: number
  • alpha: number

  Returns Color4