PixiJS API Documentation

Class: Matrix

Matrix

A fast matrix for 2D transformations.

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

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

ts:48

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.

This is a shared object, if you want to modify it consider creating a new 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. Use this object for fast but temporary calculations, as it may be mutated later on. This is a different object to the IDENTITY object and so can be modified without changing IDENTITY.

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

ts:257

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

ts:280

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

ts:152

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

ts:172

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

ts:450

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

ts:485

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

ts:468

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) TransformableObject

ts:363

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

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

Returns:

Type	Description
TransformableObject	The transform with the newly applied properties

equals (matrix)

ts:502

check to see if two matrices are the same

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

fromArray (array) void

ts:66

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

ts:434

Resets this Matrix to an identity (default) matrix.

Returns:

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

invert () this

ts:405

Inverts this matrix

Returns:

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

isIdentity () boolean

ts:428

Checks if this matrix is an identity matrix

Returns:

Type	Description
boolean

prepend (matrix) this

ts:337

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

ts:233

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

ts:215

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

ts:87

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

ts:310

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

ts:109

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

ts:201

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.