Class Color

The Color class is a color based on RGBA.

Hierarchy

Color

Index

Constructors

Properties

m_alpha m_blue m_green m_red

Accessors

alpha blue green hex red rgba

Methods

clone compare copy darker lighter toHSB toRGB toRGBA fromHSB fromHex fromRGB fromRGBA random

Constructors

constructor

new Color(red?, green?, blue?, alpha?): Color
Constructs a color with the red, green, blue, and the alpha.
Parameters
- red: number = 255
- green: number = 255
- blue: number = 255
- alpha: number = 1.0
Returns Color
- Defined in core/color.ts:105

Properties

`Private` m_alpha

m_alpha: number

`Private` m_blue

m_blue: number

`Private` m_green

m_green: number

`Private` m_red

m_red: number

Accessors

alpha

get alpha(): number
Returns the alpha color component of this color.

Returns number
- Defined in core/color.ts:157
set alpha(alpha): void
Sets the alpha color component of this color to alpha that is specified in the range 0-1.0.
Parameters
- alpha: number
Returns void
- Defined in core/color.ts:164

blue

get blue(): number
Returns the blue color component of this color.

Returns number
- Defined in core/color.ts:143
set blue(blue): void
Sets the blue color component of this color to blue that is specified in the range 0-255.
Parameters
- blue: number
Returns void
- Defined in core/color.ts:150

green

get green(): number
Returns the green color component of this color.

Returns number
- Defined in core/color.ts:129
set green(green): void
Sets the green color component of this color to green that is specified in the range 0-255.
Parameters
- green: number
Returns void
- Defined in core/color.ts:136

hex

get hex(): string
Returns the string of this color in the specified format("#RRGGBB").

Returns string
- Defined in core/color.ts:182

red

get red(): number
Returns the red color component of this color.

Returns number
- Defined in core/color.ts:115
set red(red): void
Sets the red color component of this color to red that is specified in the range 0-255.
Parameters
- red: number
Returns void
- Defined in core/color.ts:122

rgba

get rgba(): string
Returns the rgba string("rgba(r, g, b, a)") of this color.

Returns string
- Defined in core/color.ts:171

Methods

clone

clone(): Color
Returns a copy of this color.

Returns Color
- Defined in core/color.ts:268

compare

compare(other): boolean
Returns true if this color and other are equal; otherwise returns false.
Parameters
- other: Color
Returns boolean
- Defined in core/color.ts:275

copy

copy(other): void
Copies the other color to this color.
Parameters
- other: Color
Returns void
- Defined in core/color.ts:258

darker

darker(dark): Color
Returns a darker color, but does not change this color.
Parameters
- dark: number
Returns Color
- Defined in core/color.ts:249

lighter

lighter(light): Color
Returns a lighter color, but does not change this color.
Parameters
- light: number
Returns Color
- Defined in core/color.ts:240

toHSB

toHSB(): HSB
Returns the HSB value of this color.

Returns HSB
- Defined in core/color.ts:206

toRGB

toRGB(): RGB
Returns the RGB value of this color.

Returns RGB
- Defined in core/color.ts:192

toRGBA

toRGBA(): RGBA
Returns the RGBA value of this color.

Returns RGBA
- Defined in core/color.ts:199

`Static` fromHSB

fromHSB(hsb): Color
Returns a color constructed from the HSB, h (hue), s (saturation), b (brightness). The value of s, v must all be in the range 0-100; the value of h must be in the range 0-360.
Parameters
- hsb: HSB
Returns Color
- Defined in core/color.ts:60

`Static` fromHex

fromHex(hex): Color
Returns a color parsed from hex string("#RRGGBB").
Parameters
- hex: string
Returns Color
- Defined in core/color.ts:47

`Static` fromRGB

fromRGB(rgb): Color
Returns a color constructed from the given rgb.
Parameters
- rgb: RGB
Returns Color
- Defined in core/color.ts:29

`Static` fromRGBA

fromRGBA(rgba): Color
Returns a color constructed from the given rgba. The alpha component of the color should be within the range of 0 to 1.0.
Parameters
- rgba: RGBA
Returns Color
- Defined in core/color.ts:38

`Static` random

random(): Color
Returns a random color.

Returns Color
- Defined in core/color.ts:94

Generated using TypeDoc