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.

The matrix rows (indices 0, 1, 2, 3, 4 form the first row) are summed to create the red, green, blue, and alpha channels in order. The matrix columns (indices 0, 5, 10, 15 form the first column) describe contributions from the initial channels, typically in the range -1 to 1. The last column (4, 9, 14, 19) contains an addition, expected to be in the range 0-255 (although other values are valid). For example, to set the red channel to the contents of the green channel, the first row would be [0, 1, 0, 0, 0]. To set the red channel to full, regardless of current channels, the first row would be [0, 0, 0, 0, 255].

These operations are the default use, but you can use ColorMatrix to conveniently store data for other purposes.

Use the method getData to return a Float32Array containing the current color values. This shrinks the addition column from the range 0-255 to 0-1 (but does not clamp it).

Constructors

constructor

new ColorMatrix(): ColorMatrix

Returns 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`ALPHA_TO_BRIGHTNESS

ALPHA_TO_BRIGHTNESS: number[]

A constant array used by the ColorMatrix class for alpha-to-brightness operations.

`Static` `Readonly`ALPHA_TO_BRIGHTNESS_INVERSE

ALPHA_TO_BRIGHTNESS_INVERSE: number[]

A constant array used by the ColorMatrix class for inverse alpha-to-brightness operations.

`Static` `Readonly`BLACK

BLACK: number[]

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

`Static` `Readonly`BLACK_WHITE

BLACK_WHITE: number[]

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

`Static` `Readonly`BRIGHTNESS_TO_ALPHA

BRIGHTNESS_TO_ALPHA: number[]

A constant array used by the ColorMatrix class for brightness-to-alpha operations.

`Static` `Readonly`BRIGHTNESS_TO_ALPHA_INVERSE

BRIGHTNESS_TO_ALPHA_INVERSE: number[]

A constant array used by the ColorMatrix class for inverse brightness-to-alpha 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 desaturated 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

alphaToBrightness

alphaToBrightness(multiply?: boolean): this
Applies an alpha-to-brightness color effect to this ColorMatrix. This replaces the color with a grayscale depiction of the original alpha, where black represents transparency and white represents opacity, and sets the alpha to full.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10267

alphaToBrightnessInverse

alphaToBrightnessInverse(multiply?: boolean): this
Applies an alpha-to-brightness color effect to this ColorMatrix. This replaces the color with a grayscale depiction of the original alpha, where white represents transparency and black represents opacity, and sets the alpha to full.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10277

black

black(multiply?: boolean): this
Sets this ColorMatrix to be black, only preserving alpha. Useful for cases where you only want the alpha.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10178

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10170

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10132

brightnessToAlpha

brightnessToAlpha(multiply?: boolean): this
Applies a brightness-to-alpha color effect to this ColorMatrix. This preserves RGB, but replaces the alpha with the brightness of the color.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10285

brightnessToAlphaInverse

brightnessToAlphaInverse(multiply?: boolean): this
Applies a brightness-to-alpha color effect to this ColorMatrix. This preserves RGB, but replaces the alpha with the brightness of the color, inverted.
Parameters
- Optionalmultiply: boolean
  Multiply the resulting ColorMatrix (true), or set it (false) ? Default false.
Returns this
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10294

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10229

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10186

desaturate

desaturate(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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10147

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10200

getData

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

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

Returns Float32Array
The ColorMatrix as a Float32Array.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10124

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10163

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10155

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10243

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10222

multiply

multiply(a: number[], multiply?: boolean): this
Multiplies the given matrix a against the current _matrix.
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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10309

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10193

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10215

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10257

reset

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

Returns this
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10116

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10140

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10207

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10109

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10301

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10250

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
This ColorMatrix instance.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10236

Class ColorMatrix

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ColorMatrix

Properties

alpha

Static ReadonlyALPHA_TO_BRIGHTNESS

Static ReadonlyALPHA_TO_BRIGHTNESS_INVERSE

Static ReadonlyBLACK

Static ReadonlyBLACK_WHITE

Static ReadonlyBRIGHTNESS_TO_ALPHA

Static ReadonlyBRIGHTNESS_TO_ALPHA_INVERSE

Static ReadonlyBROWN

Static ReadonlyDESATURATE_LUMINANCE

Static ReadonlyKODACHROME

Static ReadonlyLSD

Static ReadonlyNEGATIVE

Static ReadonlyPOLAROID

Static ReadonlySEPIA

Static ReadonlySHIFT_BGR

Static ReadonlyTECHNICOLOR

Static ReadonlyVINTAGE

Methods

alphaToBrightness

Parameters

Returns this

alphaToBrightnessInverse

Parameters

Returns this

black

Parameters

Returns this

blackWhite

Parameters

Returns this

brightness

Parameters

Returns this

brightnessToAlpha

Parameters

Returns this

brightnessToAlphaInverse

Parameters

Returns this

brown

Parameters

Returns this

contrast

Parameters

Returns this

desaturate

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

`Static` `Readonly`ALPHA_TO_BRIGHTNESS

`Static` `Readonly`ALPHA_TO_BRIGHTNESS_INVERSE

`Static` `Readonly`BLACK

`Static` `Readonly`BLACK_WHITE

`Static` `Readonly`BRIGHTNESS_TO_ALPHA

`Static` `Readonly`BRIGHTNESS_TO_ALPHA_INVERSE

`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