Class ColorMatrix

The ColorMatrix FX Controller.

This FX controller manages the color matrix effect for a Game Object.

The color matrix effect is a visual technique that involves manipulating the colors of an image or scene using a mathematical matrix. This process can adjust hue, saturation, brightness, and contrast, allowing developers to create various stylistic appearances or mood settings within the game. Common applications include simulating different lighting conditions, applying color filters, or achieving a specific visual style.

A ColorMatrix effect is added to a Game Object via the FX component:

const sprite = this.add.sprite();

sprite.preFX.addColorMatrix();
sprite.postFX.addColorMatrix();

Hierarchy (View Summary)

Display.ColorMatrix
- ColorMatrix

Constructors

constructor

new ColorMatrix(gameObject: GameObject): FX.ColorMatrix
Parameters
- gameObject: GameObject
  A reference to the Game Object that has this fx.
Returns FX.ColorMatrix
Overrides ColorMatrix.constructor
- Defined in types/phaser.d.ts:10406

Properties

active

active: boolean

Toggle this boolean to enable or disable this effect, without removing and adding it from the Game Object.

alpha

alpha: number

The value that determines how much of the original color is used when mixing the colors. A value between 0 (all original) and 1 (all final)

gameObject

gameObject: GameObject

A reference to the Game Object that owns this effect.

type

type: number

The FX_CONST type of this effect.

`Static` `Readonly`BLACK_WHITE

BLACK_WHITE: number[]

A constant array used by the ColorMatrix class for black_white operations.

`Static` `Readonly`BROWN

BROWN: number[]

A constant array used by the ColorMatrix class for brown operations.

`Static` `Readonly`DESATURATE_LUMINANCE

DESATURATE_LUMINANCE: number[]

A constant array used by the ColorMatrix class for desatured luminance operations.

`Static` `Readonly`KODACHROME

KODACHROME: number[]

A constant array used by the ColorMatrix class for kodachrome operations.

`Static` `Readonly`LSD

LSD: number[]

A constant array used by the ColorMatrix class for lsd operations.

`Static` `Readonly`NEGATIVE

NEGATIVE: number[]

A constant array used by the ColorMatrix class for negative operations.

`Static` `Readonly`POLAROID

POLAROID: number[]

A constant array used by the ColorMatrix class for polaroid shift operations.

`Static` `Readonly`SEPIA

SEPIA: number[]

A constant array used by the ColorMatrix class for sepia operations.

`Static` `Readonly`SHIFT_BGR

SHIFT_BGR: number[]

A constant array used by the ColorMatrix class for shift BGR operations.

`Static` `Readonly`TECHNICOLOR

TECHNICOLOR: number[]

A constant array used by the ColorMatrix class for technicolor operations.

`Static` `Readonly`VINTAGE

VINTAGE: number[]

A constant array used by the ColorMatrix class for vintage pinhole operations.

Methods

blackWhite

blackWhite(multiply?: boolean): this
Sets this ColorMatrix to be black and white.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.blackWhite
- Defined in types/phaser.d.ts:9300

brightness

brightness(value?: number, multiply?: boolean): this
Changes the brightness of this ColorMatrix by the given amount.
Parameters
- Optionalvalue: number
  The amount of brightness to apply to this ColorMatrix. Between 0 (black) and 1. Default 0.
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.brightness
- Defined in types/phaser.d.ts:9267

brown

brown(multiply?: boolean): this
Applies a brown tone to this ColorMatrix.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.brown
- Defined in types/phaser.d.ts:9344

contrast

contrast(value?: number, multiply?: boolean): this
Change the contrast of this ColorMatrix by the amount given.
Parameters
- Optionalvalue: number
  The amount of contrast to apply to this ColorMatrix. Default 0.
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.contrast
- Defined in types/phaser.d.ts:9307

desaturateLuminance

desaturateLuminance(multiply?: boolean): this
Apply a desaturated luminance to this ColorMatrix.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.desaturateLuminance
- Defined in types/phaser.d.ts:9319

getData

getData(): Float32Array
Gets the ColorMatrix as a Float32Array.

Can be used directly as a 1fv shader uniform value.

Returns Float32Array
Inherited from ColorMatrix.getData
- Defined in types/phaser.d.ts:9260

grayscale

grayscale(value?: number, multiply?: boolean): this
Sets this ColorMatrix to be grayscale.
Parameters
- Optionalvalue: number
  The grayscale scale (0 is black). Default 1.
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.grayscale
- Defined in types/phaser.d.ts:9294

hue

hue(rotation?: number, multiply?: boolean): this
Rotates the hues of this ColorMatrix by the value given.
Parameters
- Optionalrotation: number
  The amount of hue rotation to apply to this ColorMatrix, in degrees. Default 0.
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.hue
- Defined in types/phaser.d.ts:9287

kodachrome

kodachrome(multiply?: boolean): this
Applies a kodachrome color effect to this ColorMatrix.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.kodachrome
- Defined in types/phaser.d.ts:9356

lsd

lsd(multiply?: boolean): this
Applies a trippy color tone to this ColorMatrix.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.lsd
- Defined in types/phaser.d.ts:9338

multiply

multiply(a: number[], multiply?: boolean): this
Multiplies the two given matrices.
Parameters
- a: number[]
  The 5x4 array to multiply with ColorMatrix._matrix.
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.multiply
- Defined in types/phaser.d.ts:9381

negative

negative(multiply?: boolean): this
Converts this ColorMatrix to have negative values.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.negative
- Defined in types/phaser.d.ts:9313

night

night(intensity?: number, multiply?: boolean): this
Applies a night vision tone to this ColorMatrix.
Parameters
- Optionalintensity: number
  The intensity of this effect. Default 0.1.
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.night
- Defined in types/phaser.d.ts:9332

polaroid

polaroid(multiply?: boolean): this
Applies a polaroid color effect to this ColorMatrix.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.polaroid
- Defined in types/phaser.d.ts:9368

reset

reset(): this
Resets the ColorMatrix to default values and also resets the alpha property back to 1.

Returns this
Inherited from ColorMatrix.reset
- Defined in types/phaser.d.ts:9253

saturate

saturate(value?: number, multiply?: boolean): this
Changes the saturation of this ColorMatrix by the given amount.
Parameters
- Optionalvalue: number
  The amount of saturation to apply to this ColorMatrix. Default 0.
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.saturate
- Defined in types/phaser.d.ts:9274

saturation

saturation(multiply?: boolean): this
Desaturates this ColorMatrix (removes color from it).
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.saturation
- Defined in types/phaser.d.ts:9280

sepia

sepia(multiply?: boolean): this
Applies a sepia tone to this ColorMatrix.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.sepia
- Defined in types/phaser.d.ts:9325

set

set(value: number[] | Float32Array<ArrayBuffer>): this
Sets this ColorMatrix from the given array of color values.
Parameters
- value: number[] | Float32Array<ArrayBuffer>
  The ColorMatrix values to set. Must have 20 elements.
Returns this
Inherited from ColorMatrix.set
- Defined in types/phaser.d.ts:9247

shiftToBGR

shiftToBGR(multiply?: boolean): this
Shifts the values of this ColorMatrix into BGR order.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.shiftToBGR
- Defined in types/phaser.d.ts:9374

technicolor

technicolor(multiply?: boolean): this
Applies a technicolor color effect to this ColorMatrix.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.technicolor
- Defined in types/phaser.d.ts:9362

vintagePinhole

vintagePinhole(multiply?: boolean): this
Applies a vintage pinhole color effect to this ColorMatrix.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
Inherited from ColorMatrix.vintagePinhole
- Defined in types/phaser.d.ts:9350

Class ColorMatrix

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FX.ColorMatrix

Properties

active

alpha

gameObject

type

Static ReadonlyBLACK_WHITE

Static ReadonlyBROWN

Static ReadonlyDESATURATE_LUMINANCE

Static ReadonlyKODACHROME

Static ReadonlyLSD

Static ReadonlyNEGATIVE

Static ReadonlyPOLAROID

Static ReadonlySEPIA

Static ReadonlySHIFT_BGR

Static ReadonlyTECHNICOLOR

Static ReadonlyVINTAGE

Methods

blackWhite

Parameters

Returns this

brightness

Parameters

Returns this

brown

Parameters

Returns this

contrast

Parameters

Returns this

desaturateLuminance

Parameters

Returns this

getData

Returns Float32Array

grayscale

Parameters

Returns this

hue

Parameters

Returns this

kodachrome

Parameters

Returns this

lsd

Parameters

Returns this

multiply

Parameters

Returns this

negative

Parameters

Returns this

night

Parameters

Returns this

polaroid

Parameters

Returns this

reset

Returns this

saturate

Parameters

Returns this

saturation

Parameters

Returns this

sepia

Parameters

Returns this

set

`Static` `Readonly`BLACK_WHITE

`Static` `Readonly`BROWN

`Static` `Readonly`DESATURATE_LUMINANCE

`Static` `Readonly`KODACHROME

`Static` `Readonly`LSD

`Static` `Readonly`NEGATIVE

`Static` `Readonly`POLAROID

`Static` `Readonly`SEPIA

`Static` `Readonly`SHIFT_BGR

`Static` `Readonly`TECHNICOLOR

`Static` `Readonly`VINTAGE