Class Color

Represents an RGB color using values ranging from O and 1 for each color component.

Implements

ColorUtils.IColor

Index

Constructors

constructor

new Color(): Color
Create a new instance from either:
- a (R, G, B) triplet (values ranging from 0 to 1)
- a 24 bit color value
- an hexadecimal color string (web style)
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:20
new Color(r: number, g: number, b: number): Color
Parameters
- r: number
- g: number
- b: number
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:21
new Color(color: ColorUtils.IColor): Color
Parameters
- color: ColorUtils.IColor
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:22
new Color(color24: number): Color
Parameters
- color24: number
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:23
new Color(hexColor: string): Color
Parameters
- hexColor: string
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:24

Properties

b

b: number

g

g: number

r

r: number

`Static` `Readonly`black

black: Readonly<Color>

`Static` `Readonly`blue

blue: Readonly<Color>

`Static` `Readonly`brightBlue

brightBlue: Readonly<Color>

`Static` `Readonly`brightCyan

brightCyan: Readonly<Color>

`Static` `Readonly`brightGreen

brightGreen: Readonly<Color>

`Static` `Readonly`brightMagenta

brightMagenta: Readonly<Color>

`Static` `Readonly`brightOrange

brightOrange: Readonly<Color>

`Static` `Readonly`brightPurple

brightPurple: Readonly<Color>

`Static` `Readonly`brightRed

brightRed: Readonly<Color>

`Static` `Readonly`brightWhite

brightWhite: Readonly<Color>

`Static` `Readonly`brightYellow

brightYellow: Readonly<Color>

`Static` `Readonly`cyan

cyan: Readonly<Color>

`Static` `Readonly`dimBlue

dimBlue: Readonly<Color>

`Static` `Readonly`dimCyan

dimCyan: Readonly<Color>

`Static` `Readonly`dimGreen

dimGreen: Readonly<Color>

`Static` `Readonly`dimMagenta

dimMagenta: Readonly<Color>

`Static` `Readonly`dimOrange

dimOrange: Readonly<Color>

`Static` `Readonly`dimRed

dimRed: Readonly<Color>

`Static` `Readonly`dimWhite

dimWhite: Readonly<Color>

`Static` `Readonly`dimYellow

dimYellow: Readonly<Color>

`Static` `Readonly`faintWhite

faintWhite: Readonly<Color>

`Static` `Readonly`green

green: Readonly<Color>

`Static` `Readonly`magenta

magenta: Readonly<Color>

`Static` `Readonly`mediumWhite

mediumWhite: Readonly<Color>

`Static` `Readonly`orange

orange: Readonly<Color>

`Static` `Readonly`red

red: Readonly<Color>

`Static` `Readonly`white

white: Readonly<Color>

`Static` `Readonly`yellow

yellow: Readonly<Color>

Accessors

bByte

get bByte(): number
Returns number
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:13

gByte

get gByte(): number
Returns number
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:12

rByte

get rByte(): number
Returns number
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:11

Methods

assign

assign(other: ColorUtils.IColor): Color
Parameters
- other: ColorUtils.IColor
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:26

desaturate

desaturate(): number
Returns number
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:28

duplicate

duplicate(): Color
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:27

equals

equals(other: ColorUtils.IColor): boolean
Parameters
- other: ColorUtils.IColor
Returns boolean
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:25

serialize

serialize(
dataView: DataView,
byteOffset?: number,
): [DataView<ArrayBufferLike>, number]
Parameters
- dataView: DataView
- OptionalbyteOffset: number
Returns [DataView<ArrayBufferLike>, number]
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:29

set

set(r: number, g: number, b: number): Color
Parameters
- r: number
- g: number
- b: number
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:32

setWithBytes

setWithBytes(rByte: number, gByte: number, bByte: number): Color
Parameters
- rByte: number
- gByte: number
- bByte: number
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:33

setWithHex

setWithHex(hexColor: string): Color
Parameters
- hexColor: string
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:35

setWithValue

setWithValue(color24: number): Color
Parameters
- color24: number
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:34

toColor32

toColor32(): number
Returns number
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:31

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:30

`Static`fromBytes

fromBytes(rByte: number, gByte: number, bByte: number): Color
Parameters
- rByte: number
- gByte: number
- bByte: number
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:36

`Static`fromString

fromString(hexColor: string): Color
Parameters
- hexColor: string
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:37

`Static`lerp

lerp(color1: Color, color2: Color, t: number): Color
Parameters
- color1: Color
- color2: Color
- t: number
Returns Color
- Defined in packages/pixels-core-animation/dist/src/color/Color.d.ts:38

Class Color

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Color

Parameters

Returns Color

Parameters

Returns Color

Parameters

Returns Color

Parameters

Returns Color

Properties

b

g

r

Static Readonlyblack

Static Readonlyblue

Static ReadonlybrightBlue

Static ReadonlybrightCyan

Static ReadonlybrightGreen

Static ReadonlybrightMagenta

Static ReadonlybrightOrange

Static ReadonlybrightPurple

Static ReadonlybrightRed

Static ReadonlybrightWhite

Static ReadonlybrightYellow

Static Readonlycyan

Static ReadonlydimBlue

Static ReadonlydimCyan

Static ReadonlydimGreen

Static ReadonlydimMagenta

Static ReadonlydimOrange

Static ReadonlydimRed

Static ReadonlydimWhite

Static ReadonlydimYellow

Static ReadonlyfaintWhite

Static Readonlygreen

Static Readonlymagenta

Static ReadonlymediumWhite

Static Readonlyorange

Static Readonlyred

Static Readonlywhite

Static Readonlyyellow

Accessors

bByte

Returns number

gByte

Returns number

rByte

Returns number

Methods

assign

Parameters

Returns Color

desaturate

Returns number

duplicate

Returns Color

equals

Parameters

Returns boolean

serialize

Parameters

Returns [DataView<ArrayBufferLike>, number]

set

Parameters

Returns Color

setWithBytes

Parameters

Returns Color

setWithHex

Parameters

Returns Color

`Static` `Readonly`black

`Static` `Readonly`blue

`Static` `Readonly`brightBlue

`Static` `Readonly`brightCyan

`Static` `Readonly`brightGreen

`Static` `Readonly`brightMagenta

`Static` `Readonly`brightOrange

`Static` `Readonly`brightPurple

`Static` `Readonly`brightRed

`Static` `Readonly`brightWhite

`Static` `Readonly`brightYellow

`Static` `Readonly`cyan

`Static` `Readonly`dimBlue

`Static` `Readonly`dimCyan

`Static` `Readonly`dimGreen

`Static` `Readonly`dimMagenta

`Static` `Readonly`dimOrange

`Static` `Readonly`dimRed

`Static` `Readonly`dimWhite

`Static` `Readonly`dimYellow

`Static` `Readonly`faintWhite

`Static` `Readonly`green

`Static` `Readonly`magenta

`Static` `Readonly`mediumWhite

`Static` `Readonly`orange

`Static` `Readonly`red

`Static` `Readonly`white

`Static` `Readonly`yellow

`Static`fromBytes

`Static`fromString

`Static`lerp