PixiJS API Documentation

Class: Matrix

Matrix

The PixiJS Matrix as a class makes it a lot faster.

Here is a representation of it:

| a | c | tx|
| b | d | ty|
| 0 | 0 | 1 |

new Matrix (a, b, c, d, tx, ty)

Matrix.ts:42

Name	Type	Default	Description
`a`	number	1	x scale
`b`	number	0	y skew
`c`	number	0	x skew
`d`	number	1	y scale
`tx`	number	0	x translation
`ty`	number	0	y translation

Members

IDENTITY Readonly<Matrix> staticreadonly

A default (identity) matrix

shared Matrix staticreadonly

A static Matrix that can be used to avoid creating new objects. Will always ensure the matrix is reset to identity when requested.

a number

Default Value:

array Float32Array | null

An array of the current matrix. Only populated when toArray is called

Default Value:

undefined

b number

Default Value:

c number

Default Value:

d number

Default Value:

tx number

Default Value:

ty number

Default Value:

Methods

append (matrix) this

Matrix.ts:251

Appends the given Matrix to this Matrix.

Name	Type	Description
`matrix`	Matrix	The matrix to append.

Returns:

Type	Description
this	This matrix. Good for chaining method calls.

appendFrom (a, b) this

Matrix.ts:274

Appends two matrix's and sets the result to this matrix. AB = A * B

Name	Type	Description
`a`	Matrix	The matrix to append.
`b`	Matrix	The matrix to append.

Returns:

Type	Description
this	This matrix. Good for chaining method calls.

apply (pos, newPos) Point

Matrix.ts:146

Get a new position with the current transformation applied. Can be used to go from a child's coordinate space to the world coordinate space. (e.g. rendering)

Name	Type	Attributes	Description
`pos`	PointData		The origin
`newPos`	Point	<optional>	The point that the new position is assigned to (allowed to be same as input)

Returns:

Type	Description
Point	The new point, transformed through this matrix

applyInverse (pos, newPos) Point

Matrix.ts:166

Get a new position with the inverse of the current transformation applied. Can be used to go from the world coordinate space to a child's coordinate space. (e.g. input)

Name	Type	Attributes	Description
`pos`	PointData		The origin
`newPos`	Point	<optional>	The point that the new position is assigned to (allowed to be same as input)

Returns:

Type	Description
Point	The new point, inverse-transformed through this matrix

clone () Matrix

Matrix.ts:444

Creates a new Matrix object with the same values as this one.

Returns:

Type	Description
Matrix	A copy of this matrix. Good for chaining method calls.

copyFrom (matrix) this

Matrix.ts:479

Changes the values of the matrix to be the same as the ones in given matrix

Name	Type	Description
`matrix`	Matrix	The matrix to copy from.

Returns:

Type	Description
this	this

copyTo (matrix) Matrix

Matrix.ts:462

Changes the values of the given matrix to be the same as the ones in this matrix

Name	Type	Description
`matrix`	Matrix	The matrix to copy to.

Returns:

Type	Description
Matrix	The matrix given in parameter with its values updated.

decompose (transform) Transform

Matrix.ts:357

Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.

Name	Type	Description
`transform`	Transform	The transform to apply the properties to.

Returns:

Type	Description
Transform	The transform with the newly applied properties

fromArray (array) void

Matrix.ts:60

Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:

a = array[0] b = array[1] c = array[3] d = array[4] tx = array[2] ty = array[5]

Name	Type	Description
`array`	number[]	The array that the matrix will be populated from.

identity () this

Matrix.ts:428

Resets this Matrix to an identity (default) matrix.

Returns:

Type	Description
this	This matrix. Good for chaining method calls.

invert () this

Matrix.ts:399

Inverts this matrix

Returns:

Type	Description
this	This matrix. Good for chaining method calls.

isIdentity () boolean

Matrix.ts:422

Checks if this matrix is an identity matrix

Returns:

Type	Description
boolean

prepend (matrix) this

Matrix.ts:331

Prepends the given Matrix to this Matrix.

Name	Type	Description
`matrix`	Matrix	The matrix to prepend

Returns:

Type	Description
this	This matrix. Good for chaining method calls.

rotate (angle) this

Matrix.ts:227

Applies a rotation transformation to the matrix.

Name	Type	Description
`angle`	number	The angle in radians.

Returns:

Type	Description
this	This matrix. Good for chaining method calls.

scale (x, y) this

Matrix.ts:209

Applies a scale transformation to the matrix.

Name	Type	Description
`x`	number	The amount to scale horizontally
`y`	number	The amount to scale vertically

Returns:

Type	Description
this	This matrix. Good for chaining method calls.

set (a, b, c, d, tx, ty) this

Matrix.ts:81

Sets the matrix properties.

Name	Type	Description
`a`	number	Matrix component
`b`	number	Matrix component
`c`	number	Matrix component
`d`	number	Matrix component
`tx`	number	Matrix component
`ty`	number	Matrix component

Returns:

Type	Description
this	This matrix. Good for chaining method calls.

setTransform (x, y, pivotX, pivotY, scaleX, scaleY, rotation, skewX, skewY) this

Matrix.ts:304

Sets the matrix based on all the available properties

Name	Type	Description
`x`	number	Position on the x axis
`y`	number	Position on the y axis
`pivotX`	number	Pivot on the x axis
`pivotY`	number	Pivot on the y axis
`scaleX`	number	Scale on the x axis
`scaleY`	number	Scale on the y axis
`rotation`	number	Rotation in radians
`skewX`	number	Skew on the x axis
`skewY`	number	Skew on the y axis

Returns:

Type	Description
this	This matrix. Good for chaining method calls.

toArray (transpose, out) Float32Array

Matrix.ts:103

Creates an array from the current Matrix object.

Name	Type	Attributes	Default	Description
`transpose`	boolean	<optional>		Whether we need to transpose the matrix or not
`out`	Float32Array	<optional>	new Float32Array(9)	If provided the array will be assigned to out

Returns:

Type	Description
Float32Array	The newly created array which contains the matrix

translate (x, y) this

Matrix.ts:195

Translates the matrix on the x and y.

Name	Type	Description
`x`	number	How much to translate x by
`y`	number	How much to translate y by

Returns:

Type	Description
this	This matrix. Good for chaining method calls.