Color | PIXI-Extended

Hierarchy

EventEmitter<ColorEvents>
- Color

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Color(red?: number, green?: number, blue?: number, alpha?: number): Color

Overrides EventEmitter.constructor
- Defined in source/src/utils/Color.ts:30
Creates a new color.

remarks

Values can only go up to 1.

Parameters
- red: number = 0
  
  The red value of the color, from 0 to 1.
- green: number = 0
  
  The green value of the color, from 0 to 1.
- blue: number = 0
  
  The blue value of the color, from 0 to 1.
- alpha: number = 1
  
  The alpha value of the color, from 0 to 1, default to 1.
Returns Color

Properties

Private _alpha

_alpha: number = 1

Private _blue

_blue: number = 0

Private _green

_green: number = 0

Private _red

_red: number = 0

Static Readonly BLACK

BLACK: Color = ...

Static Readonly BLUE

BLUE: Color = ...

Static Readonly GREEN

GREEN: Color = ...

Static Readonly RED

RED: Color = ...

Static Readonly WHITE

WHITE: Color = ...

Static prefixed

prefixed: string | boolean

Accessors

alpha

get alpha(): number
set alpha(value: number): void

- Defined in source/src/utils/Color.ts:153
Get the alpha value.

remarks

Alpha is the opacity, 1 means full visible, 0 means transparent.

Returns number
- The value, can only be from 0 up to 1.
- Defined in source/src/utils/Color.ts:164
Set the alpha value, emit the 'alphaChange' and 'change' events for the color.

remarks

Alpha is the transparency.

Parameters
- value: number
  
  The value, can only be form 0 up to 1.
Returns void
- The value, can only be from 0 up to 1.

blue

get blue(): number
set blue(value: number): void

- Defined in source/src/utils/Color.ts:131
Get the blue value.

Returns number
- The value, can only be from 0 up to 1.
- Defined in source/src/utils/Color.ts:140
Set the blue value, emit the 'blueChange' and 'change' events for the color.

Parameters
- value: number
  
  The value, can only be form 0 up to 1.
Returns void
- The value, can only be from 0 up to 1.

green

get green(): number
set green(value: number): void

- Defined in source/src/utils/Color.ts:111
Get the green value.

Returns number
- The value, can only be from 0 up to 1.
- Defined in source/src/utils/Color.ts:120
Set the green value, emit the 'greenChange' and 'change' events for the color.

Parameters
- value: number
  
  The value, can only be form 0 up to 1.
Returns void
- The value, can only be from 0 up to 1.

red

get red(): number
set red(value: number): void

- Defined in source/src/utils/Color.ts:91
Get the red value.

Returns number
- The value, can only be from 0 up to 1.
- Defined in source/src/utils/Color.ts:100
Set the red value, emit the 'redChange' and 'change' events for the color.

Parameters
- value: number
  
  The value, can only be form 0 up to 1.
Returns void
- The value, can only be from 0 up to 1.

rgb

get rgb(): RGB
set rgb(value: RGB): void

- Defined in source/src/utils/Color.ts:73
Returns an array containing the red, green and blue values.

Returns RGB
- The array.
- Defined in source/src/utils/Color.ts:82
Set the red, green and blue values from an array of these.

Parameters
- value: RGB
  
  The array.
Returns void
- The array.

rgba

get rgba(): RGBA
set rgba(value: RGBA): void

- Defined in source/src/utils/Color.ts:55
Returns an array containing the red, green, blue and alpha values.

Returns RGBA
- The array.
- Defined in source/src/utils/Color.ts:64
Set the red, green, blue and alpha values from an array of these.

Parameters
- value: RGBA
  
  The array.
Returns void
- The array.

Methods

addListener

addListener(event: string | symbol, fn: ListenerFn, context?: any): Color

Inherited from EventEmitter.addListener
- Defined in source/node_modules/eventemitter3/index.d.ts:33
Parameters
- event: string | symbol
- fn: ListenerFn
- Optional context: any
Returns Color

emit

emit<K>(event: K, ...args: ColorEvents[K]): boolean

Inherited from EventEmitter.emit
- Defined in source/src/utils/EventEmitter.ts:6
Calls each of the listeners registered for a given event.

Type parameters
- K: "change" | "redChange" | "greenChange" | "blueChange" | "alphaChange"
Parameters
- event: K
- Rest ...args: ColorEvents[K]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames
- Defined in source/node_modules/eventemitter3/index.d.ts:12
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]

invert

invert(): Color

- Defined in source/src/utils/Color.ts:303
Inverts the color returning its negative forme.

example

Color.WHITE.invert() === Color.BLACK;

Returns Color
- The resulting color.

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in source/node_modules/eventemitter3/index.d.ts:22
Return the number of listeners listening to a given event.

Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): ListenerFn[]

Inherited from EventEmitter.listeners
- Defined in source/node_modules/eventemitter3/index.d.ts:17
Return the listeners registered for a given event.

Parameters
- event: string | symbol
Returns ListenerFn[]

off

off(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): Color

Inherited from EventEmitter.off
- Defined in source/node_modules/eventemitter3/index.d.ts:44
Parameters
- event: string | symbol
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns Color

on

on<K>(event: K, fn: (...params: ColorEvents[K]) => void, context?: any): Color

Inherited from EventEmitter.on
- Defined in source/src/utils/EventEmitter.ts:10
Add a listener for a given event.

Type parameters
- K: "change" | "redChange" | "greenChange" | "blueChange" | "alphaChange"
Parameters
- event: K
- fn: (...params: ColorEvents[K]) => void
  - - (...params: ColorEvents[K]): void
    - Parameters
      - Rest ...params: ColorEvents[K]
      Returns void
- Optional context: any
Returns Color

once

once<K>(event: K, fn: (...params: ColorEvents[K]) => void, context?: any): Color

Inherited from EventEmitter.once
- Defined in source/src/utils/EventEmitter.ts:14
Add a one-time listener for a given event.

Type parameters
- K: "change" | "redChange" | "greenChange" | "blueChange" | "alphaChange"
Parameters
- event: K
- fn: (...params: ColorEvents[K]) => void
  - - (...params: ColorEvents[K]): void
    - Parameters
      - Rest ...params: ColorEvents[K]
      Returns void
- Optional context: any
Returns Color

removeAllListeners

removeAllListeners(event?: string | symbol): Color

Inherited from EventEmitter.removeAllListeners
- Defined in source/node_modules/eventemitter3/index.d.ts:49
Remove all listeners, or those of the specified event.

Parameters
- Optional event: string | symbol
Returns Color

removeListener

removeListener(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): Color

Inherited from EventEmitter.removeListener
- Defined in source/node_modules/eventemitter3/index.d.ts:43
Remove the listeners of a given event.

Parameters
- event: string | symbol
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns Color

set

set(red?: number, green?: number, blue?: number, alpha?: number): void

- Defined in source/src/utils/Color.ts:276
Sets the values of the color.

Parameters
- Optional red: number
  
  The red value.
- Optional green: number
  
  The green value.
- Optional blue: number
  
  The blue value.
- Optional alpha: number
  
  The alpha value.
Returns void

toHex

toHex(): number

- Defined in source/src/utils/Color.ts:291
Transforms the color to its hexadecimal form.

example

Color.RED.toHex() === 0xff0000

Returns number
- The resulting hexadecimal number.

toHexString

toHexString(): string

- Defined in source/src/utils/Color.ts:264
Transforms the color to its stringed hexadecimal form.

example

Color.BLUE.toHexString() === "#0000ff"

Returns string
- The resulting stringed hexadecimal form.

Static fromHex

fromHex(hex: number, alpha?: number): Color

- Defined in source/src/utils/Color.ts:252
Creates a color from a hexadecimal form.

example

Color.fromHex(0x000000) === Color.BLACK

Parameters
- hex: number
  
  The hexadecimal form of your color.
- Optional alpha: number
  
  The alpha value of the color, defaults to 1.
Returns Color
- The resulting color.

Static fromHexString

fromHexString(hexString: string | `#${string}`, alpha?: number): Color

- Defined in source/src/utils/Color.ts:233
Creates a color from a stringed hexadecimal form.

example

Color.fromHexString("#00ff00") === Color.GREEN

Parameters
- hexString: string | `#${string}`
  
  The stringed hexadecimal form of your color.
- Optional alpha: number
  
  The alpha value of the color, defaults to 1.
Returns Color
- The resulting color.

Static invert

invert(color: Color): Color

- Defined in source/src/utils/Color.ts:191
Inverts a color returning its negative forme.

example

Color.invert(Color.WHITE) === Color.BLACK;

Parameters
- color: Color
  
  The color to invert.
Returns Color
- The resulting color.

Static random

random(): Color
random(alpha: boolean): Color

- Defined in source/src/utils/Color.ts:170
Returns Color
- Defined in source/src/utils/Color.ts:171
Parameters
- alpha: boolean
Returns Color

Static toHex

toHex(color: Color): number

- Defined in source/src/utils/Color.ts:204
Transforms a color to its hexadecimal form.

example

Color.toHex(Color.RED) === 0xff0000

Parameters
- color: Color
  
  The color to get its hexadecimal form.
Returns number
- The resulting hexadecimal number.

Static toHexString

toHexString(color: Color): `#${string}`

- Defined in source/src/utils/Color.ts:217
Transforms a color to its stringed hexadecimal form.

example

Color.toHex(Color.BLUE) === "#0000ff"

Parameters
- color: Color
  
  The color to get its stringed hexadecimal form.
Returns `#${string}`
- The resulting stringed hexadecimal form.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

red: number = 0

green: number = 0

blue: number = 0

alpha: number = 1

Returns Color

Properties

Private _alpha

Private _blue

Private _green

Private _red

Static Readonly BLACK

Static Readonly BLUE

Static Readonly GREEN

Static Readonly RED

Static Readonly WHITE

Static prefixed

Accessors

alpha

Returns number

Parameters

value: number

Returns void

blue

Returns number

Parameters

value: number

Returns void

green

Returns number

Parameters

value: number

Returns void

red

Returns number

Parameters

value: number

Returns void

rgb

Returns RGB

Parameters

value: RGB

Returns void

rgba

Returns RGBA

Parameters

value: RGBA

Returns void

Methods

addListener

Parameters

event: string | symbol

fn: ListenerFn

Optional context: any

Returns Color

emit

Type parameters

K: "change" | "redChange" | "greenChange" | "blueChange" | "alphaChange"

Parameters

event: K

Rest ...args: ColorEvents[K]

Returns boolean

eventNames

Returns (string | symbol)[]

invert

Returns Color

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters