Class Color

Color information and functionality. Colors are stored in RGBA format.

Index

Constructors

Accessors

alpha blue color green hex name red

Methods

getHSLAColor getHSLColor getRGBAHex getRGBHex

Constructors

constructor

new Color(color?): Color
Parameters
- Optionalcolor: Color | PaletteColor
  A p5.js Color or PaletteColor object. If given a p5.js Color, the color's RGBA components will become the values of red, green, blue, and alpha.
  If given a PaletteColor, the color's HEX value will be used to build the color.
Returns Color
- Defined in color/color.ts:67

Accessors

alpha

get alpha(): number
Returns number
The current alpha component value (0-255).
- Defined in color/color.ts:203
set alpha(a): void
Set the value of the alpha component.
Parameters
- a: number
Returns void
- Defined in color/color.ts:212

blue

get blue(): number
Returns number
The current blue component value (0-255).
- Defined in color/color.ts:185
set blue(b): void
Set the value of the blue component.
IMPORTANT: This method will set _name to null.
Parameters
- b: number
Returns void
- Defined in color/color.ts:195

color

get color(): Color
Returns Color
A p5.js Color object matching the current red, green, blue, and alpha values.
- Defined in color/color.ts:128
set color(c): void
Set the current color.
IMPORTANT: This method will set _name to null.
Parameters
- c: Color
  A p5.js Color object. The color's RGBA components will become the new values of red, green, blue, and alpha.
Returns void
- Defined in color/color.ts:141

green

get green(): number
Returns number
The current green component value (0-255).
- Defined in color/color.ts:167
set green(g): void
Set the value of the green component.
IMPORTANT: This method will set _name to null.
Parameters
- g: number
Returns void
- Defined in color/color.ts:177

hex

get hex(): string
Returns string
The hex color string for the RGB (red, green, blue) components of the color (#RRGGBB).
- Defined in color/color.ts:237

name

get name(): string
Returns string
The name of the color.
- Defined in color/color.ts:219

red

get red(): number
Returns number
The current red component value (0-255).
- Defined in color/color.ts:149
set red(r): void
Set the value of the red component.
IMPORTANT: This method will set _name to null.
Parameters
- r: number
Returns void
- Defined in color/color.ts:159

Methods

`Static`getHSLAColor

getHSLAColor(h, s, l, a): Color
Parameters
- h: number
  Some number between 0 and 360.
- s: number
  Some number between 0 and 100.
- l: number
  Some number between 0 and 100.
- a: number
  Some number between 0 and 1.
Returns Color
A p5.js Color object matching the color specified by the given hsla values.
- Defined in color/color.ts:120

`Static`getHSLColor

getHSLColor(h, s, l, a?): Color
Parameters
- h: number
  Some number between 0 and 360.
- s: number
  Some number between 0 and 100.
- l: number
  Some number between 0 and 100.
- Optionala: number
  Some number between 0 and 1.
Returns Color
A p5.js Color object matching the color specified by the given hsla values.
- Defined in color/color.ts:95

getRGBAHex

getRGBAHex(): string
The hex color string for the RGBA (red, green, blue, alpha) components of the color.

Returns string
- Defined in color/color.ts:268

getRGBHex

getRGBHex(withAlpha): string
The hex color string for the RGBA (red, green, blue, alpha) components of the color.
Parameters
- withAlpha: boolean
  if true, an alpha component will be included in the hex string (#RRGGBBAA).
  If false, only the RGB components will be included (#RRGGBB).
Returns string
- Defined in color/color.ts:250