Class ColorMatrix

The ColorMatrix class creates a 5x4 matrix that can be used in shaders and graphics operations. It provides methods required to modify the color values, such as adjusting the brightness, setting a sepia tone, hue rotation and more.

Use the method getData to return a Float32Array containing the current color values.

Constructors

constructor

new ColorMatrix(): Display.ColorMatrix
Returns Display.ColorMatrix

Properties

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)

`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
- Defined in types/phaser.d.ts:8221

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
- Defined in types/phaser.d.ts:8188

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
- Defined in types/phaser.d.ts:8265

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
- Defined in types/phaser.d.ts:8228

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
- Defined in types/phaser.d.ts:8240

getData

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

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

Returns Float32Array
- Defined in types/phaser.d.ts:8181

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
- Defined in types/phaser.d.ts:8215

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
- Defined in types/phaser.d.ts:8208

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
- Defined in types/phaser.d.ts:8277

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
- Defined in types/phaser.d.ts:8259

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
- Defined in types/phaser.d.ts:8302

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
- Defined in types/phaser.d.ts:8234

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
- Defined in types/phaser.d.ts:8253

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
- Defined in types/phaser.d.ts:8289

reset

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

Returns this
- Defined in types/phaser.d.ts:8174

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
- Defined in types/phaser.d.ts:8195

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
- Defined in types/phaser.d.ts:8201

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
- Defined in types/phaser.d.ts:8246

set

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

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
- Defined in types/phaser.d.ts:8295

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
- Defined in types/phaser.d.ts:8283

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
- Defined in types/phaser.d.ts:8271

Class ColorMatrix

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Display.ColorMatrix

Properties

alpha

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

Parameters

Returns this

shiftToBGR

Parameters

Returns this

`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