ClassColors

Conversions between RGBA, HSLA and the 32-bit color values (Color, 0xRRGGBBAA) that the image methods take and return, and gradients between colors

Index

Methods

fromHSL fromHSLA fromRGB fromRGBA gradient toHSLA toRGB toRGBA

Methods

`Static`fromHSL

fromHSL(h: number, s: number, l: number): number
Converts HSL colors to RGBA colors (assuming an opacity of 255)
Parameters
- h: number
  hue (0..1)
- s: number
  saturation (0..1)
- l: number
  lightness (0..1)
Returns number
color
- Defined in src/colors.ts:158

`Static`fromHSLA

fromHSLA(h: number, s: number, l: number, a: number): number
Converts HSLA colors to RGBA colors
Parameters
- h: number
  hue (0..1)
- s: number
  saturation (0..1)
- l: number
  lightness (0..1)
- a: number
  opacity (0..1)
Returns number
color
- Defined in src/colors.ts:126

`Static`fromRGB

fromRGB(r: number, g: number, b: number): number
Converts RGB components to an RGBA value (assuming alpha = 255)
Parameters
- r: number
  red (0..255)
- g: number
  green (0..255)
- b: number
  blue (0..255)
Returns number
RGBA value
- Defined in src/colors.ts:114

`Static`fromRGBA

fromRGBA(r: number, g: number, b: number, a: number): number
Converts RGBA components to an RGBA value, values are rounded and clamped to 0..255
Parameters
- r: number
  red (0..255)
- g: number
  green (0..255)
- b: number
  blue (0..255)
- a: number
  alpha (0..255)
Returns number
RGBA value
- Defined in src/colors.ts:99

`Static`gradient

gradient(colors: Record<number, number>): (position: number) => number
Creates a multi-point gradient generator
Parameters
- colors: Record<number, number>
  The gradient points to use (e.g. {0: 0xff0000ff, 1: 0x00ff00ff})
Returns (position: number) => number
The gradient generator. The function argument is the position in the gradient (0..1).
- Defined in src/colors.ts:198

`Static`toHSLA

toHSLA(color: number): [h: number, s: number, l: number, a: number]
Converts a color to an array of HSLA values
Parameters
- color: number
  The color value to convert
Returns [h: number, s: number, l: number, a: number]
The HSLA values ([H, S, L, A]), H and S and L and A in 0..1
- Defined in src/colors.ts:187

`Static`toRGB

toRGB(color: number): [r: number, g: number, b: number]
Converts a color value to an array of RGB values (ignoring the colors alpha)
Parameters
- color: number
  The color value to convert
Returns [r: number, g: number, b: number]
The RGB values ([R, G, B])
- Defined in src/colors.ts:177

`Static`toRGBA

toRGBA(color: number): [r: number, g: number, b: number, a: number]
Converts a color value to an array of RGBA values
Parameters
- color: number
  The color value to convert
Returns [r: number, g: number, b: number, a: number]
The RGBA values ([R, G, B, A])
- Defined in src/colors.ts:167