Class Color

Index

Constructors

Properties

Accessors

a b g r

Methods

add clamp clone copy divide equal multiply reset setRGBA subtract toHexString Black Blue Brown Cyan fromHex fromNorm Gray Green Lime Magenta Orange Pink Purple Red Transparent White Yellow

Constructors

constructor

new Color(r: number, g: number, b: number, a?: number): Color
Creates an instance of Color.
Parameters
- r: number
  The red component (0-255).
- g: number
  The green component (0-255).
- b: number
  The blue component (0-255).
- a: number = 255
  The alpha component (0-255).
Returns Color
- Defined in color.ts:15

Properties

uint32

uint32: number

Accessors

a

get a(): number
Gets the alpha component.

Returns number
- Defined in color.ts:74
set a(value: number): void
Sets the alpha component and updates the uint32 representation.
Parameters
- value: number
  The new alpha component (0-255).
Returns void
- Defined in color.ts:82

b

get b(): number
Gets the blue component.

Returns number
- Defined in color.ts:58
set b(value: number): void
Sets the blue component and updates the uint32 representation.
Parameters
- value: number
  The new blue component (0-255).
Returns void
- Defined in color.ts:66

g

get g(): number
Gets the green component.

Returns number
- Defined in color.ts:42
set g(value: number): void
Sets the green component and updates the uint32 representation.
Parameters
- value: number
  The new green component (0-255).
Returns void
- Defined in color.ts:50

r

get r(): number
Gets the red component.

Returns number
- Defined in color.ts:26
set r(value: number): void
Sets the red component and updates the uint32 representation.
Parameters
- value: number
  The new red component (0-255).
Returns void
- Defined in color.ts:34

Methods

add

add(color: Color): Color
Adds the components of another color to this color, clamping the result to 255.
Parameters
- color: Color
  The color to add.
Returns Color
A new Color instance with the result of the addition.
- Defined in color.ts:204

clamp

clamp(): void
Returns void
- Defined in color.ts:261

clone

clone(): Color
Clone the current color

Returns Color
A new Color instance with the same RGBA values.
- Defined in color.ts:130

copy

copy(color: Color): void
Copies the RGBA values from another color.
Parameters
- color: Color
  The color to copy from.
Returns void
- Defined in color.ts:122

divide

divide(color: number | Color): Color
Parameters
- color: number | Color
Returns Color
- Defined in color.ts:226

equal

equal(color: Color): boolean
Checks if the current color is equal to another color.
Parameters
- color: Color
  The color to compare with.
Returns boolean
True if the colors are equal, otherwise false.
- Defined in color.ts:153

multiply

multiply(color: number | Color): Color
Parameters
- color: number | Color
Returns Color
- Defined in color.ts:244

reset

reset(): void
Returns void
- Defined in color.ts:95

setRGBA

setRGBA(r: number, g: number, b: number, a: number): void
Sets the RGBA values of the color and updates the uint32 representation.
Parameters
- r: number
  The red component (0-255).
- g: number
  The green component (0-255).
- b: number
  The blue component (0-255).
- a: number
  The alpha component (0-255).
Returns void
- Defined in color.ts:110

subtract

subtract(color: Color): Color
Subtracts the components of another color from this color, clamping the result to 0.
Parameters
- color: Color
  The color to subtract.
Returns Color
A new Color instance with the result of the subtraction.
- Defined in color.ts:218

toHexString

toHexString(includeAlpha?: boolean): string
Converts the color to a hexadecimal string representation (e.g., '#RRGGBBAA').
Parameters
- includeAlpha: boolean = true
  Whether to include the alpha channel in the hex string.
Returns string
The hexadecimal string representation of the color.
- Defined in color.ts:139

`Static`Black

Black(): Color
Returns Color
- Defined in color.ts:281

`Static`Blue

Blue(): Color
Returns Color
- Defined in color.ts:270

`Static`Brown

Brown(): Color
Returns Color
- Defined in color.ts:276

`Static`Cyan

Cyan(): Color
Returns Color
- Defined in color.ts:277

`Static`fromHex

fromHex(hexString: string): Color
Creates a Color instance from a hexadecimal color string.
Parameters
- hexString: string
  The hexadecimal color string, e.g., '#RRGGBB' or '#RRGGBBAA'.
Returns Color
A new Color instance.
- Defined in color.ts:185

`Static`fromNorm

fromNorm(r: number, g: number, b: number, a?: number): Color
Creates a Color instance from normalized float components (0–1 range). Use this instead of new Color() when working with shader-style 0.0–1.0 values.
Parameters
- r: number
  Red channel (0.0–1.0)
- g: number
  Green channel (0.0–1.0)
- b: number
  Blue channel (0.0–1.0)
- a: number = 1.0
  Alpha channel (0.0–1.0), defaults to 1.0
Returns Color
A new Color instance with components scaled to 0–255.
Example
```
Color.fromNorm(0.9, 0.87, 0.55, 0.1) // moon glow
```
- Defined in color.ts:171

`Static`Gray

Gray(): Color
Returns Color
- Defined in color.ts:275

`Static`Green

Green(): Color
Returns Color
- Defined in color.ts:269

`Static`Lime

Lime(): Color
Returns Color
- Defined in color.ts:279

`Static`Magenta

Magenta(): Color
Returns Color
- Defined in color.ts:278

`Static`Orange

Orange(): Color
Returns Color
- Defined in color.ts:273

`Static`Pink

Pink(): Color
Returns Color
- Defined in color.ts:274

`Static`Purple

Purple(): Color
Returns Color
- Defined in color.ts:272

`Static`Red

Red(): Color
Returns Color
- Defined in color.ts:268

`Static`Transparent

Transparent(): Color
Returns Color
- Defined in color.ts:282

`Static`White

White(): Color
Returns Color
- Defined in color.ts:280

`Static`Yellow

Yellow(): Color
Returns Color
- Defined in color.ts:271