Phaser API Documentation


Member of: Phaser.Math.Vector3

unproject(viewport, invProjectionView)


Unproject this point from 2D space to 3D space. The point should have its x and y properties set to 2D screen space, and the z either at 0 (near plane) or 1 (far plane). The provided matrix is assumed to already be combined, i.e. projection * view * model.

After this operation, this vector's (x, y, z) components will represent the unprojected 3D coordinate.


name type description
viewport Phaser.Math.Vector4

Screen x, y, width and height in pixels.

invProjectionView Phaser.Math.Matrix4

Combined projection and view matrix.


This Vector3.

Since: 3.0.0
Source: src/math/Vector3.js (Line 889)