Package org.joml

Interface Matrix4fc

All Known Implementing Classes:

Matrix4f, Matrix4fStack

public interface Matrix4fc

Interface to a read-only view of a 4x4 matrix of single-precision floats.

Author:

Kai Burjack

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CORNER_NXNYNZ	Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (-1, -1, -1) when using the identity matrix.
static final int	CORNER_NXNYPZ	Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (-1, -1, 1) when using the identity matrix.
static final int	CORNER_NXPYNZ	Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (-1, 1, -1) when using the identity matrix.
static final int	CORNER_NXPYPZ	Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (-1, 1, 1) when using the identity matrix.
static final int	CORNER_PXNYNZ	Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (1, -1, -1) when using the identity matrix.
static final int	CORNER_PXNYPZ	Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (1, -1, 1) when using the identity matrix.
static final int	CORNER_PXPYNZ	Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (1, 1, -1) when using the identity matrix.
static final int	CORNER_PXPYPZ	Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (1, 1, 1) when using the identity matrix.
static final int	PLANE_NX	Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation x=-1 when using the identity matrix.
static final int	PLANE_NY	Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation y=-1 when using the identity matrix.
static final int	PLANE_NZ	Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation z=-1 when using the identity matrix.
static final int	PLANE_PX	Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation x=1 when using the identity matrix.
static final int	PLANE_PY	Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation y=1 when using the identity matrix.
static final int	PLANE_PZ	Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation z=1 when using the identity matrix.
static final byte	PROPERTY_AFFINE	Bit returned by properties() to indicate that the matrix represents an affine transformation.
static final byte	PROPERTY_IDENTITY	Bit returned by properties() to indicate that the matrix represents the identity transformation.
static final byte	PROPERTY_ORTHONORMAL	Bit returned by properties() to indicate that the upper-left 3x3 submatrix represents an orthogonal matrix (i.e.
static final byte	PROPERTY_PERSPECTIVE	Bit returned by properties() to indicate that the matrix represents a perspective transformation.
static final byte	PROPERTY_TRANSLATION	Bit returned by properties() to indicate that the matrix represents a pure translation transformation.

Method Summary

Modifier and Type	Method	Description
Matrix4f	add(Matrix4fc other, Matrix4f dest)	Component-wise add this and other and store the result in dest.
Matrix4f	add4x3(Matrix4fc other, Matrix4f dest)	Component-wise add the upper 4x3 submatrices of this and other and store the result in dest.
Matrix4f	arcball(float radius, float centerX, float centerY, float centerZ, float angleX, float angleY, Matrix4f dest)	Apply an arcball view transformation to this matrix with the given radius and center (centerX, centerY, centerZ) position of the arcball and the specified X and Y rotation angles, and store the result in dest.
Matrix4f	arcball(float radius, Vector3fc center, float angleX, float angleY, Matrix4f dest)	Apply an arcball view transformation to this matrix with the given radius and center position of the arcball and the specified X and Y rotation angles, and store the result in dest.
Matrix3f	cofactor3x3(Matrix3f dest)	Compute the cofactor matrix of the upper left 3x3 submatrix of this and store it into dest.
Matrix4f	cofactor3x3(Matrix4f dest)	Compute the cofactor matrix of the upper left 3x3 submatrix of this and store it into dest.
float	determinant()	Return the determinant of this matrix.
float	determinant3x3()	Return the determinant of the upper left 3x3 submatrix of this matrix.
float	determinantAffine()	Return the determinant of this matrix by assuming that it represents an affine transformation and thus its last row is equal to (0, 0, 0, 1).
boolean	equals(Matrix4fc m, float delta)	Compare the matrix elements of this matrix with the given matrix using the given delta and return whether all of them are equal within a maximum difference of delta.
Matrix4f	fma4x3(Matrix4fc other, float otherFactor, Matrix4f dest)	Component-wise add the upper 4x3 submatrices of this and other by first multiplying each component of other's 4x3 submatrix by otherFactor, adding that to this and storing the final result in dest.
Matrix4f	frustum(float left, float right, float bottom, float top, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply an arbitrary perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	frustum(float left, float right, float bottom, float top, float zNear, float zFar, Matrix4f dest)	Apply an arbitrary perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Matrix4f	frustumAabb(Vector3f min, Vector3f max)	Compute the axis-aligned bounding box of the frustum described by this matrix and store the minimum corner coordinates in the given min and the maximum corner coordinates in the given max vector.
Vector3f	frustumCorner(int corner, Vector3f point)	Compute the corner coordinates of the frustum defined by this matrix, which can be a projection matrix or a combined modelview-projection matrix, and store the result in the given point.
Matrix4f	frustumLH(float left, float right, float bottom, float top, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply an arbitrary perspective projection frustum transformation for a left-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	frustumLH(float left, float right, float bottom, float top, float zNear, float zFar, Matrix4f dest)	Apply an arbitrary perspective projection frustum transformation for a left-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Vector4f	frustumPlane(int plane, Vector4f planeEquation)	Calculate a frustum plane of this matrix, which can be a projection matrix or a combined modelview-projection matrix, and store the result in the given planeEquation.
Vector3f	frustumRayDir(float x, float y, Vector3f dir)	Obtain the direction of a ray starting at the center of the coordinate system and going through the near frustum plane.
float[]	get(float[] arr)	Store this matrix into the supplied float array in column-major order.
float[]	get(float[] arr, int offset)	Store this matrix into the supplied float array in column-major order at the given offset.
float	get(int column, int row)	Get the matrix element value at the given column and row.
com.google.gwt.typedarrays.shared.Float32Array	get(int index, com.google.gwt.typedarrays.shared.Float32Array buffer)	Store this matrix in column-major order into the supplied Float32Array at the given index.
ByteBuffer	get(int index, ByteBuffer buffer)	Store this matrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.
FloatBuffer	get(int index, FloatBuffer buffer)	Store this matrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.
com.google.gwt.typedarrays.shared.Float32Array	get(com.google.gwt.typedarrays.shared.Float32Array buffer)	Store this matrix in column-major order into the supplied Float32Array.
ByteBuffer	get(ByteBuffer buffer)	Store this matrix in column-major order into the supplied ByteBuffer at the current buffer position.
FloatBuffer	get(FloatBuffer buffer)	Store this matrix in column-major order into the supplied FloatBuffer at the current buffer position.
Matrix4d	get(Matrix4d dest)	Get the current values of this matrix and store them into dest.
Matrix4f	get(Matrix4f dest)	Get the current values of this matrix and store them into dest.
Matrix3d	get3x3(Matrix3d dest)	Get the current values of the upper left 3x3 submatrix of this matrix and store them into dest.
Matrix3f	get3x3(Matrix3f dest)	Get the current values of the upper left 3x3 submatrix of this matrix and store them into dest.
ByteBuffer	get3x4(int index, ByteBuffer buffer)	Store the left 3x4 submatrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.
FloatBuffer	get3x4(int index, FloatBuffer buffer)	Store the left 3x4 submatrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.
ByteBuffer	get3x4(ByteBuffer buffer)	Store the left 3x4 submatrix in column-major order into the supplied ByteBuffer at the current buffer position.
FloatBuffer	get3x4(FloatBuffer buffer)	Store the left 3x4 submatrix in column-major order into the supplied FloatBuffer at the current buffer position.
ByteBuffer	get4x3(int index, ByteBuffer buffer)	Store the upper 4x3 submatrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.
FloatBuffer	get4x3(int index, FloatBuffer buffer)	Store the upper 4x3 submatrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.
ByteBuffer	get4x3(ByteBuffer buffer)	Store the upper 4x3 submatrix in column-major order into the supplied ByteBuffer at the current buffer position.
FloatBuffer	get4x3(FloatBuffer buffer)	Store the upper 4x3 submatrix in column-major order into the supplied FloatBuffer at the current buffer position.
Matrix4x3f	get4x3(Matrix4x3f dest)	Get the current values of the upper 4x3 submatrix of this matrix and store them into dest.
ByteBuffer	get4x3Transposed(int index, ByteBuffer buffer)	Store the upper 4x3 submatrix of this matrix in row-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.
FloatBuffer	get4x3Transposed(int index, FloatBuffer buffer)	Store the upper 4x3 submatrix of this matrix in row-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.
ByteBuffer	get4x3Transposed(ByteBuffer buffer)	Store the upper 4x3 submatrix of this matrix in row-major order into the supplied ByteBuffer at the current buffer position.
FloatBuffer	get4x3Transposed(FloatBuffer buffer)	Store the upper 4x3 submatrix of this matrix in row-major order into the supplied FloatBuffer at the current buffer position.
Vector3f	getColumn(int column, Vector3f dest)	Get the first three components of the column at the given column index, starting with 0.
Vector4f	getColumn(int column, Vector4f dest)	Get the column at the given column index, starting with 0.
Vector3f	getEulerAnglesXYZ(Vector3f dest)	Extract the Euler angles from the rotation represented by the upper left 3x3 submatrix of this and store the extracted Euler angles in dest.
Vector3f	getEulerAnglesZYX(Vector3f dest)	Extract the Euler angles from the rotation represented by the upper left 3x3 submatrix of this and store the extracted Euler angles in dest.
Quaterniond	getNormalizedRotation(Quaterniond dest)	Get the current values of this matrix and store the represented rotation into the given Quaterniond.
Quaternionf	getNormalizedRotation(Quaternionf dest)	Get the current values of this matrix and store the represented rotation into the given Quaternionf.
AxisAngle4d	getRotation(AxisAngle4d dest)	Get the rotational component of this matrix and store the represented rotation into the given AxisAngle4d.
AxisAngle4f	getRotation(AxisAngle4f dest)	Get the rotational component of this matrix and store the represented rotation into the given AxisAngle4f.
Vector3f	getRow(int row, Vector3f dest)	Get the first three components of the row at the given row index, starting with 0.
Vector4f	getRow(int row, Vector4f dest)	Get the row at the given row index, starting with 0.
float	getRowColumn(int row, int column)	Get the matrix element value at the given row and column.
Vector3f	getScale(Vector3f dest)	Get the scaling factors of this matrix for the three base axes.
Matrix4fc	getToAddress(long address)	Store this matrix in column-major order at the given off-heap address.
Vector3f	getTranslation(Vector3f dest)	Get only the translation components (m30, m31, m32) of this matrix and store them in the given vector xyz.
ByteBuffer	getTransposed(int index, ByteBuffer buffer)	Store the transpose of this matrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.
FloatBuffer	getTransposed(int index, FloatBuffer buffer)	Store the transpose of this matrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.
ByteBuffer	getTransposed(ByteBuffer buffer)	Store the transpose of this matrix in column-major order into the supplied ByteBuffer at the current buffer position.
FloatBuffer	getTransposed(FloatBuffer buffer)	Store the transpose of this matrix in column-major order into the supplied FloatBuffer at the current buffer position.
Quaterniond	getUnnormalizedRotation(Quaterniond dest)	Get the current values of this matrix and store the represented rotation into the given Quaterniond.
Quaternionf	getUnnormalizedRotation(Quaternionf dest)	Get the current values of this matrix and store the represented rotation into the given Quaternionf.
Matrix4f	invert(Matrix4f dest)	Invert this matrix and write the result into dest.
Matrix4f	invertAffine(Matrix4f dest)	Invert this matrix by assuming that it is an affine transformation (i.e.
Matrix4f	invertFrustum(Matrix4f dest)	If this is an arbitrary perspective projection matrix obtained via one of the frustum() methods, then this method builds the inverse of this and stores it into the given dest.
Matrix4f	invertOrtho(Matrix4f dest)	Invert this orthographic projection matrix and store the result into the given dest.
Matrix4f	invertPerspective(Matrix4f dest)	If this is a perspective projection matrix obtained via one of the perspective() methods, that is, if this is a symmetrical perspective frustum transformation, then this method builds the inverse of this and stores it into the given dest.
Matrix4f	invertPerspectiveView(Matrix4fc view, Matrix4f dest)	If this is a perspective projection matrix obtained via one of the perspective() methods, that is, if this is a symmetrical perspective frustum transformation and the given view matrix is affine and has unit scaling (for example by being obtained via lookAt()), then this method builds the inverse of this * view and stores it into the given dest.
Matrix4f	invertPerspectiveView(Matrix4x3fc view, Matrix4f dest)	If this is a perspective projection matrix obtained via one of the perspective() methods, that is, if this is a symmetrical perspective frustum transformation and the given view matrix has unit scaling, then this method builds the inverse of this * view and stores it into the given dest.
boolean	isAffine()	Determine whether this matrix describes an affine transformation.
boolean	isFinite()	Determine whether all matrix elements are finite floating-point values, that is, they are not NaN and not infinity.
Matrix4f	lerp(Matrix4fc other, float t, Matrix4f dest)	Linearly interpolate this and other using the given interpolation factor t and store the result in dest.
Matrix4f	lookAlong(float dirX, float dirY, float dirZ, float upX, float upY, float upZ, Matrix4f dest)	Apply a rotation transformation to this matrix to make -z point along dir and store the result in dest.
Matrix4f	lookAlong(Vector3fc dir, Vector3fc up, Matrix4f dest)	Apply a rotation transformation to this matrix to make -z point along dir and store the result in dest.
Matrix4f	lookAt(float eyeX, float eyeY, float eyeZ, float centerX, float centerY, float centerZ, float upX, float upY, float upZ, Matrix4f dest)	Apply a "lookat" transformation to this matrix for a right-handed coordinate system, that aligns -z with center - eye and store the result in dest.
Matrix4f	lookAt(Vector3fc eye, Vector3fc center, Vector3fc up, Matrix4f dest)	Apply a "lookat" transformation to this matrix for a right-handed coordinate system, that aligns -z with center - eye and store the result in dest.
Matrix4f	lookAtLH(float eyeX, float eyeY, float eyeZ, float centerX, float centerY, float centerZ, float upX, float upY, float upZ, Matrix4f dest)	Apply a "lookat" transformation to this matrix for a left-handed coordinate system, that aligns +z with center - eye and store the result in dest.
Matrix4f	lookAtLH(Vector3fc eye, Vector3fc center, Vector3fc up, Matrix4f dest)	Apply a "lookat" transformation to this matrix for a left-handed coordinate system, that aligns +z with center - eye and store the result in dest.
Matrix4f	lookAtPerspective(float eyeX, float eyeY, float eyeZ, float centerX, float centerY, float centerZ, float upX, float upY, float upZ, Matrix4f dest)	Apply a "lookat" transformation to this matrix for a right-handed coordinate system, that aligns -z with center - eye and store the result in dest.
Matrix4f	lookAtPerspectiveLH(float eyeX, float eyeY, float eyeZ, float centerX, float centerY, float centerZ, float upX, float upY, float upZ, Matrix4f dest)	Apply a "lookat" transformation to this matrix for a left-handed coordinate system, that aligns +z with center - eye and store the result in dest.
float	m00()	Return the value of the matrix element at column 0 and row 0.
float	m01()	Return the value of the matrix element at column 0 and row 1.
float	m02()	Return the value of the matrix element at column 0 and row 2.
float	m03()	Return the value of the matrix element at column 0 and row 3.
float	m10()	Return the value of the matrix element at column 1 and row 0.
float	m11()	Return the value of the matrix element at column 1 and row 1.
float	m12()	Return the value of the matrix element at column 1 and row 2.
float	m13()	Return the value of the matrix element at column 1 and row 3.
float	m20()	Return the value of the matrix element at column 2 and row 0.
float	m21()	Return the value of the matrix element at column 2 and row 1.
float	m22()	Return the value of the matrix element at column 2 and row 2.
float	m23()	Return the value of the matrix element at column 2 and row 3.
float	m30()	Return the value of the matrix element at column 3 and row 0.
float	m31()	Return the value of the matrix element at column 3 and row 1.
float	m32()	Return the value of the matrix element at column 3 and row 2.
float	m33()	Return the value of the matrix element at column 3 and row 3.
Matrix4f	mapnXnYnZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnXnYZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnXnZnY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnXnZY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnXYnZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnXZnY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnXZY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnYnXnZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnYnXZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnYnZnX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnYnZX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnYXnZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnYXZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnYZnX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnYZX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnZnXnY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnZnXY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnZnYnX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnZnYX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnZXnY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnZXY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnZYnX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapnZYX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapXnYnZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapXnZnY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapXnZY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapXZnY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapXZY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapYnXnZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapYnXZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapYnZnX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapYnZX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapYXnZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapYXZ(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapYZnX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapYZX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapZnXnY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapZnXY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapZnYnX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapZnYX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapZXnY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapZXY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapZYnX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mapZYX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	mul(float r00, float r01, float r02, float r03, float r10, float r11, float r12, float r13, float r20, float r21, float r22, float r23, float r30, float r31, float r32, float r33, Matrix4f dest)	Multiply this matrix by the matrix with the supplied elements and store the result in dest.
Matrix4f	mul(Matrix3x2fc right, Matrix4f dest)	Multiply this matrix by the supplied right matrix and store the result in dest.
Matrix4f	mul(Matrix4fc right, Matrix4f dest)	Multiply this matrix by the supplied right matrix and store the result in dest.
Matrix4f	mul(Matrix4x3fc right, Matrix4f dest)	Multiply this matrix by the supplied right matrix and store the result in dest.
Matrix4f	mul0(Matrix4fc right, Matrix4f dest)	Multiply this matrix by the supplied right matrix and store the result in dest.
Matrix4f	mul3x3(float r00, float r01, float r02, float r10, float r11, float r12, float r20, float r21, float r22, Matrix4f dest)	Multiply this matrix by the 3x3 matrix with the supplied elements expanded to a 4x4 matrix with all other matrix elements set to identity, and store the result in dest.
Matrix4f	mul4x3ComponentWise(Matrix4fc other, Matrix4f dest)	Component-wise multiply the upper 4x3 submatrices of this by other and store the result in dest.
Matrix4f	mulAffine(Matrix4fc right, Matrix4f dest)	Multiply this matrix by the supplied right matrix, both of which are assumed to be affine, and store the result in dest.
Matrix4f	mulAffineR(Matrix4fc right, Matrix4f dest)	Multiply this matrix by the supplied right matrix, which is assumed to be affine, and store the result in dest.
Matrix4f	mulComponentWise(Matrix4fc other, Matrix4f dest)	Component-wise multiply this by other and store the result in dest.
Matrix4f	mulLocal(Matrix4fc left, Matrix4f dest)	Pre-multiply this matrix by the supplied left matrix and store the result in dest.
Matrix4f	mulLocalAffine(Matrix4fc left, Matrix4f dest)	Pre-multiply this matrix by the supplied left matrix, both of which are assumed to be affine, and store the result in dest.
Matrix4f	mulOrthoAffine(Matrix4fc view, Matrix4f dest)	Multiply this orthographic projection matrix by the supplied affine view matrix and store the result in dest.
Matrix4f	mulPerspectiveAffine(Matrix4fc view, Matrix4f dest)	Multiply this symmetric perspective projection matrix by the supplied affine view matrix and store the result in dest.
Matrix4f	mulPerspectiveAffine(Matrix4x3fc view, Matrix4f dest)	Multiply this symmetric perspective projection matrix by the supplied view matrix and store the result in dest.
Matrix4f	mulTranslationAffine(Matrix4fc right, Matrix4f dest)	Multiply this matrix, which is assumed to only contain a translation, by the supplied right matrix, which is assumed to be affine, and store the result in dest.
Matrix4f	negateX(Matrix4f dest)	Multiply this by the matrix
Matrix4f	negateY(Matrix4f dest)	Multiply this by the matrix
Matrix4f	negateZ(Matrix4f dest)	Multiply this by the matrix
Matrix3f	normal(Matrix3f dest)	Compute a normal matrix from the upper left 3x3 submatrix of this and store it into dest.
Matrix4f	normal(Matrix4f dest)	Compute a normal matrix from the upper left 3x3 submatrix of this and store it into the upper left 3x3 submatrix of dest.
Matrix3f	normalize3x3(Matrix3f dest)	Normalize the upper left 3x3 submatrix of this matrix and store the result in dest.
Matrix4f	normalize3x3(Matrix4f dest)	Normalize the upper left 3x3 submatrix of this matrix and store the result in dest.
Vector3f	normalizedPositiveX(Vector3f dir)	Obtain the direction of +X before the transformation represented by this orthogonal matrix is applied.
Vector3f	normalizedPositiveY(Vector3f dir)	Obtain the direction of +Y before the transformation represented by this orthogonal matrix is applied.
Vector3f	normalizedPositiveZ(Vector3f dir)	Obtain the direction of +Z before the transformation represented by this orthogonal matrix is applied.
Matrix4f	obliqueZ(float a, float b, Matrix4f dest)	Apply an oblique projection transformation to this matrix with the given values for a and b and store the result in dest.
Vector3f	origin(Vector3f origin)	Obtain the position that gets transformed to the origin by this matrix.
Vector3f	originAffine(Vector3f origin)	Obtain the position that gets transformed to the origin by this affine matrix.
Matrix4f	ortho(float left, float right, float bottom, float top, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply an orthographic projection transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	ortho(float left, float right, float bottom, float top, float zNear, float zFar, Matrix4f dest)	Apply an orthographic projection transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Matrix4f	ortho2D(float left, float right, float bottom, float top, Matrix4f dest)	Apply an orthographic projection transformation for a right-handed coordinate system to this matrix and store the result in dest.
Matrix4f	ortho2DLH(float left, float right, float bottom, float top, Matrix4f dest)	Apply an orthographic projection transformation for a left-handed coordinate system to this matrix and store the result in dest.
Matrix4f	orthoCrop(Matrix4fc view, Matrix4f dest)	Build an ortographic projection transformation that fits the view-projection transformation represented by this into the given affine view transformation.
Matrix4f	orthoLH(float left, float right, float bottom, float top, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply an orthographic projection transformation for a left-handed coordiante system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	orthoLH(float left, float right, float bottom, float top, float zNear, float zFar, Matrix4f dest)	Apply an orthographic projection transformation for a left-handed coordiante system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Matrix4f	orthoSymmetric(float width, float height, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply a symmetric orthographic projection transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	orthoSymmetric(float width, float height, float zNear, float zFar, Matrix4f dest)	Apply a symmetric orthographic projection transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Matrix4f	orthoSymmetricLH(float width, float height, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply a symmetric orthographic projection transformation for a left-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	orthoSymmetricLH(float width, float height, float zNear, float zFar, Matrix4f dest)	Apply a symmetric orthographic projection transformation for a left-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Matrix4f	perspective(float fovy, float aspect, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply a symmetric perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	perspective(float fovy, float aspect, float zNear, float zFar, Matrix4f dest)	Apply a symmetric perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
float	perspectiveFar()	Extract the far clip plane distance from this perspective projection matrix.
float	perspectiveFov()	Return the vertical field-of-view angle in radians of this perspective transformation matrix.
Matrix4f	perspectiveFrustumSlice(float near, float far, Matrix4f dest)	Change the near and far clip plane distances of this perspective frustum transformation matrix and store the result in dest.
Vector3f	perspectiveInvOrigin(Vector3f dest)	Compute the eye/origin of the inverse of the perspective frustum transformation defined by this matrix, which can be the inverse of a projection matrix or the inverse of a combined modelview-projection matrix, and store the result in the given dest.
Matrix4f	perspectiveLH(float fovy, float aspect, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply a symmetric perspective projection frustum transformation for a left-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	perspectiveLH(float fovy, float aspect, float zNear, float zFar, Matrix4f dest)	Apply a symmetric perspective projection frustum transformation for a left-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
float	perspectiveNear()	Extract the near clip plane distance from this perspective projection matrix.
Matrix4f	perspectiveOffCenter(float fovy, float offAngleX, float offAngleY, float aspect, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply an asymmetric off-center perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	perspectiveOffCenter(float fovy, float offAngleX, float offAngleY, float aspect, float zNear, float zFar, Matrix4f dest)	Apply an asymmetric off-center perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Matrix4f	perspectiveOffCenterFov(float angleLeft, float angleRight, float angleDown, float angleUp, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply an asymmetric off-center perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	perspectiveOffCenterFov(float angleLeft, float angleRight, float angleDown, float angleUp, float zNear, float zFar, Matrix4f dest)	Apply an asymmetric off-center perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Matrix4f	perspectiveOffCenterFovLH(float angleLeft, float angleRight, float angleDown, float angleUp, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply an asymmetric off-center perspective projection frustum transformation for a left-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	perspectiveOffCenterFovLH(float angleLeft, float angleRight, float angleDown, float angleUp, float zNear, float zFar, Matrix4f dest)	Apply an asymmetric off-center perspective projection frustum transformation for a left-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Vector3f	perspectiveOrigin(Vector3f origin)	Compute the eye/origin of the perspective frustum transformation defined by this matrix, which can be a projection matrix or a combined modelview-projection matrix, and store the result in the given origin.
Matrix4f	perspectiveRect(float width, float height, float zNear, float zFar, boolean zZeroToOne, Matrix4f dest)	Apply a symmetric perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.
Matrix4f	perspectiveRect(float width, float height, float zNear, float zFar, Matrix4f dest)	Apply a symmetric perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.
Matrix4f	pick(float x, float y, float width, float height, int[] viewport, Matrix4f dest)	Apply a picking transformation to this matrix using the given window coordinates (x, y) as the pick center and the given (width, height) as the size of the picking region in window coordinates, and store the result in dest.
Vector3f	positiveX(Vector3f dir)	Obtain the direction of +X before the transformation represented by this matrix is applied.
Vector3f	positiveY(Vector3f dir)	Obtain the direction of +Y before the transformation represented by this matrix is applied.
Vector3f	positiveZ(Vector3f dir)	Obtain the direction of +Z before the transformation represented by this matrix is applied.
Vector3f	project(float x, float y, float z, int[] viewport, Vector3f winCoordsDest)	Project the given (x, y, z) position via this matrix using the specified viewport and store the resulting window coordinates in winCoordsDest.
Vector4f	project(float x, float y, float z, int[] viewport, Vector4f winCoordsDest)	Project the given (x, y, z) position via this matrix using the specified viewport and store the resulting window coordinates in winCoordsDest.
Vector3f	project(Vector3fc position, int[] viewport, Vector3f winCoordsDest)	Project the given position via this matrix using the specified viewport and store the resulting window coordinates in winCoordsDest.
Vector4f	project(Vector3fc position, int[] viewport, Vector4f winCoordsDest)	Project the given position via this matrix using the specified viewport and store the resulting window coordinates in winCoordsDest.
Matrix4f	projectedGridRange(Matrix4fc projector, float sLower, float sUpper, Matrix4f dest)	Compute the range matrix for the Projected Grid transformation as described in chapter "2.4.2 Creating the range conversion matrix" of the paper Real-time water rendering - Introducing the projected grid concept based on the inverse of the view-projection matrix which is assumed to be this, and store that range matrix into dest.
int	properties()	Return the assumed properties of this matrix.
Matrix4f	reflect(float nx, float ny, float nz, float px, float py, float pz, Matrix4f dest)	Apply a mirror/reflection transformation to this matrix that reflects about the given plane specified via the plane normal and a point on the plane, and store the result in dest.
Matrix4f	reflect(float a, float b, float c, float d, Matrix4f dest)	Apply a mirror/reflection transformation to this matrix that reflects about the given plane specified via the equation x*a + y*b + z*c + d = 0 and store the result in dest.
Matrix4f	reflect(Quaternionfc orientation, Vector3fc point, Matrix4f dest)	Apply a mirror/reflection transformation to this matrix that reflects about a plane specified via the plane orientation and a point on the plane, and store the result in dest.
Matrix4f	reflect(Vector3fc normal, Vector3fc point, Matrix4f dest)	Apply a mirror/reflection transformation to this matrix that reflects about the given plane specified via the plane normal and a point on the plane, and store the result in dest.
Matrix4f	rotate(float ang, float x, float y, float z, Matrix4f dest)	Apply rotation to this matrix by rotating the given amount of radians about the specified (x, y, z) axis and store the result in dest.
Matrix4f	rotate(float angle, Vector3fc axis, Matrix4f dest)	Apply a rotation transformation, rotating the given radians about the specified axis and store the result in dest.
Matrix4f	rotate(AxisAngle4f axisAngle, Matrix4f dest)	Apply a rotation transformation, rotating about the given AxisAngle4f and store the result in dest.
Matrix4f	rotate(Quaternionfc quat, Matrix4f dest)	Apply the rotation - and possibly scaling - transformation of the given Quaternionfc to this matrix and store the result in dest.
Matrix4f	rotateAffine(float ang, float x, float y, float z, Matrix4f dest)	Apply rotation to this affine matrix by rotating the given amount of radians about the specified (x, y, z) axis and store the result in dest.
Matrix4f	rotateAffine(Quaternionfc quat, Matrix4f dest)	Apply the rotation - and possibly scaling - transformation of the given Quaternionfc to this affine matrix and store the result in dest.
Matrix4f	rotateAffineXYZ(float angleX, float angleY, float angleZ, Matrix4f dest)	Apply rotation of angleX radians about the X axis, followed by a rotation of angleY radians about the Y axis and followed by a rotation of angleZ radians about the Z axis and store the result in dest.
Matrix4f	rotateAffineYXZ(float angleY, float angleX, float angleZ, Matrix4f dest)	Apply rotation of angleY radians about the Y axis, followed by a rotation of angleX radians about the X axis and followed by a rotation of angleZ radians about the Z axis and store the result in dest.
Matrix4f	rotateAffineZYX(float angleZ, float angleY, float angleX, Matrix4f dest)	Apply rotation of angleZ radians about the Z axis, followed by a rotation of angleY radians about the Y axis and followed by a rotation of angleX radians about the X axis and store the result in dest.
Matrix4f	rotateAround(Quaternionfc quat, float ox, float oy, float oz, Matrix4f dest)	Apply the rotation - and possibly scaling - transformation of the given Quaternionfc to this matrix while using (ox, oy, oz) as the rotation origin, and store the result in dest.
Matrix4f	rotateAroundAffine(Quaternionfc quat, float ox, float oy, float oz, Matrix4f dest)	Apply the rotation - and possibly scaling - transformation of the given Quaternionfc to this affine matrix while using (ox, oy, oz) as the rotation origin, and store the result in dest.
Matrix4f	rotateAroundLocal(Quaternionfc quat, float ox, float oy, float oz, Matrix4f dest)	Pre-multiply the rotation - and possibly scaling - transformation of the given Quaternionfc to this matrix while using (ox, oy, oz) as the rotation origin, and store the result in dest.
Matrix4f	rotateLocal(float ang, float x, float y, float z, Matrix4f dest)	Pre-multiply a rotation to this matrix by rotating the given amount of radians about the specified (x, y, z) axis and store the result in dest.
Matrix4f	rotateLocal(Quaternionfc quat, Matrix4f dest)	Pre-multiply the rotation - and possibly scaling - transformation of the given Quaternionfc to this matrix and store the result in dest.
Matrix4f	rotateLocalX(float ang, Matrix4f dest)	Pre-multiply a rotation around the X axis to this matrix by rotating the given amount of radians about the X axis and store the result in dest.
Matrix4f	rotateLocalY(float ang, Matrix4f dest)	Pre-multiply a rotation around the Y axis to this matrix by rotating the given amount of radians about the Y axis and store the result in dest.
Matrix4f	rotateLocalZ(float ang, Matrix4f dest)	Pre-multiply a rotation around the Z axis to this matrix by rotating the given amount of radians about the Z axis and store the result in dest.
Matrix4f	rotateTowards(float dirX, float dirY, float dirZ, float upX, float upY, float upZ, Matrix4f dest)	Apply a model transformation to this matrix for a right-handed coordinate system, that aligns the local +Z axis with (dirX, dirY, dirZ) and store the result in dest.
Matrix4f	rotateTowards(Vector3fc dir, Vector3fc up, Matrix4f dest)	Apply a model transformation to this matrix for a right-handed coordinate system, that aligns the local +Z axis with dir and store the result in dest.
Matrix4f	rotateTowardsXY(float dirX, float dirY, Matrix4f dest)	Apply rotation about the Z axis to align the local +X towards (dirX, dirY) and store the result in dest.
Matrix4f	rotateTranslation(float ang, float x, float y, float z, Matrix4f dest)	Apply rotation to this matrix, which is assumed to only contain a translation, by rotating the given amount of radians about the specified (x, y, z) axis and store the result in dest.
Matrix4f	rotateTranslation(Quaternionfc quat, Matrix4f dest)	Apply the rotation - and possibly scaling - ransformation of the given Quaternionfc to this matrix, which is assumed to only contain a translation, and store the result in dest.
Matrix4f	rotateX(float ang, Matrix4f dest)	Apply rotation about the X axis to this matrix by rotating the given amount of radians and store the result in dest.
Matrix4f	rotateXYZ(float angleX, float angleY, float angleZ, Matrix4f dest)	Apply rotation of angleX radians about the X axis, followed by a rotation of angleY radians about the Y axis and followed by a rotation of angleZ radians about the Z axis and store the result in dest.
Matrix4f	rotateY(float ang, Matrix4f dest)	Apply rotation about the Y axis to this matrix by rotating the given amount of radians and store the result in dest.
Matrix4f	rotateYXZ(float angleY, float angleX, float angleZ, Matrix4f dest)	Apply rotation of angleY radians about the Y axis, followed by a rotation of angleX radians about the X axis and followed by a rotation of angleZ radians about the Z axis and store the result in dest.
Matrix4f	rotateZ(float ang, Matrix4f dest)	Apply rotation about the Z axis to this matrix by rotating the given amount of radians and store the result in dest.
Matrix4f	rotateZYX(float angleZ, float angleY, float angleX, Matrix4f dest)	Apply rotation of angleZ radians about the Z axis, followed by a rotation of angleY radians about the Y axis and followed by a rotation of angleX radians about the X axis and store the result in dest.
Matrix4f	scale(float x, float y, float z, Matrix4f dest)	Apply scaling to this matrix by scaling the base axes by the given x, y and z factors and store the result in dest.
Matrix4f	scale(float xyz, Matrix4f dest)	Apply scaling to this matrix by uniformly scaling all base axes by the given xyz factor and store the result in dest.
Matrix4f	scale(Vector3fc xyz, Matrix4f dest)	Apply scaling to this matrix by scaling the base axes by the given xyz.x, xyz.y and xyz.z factors, respectively and store the result in dest.
Matrix4f	scaleAround(float sx, float sy, float sz, float ox, float oy, float oz, Matrix4f dest)	Apply scaling to this matrix by scaling the base axes by the given sx, sy and sz factors while using (ox, oy, oz) as the scaling origin, and store the result in dest.
Matrix4f	scaleAround(float factor, float ox, float oy, float oz, Matrix4f dest)	Apply scaling to this matrix by scaling all three base axes by the given factor while using (ox, oy, oz) as the scaling origin, and store the result in dest.
Matrix4f	scaleAroundLocal(float sx, float sy, float sz, float ox, float oy, float oz, Matrix4f dest)	Pre-multiply scaling to this matrix by scaling the base axes by the given sx, sy and sz factors while using the given (ox, oy, oz) as the scaling origin, and store the result in dest.
Matrix4f	scaleAroundLocal(float factor, float ox, float oy, float oz, Matrix4f dest)	Pre-multiply scaling to this matrix by scaling all three base axes by the given factor while using (ox, oy, oz) as the scaling origin, and store the result in dest.
Matrix4f	scaleLocal(float x, float y, float z, Matrix4f dest)	Pre-multiply scaling to this matrix by scaling the base axes by the given x, y and z factors and store the result in dest.
Matrix4f	scaleLocal(float xyz, Matrix4f dest)	Pre-multiply scaling to this matrix by scaling all base axes by the given xyz factor, and store the result in dest.
Matrix4f	scaleXY(float x, float y, Matrix4f dest)	Apply scaling to this matrix by by scaling the X axis by x and the Y axis by y and store the result in dest.
Matrix4f	shadow(float lightX, float lightY, float lightZ, float lightW, float a, float b, float c, float d, Matrix4f dest)	Apply a projection transformation to this matrix that projects onto the plane specified via the general plane equation x*a + y*b + z*c + d = 0 as if casting a shadow from a given light position/direction (lightX, lightY, lightZ, lightW) and store the result in dest.
Matrix4f	shadow(float lightX, float lightY, float lightZ, float lightW, Matrix4fc planeTransform, Matrix4f dest)	Apply a projection transformation to this matrix that projects onto the plane with the general plane equation y = 0 as if casting a shadow from a given light position/direction (lightX, lightY, lightZ, lightW) and store the result in dest.
Matrix4f	shadow(Vector4f light, float a, float b, float c, float d, Matrix4f dest)	Apply a projection transformation to this matrix that projects onto the plane specified via the general plane equation x*a + y*b + z*c + d = 0 as if casting a shadow from a given light position/direction light and store the result in dest.
Matrix4f	shadow(Vector4f light, Matrix4fc planeTransform, Matrix4f dest)	Apply a projection transformation to this matrix that projects onto the plane with the general plane equation y = 0 as if casting a shadow from a given light position/direction light and store the result in dest.
Matrix4f	sub(Matrix4fc subtrahend, Matrix4f dest)	Component-wise subtract subtrahend from this and store the result in dest.
Matrix4f	sub4x3(Matrix4fc subtrahend, Matrix4f dest)	Component-wise subtract the upper 4x3 submatrices of subtrahend from this and store the result in dest.
boolean	testAab(float minX, float minY, float minZ, float maxX, float maxY, float maxZ)	Test whether the given axis-aligned box is partly or completely within or outside of the frustum defined by this matrix.
boolean	testPoint(float x, float y, float z)	Test whether the given point (x, y, z) is within the frustum defined by this matrix.
boolean	testSphere(float x, float y, float z, float r)	Test whether the given sphere is partly or completely within or outside of the frustum defined by this matrix.
Matrix4f	tile(int x, int y, int w, int h, Matrix4f dest)	This method is equivalent to calling: translate(w-1-2*x, h-1-2*y, 0, dest).scale(w, h, 1)
Vector4f	transform(float x, float y, float z, float w, Vector4f dest)	Transform/multiply the vector (x, y, z, w) by this matrix and store the result in dest.
Vector4f	transform(Vector4f v)	Transform/multiply the given vector by this matrix and store the result in that vector.
Vector4f	transform(Vector4fc v, Vector4f dest)	Transform/multiply the given vector by this matrix and store the result in dest.
Matrix4f	transformAab(float minX, float minY, float minZ, float maxX, float maxY, float maxZ, Vector3f outMin, Vector3f outMax)	Transform the axis-aligned box given as the minimum corner (minX, minY, minZ) and maximum corner (maxX, maxY, maxZ) by this affine matrix and compute the axis-aligned box of the result whose minimum corner is stored in outMin and maximum corner stored in outMax.
Matrix4f	transformAab(Vector3fc min, Vector3fc max, Vector3f outMin, Vector3f outMax)	Transform the axis-aligned box given as the minimum corner min and maximum corner max by this affine matrix and compute the axis-aligned box of the result whose minimum corner is stored in outMin and maximum corner stored in outMax.
Vector4f	transformAffine(float x, float y, float z, float w, Vector4f dest)	Transform/multiply the 4D-vector (x, y, z, w) by assuming that this matrix represents an affine transformation (i.e.
Vector4f	transformAffine(Vector4f v)	Transform/multiply the given 4D-vector by assuming that this matrix represents an affine transformation (i.e.
Vector4f	transformAffine(Vector4fc v, Vector4f dest)	Transform/multiply the given 4D-vector by assuming that this matrix represents an affine transformation (i.e.
Vector3f	transformDirection(float x, float y, float z, Vector3f dest)	Transform/multiply the given 3D-vector (x, y, z), as if it was a 4D-vector with w=0, by this matrix and store the result in dest.
Vector3f	transformDirection(Vector3f v)	Transform/multiply the given 3D-vector, as if it was a 4D-vector with w=0, by this matrix and store the result in that vector.
Vector3f	transformDirection(Vector3fc v, Vector3f dest)	Transform/multiply the given 3D-vector, as if it was a 4D-vector with w=0, by this matrix and store the result in dest.
Vector3f	transformPosition(float x, float y, float z, Vector3f dest)	Transform/multiply the 3D-vector (x, y, z), as if it was a 4D-vector with w=1, by this matrix and store the result in dest.
Vector3f	transformPosition(Vector3f v)	Transform/multiply the given 3D-vector, as if it was a 4D-vector with w=1, by this matrix and store the result in that vector.
Vector3f	transformPosition(Vector3fc v, Vector3f dest)	Transform/multiply the given 3D-vector, as if it was a 4D-vector with w=1, by this matrix and store the result in dest.
Vector3f	transformProject(float x, float y, float z, float w, Vector3f dest)	Transform/multiply the vector (x, y, z, w) by this matrix, perform perspective divide and store (x, y, z) of the result in dest.
Vector4f	transformProject(float x, float y, float z, float w, Vector4f dest)	Transform/multiply the vector (x, y, z, w) by this matrix, perform perspective divide and store the result in dest.
Vector3f	transformProject(float x, float y, float z, Vector3f dest)	Transform/multiply the vector (x, y, z) by this matrix, perform perspective divide and store the result in dest.
Vector3f	transformProject(Vector3f v)	Transform/multiply the given vector by this matrix, perform perspective divide and store the result in that vector.
Vector3f	transformProject(Vector3fc v, Vector3f dest)	Transform/multiply the given vector by this matrix, perform perspective divide and store the result in dest.
Vector4f	transformProject(Vector4f v)	Transform/multiply the given vector by this matrix, perform perspective divide and store the result in that vector.
Vector3f	transformProject(Vector4fc v, Vector3f dest)	Transform/multiply the given vector by this matrix, perform perspective divide and store the result in dest.
Vector4f	transformProject(Vector4fc v, Vector4f dest)	Transform/multiply the given vector by this matrix, perform perspective divide and store the result in dest.
Vector4f	transformTranspose(float x, float y, float z, float w, Vector4f dest)	Transform/multiply the vector (x, y, z, w) by the transpose of this matrix and store the result in dest.
Vector4f	transformTranspose(Vector4f v)	Transform/multiply the given vector by the transpose of this matrix and store the result in that vector.
Vector4f	transformTranspose(Vector4fc v, Vector4f dest)	Transform/multiply the given vector by the transpose of this matrix and store the result in dest.
Matrix4f	translate(float x, float y, float z, Matrix4f dest)	Apply a translation to this matrix by translating by the given number of units in x, y and z and store the result in dest.
Matrix4f	translate(Vector3fc offset, Matrix4f dest)	Apply a translation to this matrix by translating by the given number of units in x, y and z and store the result in dest.
Matrix4f	translateLocal(float x, float y, float z, Matrix4f dest)	Pre-multiply a translation to this matrix by translating by the given number of units in x, y and z and store the result in dest.
Matrix4f	translateLocal(Vector3fc offset, Matrix4f dest)	Pre-multiply a translation to this matrix by translating by the given number of units in x, y and z and store the result in dest.
Matrix4f	transpose(Matrix4f dest)	Transpose this matrix and store the result in dest.
Matrix3f	transpose3x3(Matrix3f dest)	Transpose only the upper left 3x3 submatrix of this matrix and store the result in dest.
Matrix4f	transpose3x3(Matrix4f dest)	Transpose only the upper left 3x3 submatrix of this matrix and store the result in dest.
Vector3f	unproject(float winX, float winY, float winZ, int[] viewport, Vector3f dest)	Unproject the given window coordinates (winX, winY, winZ) by this matrix using the specified viewport.
Vector4f	unproject(float winX, float winY, float winZ, int[] viewport, Vector4f dest)	Unproject the given window coordinates (winX, winY, winZ) by this matrix using the specified viewport.
Vector3f	unproject(Vector3fc winCoords, int[] viewport, Vector3f dest)	Unproject the given window coordinates winCoords by this matrix using the specified viewport.
Vector4f	unproject(Vector3fc winCoords, int[] viewport, Vector4f dest)	Unproject the given window coordinates winCoords by this matrix using the specified viewport.
Vector3f	unprojectInv(float winX, float winY, float winZ, int[] viewport, Vector3f dest)	Unproject the given window coordinates (winX, winY, winZ) by this matrix using the specified viewport.
Vector4f	unprojectInv(float winX, float winY, float winZ, int[] viewport, Vector4f dest)	Unproject the given window coordinates (winX, winY, winZ) by this matrix using the specified viewport.
Vector3f	unprojectInv(Vector3fc winCoords, int[] viewport, Vector3f dest)	Unproject the given window coordinates winCoords by this matrix using the specified viewport.
Vector4f	unprojectInv(Vector3fc winCoords, int[] viewport, Vector4f dest)	Unproject the given window coordinates winCoords by this matrix using the specified viewport.
Matrix4f	unprojectInvRay(float winX, float winY, int[] viewport, Vector3f originDest, Vector3f dirDest)	Unproject the given 2D window coordinates (winX, winY) by this matrix using the specified viewport and compute the origin and the direction of the resulting ray which starts at NDC z = -1.0 and goes through NDC z = +1.0.
Matrix4f	unprojectInvRay(Vector2fc winCoords, int[] viewport, Vector3f originDest, Vector3f dirDest)	Unproject the given window coordinates winCoords by this matrix using the specified viewport and compute the origin and the direction of the resulting ray which starts at NDC z = -1.0 and goes through NDC z = +1.0.
Matrix4f	unprojectRay(float winX, float winY, int[] viewport, Vector3f originDest, Vector3f dirDest)	Unproject the given 2D window coordinates (winX, winY) by this matrix using the specified viewport and compute the origin and the direction of the resulting ray which starts at NDC z = -1.0 and goes through NDC z = +1.0.
Matrix4f	unprojectRay(Vector2fc winCoords, int[] viewport, Vector3f originDest, Vector3f dirDest)	Unproject the given 2D window coordinates winCoords by this matrix using the specified viewport and compute the origin and the direction of the resulting ray which starts at NDC z = -1.0 and goes through NDC z = +1.0.
Matrix4f	withLookAtUp(float upX, float upY, float upZ, Matrix4f dest)	Apply a transformation to this matrix to ensure that the local Y axis (as obtained by positiveY(Vector3f)) will be coplanar to the plane spanned by the local Z axis (as obtained by positiveZ(Vector3f)) and the given vector (upX, upY, upZ), and store the result in dest.
Matrix4f	withLookAtUp(Vector3fc up, Matrix4f dest)	Apply a transformation to this matrix to ensure that the local Y axis (as obtained by positiveY(Vector3f)) will be coplanar to the plane spanned by the local Z axis (as obtained by positiveZ(Vector3f)) and the given vector up, and store the result in dest.

Field Details

PLANE_NX

static final int PLANE_NX

Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation x=-1 when using the identity matrix.

See Also:

• Constant Field Values

PLANE_PX

static final int PLANE_PX

Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation x=1 when using the identity matrix.

See Also:

• Constant Field Values

PLANE_NY

static final int PLANE_NY

Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation y=-1 when using the identity matrix.

See Also:

• Constant Field Values

PLANE_PY

static final int PLANE_PY

Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation y=1 when using the identity matrix.

See Also:

• Constant Field Values

PLANE_NZ

static final int PLANE_NZ

Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation z=-1 when using the identity matrix.

See Also:

• Constant Field Values

PLANE_PZ

static final int PLANE_PZ

Argument to the first parameter of frustumPlane(int, Vector4f) identifying the plane with equation z=1 when using the identity matrix.

See Also:

• Constant Field Values

CORNER_NXNYNZ

static final int CORNER_NXNYNZ

Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (-1, -1, -1) when using the identity matrix.

See Also:

• Constant Field Values

CORNER_PXNYNZ

static final int CORNER_PXNYNZ

Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (1, -1, -1) when using the identity matrix.

See Also:

• Constant Field Values

CORNER_PXPYNZ

static final int CORNER_PXPYNZ

Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (1, 1, -1) when using the identity matrix.

See Also:

• Constant Field Values

CORNER_NXPYNZ

static final int CORNER_NXPYNZ

Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (-1, 1, -1) when using the identity matrix.

See Also:

• Constant Field Values

CORNER_PXNYPZ

static final int CORNER_PXNYPZ

Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (1, -1, 1) when using the identity matrix.

See Also:

• Constant Field Values

CORNER_NXNYPZ

static final int CORNER_NXNYPZ

Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (-1, -1, 1) when using the identity matrix.

See Also:

• Constant Field Values

CORNER_NXPYPZ

static final int CORNER_NXPYPZ

Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (-1, 1, 1) when using the identity matrix.

See Also:

• Constant Field Values

CORNER_PXPYPZ

static final int CORNER_PXPYPZ

Argument to the first parameter of frustumCorner(int, Vector3f) identifying the corner (1, 1, 1) when using the identity matrix.

See Also:

• Constant Field Values

PROPERTY_PERSPECTIVE

static final byte PROPERTY_PERSPECTIVE

Bit returned by properties() to indicate that the matrix represents a perspective transformation.

See Also:

• Constant Field Values

PROPERTY_AFFINE

static final byte PROPERTY_AFFINE

Bit returned by properties() to indicate that the matrix represents an affine transformation.

See Also:

• Constant Field Values

PROPERTY_IDENTITY

static final byte PROPERTY_IDENTITY

Bit returned by properties() to indicate that the matrix represents the identity transformation.

See Also:

• Constant Field Values

PROPERTY_TRANSLATION

static final byte PROPERTY_TRANSLATION

Bit returned by properties() to indicate that the matrix represents a pure translation transformation.

See Also:

• Constant Field Values

PROPERTY_ORTHONORMAL

static final byte PROPERTY_ORTHONORMAL

Bit returned by properties() to indicate that the upper-left 3x3 submatrix represents an orthogonal matrix (i.e. orthonormal basis). For practical reasons, this property also always implies PROPERTY_AFFINE in this implementation.

See Also:

• Constant Field Values

Method Details

properties

int properties()

Return the assumed properties of this matrix. This is a bit-combination of PROPERTY_IDENTITY, PROPERTY_AFFINE, PROPERTY_TRANSLATION and PROPERTY_PERSPECTIVE.

Returns:

the properties of the matrix

m00

float m00()

Return the value of the matrix element at column 0 and row 0.

Returns:

the value of the matrix element

m01

float m01()

Return the value of the matrix element at column 0 and row 1.

Returns:

the value of the matrix element

m02

float m02()

Return the value of the matrix element at column 0 and row 2.

Returns:

the value of the matrix element

m03

float m03()

Return the value of the matrix element at column 0 and row 3.

Returns:

the value of the matrix element

m10

float m10()

Return the value of the matrix element at column 1 and row 0.

Returns:

the value of the matrix element

m11

float m11()

Return the value of the matrix element at column 1 and row 1.

Returns:

the value of the matrix element

m12

float m12()

Return the value of the matrix element at column 1 and row 2.

Returns:

the value of the matrix element

m13

float m13()

Return the value of the matrix element at column 1 and row 3.

Returns:

the value of the matrix element

m20

float m20()

Return the value of the matrix element at column 2 and row 0.

Returns:

the value of the matrix element

m21

float m21()

Return the value of the matrix element at column 2 and row 1.

Returns:

the value of the matrix element

m22

float m22()

Return the value of the matrix element at column 2 and row 2.

Returns:

the value of the matrix element

m23

float m23()

Return the value of the matrix element at column 2 and row 3.

Returns:

the value of the matrix element

m30

float m30()

Return the value of the matrix element at column 3 and row 0.

Returns:

the value of the matrix element

m31

float m31()

Return the value of the matrix element at column 3 and row 1.

Returns:

the value of the matrix element

m32

float m32()

Return the value of the matrix element at column 3 and row 2.

Returns:

the value of the matrix element

m33

float m33()

Return the value of the matrix element at column 3 and row 3.

Returns:

the value of the matrix element

mul

Matrix4f mul(Matrix4fc right,
 Matrix4f dest)

Multiply this matrix by the supplied right matrix and store the result in dest.

If M is this matrix and R the right matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

right - the right operand of the matrix multiplication

dest - the destination matrix, which will hold the result

Returns:

dest

mul0

Matrix4f mul0(Matrix4fc right,
 Matrix4f dest)

Multiply this matrix by the supplied right matrix and store the result in dest.

If M is this matrix and R the right matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

This method neither assumes nor checks for any matrix properties of this or right and will always perform a complete 4x4 matrix multiplication. This method should only be used whenever the multiplied matrices do not have any properties for which there are optimized multiplication methods available.

Parameters:

right - the right operand of the matrix multiplication

dest - the destination matrix, which will hold the result

Returns:

dest

mul

Matrix4f mul(float r00,
 float r01,
 float r02,
 float r03,
 float r10,
 float r11,
 float r12,
 float r13,
 float r20,
 float r21,
 float r22,
 float r23,
 float r30,
 float r31,
 float r32,
 float r33,
 Matrix4f dest)

Multiply this matrix by the matrix with the supplied elements and store the result in dest.

If M is this matrix and R the right matrix whose elements are supplied via the parameters, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

r00 - the m00 element of the right matrix

r01 - the m01 element of the right matrix

r02 - the m02 element of the right matrix

r03 - the m03 element of the right matrix

r10 - the m10 element of the right matrix

r11 - the m11 element of the right matrix

r12 - the m12 element of the right matrix

r13 - the m13 element of the right matrix

r20 - the m20 element of the right matrix

r21 - the m21 element of the right matrix

r22 - the m22 element of the right matrix

r23 - the m23 element of the right matrix

r30 - the m30 element of the right matrix

r31 - the m31 element of the right matrix

r32 - the m32 element of the right matrix

r33 - the m33 element of the right matrix

dest - the destination matrix, which will hold the result

Returns:

dest

mul3x3

Matrix4f mul3x3(float r00,
 float r01,
 float r02,
 float r10,
 float r11,
 float r12,
 float r20,
 float r21,
 float r22,
 Matrix4f dest)

Multiply this matrix by the 3x3 matrix with the supplied elements expanded to a 4x4 matrix with all other matrix elements set to identity, and store the result in dest.

If M is this matrix and R the right matrix whose elements are supplied via the parameters, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

r00 - the m00 element of the right matrix

r01 - the m01 element of the right matrix

r02 - the m02 element of the right matrix

r10 - the m10 element of the right matrix

r11 - the m11 element of the right matrix

r12 - the m12 element of the right matrix

r20 - the m20 element of the right matrix

r21 - the m21 element of the right matrix

r22 - the m22 element of the right matrix

dest - the destination matrix, which will hold the result

Returns:

this

mulLocal

Matrix4f mulLocal(Matrix4fc left,
 Matrix4f dest)

Pre-multiply this matrix by the supplied left matrix and store the result in dest.

If M is this matrix and L the left matrix, then the new matrix will be L * M. So when transforming a vector v with the new matrix by using L * M * v, the transformation of this matrix will be applied first!

Parameters:

left - the left operand of the matrix multiplication

dest - the destination matrix, which will hold the result

Returns:

dest

mulLocalAffine

Matrix4f mulLocalAffine(Matrix4fc left,
 Matrix4f dest)

Pre-multiply this matrix by the supplied left matrix, both of which are assumed to be affine, and store the result in dest.

This method assumes that this matrix and the given left matrix both represent an affine transformation (i.e. their last rows are equal to (0, 0, 0, 1)) and can be used to speed up matrix multiplication if the matrices only represent affine transformations, such as translation, rotation, scaling and shearing (in any combination).

This method will not modify either the last row of this or the last row of left.

If M is this matrix and L the left matrix, then the new matrix will be L * M. So when transforming a vector v with the new matrix by using L * M * v, the transformation of this matrix will be applied first!

Parameters:

left - the left operand of the matrix multiplication (the last row is assumed to be (0, 0, 0, 1))

dest - the destination matrix, which will hold the result

Returns:

dest

mul

Matrix4f mul(Matrix3x2fc right,
 Matrix4f dest)

Multiply this matrix by the supplied right matrix and store the result in dest.

If M is this matrix and R the right matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

right - the right operand of the matrix multiplication

dest - the destination matrix, which will hold the result

Returns:

dest

mul

Matrix4f mul(Matrix4x3fc right,
 Matrix4f dest)

Multiply this matrix by the supplied right matrix and store the result in dest.

The last row of the right matrix is assumed to be (0, 0, 0, 1).

If M is this matrix and R the right matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

right - the right operand of the matrix multiplication

dest - the destination matrix, which will hold the result

Returns:

dest

mulPerspectiveAffine

Matrix4f mulPerspectiveAffine(Matrix4fc view,
 Matrix4f dest)

Multiply this symmetric perspective projection matrix by the supplied affine view matrix and store the result in dest.

If P is this matrix and V the view matrix, then the new matrix will be P * V. So when transforming a vector v with the new matrix by using P * V * v, the transformation of the view matrix will be applied first!

Parameters:

view - the affine matrix to multiply this symmetric perspective projection matrix by

dest - the destination matrix, which will hold the result

Returns:

dest

mulPerspectiveAffine

Matrix4f mulPerspectiveAffine(Matrix4x3fc view,
 Matrix4f dest)

Multiply this symmetric perspective projection matrix by the supplied view matrix and store the result in dest.

If P is this matrix and V the view matrix, then the new matrix will be P * V. So when transforming a vector v with the new matrix by using P * V * v, the transformation of the view matrix will be applied first!

Parameters:

view - the matrix to multiply this symmetric perspective projection matrix by

dest - the destination matrix, which will hold the result

Returns:

dest

mulAffineR

Matrix4f mulAffineR(Matrix4fc right,
 Matrix4f dest)

Multiply this matrix by the supplied right matrix, which is assumed to be affine, and store the result in dest.

This method assumes that the given right matrix represents an affine transformation (i.e. its last row is equal to (0, 0, 0, 1)) and can be used to speed up matrix multiplication if the matrix only represents affine transformations, such as translation, rotation, scaling and shearing (in any combination).

If M is this matrix and R the right matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

right - the right operand of the matrix multiplication (the last row is assumed to be (0, 0, 0, 1))

dest - the destination matrix, which will hold the result

Returns:

dest

mulAffine

Matrix4f mulAffine(Matrix4fc right,
 Matrix4f dest)

Multiply this matrix by the supplied right matrix, both of which are assumed to be affine, and store the result in dest.

This method assumes that this matrix and the given right matrix both represent an affine transformation (i.e. their last rows are equal to (0, 0, 0, 1)) and can be used to speed up matrix multiplication if the matrices only represent affine transformations, such as translation, rotation, scaling and shearing (in any combination).

This method will not modify either the last row of this or the last row of right.

If M is this matrix and R the right matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

right - the right operand of the matrix multiplication (the last row is assumed to be (0, 0, 0, 1))

dest - the destination matrix, which will hold the result

Returns:

dest

mulTranslationAffine

Matrix4f mulTranslationAffine(Matrix4fc right,
 Matrix4f dest)

Multiply this matrix, which is assumed to only contain a translation, by the supplied right matrix, which is assumed to be affine, and store the result in dest.

This method assumes that this matrix only contains a translation, and that the given right matrix represents an affine transformation (i.e. its last row is equal to (0, 0, 0, 1)).

This method will not modify either the last row of this or the last row of right.

If M is this matrix and R the right matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

right - the right operand of the matrix multiplication (the last row is assumed to be (0, 0, 0, 1))

dest - the destination matrix, which will hold the result

Returns:

dest

mulOrthoAffine

Matrix4f mulOrthoAffine(Matrix4fc view,
 Matrix4f dest)

Multiply this orthographic projection matrix by the supplied affine view matrix and store the result in dest.

If M is this matrix and V the view matrix, then the new matrix will be M * V. So when transforming a vector v with the new matrix by using M * V * v, the transformation of the view matrix will be applied first!

Parameters:

view - the affine matrix which to multiply this with

dest - the destination matrix, which will hold the result

Returns:

dest

fma4x3

Matrix4f fma4x3(Matrix4fc other,
 float otherFactor,
 Matrix4f dest)

Component-wise add the upper 4x3 submatrices of this and other by first multiplying each component of other's 4x3 submatrix by otherFactor, adding that to this and storing the final result in dest.

The other components of dest will be set to the ones of this.

The matrices this and other will not be changed.

Parameters:

other - the other matrix

otherFactor - the factor to multiply each of the other matrix's 4x3 components

dest - will hold the result

Returns:

dest

add

Matrix4f add(Matrix4fc other,
 Matrix4f dest)

Component-wise add this and other and store the result in dest.

Parameters:

other - the other addend

dest - will hold the result

Returns:

dest

sub

Matrix4f sub(Matrix4fc subtrahend,
 Matrix4f dest)

Component-wise subtract subtrahend from this and store the result in dest.

Parameters:

subtrahend - the subtrahend

dest - will hold the result

Returns:

dest

mulComponentWise

Matrix4f mulComponentWise(Matrix4fc other,
 Matrix4f dest)

Component-wise multiply this by other and store the result in dest.

Parameters:

other - the other matrix

dest - will hold the result

Returns:

dest

add4x3

Matrix4f add4x3(Matrix4fc other,
 Matrix4f dest)

Component-wise add the upper 4x3 submatrices of this and other and store the result in dest.

The other components of dest will be set to the ones of this.

Parameters:

other - the other addend

dest - will hold the result

Returns:

dest

sub4x3

Matrix4f sub4x3(Matrix4fc subtrahend,
 Matrix4f dest)

Component-wise subtract the upper 4x3 submatrices of subtrahend from this and store the result in dest.

The other components of dest will be set to the ones of this.

Parameters:

subtrahend - the subtrahend

dest - will hold the result

Returns:

dest

mul4x3ComponentWise

Matrix4f mul4x3ComponentWise(Matrix4fc other,
 Matrix4f dest)

Component-wise multiply the upper 4x3 submatrices of this by other and store the result in dest.

The other components of dest will be set to the ones of this.

Parameters:

other - the other matrix

dest - will hold the result

Returns:

dest

determinant

float determinant()

Return the determinant of this matrix.

If this matrix represents an affine transformation, such as translation, rotation, scaling and shearing, and thus its last row is equal to (0, 0, 0, 1), then determinantAffine() can be used instead of this method.

Returns:

the determinant

See Also:

• determinantAffine()

determinant3x3

float determinant3x3()

Return the determinant of the upper left 3x3 submatrix of this matrix.

Returns:

the determinant

determinantAffine

float determinantAffine()

Return the determinant of this matrix by assuming that it represents an affine transformation and thus its last row is equal to (0, 0, 0, 1).

Returns:

the determinant

invert

Matrix4f invert(Matrix4f dest)

Invert this matrix and write the result into dest.

If this matrix represents an affine transformation, such as translation, rotation, scaling and shearing, and thus its last row is equal to (0, 0, 0, 1), then invertAffine(Matrix4f) can be used instead of this method.

Parameters:

dest - will hold the result

Returns:

dest

See Also:

• invertAffine(Matrix4f)

invertPerspective

Matrix4f invertPerspective(Matrix4f dest)

If this is a perspective projection matrix obtained via one of the perspective() methods, that is, if this is a symmetrical perspective frustum transformation, then this method builds the inverse of this and stores it into the given dest.

This method can be used to quickly obtain the inverse of a perspective projection matrix when being obtained via perspective().

Parameters:

dest - will hold the inverse of this

Returns:

dest

See Also:

• perspective(float, float, float, float, Matrix4f)

invertFrustum

Matrix4f invertFrustum(Matrix4f dest)

If this is an arbitrary perspective projection matrix obtained via one of the frustum() methods, then this method builds the inverse of this and stores it into the given dest.

This method can be used to quickly obtain the inverse of a perspective projection matrix.

If this matrix represents a symmetric perspective frustum transformation, as obtained via perspective(), then invertPerspective(Matrix4f) should be used instead.

Parameters:

dest - will hold the inverse of this

Returns:

dest

See Also:

• frustum(float, float, float, float, float, float, Matrix4f)
• invertPerspective(Matrix4f)

invertOrtho

Matrix4f invertOrtho(Matrix4f dest)

Invert this orthographic projection matrix and store the result into the given dest.

This method can be used to quickly obtain the inverse of an orthographic projection matrix.

Parameters:

dest - will hold the inverse of this

Returns:

dest

invertPerspectiveView

Matrix4f invertPerspectiveView(Matrix4fc view,
 Matrix4f dest)

If this is a perspective projection matrix obtained via one of the perspective() methods, that is, if this is a symmetrical perspective frustum transformation and the given view matrix is affine and has unit scaling (for example by being obtained via lookAt()), then this method builds the inverse of this * view and stores it into the given dest.

This method can be used to quickly obtain the inverse of the combination of the view and projection matrices, when both were obtained via the common methods perspective() and lookAt() or other methods, that build affine matrices, such as translate and rotate(float, float, float, float, Matrix4f), except for scale().

For the special cases of the matrices this and view mentioned above, this method is equivalent to the following code:

 dest.set(this).mul(view).invert();
 

Parameters:

view - the view transformation (must be affine and have unit scaling)

dest - will hold the inverse of this * view

Returns:

dest

invertPerspectiveView

Matrix4f invertPerspectiveView(Matrix4x3fc view,
 Matrix4f dest)

If this is a perspective projection matrix obtained via one of the perspective() methods, that is, if this is a symmetrical perspective frustum transformation and the given view matrix has unit scaling, then this method builds the inverse of this * view and stores it into the given dest.

This method can be used to quickly obtain the inverse of the combination of the view and projection matrices, when both were obtained via the common methods perspective() and lookAt() or other methods, that build affine matrices, such as translate and rotate(float, float, float, float, Matrix4f), except for scale().

For the special cases of the matrices this and view mentioned above, this method is equivalent to the following code:

 dest.set(this).mul(view).invert();
 

Parameters:

view - the view transformation (must have unit scaling)

dest - will hold the inverse of this * view

Returns:

dest

invertAffine

Matrix4f invertAffine(Matrix4f dest)

Invert this matrix by assuming that it is an affine transformation (i.e. its last row is equal to (0, 0, 0, 1)) and write the result into dest.

Parameters:

dest - will hold the result

Returns:

dest

transpose

Matrix4f transpose(Matrix4f dest)

Transpose this matrix and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

transpose3x3

Matrix4f transpose3x3(Matrix4f dest)

Transpose only the upper left 3x3 submatrix of this matrix and store the result in dest.

All other matrix elements are left unchanged.

Parameters:

dest - will hold the result

Returns:

dest

transpose3x3

Matrix3f transpose3x3(Matrix3f dest)

Transpose only the upper left 3x3 submatrix of this matrix and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

getTranslation

Vector3f getTranslation(Vector3f dest)

Get only the translation components (m30, m31, m32) of this matrix and store them in the given vector xyz.

Parameters:

dest - will hold the translation components of this matrix

Returns:

dest

getScale

Vector3f getScale(Vector3f dest)

Get the scaling factors of this matrix for the three base axes.

Parameters:

dest - will hold the scaling factors for x, y and z

Returns:

dest

get

Matrix4f get(Matrix4f dest)

Get the current values of this matrix and store them into dest.

Parameters:

dest - the destination matrix

Returns:

the passed in destination

get4x3

Matrix4x3f get4x3(Matrix4x3f dest)

Get the current values of the upper 4x3 submatrix of this matrix and store them into dest.

Parameters:

dest - the destination matrix

Returns:

the passed in destination

See Also:

• Matrix4x3f.set(Matrix4fc)

get

Matrix4d get(Matrix4d dest)

Get the current values of this matrix and store them into dest.

Parameters:

dest - the destination matrix

Returns:

the passed in destination

get3x3

Matrix3f get3x3(Matrix3f dest)

Get the current values of the upper left 3x3 submatrix of this matrix and store them into dest.

Parameters:

dest - the destination matrix

Returns:

the passed in destination

See Also:

• Matrix3f.set(Matrix4fc)

get3x3

Matrix3d get3x3(Matrix3d dest)

Get the current values of the upper left 3x3 submatrix of this matrix and store them into dest.

Parameters:

dest - the destination matrix

Returns:

the passed in destination

See Also:

• Matrix3d.set(Matrix4fc)

getRotation

AxisAngle4f getRotation(AxisAngle4f dest)

Get the rotational component of this matrix and store the represented rotation into the given AxisAngle4f.

Parameters:

dest - the destination AxisAngle4f

Returns:

the passed in destination

See Also:

• AxisAngle4f.set(Matrix4fc)

getRotation

AxisAngle4d getRotation(AxisAngle4d dest)

Get the rotational component of this matrix and store the represented rotation into the given AxisAngle4d.

Parameters:

dest - the destination AxisAngle4d

Returns:

the passed in destination

See Also:

• AxisAngle4f.set(Matrix4fc)

getUnnormalizedRotation

Quaternionf getUnnormalizedRotation(Quaternionf dest)

Get the current values of this matrix and store the represented rotation into the given Quaternionf.

This method assumes that the first three column vectors of the upper left 3x3 submatrix are not normalized and thus allows to ignore any additional scaling factor that is applied to the matrix.

Parameters:

dest - the destination Quaternionf

Returns:

the passed in destination

See Also:

• Quaternionf.setFromUnnormalized(Matrix4fc)

getNormalizedRotation

Quaternionf getNormalizedRotation(Quaternionf dest)

Get the current values of this matrix and store the represented rotation into the given Quaternionf.

This method assumes that the first three column vectors of the upper left 3x3 submatrix are normalized.

Parameters:

dest - the destination Quaternionf

Returns:

the passed in destination

See Also:

• Quaternionf.setFromNormalized(Matrix4fc)

getUnnormalizedRotation

Quaterniond getUnnormalizedRotation(Quaterniond dest)

Get the current values of this matrix and store the represented rotation into the given Quaterniond.

This method assumes that the first three column vectors of the upper left 3x3 submatrix are not normalized and thus allows to ignore any additional scaling factor that is applied to the matrix.

Parameters:

dest - the destination Quaterniond

Returns:

the passed in destination

See Also:

• Quaterniond.setFromUnnormalized(Matrix4fc)

getNormalizedRotation

Quaterniond getNormalizedRotation(Quaterniond dest)

Get the current values of this matrix and store the represented rotation into the given Quaterniond.

This method assumes that the first three column vectors of the upper left 3x3 submatrix are normalized.

Parameters:

dest - the destination Quaterniond

Returns:

the passed in destination

See Also:

• Quaterniond.setFromNormalized(Matrix4fc)

get

com.google.gwt.typedarrays.shared.Float32Array get(com.google.gwt.typedarrays.shared.Float32Array buffer)

Store this matrix in column-major order into the supplied Float32Array.

Parameters:

buffer - will receive the values of this matrix in column-major order

Returns:

the passed in buffer

get

com.google.gwt.typedarrays.shared.Float32Array get(int index,
 com.google.gwt.typedarrays.shared.Float32Array buffer)

Store this matrix in column-major order into the supplied Float32Array at the given index.

Parameters:

index - the index at which to store this matrix in the supplied Float32Array

buffer - will receive the values of this matrix in column-major order

Returns:

the passed in buffer

get

FloatBuffer get(FloatBuffer buffer)

Store this matrix in column-major order into the supplied FloatBuffer at the current buffer position.

This method will not increment the position of the given FloatBuffer.

In order to specify the offset into the FloatBuffer at which the matrix is stored, use get(int, FloatBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of this matrix in column-major order at its current position

Returns:

the passed in buffer

See Also:

• get(int, FloatBuffer)

get

FloatBuffer get(int index,
 FloatBuffer buffer)

Store this matrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given FloatBuffer.

Parameters:

index - the absolute position into the FloatBuffer

buffer - will receive the values of this matrix in column-major order

Returns:

the passed in buffer

get

ByteBuffer get(ByteBuffer buffer)

Store this matrix in column-major order into the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the matrix is stored, use get(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of this matrix in column-major order at its current position

Returns:

the passed in buffer

See Also:

• get(int, ByteBuffer)

get

ByteBuffer get(int index,
 ByteBuffer buffer)

Store this matrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - will receive the values of this matrix in column-major order

Returns:

the passed in buffer

get4x3

FloatBuffer get4x3(FloatBuffer buffer)

Store the upper 4x3 submatrix in column-major order into the supplied FloatBuffer at the current buffer position.

This method will not increment the position of the given FloatBuffer.

In order to specify the offset into the FloatBuffer at which the matrix is stored, use get(int, FloatBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of the upper 4x3 submatrix in column-major order at its current position

Returns:

the passed in buffer

See Also:

• get(int, FloatBuffer)

get4x3

FloatBuffer get4x3(int index,
 FloatBuffer buffer)

Store the upper 4x3 submatrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given FloatBuffer.

Parameters:

index - the absolute position into the FloatBuffer

buffer - will receive the values of the upper 4x3 submatrix in column-major order

Returns:

the passed in buffer

get4x3

ByteBuffer get4x3(ByteBuffer buffer)

Store the upper 4x3 submatrix in column-major order into the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the matrix is stored, use get(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of the upper 4x3 submatrix in column-major order at its current position

Returns:

the passed in buffer

See Also:

• get(int, ByteBuffer)

get4x3

ByteBuffer get4x3(int index,
 ByteBuffer buffer)

Store the upper 4x3 submatrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - will receive the values of the upper 4x3 submatrix in column-major order

Returns:

the passed in buffer

get3x4

FloatBuffer get3x4(FloatBuffer buffer)

Store the left 3x4 submatrix in column-major order into the supplied FloatBuffer at the current buffer position.

This method will not increment the position of the given FloatBuffer.

In order to specify the offset into the FloatBuffer at which the matrix is stored, use get3x4(int, FloatBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of the left 3x4 submatrix in column-major order at its current position

Returns:

the passed in buffer

See Also:

• get3x4(int, FloatBuffer)

get3x4

FloatBuffer get3x4(int index,
 FloatBuffer buffer)

Store the left 3x4 submatrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given FloatBuffer.

Parameters:

index - the absolute position into the FloatBuffer

buffer - will receive the values of the left 3x4 submatrix in column-major order

Returns:

the passed in buffer

get3x4

ByteBuffer get3x4(ByteBuffer buffer)

Store the left 3x4 submatrix in column-major order into the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the matrix is stored, use get3x4(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of the left 3x4 submatrix in column-major order at its current position

Returns:

the passed in buffer

See Also:

• get3x4(int, ByteBuffer)

get3x4

ByteBuffer get3x4(int index,
 ByteBuffer buffer)

Store the left 3x4 submatrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - will receive the values of the left 3x4 submatrix in column-major order

Returns:

the passed in buffer

getTransposed

FloatBuffer getTransposed(FloatBuffer buffer)

Store the transpose of this matrix in column-major order into the supplied FloatBuffer at the current buffer position.

This method will not increment the position of the given FloatBuffer.

In order to specify the offset into the FloatBuffer at which the matrix is stored, use getTransposed(int, FloatBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of this matrix in column-major order at its current position

Returns:

the passed in buffer

See Also:

• getTransposed(int, FloatBuffer)

getTransposed

FloatBuffer getTransposed(int index,
 FloatBuffer buffer)

Store the transpose of this matrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given FloatBuffer.

Parameters:

index - the absolute position into the FloatBuffer

buffer - will receive the values of this matrix in column-major order

Returns:

the passed in buffer

getTransposed

ByteBuffer getTransposed(ByteBuffer buffer)

Store the transpose of this matrix in column-major order into the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the matrix is stored, use getTransposed(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of this matrix in column-major order at its current position

Returns:

the passed in buffer

See Also:

• getTransposed(int, ByteBuffer)

getTransposed

ByteBuffer getTransposed(int index,
 ByteBuffer buffer)

Store the transpose of this matrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - will receive the values of this matrix in column-major order

Returns:

the passed in buffer

get4x3Transposed

FloatBuffer get4x3Transposed(FloatBuffer buffer)

Store the upper 4x3 submatrix of this matrix in row-major order into the supplied FloatBuffer at the current buffer position.

This method will not increment the position of the given FloatBuffer.

In order to specify the offset into the FloatBuffer at which the matrix is stored, use get4x3Transposed(int, FloatBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of the upper 4x3 submatrix in row-major order at its current position

Returns:

the passed in buffer

See Also:

• get4x3Transposed(int, FloatBuffer)

get4x3Transposed

FloatBuffer get4x3Transposed(int index,
 FloatBuffer buffer)

Store the upper 4x3 submatrix of this matrix in row-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given FloatBuffer.

Parameters:

index - the absolute position into the FloatBuffer

buffer - will receive the values of the upper 4x3 submatrix in row-major order

Returns:

the passed in buffer

get4x3Transposed

ByteBuffer get4x3Transposed(ByteBuffer buffer)

Store the upper 4x3 submatrix of this matrix in row-major order into the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the matrix is stored, use get4x3Transposed(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of the upper 4x3 submatrix in row-major order at its current position

Returns:

the passed in buffer

See Also:

• get4x3Transposed(int, ByteBuffer)

get4x3Transposed

ByteBuffer get4x3Transposed(int index,
 ByteBuffer buffer)

Store the upper 4x3 submatrix of this matrix in row-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - will receive the values of the upper 4x3 submatrix in row-major order

Returns:

the passed in buffer

getToAddress

Matrix4fc getToAddress(long address)

Store this matrix in column-major order at the given off-heap address.

This method will throw an UnsupportedOperationException when JOML is used with `-Djoml.nounsafe`.

This method is unsafe as it can result in a crash of the JVM process when the specified address range does not belong to this process.

Parameters:

address - the off-heap address where to store this matrix

Returns:

this

get

float[] get(float[] arr,
 int offset)

Store this matrix into the supplied float array in column-major order at the given offset.

Parameters:

arr - the array to write the matrix values into

offset - the offset into the array

Returns:

the passed in array

get

float[] get(float[] arr)

Store this matrix into the supplied float array in column-major order.

In order to specify an explicit offset into the array, use the method get(float[], int).

Parameters:

arr - the array to write the matrix values into

Returns:

the passed in array

See Also:

• get(float[], int)

transform

Vector4f transform(Vector4f v)

Transform/multiply the given vector by this matrix and store the result in that vector.

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

• Vector4f.mul(Matrix4fc)

transform

Vector4f transform(Vector4fc v,
 Vector4f dest)

Transform/multiply the given vector by this matrix and store the result in dest.

Parameters:

v - the vector to transform

dest - will contain the result

Returns:

dest

See Also:

• Vector4f.mul(Matrix4fc, Vector4f)

transform

Vector4f transform(float x,
 float y,
 float z,
 float w,
 Vector4f dest)

Transform/multiply the vector (x, y, z, w) by this matrix and store the result in dest.

Parameters:

x - the x coordinate of the vector to transform

y - the y coordinate of the vector to transform

z - the z coordinate of the vector to transform

w - the w coordinate of the vector to transform

dest - will contain the result

Returns:

dest

transformTranspose

Vector4f transformTranspose(Vector4f v)

Transform/multiply the given vector by the transpose of this matrix and store the result in that vector.

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

• Vector4f.mulTranspose(Matrix4fc)

transformTranspose

Vector4f transformTranspose(Vector4fc v,
 Vector4f dest)

Transform/multiply the given vector by the transpose of this matrix and store the result in dest.

Parameters:

v - the vector to transform

dest - will contain the result

Returns:

dest

See Also:

• Vector4f.mulTranspose(Matrix4fc, Vector4f)

transformTranspose

Vector4f transformTranspose(float x,
 float y,
 float z,
 float w,
 Vector4f dest)

Transform/multiply the vector (x, y, z, w) by the transpose of this matrix and store the result in dest.

Parameters:

x - the x coordinate of the vector to transform

y - the y coordinate of the vector to transform

z - the z coordinate of the vector to transform

w - the w coordinate of the vector to transform

dest - will contain the result

Returns:

dest

transformProject

Vector4f transformProject(Vector4f v)

Transform/multiply the given vector by this matrix, perform perspective divide and store the result in that vector.

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

• Vector4f.mulProject(Matrix4fc)

transformProject

Vector4f transformProject(Vector4fc v,
 Vector4f dest)

Transform/multiply the given vector by this matrix, perform perspective divide and store the result in dest.

Parameters:

v - the vector to transform

dest - will contain the result

Returns:

dest

See Also:

• Vector4f.mulProject(Matrix4fc, Vector4f)

transformProject

Vector4f transformProject(float x,
 float y,
 float z,
 float w,
 Vector4f dest)

Transform/multiply the vector (x, y, z, w) by this matrix, perform perspective divide and store the result in dest.

Parameters:

x - the x coordinate of the vector to transform

y - the y coordinate of the vector to transform

z - the z coordinate of the vector to transform

w - the w coordinate of the vector to transform

dest - will contain the result

Returns:

dest

transformProject

Vector3f transformProject(Vector3f v)

Transform/multiply the given vector by this matrix, perform perspective divide and store the result in that vector.

This method uses w=1.0 as the fourth vector component.

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

• Vector3f.mulProject(Matrix4fc)

transformProject

Vector3f transformProject(Vector3fc v,
 Vector3f dest)

Transform/multiply the given vector by this matrix, perform perspective divide and store the result in dest.

This method uses w=1.0 as the fourth vector component.

Parameters:

v - the vector to transform

dest - will contain the result

Returns:

dest

See Also:

• Vector3f.mulProject(Matrix4fc, Vector3f)

transformProject

Vector3f transformProject(Vector4fc v,
 Vector3f dest)

Transform/multiply the given vector by this matrix, perform perspective divide and store the result in dest.

Parameters:

v - the vector to transform

dest - will contain the (x, y, z) components of the result

Returns:

dest

See Also:

• Vector4f.mulProject(Matrix4fc, Vector4f)

transformProject

Vector3f transformProject(float x,
 float y,
 float z,
 Vector3f dest)

Transform/multiply the vector (x, y, z) by this matrix, perform perspective divide and store the result in dest.

This method uses w=1.0 as the fourth vector component.

Parameters:

x - the x coordinate of the vector to transform

y - the y coordinate of the vector to transform

z - the z coordinate of the vector to transform

dest - will contain the result

Returns:

dest

transformProject

Vector3f transformProject(float x,
 float y,
 float z,
 float w,
 Vector3f dest)

Transform/multiply the vector (x, y, z, w) by this matrix, perform perspective divide and store (x, y, z) of the result in dest.

Parameters:

x - the x coordinate of the vector to transform

y - the y coordinate of the vector to transform

z - the z coordinate of the vector to transform

w - the w coordinate of the vector to transform

dest - will contain the (x, y, z) components of the result

Returns:

dest

transformPosition

Vector3f transformPosition(Vector3f v)

Transform/multiply the given 3D-vector, as if it was a 4D-vector with w=1, by this matrix and store the result in that vector.

The given 3D-vector is treated as a 4D-vector with its w-component being 1.0, so it will represent a position/location in 3D-space rather than a direction. This method is therefore not suited for perspective projection transformations as it will not save the w component of the transformed vector. For perspective projection use transform(Vector4f) or transformProject(Vector3f) when perspective divide should be applied, too.

In order to store the result in another vector, use transformPosition(Vector3fc, Vector3f).

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

• transformPosition(Vector3fc, Vector3f)
• transform(Vector4f)
• transformProject(Vector3f)

transformPosition

Vector3f transformPosition(Vector3fc v,
 Vector3f dest)

Transform/multiply the given 3D-vector, as if it was a 4D-vector with w=1, by this matrix and store the result in dest.

The given 3D-vector is treated as a 4D-vector with its w-component being 1.0, so it will represent a position/location in 3D-space rather than a direction. This method is therefore not suited for perspective projection transformations as it will not save the w component of the transformed vector. For perspective projection use transform(Vector4fc, Vector4f) or transformProject(Vector3fc, Vector3f) when perspective divide should be applied, too.

In order to store the result in the same vector, use transformPosition(Vector3f).

Parameters:

v - the vector to transform

dest - will hold the result

Returns:

dest

See Also:

• transformPosition(Vector3f)
• transform(Vector4fc, Vector4f)
• transformProject(Vector3fc, Vector3f)

transformPosition

Vector3f transformPosition(float x,
 float y,
 float z,
 Vector3f dest)

Transform/multiply the 3D-vector (x, y, z), as if it was a 4D-vector with w=1, by this matrix and store the result in dest.

The given 3D-vector is treated as a 4D-vector with its w-component being 1.0, so it will represent a position/location in 3D-space rather than a direction. This method is therefore not suited for perspective projection transformations as it will not save the w component of the transformed vector. For perspective projection use transform(float, float, float, float, Vector4f) or transformProject(float, float, float, Vector3f) when perspective divide should be applied, too.

Parameters:

x - the x coordinate of the position

y - the y coordinate of the position

z - the z coordinate of the position

dest - will hold the result

Returns:

dest

See Also:

• transform(float, float, float, float, Vector4f)
• transformProject(float, float, float, Vector3f)

transformDirection

Vector3f transformDirection(Vector3f v)

Transform/multiply the given 3D-vector, as if it was a 4D-vector with w=0, by this matrix and store the result in that vector.

The given 3D-vector is treated as a 4D-vector with its w-component being 0.0, so it will represent a direction in 3D-space rather than a position. This method will therefore not take the translation part of the matrix into account.

In order to store the result in another vector, use transformDirection(Vector3fc, Vector3f).

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

• transformDirection(Vector3fc, Vector3f)

transformDirection

Vector3f transformDirection(Vector3fc v,
 Vector3f dest)

Transform/multiply the given 3D-vector, as if it was a 4D-vector with w=0, by this matrix and store the result in dest.

The given 3D-vector is treated as a 4D-vector with its w-component being 0.0, so it will represent a direction in 3D-space rather than a position. This method will therefore not take the translation part of the matrix into account.

In order to store the result in the same vector, use transformDirection(Vector3f).

Parameters:

v - the vector to transform and to hold the final result

dest - will hold the result

Returns:

dest

See Also:

• transformDirection(Vector3f)

transformDirection

Vector3f transformDirection(float x,
 float y,
 float z,
 Vector3f dest)

Transform/multiply the given 3D-vector (x, y, z), as if it was a 4D-vector with w=0, by this matrix and store the result in dest.

The given 3D-vector is treated as a 4D-vector with its w-component being 0.0, so it will represent a direction in 3D-space rather than a position. This method will therefore not take the translation part of the matrix into account.

Parameters:

x - the x coordinate of the direction to transform

y - the y coordinate of the direction to transform

z - the z coordinate of the direction to transform

dest - will hold the result

Returns:

dest

transformAffine

Vector4f transformAffine(Vector4f v)

Transform/multiply the given 4D-vector by assuming that this matrix represents an affine transformation (i.e. its last row is equal to (0, 0, 0, 1)).

In order to store the result in another vector, use transformAffine(Vector4fc, Vector4f).

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

• transformAffine(Vector4fc, Vector4f)

transformAffine

Vector4f transformAffine(Vector4fc v,
 Vector4f dest)

Transform/multiply the given 4D-vector by assuming that this matrix represents an affine transformation (i.e. its last row is equal to (0, 0, 0, 1)) and store the result in dest.

In order to store the result in the same vector, use transformAffine(Vector4f).

Parameters:

v - the vector to transform and to hold the final result

dest - will hold the result

Returns:

dest

See Also:

• transformAffine(Vector4f)

transformAffine

Vector4f transformAffine(float x,
 float y,
 float z,
 float w,
 Vector4f dest)

Transform/multiply the 4D-vector (x, y, z, w) by assuming that this matrix represents an affine transformation (i.e. its last row is equal to (0, 0, 0, 1)) and store the result in dest.

Parameters:

x - the x coordinate of the direction to transform

y - the y coordinate of the direction to transform

z - the z coordinate of the direction to transform

w - the w coordinate of the direction to transform

dest - will hold the result

Returns:

dest

scale

Matrix4f scale(Vector3fc xyz,
 Matrix4f dest)

Apply scaling to this matrix by scaling the base axes by the given xyz.x, xyz.y and xyz.z factors, respectively and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v , the scaling will be applied first!

Parameters:

xyz - the factors of the x, y and z component, respectively

dest - will hold the result

Returns:

dest

scale

Matrix4f scale(float xyz,
 Matrix4f dest)

Apply scaling to this matrix by uniformly scaling all base axes by the given xyz factor and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the scaling will be applied first!

Individual scaling of all three axes can be applied using scale(float, float, float, Matrix4f).

Parameters:

xyz - the factor for all components

dest - will hold the result

Returns:

dest

See Also:

• scale(float, float, float, Matrix4f)

scaleXY

Matrix4f scaleXY(float x,
 float y,
 Matrix4f dest)

Apply scaling to this matrix by by scaling the X axis by x and the Y axis by y and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the scaling will be applied first!

Parameters:

x - the factor of the x component

y - the factor of the y component

dest - will hold the result

Returns:

dest

scale

Matrix4f scale(float x,
 float y,
 float z,
 Matrix4f dest)

Apply scaling to this matrix by scaling the base axes by the given x, y and z factors and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v , the scaling will be applied first!

Parameters:

x - the factor of the x component

y - the factor of the y component

z - the factor of the z component

dest - will hold the result

Returns:

dest

scaleAround

Matrix4f scaleAround(float sx,
 float sy,
 float sz,
 float ox,
 float oy,
 float oz,
 Matrix4f dest)

Apply scaling to this matrix by scaling the base axes by the given sx, sy and sz factors while using (ox, oy, oz) as the scaling origin, and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v , the scaling will be applied first!

This method is equivalent to calling: translate(ox, oy, oz, dest).scale(sx, sy, sz).translate(-ox, -oy, -oz)

Parameters:

sx - the scaling factor of the x component

sy - the scaling factor of the y component

sz - the scaling factor of the z component

ox - the x coordinate of the scaling origin

oy - the y coordinate of the scaling origin

oz - the z coordinate of the scaling origin

dest - will hold the result

Returns:

dest

scaleAround

Matrix4f scaleAround(float factor,
 float ox,
 float oy,
 float oz,
 Matrix4f dest)

Apply scaling to this matrix by scaling all three base axes by the given factor while using (ox, oy, oz) as the scaling origin, and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the scaling will be applied first!

This method is equivalent to calling: translate(ox, oy, oz, dest).scale(factor).translate(-ox, -oy, -oz)

Parameters:

factor - the scaling factor for all three axes

ox - the x coordinate of the scaling origin

oy - the y coordinate of the scaling origin

oz - the z coordinate of the scaling origin

dest - will hold the result

Returns:

this

scaleLocal

Matrix4f scaleLocal(float xyz,
 Matrix4f dest)

Pre-multiply scaling to this matrix by scaling all base axes by the given xyz factor, and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be S * M. So when transforming a vector v with the new matrix by using S * M * v , the scaling will be applied last!

Parameters:

xyz - the factor to scale all three base axes by

dest - will hold the result

Returns:

dest

scaleLocal

Matrix4f scaleLocal(float x,
 float y,
 float z,
 Matrix4f dest)

Pre-multiply scaling to this matrix by scaling the base axes by the given x, y and z factors and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be S * M. So when transforming a vector v with the new matrix by using S * M * v , the scaling will be applied last!

Parameters:

x - the factor of the x component

y - the factor of the y component

z - the factor of the z component

dest - will hold the result

Returns:

dest

scaleAroundLocal

Matrix4f scaleAroundLocal(float sx,
 float sy,
 float sz,
 float ox,
 float oy,
 float oz,
 Matrix4f dest)

Pre-multiply scaling to this matrix by scaling the base axes by the given sx, sy and sz factors while using the given (ox, oy, oz) as the scaling origin, and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be S * M. So when transforming a vector v with the new matrix by using S * M * v , the scaling will be applied last!

This method is equivalent to calling: new Matrix4f().translate(ox, oy, oz).scale(sx, sy, sz).translate(-ox, -oy, -oz).mul(this, dest)

Parameters:

sx - the scaling factor of the x component

sy - the scaling factor of the y component

sz - the scaling factor of the z component

ox - the x coordinate of the scaling origin

oy - the y coordinate of the scaling origin

oz - the z coordinate of the scaling origin

dest - will hold the result

Returns:

dest

scaleAroundLocal

Matrix4f scaleAroundLocal(float factor,
 float ox,
 float oy,
 float oz,
 Matrix4f dest)

Pre-multiply scaling to this matrix by scaling all three base axes by the given factor while using (ox, oy, oz) as the scaling origin, and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be S * M. So when transforming a vector v with the new matrix by using S * M * v, the scaling will be applied last!

This method is equivalent to calling: new Matrix4f().translate(ox, oy, oz).scale(factor).translate(-ox, -oy, -oz).mul(this, dest)

Parameters:

factor - the scaling factor for all three axes

ox - the x coordinate of the scaling origin

oy - the y coordinate of the scaling origin

oz - the z coordinate of the scaling origin

dest - will hold the result

Returns:

this

rotateX

Matrix4f rotateX(float ang,
 Matrix4f dest)

Apply rotation about the X axis to this matrix by rotating the given amount of radians and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians

dest - will hold the result

Returns:

dest

rotateY

Matrix4f rotateY(float ang,
 Matrix4f dest)

Apply rotation about the Y axis to this matrix by rotating the given amount of radians and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians

dest - will hold the result

Returns:

dest

rotateZ

Matrix4f rotateZ(float ang,
 Matrix4f dest)

Apply rotation about the Z axis to this matrix by rotating the given amount of radians and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians

dest - will hold the result

Returns:

dest

rotateTowardsXY

Matrix4f rotateTowardsXY(float dirX,
 float dirY,
 Matrix4f dest)

Apply rotation about the Z axis to align the local +X towards (dirX, dirY) and store the result in dest.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

The vector (dirX, dirY) must be a unit vector.

Parameters:

dirX - the x component of the normalized direction

dirY - the y component of the normalized direction

dest - will hold the result

Returns:

this

rotateXYZ

Matrix4f rotateXYZ(float angleX,
 float angleY,
 float angleZ,
 Matrix4f dest)

Apply rotation of angleX radians about the X axis, followed by a rotation of angleY radians about the Y axis and followed by a rotation of angleZ radians about the Z axis and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

This method is equivalent to calling: rotateX(angleX, dest).rotateY(angleY).rotateZ(angleZ)

Parameters:

angleX - the angle to rotate about X

angleY - the angle to rotate about Y

angleZ - the angle to rotate about Z

dest - will hold the result

Returns:

dest

rotateAffineXYZ

Matrix4f rotateAffineXYZ(float angleX,
 float angleY,
 float angleZ,
 Matrix4f dest)

Apply rotation of angleX radians about the X axis, followed by a rotation of angleY radians about the Y axis and followed by a rotation of angleZ radians about the Z axis and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

This method assumes that this matrix represents an affine transformation (i.e. its last row is equal to (0, 0, 0, 1)) and can be used to speed up matrix multiplication if the matrix only represents affine transformations, such as translation, rotation, scaling and shearing (in any combination).

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Parameters:

angleX - the angle to rotate about X

angleY - the angle to rotate about Y

angleZ - the angle to rotate about Z

dest - will hold the result

Returns:

dest

rotateZYX

Matrix4f rotateZYX(float angleZ,
 float angleY,
 float angleX,
 Matrix4f dest)

Apply rotation of angleZ radians about the Z axis, followed by a rotation of angleY radians about the Y axis and followed by a rotation of angleX radians about the X axis and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

This method is equivalent to calling: rotateZ(angleZ, dest).rotateY(angleY).rotateX(angleX)

Parameters:

angleZ - the angle to rotate about Z

angleY - the angle to rotate about Y

angleX - the angle to rotate about X

dest - will hold the result

Returns:

dest

rotateAffineZYX

Matrix4f rotateAffineZYX(float angleZ,
 float angleY,
 float angleX,
 Matrix4f dest)

Apply rotation of angleZ radians about the Z axis, followed by a rotation of angleY radians about the Y axis and followed by a rotation of angleX radians about the X axis and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

This method assumes that this matrix represents an affine transformation (i.e. its last row is equal to (0, 0, 0, 1)) and can be used to speed up matrix multiplication if the matrix only represents affine transformations, such as translation, rotation, scaling and shearing (in any combination).

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Parameters:

angleZ - the angle to rotate about Z

angleY - the angle to rotate about Y

angleX - the angle to rotate about X

dest - will hold the result

Returns:

dest

rotateYXZ

Matrix4f rotateYXZ(float angleY,
 float angleX,
 float angleZ,
 Matrix4f dest)

Apply rotation of angleY radians about the Y axis, followed by a rotation of angleX radians about the X axis and followed by a rotation of angleZ radians about the Z axis and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

This method is equivalent to calling: rotateY(angleY, dest).rotateX(angleX).rotateZ(angleZ)

Parameters:

angleY - the angle to rotate about Y

angleX - the angle to rotate about X

angleZ - the angle to rotate about Z

dest - will hold the result

Returns:

dest

rotateAffineYXZ

Matrix4f rotateAffineYXZ(float angleY,
 float angleX,
 float angleZ,
 Matrix4f dest)

Apply rotation of angleY radians about the Y axis, followed by a rotation of angleX radians about the X axis and followed by a rotation of angleZ radians about the Z axis and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

This method assumes that this matrix represents an affine transformation (i.e. its last row is equal to (0, 0, 0, 1)) and can be used to speed up matrix multiplication if the matrix only represents affine transformations, such as translation, rotation, scaling and shearing (in any combination).

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Parameters:

angleY - the angle to rotate about Y

angleX - the angle to rotate about X

angleZ - the angle to rotate about Z

dest - will hold the result

Returns:

dest

rotate

Matrix4f rotate(float ang,
 float x,
 float y,
 float z,
 Matrix4f dest)

Apply rotation to this matrix by rotating the given amount of radians about the specified (x, y, z) axis and store the result in dest.

The axis described by the three components needs to be a unit vector.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians

x - the x component of the axis

y - the y component of the axis

z - the z component of the axis

dest - will hold the result

Returns:

dest

rotateTranslation

Matrix4f rotateTranslation(float ang,
 float x,
 float y,
 float z,
 Matrix4f dest)

Apply rotation to this matrix, which is assumed to only contain a translation, by rotating the given amount of radians about the specified (x, y, z) axis and store the result in dest.

This method assumes this to only contain a translation.

The axis described by the three components needs to be a unit vector.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians

x - the x component of the axis

y - the y component of the axis

z - the z component of the axis

dest - will hold the result

Returns:

dest

rotateAffine

Matrix4f rotateAffine(float ang,
 float x,
 float y,
 float z,
 Matrix4f dest)

Apply rotation to this affine matrix by rotating the given amount of radians about the specified (x, y, z) axis and store the result in dest.

This method assumes this to be affine.

The axis described by the three components needs to be a unit vector.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians

x - the x component of the axis

y - the y component of the axis

z - the z component of the axis

dest - will hold the result

Returns:

dest

rotateLocal

Matrix4f rotateLocal(float ang,
 float x,
 float y,
 float z,
 Matrix4f dest)

Pre-multiply a rotation to this matrix by rotating the given amount of radians about the specified (x, y, z) axis and store the result in dest.

The axis described by the three components needs to be a unit vector.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be R * M. So when transforming a vector v with the new matrix by using R * M * v, the rotation will be applied last!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians

x - the x component of the axis

y - the y component of the axis

z - the z component of the axis

dest - will hold the result

Returns:

dest

rotateLocalX

Matrix4f rotateLocalX(float ang,
 Matrix4f dest)

Pre-multiply a rotation around the X axis to this matrix by rotating the given amount of radians about the X axis and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be R * M. So when transforming a vector v with the new matrix by using R * M * v, the rotation will be applied last!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians to rotate about the X axis

dest - will hold the result

Returns:

dest

rotateLocalY

Matrix4f rotateLocalY(float ang,
 Matrix4f dest)

Pre-multiply a rotation around the Y axis to this matrix by rotating the given amount of radians about the Y axis and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be R * M. So when transforming a vector v with the new matrix by using R * M * v, the rotation will be applied last!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians to rotate about the Y axis

dest - will hold the result

Returns:

dest

rotateLocalZ

Matrix4f rotateLocalZ(float ang,
 Matrix4f dest)

Pre-multiply a rotation around the Z axis to this matrix by rotating the given amount of radians about the Z axis and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and R the rotation matrix, then the new matrix will be R * M. So when transforming a vector v with the new matrix by using R * M * v, the rotation will be applied last!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians to rotate about the Z axis

dest - will hold the result

Returns:

dest

translate

Matrix4f translate(Vector3fc offset,
 Matrix4f dest)

Apply a translation to this matrix by translating by the given number of units in x, y and z and store the result in dest.

If M is this matrix and T the translation matrix, then the new matrix will be M * T. So when transforming a vector v with the new matrix by using M * T * v, the translation will be applied first!

Parameters:

offset - the number of units in x, y and z by which to translate

dest - will hold the result

Returns:

dest

translate

Matrix4f translate(float x,
 float y,
 float z,
 Matrix4f dest)

Apply a translation to this matrix by translating by the given number of units in x, y and z and store the result in dest.

If M is this matrix and T the translation matrix, then the new matrix will be M * T. So when transforming a vector v with the new matrix by using M * T * v, the translation will be applied first!

Parameters:

x - the offset to translate in x

y - the offset to translate in y

z - the offset to translate in z

dest - will hold the result

Returns:

dest

translateLocal

Matrix4f translateLocal(Vector3fc offset,
 Matrix4f dest)

Pre-multiply a translation to this matrix by translating by the given number of units in x, y and z and store the result in dest.

If M is this matrix and T the translation matrix, then the new matrix will be T * M. So when transforming a vector v with the new matrix by using T * M * v, the translation will be applied last!

Parameters:

offset - the number of units in x, y and z by which to translate

dest - will hold the result

Returns:

dest

translateLocal

Matrix4f translateLocal(float x,
 float y,
 float z,
 Matrix4f dest)

Pre-multiply a translation to this matrix by translating by the given number of units in x, y and z and store the result in dest.

If M is this matrix and T the translation matrix, then the new matrix will be T * M. So when transforming a vector v with the new matrix by using T * M * v, the translation will be applied last!

Parameters:

x - the offset to translate in x

y - the offset to translate in y

z - the offset to translate in z

dest - will hold the result

Returns:

dest

ortho

Matrix4f ortho(float left,
 float right,
 float bottom,
 float top,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply an orthographic projection transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first! Reference: http://www.songho.ca

Parameters:

left - the distance from the center to the left frustum edge

right - the distance from the center to the right frustum edge

bottom - the distance from the center to the bottom frustum edge

top - the distance from the center to the top frustum edge

zNear - near clipping plane distance

zFar - far clipping plane distance

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

dest - will hold the result

Returns:

dest

ortho

Matrix4f ortho(float left,
 float right,
 float bottom,
 float top,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply an orthographic projection transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

left - the distance from the center to the left frustum edge

right - the distance from the center to the right frustum edge

bottom - the distance from the center to the bottom frustum edge

top - the distance from the center to the top frustum edge

zNear - near clipping plane distance

zFar - far clipping plane distance

dest - will hold the result

Returns:

dest

orthoLH

Matrix4f orthoLH(float left,
 float right,
 float bottom,
 float top,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply an orthographic projection transformation for a left-handed coordiante system using the given NDC z range to this matrix and store the result in dest.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

left - the distance from the center to the left frustum edge

right - the distance from the center to the right frustum edge

bottom - the distance from the center to the bottom frustum edge

top - the distance from the center to the top frustum edge

zNear - near clipping plane distance

zFar - far clipping plane distance

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

dest - will hold the result

Returns:

dest

orthoLH

Matrix4f orthoLH(float left,
 float right,
 float bottom,
 float top,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply an orthographic projection transformation for a left-handed coordiante system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

left - the distance from the center to the left frustum edge

right - the distance from the center to the right frustum edge

bottom - the distance from the center to the bottom frustum edge

top - the distance from the center to the top frustum edge

zNear - near clipping plane distance

zFar - far clipping plane distance

dest - will hold the result

Returns:

dest

orthoSymmetric

Matrix4f orthoSymmetric(float width,
 float height,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply a symmetric orthographic projection transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

This method is equivalent to calling ortho() with left=-width/2, right=+width/2, bottom=-height/2 and top=+height/2.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

width - the distance between the right and left frustum edges

height - the distance between the top and bottom frustum edges

zNear - near clipping plane distance

zFar - far clipping plane distance

dest - will hold the result

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

Returns:

dest

orthoSymmetric

Matrix4f orthoSymmetric(float width,
 float height,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply a symmetric orthographic projection transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

This method is equivalent to calling ortho() with left=-width/2, right=+width/2, bottom=-height/2 and top=+height/2.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

width - the distance between the right and left frustum edges

height - the distance between the top and bottom frustum edges

zNear - near clipping plane distance

zFar - far clipping plane distance

dest - will hold the result

Returns:

dest

orthoSymmetricLH

Matrix4f orthoSymmetricLH(float width,
 float height,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply a symmetric orthographic projection transformation for a left-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

This method is equivalent to calling orthoLH() with left=-width/2, right=+width/2, bottom=-height/2 and top=+height/2.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

width - the distance between the right and left frustum edges

height - the distance between the top and bottom frustum edges

zNear - near clipping plane distance

zFar - far clipping plane distance

dest - will hold the result

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

Returns:

dest

orthoSymmetricLH

Matrix4f orthoSymmetricLH(float width,
 float height,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply a symmetric orthographic projection transformation for a left-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

This method is equivalent to calling orthoLH() with left=-width/2, right=+width/2, bottom=-height/2 and top=+height/2.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

width - the distance between the right and left frustum edges

height - the distance between the top and bottom frustum edges

zNear - near clipping plane distance

zFar - far clipping plane distance

dest - will hold the result

Returns:

dest

ortho2D

Matrix4f ortho2D(float left,
 float right,
 float bottom,
 float top,
 Matrix4f dest)

Apply an orthographic projection transformation for a right-handed coordinate system to this matrix and store the result in dest.

This method is equivalent to calling ortho() with zNear=-1 and zFar=+1.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

left - the distance from the center to the left frustum edge

right - the distance from the center to the right frustum edge

bottom - the distance from the center to the bottom frustum edge

top - the distance from the center to the top frustum edge

dest - will hold the result

Returns:

dest

See Also:

• ortho(float, float, float, float, float, float, Matrix4f)

ortho2DLH

Matrix4f ortho2DLH(float left,
 float right,
 float bottom,
 float top,
 Matrix4f dest)

Apply an orthographic projection transformation for a left-handed coordinate system to this matrix and store the result in dest.

This method is equivalent to calling orthoLH() with zNear=-1 and zFar=+1.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

left - the distance from the center to the left frustum edge

right - the distance from the center to the right frustum edge

bottom - the distance from the center to the bottom frustum edge

top - the distance from the center to the top frustum edge

dest - will hold the result

Returns:

dest

See Also:

• orthoLH(float, float, float, float, float, float, Matrix4f)

lookAlong

Matrix4f lookAlong(Vector3fc dir,
 Vector3fc up,
 Matrix4f dest)

Apply a rotation transformation to this matrix to make -z point along dir and store the result in dest.

If M is this matrix and L the lookalong rotation matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookalong rotation transformation will be applied first!

This is equivalent to calling lookAt with eye = (0, 0, 0) and center = dir.

Parameters:

dir - the direction in space to look along

up - the direction of 'up'

dest - will hold the result

Returns:

dest

See Also:

• lookAlong(float, float, float, float, float, float, Matrix4f)
• lookAt(Vector3fc, Vector3fc, Vector3fc, Matrix4f)

lookAlong

Matrix4f lookAlong(float dirX,
 float dirY,
 float dirZ,
 float upX,
 float upY,
 float upZ,
 Matrix4f dest)

Apply a rotation transformation to this matrix to make -z point along dir and store the result in dest.

If M is this matrix and L the lookalong rotation matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookalong rotation transformation will be applied first!

This is equivalent to calling lookAt() with eye = (0, 0, 0) and center = dir.

Parameters:

dirX - the x-coordinate of the direction to look along

dirY - the y-coordinate of the direction to look along

dirZ - the z-coordinate of the direction to look along

upX - the x-coordinate of the up vector

upY - the y-coordinate of the up vector

upZ - the z-coordinate of the up vector

dest - will hold the result

Returns:

dest

See Also:

• lookAt(float, float, float, float, float, float, float, float, float, Matrix4f)

lookAt

Matrix4f lookAt(Vector3fc eye,
 Vector3fc center,
 Vector3fc up,
 Matrix4f dest)

Apply a "lookat" transformation to this matrix for a right-handed coordinate system, that aligns -z with center - eye and store the result in dest.

If M is this matrix and L the lookat matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookat transformation will be applied first!

Parameters:

eye - the position of the camera

center - the point in space to look at

up - the direction of 'up'

dest - will hold the result

Returns:

dest

See Also:

• lookAt(float, float, float, float, float, float, float, float, float, Matrix4f)

lookAt

Matrix4f lookAt(float eyeX,
 float eyeY,
 float eyeZ,
 float centerX,
 float centerY,
 float centerZ,
 float upX,
 float upY,
 float upZ,
 Matrix4f dest)

Apply a "lookat" transformation to this matrix for a right-handed coordinate system, that aligns -z with center - eye and store the result in dest.

If M is this matrix and L the lookat matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookat transformation will be applied first!

Parameters:

eyeX - the x-coordinate of the eye/camera location

eyeY - the y-coordinate of the eye/camera location

eyeZ - the z-coordinate of the eye/camera location

centerX - the x-coordinate of the point to look at

centerY - the y-coordinate of the point to look at

centerZ - the z-coordinate of the point to look at

upX - the x-coordinate of the up vector

upY - the y-coordinate of the up vector

upZ - the z-coordinate of the up vector

dest - will hold the result

Returns:

dest

See Also:

• lookAt(Vector3fc, Vector3fc, Vector3fc, Matrix4f)

lookAtPerspective

Matrix4f lookAtPerspective(float eyeX,
 float eyeY,
 float eyeZ,
 float centerX,
 float centerY,
 float centerZ,
 float upX,
 float upY,
 float upZ,
 Matrix4f dest)

Apply a "lookat" transformation to this matrix for a right-handed coordinate system, that aligns -z with center - eye and store the result in dest.

This method assumes this to be a perspective transformation, obtained via frustum() or perspective() or one of their overloads.

If M is this matrix and L the lookat matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookat transformation will be applied first!

Parameters:

eyeX - the x-coordinate of the eye/camera location

eyeY - the y-coordinate of the eye/camera location

eyeZ - the z-coordinate of the eye/camera location

centerX - the x-coordinate of the point to look at

centerY - the y-coordinate of the point to look at

centerZ - the z-coordinate of the point to look at

upX - the x-coordinate of the up vector

upY - the y-coordinate of the up vector

upZ - the z-coordinate of the up vector

dest - will hold the result

Returns:

dest

lookAtLH

Matrix4f lookAtLH(Vector3fc eye,
 Vector3fc center,
 Vector3fc up,
 Matrix4f dest)

Apply a "lookat" transformation to this matrix for a left-handed coordinate system, that aligns +z with center - eye and store the result in dest.

If M is this matrix and L the lookat matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookat transformation will be applied first!

Parameters:

eye - the position of the camera

center - the point in space to look at

up - the direction of 'up'

dest - will hold the result

Returns:

dest

See Also:

• lookAtLH(float, float, float, float, float, float, float, float, float, Matrix4f)

lookAtLH

Matrix4f lookAtLH(float eyeX,
 float eyeY,
 float eyeZ,
 float centerX,
 float centerY,
 float centerZ,
 float upX,
 float upY,
 float upZ,
 Matrix4f dest)

Apply a "lookat" transformation to this matrix for a left-handed coordinate system, that aligns +z with center - eye and store the result in dest.

If M is this matrix and L the lookat matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookat transformation will be applied first!

Parameters:

eyeX - the x-coordinate of the eye/camera location

eyeY - the y-coordinate of the eye/camera location

eyeZ - the z-coordinate of the eye/camera location

centerX - the x-coordinate of the point to look at

centerY - the y-coordinate of the point to look at

centerZ - the z-coordinate of the point to look at

upX - the x-coordinate of the up vector

upY - the y-coordinate of the up vector

upZ - the z-coordinate of the up vector

dest - will hold the result

Returns:

dest

See Also:

• lookAtLH(Vector3fc, Vector3fc, Vector3fc, Matrix4f)

lookAtPerspectiveLH

Matrix4f lookAtPerspectiveLH(float eyeX,
 float eyeY,
 float eyeZ,
 float centerX,
 float centerY,
 float centerZ,
 float upX,
 float upY,
 float upZ,
 Matrix4f dest)

Apply a "lookat" transformation to this matrix for a left-handed coordinate system, that aligns +z with center - eye and store the result in dest.

This method assumes this to be a perspective transformation, obtained via frustumLH() or perspectiveLH() or one of their overloads.

If M is this matrix and L the lookat matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookat transformation will be applied first!

Parameters:

eyeX - the x-coordinate of the eye/camera location

eyeY - the y-coordinate of the eye/camera location

eyeZ - the z-coordinate of the eye/camera location

centerX - the x-coordinate of the point to look at

centerY - the y-coordinate of the point to look at

centerZ - the z-coordinate of the point to look at

upX - the x-coordinate of the up vector

upY - the y-coordinate of the up vector

upZ - the z-coordinate of the up vector

dest - will hold the result

Returns:

dest

tile

Matrix4f tile(int x,
 int y,
 int w,
 int h,
 Matrix4f dest)

This method is equivalent to calling: translate(w-1-2*x, h-1-2*y, 0, dest).scale(w, h, 1)

If M is this matrix and T the created transformation matrix, then the new matrix will be M * T. So when transforming a vector v with the new matrix by using M * T * v, the created transformation will be applied first!

Parameters:

x - the tile's x coordinate/index (should be in [0..w))

y - the tile's y coordinate/index (should be in [0..h))

w - the number of tiles along the x axis

h - the number of tiles along the y axis

dest - will hold the result

Returns:

dest

perspective

Matrix4f perspective(float fovy,
 float aspect,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply a symmetric perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

fovy - the vertical field of view in radians (must be greater than zero and less than PI)

aspect - the aspect ratio (i.e. width / height; must be greater than zero)

zNear - near clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

Returns:

dest

perspective

Matrix4f perspective(float fovy,
 float aspect,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply a symmetric perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

fovy - the vertical field of view in radians (must be greater than zero and less than PI)

aspect - the aspect ratio (i.e. width / height; must be greater than zero)

zNear - near clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

Returns:

dest

perspectiveRect

Matrix4f perspectiveRect(float width,
 float height,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply a symmetric perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

width - the width of the near frustum plane

height - the height of the near frustum plane

zNear - near clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

Returns:

dest

perspectiveRect

Matrix4f perspectiveRect(float width,
 float height,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply a symmetric perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

width - the width of the near frustum plane

height - the height of the near frustum plane

zNear - near clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

Returns:

dest

perspectiveOffCenter

Matrix4f perspectiveOffCenter(float fovy,
 float offAngleX,
 float offAngleY,
 float aspect,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply an asymmetric off-center perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

The given angles offAngleX and offAngleY are the horizontal and vertical angles between the line of sight and the line given by the center of the near and far frustum planes. So, when offAngleY is just fovy/2 then the projection frustum is rotated towards +Y and the bottom frustum plane is parallel to the XZ-plane.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

fovy - the vertical field of view in radians (must be greater than zero and less than PI)

offAngleX - the horizontal angle between the line of sight and the line crossing the center of the near and far frustum planes

offAngleY - the vertical angle between the line of sight and the line crossing the center of the near and far frustum planes

aspect - the aspect ratio (i.e. width / height; must be greater than zero)

zNear - near clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

Returns:

dest

perspectiveOffCenter

Matrix4f perspectiveOffCenter(float fovy,
 float offAngleX,
 float offAngleY,
 float aspect,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply an asymmetric off-center perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

The given angles offAngleX and offAngleY are the horizontal and vertical angles between the line of sight and the line given by the center of the near and far frustum planes. So, when offAngleY is just fovy/2 then the projection frustum is rotated towards +Y and the bottom frustum plane is parallel to the XZ-plane.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

fovy - the vertical field of view in radians (must be greater than zero and less than PI)

offAngleX - the horizontal angle between the line of sight and the line crossing the center of the near and far frustum planes

offAngleY - the vertical angle between the line of sight and the line crossing the center of the near and far frustum planes

aspect - the aspect ratio (i.e. width / height; must be greater than zero)

zNear - near clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

Returns:

dest

perspectiveOffCenterFov

Matrix4f perspectiveOffCenterFov(float angleLeft,
 float angleRight,
 float angleDown,
 float angleUp,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply an asymmetric off-center perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

The given angles angleLeft and angleRight are the horizontal angles between the left and right frustum planes, respectively, and a line perpendicular to the near and far frustum planes. The angles angleDown and angleUp are the vertical angles between the bottom and top frustum planes, respectively, and a line perpendicular to the near and far frustum planes.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

angleLeft - the horizontal angle between left frustum plane and a line perpendicular to the near/far frustum planes. For a symmetric frustum, this value is negative.

angleRight - the horizontal angle between right frustum plane and a line perpendicular to the near/far frustum planes

angleDown - the vertical angle between bottom frustum plane and a line perpendicular to the near/far frustum planes. For a symmetric frustum, this value is negative.

angleUp - the vertical angle between top frustum plane and a line perpendicular to the near/far frustum planes

zNear - near clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

dest - will hold the result

Returns:

dest

perspectiveOffCenterFov

Matrix4f perspectiveOffCenterFov(float angleLeft,
 float angleRight,
 float angleDown,
 float angleUp,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply an asymmetric off-center perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

The given angles angleLeft and angleRight are the horizontal angles between the left and right frustum planes, respectively, and a line perpendicular to the near and far frustum planes. The angles angleDown and angleUp are the vertical angles between the bottom and top frustum planes, respectively, and a line perpendicular to the near and far frustum planes.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

angleLeft - the horizontal angle between left frustum plane and a line perpendicular to the near/far frustum planes. For a symmetric frustum, this value is negative.

angleRight - the horizontal angle between right frustum plane and a line perpendicular to the near/far frustum planes

angleDown - the vertical angle between bottom frustum plane and a line perpendicular to the near/far frustum planes. For a symmetric frustum, this value is negative.

angleUp - the vertical angle between top frustum plane and a line perpendicular to the near/far frustum planes

zNear - near clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

Returns:

dest

perspectiveOffCenterFovLH

Matrix4f perspectiveOffCenterFovLH(float angleLeft,
 float angleRight,
 float angleDown,
 float angleUp,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply an asymmetric off-center perspective projection frustum transformation for a left-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

The given angles angleLeft and angleRight are the horizontal angles between the left and right frustum planes, respectively, and a line perpendicular to the near and far frustum planes. The angles angleDown and angleUp are the vertical angles between the bottom and top frustum planes, respectively, and a line perpendicular to the near and far frustum planes.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

angleLeft - the horizontal angle between left frustum plane and a line perpendicular to the near/far frustum planes. For a symmetric frustum, this value is negative.

angleRight - the horizontal angle between right frustum plane and a line perpendicular to the near/far frustum planes

angleDown - the vertical angle between bottom frustum plane and a line perpendicular to the near/far frustum planes. For a symmetric frustum, this value is negative.

angleUp - the vertical angle between top frustum plane and a line perpendicular to the near/far frustum planes

zNear - near clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

dest - will hold the result

Returns:

dest

perspectiveOffCenterFovLH

Matrix4f perspectiveOffCenterFovLH(float angleLeft,
 float angleRight,
 float angleDown,
 float angleUp,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply an asymmetric off-center perspective projection frustum transformation for a left-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

The given angles angleLeft and angleRight are the horizontal angles between the left and right frustum planes, respectively, and a line perpendicular to the near and far frustum planes. The angles angleDown and angleUp are the vertical angles between the bottom and top frustum planes, respectively, and a line perpendicular to the near and far frustum planes.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

angleLeft - the horizontal angle between left frustum plane and a line perpendicular to the near/far frustum planes. For a symmetric frustum, this value is negative.

angleRight - the horizontal angle between right frustum plane and a line perpendicular to the near/far frustum planes

angleDown - the vertical angle between bottom frustum plane and a line perpendicular to the near/far frustum planes. For a symmetric frustum, this value is negative.

angleUp - the vertical angle between top frustum plane and a line perpendicular to the near/far frustum planes

zNear - near clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

Returns:

dest

perspectiveLH

Matrix4f perspectiveLH(float fovy,
 float aspect,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply a symmetric perspective projection frustum transformation for a left-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

fovy - the vertical field of view in radians (must be greater than zero and less than PI)

aspect - the aspect ratio (i.e. width / height; must be greater than zero)

zNear - near clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

dest - will hold the result

Returns:

dest

perspectiveLH

Matrix4f perspectiveLH(float fovy,
 float aspect,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply a symmetric perspective projection frustum transformation for a left-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

If M is this matrix and P the perspective projection matrix, then the new matrix will be M * P. So when transforming a vector v with the new matrix by using M * P * v, the perspective projection will be applied first!

Parameters:

fovy - the vertical field of view in radians (must be greater than zero and less than PI)

aspect - the aspect ratio (i.e. width / height; must be greater than zero)

zNear - near clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

Returns:

dest

frustum

Matrix4f frustum(float left,
 float right,
 float bottom,
 float top,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply an arbitrary perspective projection frustum transformation for a right-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

If M is this matrix and F the frustum matrix, then the new matrix will be M * F. So when transforming a vector v with the new matrix by using M * F * v, the frustum transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

left - the distance along the x-axis to the left frustum edge

right - the distance along the x-axis to the right frustum edge

bottom - the distance along the y-axis to the bottom frustum edge

top - the distance along the y-axis to the top frustum edge

zNear - near clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

dest - will hold the result

Returns:

dest

frustum

Matrix4f frustum(float left,
 float right,
 float bottom,
 float top,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply an arbitrary perspective projection frustum transformation for a right-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

If M is this matrix and F the frustum matrix, then the new matrix will be M * F. So when transforming a vector v with the new matrix by using M * F * v, the frustum transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

left - the distance along the x-axis to the left frustum edge

right - the distance along the x-axis to the right frustum edge

bottom - the distance along the y-axis to the bottom frustum edge

top - the distance along the y-axis to the top frustum edge

zNear - near clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

Returns:

dest

frustumLH

Matrix4f frustumLH(float left,
 float right,
 float bottom,
 float top,
 float zNear,
 float zFar,
 boolean zZeroToOne,
 Matrix4f dest)

Apply an arbitrary perspective projection frustum transformation for a left-handed coordinate system using the given NDC z range to this matrix and store the result in dest.

If M is this matrix and F the frustum matrix, then the new matrix will be M * F. So when transforming a vector v with the new matrix by using M * F * v, the frustum transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

left - the distance along the x-axis to the left frustum edge

right - the distance along the x-axis to the right frustum edge

bottom - the distance along the y-axis to the bottom frustum edge

top - the distance along the y-axis to the top frustum edge

zNear - near clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

zZeroToOne - whether to use Vulkan's and Direct3D's NDC z range of [0..+1] when true or whether to use OpenGL's NDC z range of [-1..+1] when false

dest - will hold the result

Returns:

dest

frustumLH

Matrix4f frustumLH(float left,
 float right,
 float bottom,
 float top,
 float zNear,
 float zFar,
 Matrix4f dest)

Apply an arbitrary perspective projection frustum transformation for a left-handed coordinate system using OpenGL's NDC z range of [-1..+1] to this matrix and store the result in dest.

If M is this matrix and F the frustum matrix, then the new matrix will be M * F. So when transforming a vector v with the new matrix by using M * F * v, the frustum transformation will be applied first!

Reference: http://www.songho.ca

Parameters:

left - the distance along the x-axis to the left frustum edge

right - the distance along the x-axis to the right frustum edge

bottom - the distance along the y-axis to the bottom frustum edge

top - the distance along the y-axis to the top frustum edge

zNear - near clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the near clipping plane will be at positive infinity. In that case, zFar may not also be Float.POSITIVE_INFINITY.

zFar - far clipping plane distance. This value must be greater than zero. If the special value Float.POSITIVE_INFINITY is used, the far clipping plane will be at positive infinity. In that case, zNear may not also be Float.POSITIVE_INFINITY.

dest - will hold the result

Returns:

dest

rotate

Matrix4f rotate(Quaternionfc quat,
 Matrix4f dest)

Apply the rotation - and possibly scaling - transformation of the given Quaternionfc to this matrix and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and Q the rotation matrix obtained from the given quaternion, then the new matrix will be M * Q. So when transforming a vector v with the new matrix by using M * Q * v, the quaternion rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

quat - the Quaternionfc

dest - will hold the result

Returns:

dest

rotateAffine

Matrix4f rotateAffine(Quaternionfc quat,
 Matrix4f dest)

Apply the rotation - and possibly scaling - transformation of the given Quaternionfc to this affine matrix and store the result in dest.

This method assumes this to be affine.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and Q the rotation matrix obtained from the given quaternion, then the new matrix will be M * Q. So when transforming a vector v with the new matrix by using M * Q * v, the quaternion rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

quat - the Quaternionfc

dest - will hold the result

Returns:

dest

rotateTranslation

Matrix4f rotateTranslation(Quaternionfc quat,
 Matrix4f dest)

Apply the rotation - and possibly scaling - ransformation of the given Quaternionfc to this matrix, which is assumed to only contain a translation, and store the result in dest.

This method assumes this to only contain a translation.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and Q the rotation matrix obtained from the given quaternion, then the new matrix will be M * Q. So when transforming a vector v with the new matrix by using M * Q * v, the quaternion rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

quat - the Quaternionfc

dest - will hold the result

Returns:

dest

rotateAroundAffine

Matrix4f rotateAroundAffine(Quaternionfc quat,
 float ox,
 float oy,
 float oz,
 Matrix4f dest)

Apply the rotation - and possibly scaling - transformation of the given Quaternionfc to this affine matrix while using (ox, oy, oz) as the rotation origin, and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and Q the rotation matrix obtained from the given quaternion, then the new matrix will be M * Q. So when transforming a vector v with the new matrix by using M * Q * v, the quaternion rotation will be applied first!

This method is only applicable if this is an affine matrix.

This method is equivalent to calling: translate(ox, oy, oz, dest).rotate(quat).translate(-ox, -oy, -oz)

Reference: http://en.wikipedia.org

Parameters:

quat - the Quaternionfc

ox - the x coordinate of the rotation origin

oy - the y coordinate of the rotation origin

oz - the z coordinate of the rotation origin

dest - will hold the result

Returns:

dest

rotateAround

Matrix4f rotateAround(Quaternionfc quat,
 float ox,
 float oy,
 float oz,
 Matrix4f dest)

Apply the rotation - and possibly scaling - transformation of the given Quaternionfc to this matrix while using (ox, oy, oz) as the rotation origin, and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and Q the rotation matrix obtained from the given quaternion, then the new matrix will be M * Q. So when transforming a vector v with the new matrix by using M * Q * v, the quaternion rotation will be applied first!

This method is equivalent to calling: translate(ox, oy, oz, dest).rotate(quat).translate(-ox, -oy, -oz)

Reference: http://en.wikipedia.org

Parameters:

quat - the Quaternionfc

ox - the x coordinate of the rotation origin

oy - the y coordinate of the rotation origin

oz - the z coordinate of the rotation origin

dest - will hold the result

Returns:

dest

rotateLocal

Matrix4f rotateLocal(Quaternionfc quat,
 Matrix4f dest)

Pre-multiply the rotation - and possibly scaling - transformation of the given Quaternionfc to this matrix and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and Q the rotation matrix obtained from the given quaternion, then the new matrix will be Q * M. So when transforming a vector v with the new matrix by using Q * M * v, the quaternion rotation will be applied last!

Reference: http://en.wikipedia.org

Parameters:

quat - the Quaternionfc

dest - will hold the result

Returns:

dest

rotateAroundLocal

Matrix4f rotateAroundLocal(Quaternionfc quat,
 float ox,
 float oy,
 float oz,
 Matrix4f dest)

Pre-multiply the rotation - and possibly scaling - transformation of the given Quaternionfc to this matrix while using (ox, oy, oz) as the rotation origin, and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and Q the rotation matrix obtained from the given quaternion, then the new matrix will be Q * M. So when transforming a vector v with the new matrix by using Q * M * v, the quaternion rotation will be applied last!

This method is equivalent to calling: translateLocal(-ox, -oy, -oz, dest).rotateLocal(quat).translateLocal(ox, oy, oz)

Reference: http://en.wikipedia.org

Parameters:

quat - the Quaternionfc

ox - the x coordinate of the rotation origin

oy - the y coordinate of the rotation origin

oz - the z coordinate of the rotation origin

dest - will hold the result

Returns:

dest

rotate

Matrix4f rotate(AxisAngle4f axisAngle,
 Matrix4f dest)

Apply a rotation transformation, rotating about the given AxisAngle4f and store the result in dest.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and A the rotation matrix obtained from the given AxisAngle4f, then the new matrix will be M * A. So when transforming a vector v with the new matrix by using M * A * v, the AxisAngle4f rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

axisAngle - the AxisAngle4f (needs to be normalized)

dest - will hold the result

Returns:

dest

See Also:

• rotate(float, float, float, float, Matrix4f)

rotate

Matrix4f rotate(float angle,
 Vector3fc axis,
 Matrix4f dest)

Apply a rotation transformation, rotating the given radians about the specified axis and store the result in dest.

The axis described by the axis vector needs to be a unit vector.

When used with a right-handed coordinate system, the produced rotation will rotate a vector counter-clockwise around the rotation axis, when viewing along the negative axis direction towards the origin. When used with a left-handed coordinate system, the rotation is clockwise.

If M is this matrix and A the rotation matrix obtained from the given axis-angle, then the new matrix will be M * A. So when transforming a vector v with the new matrix by using M * A * v, the axis-angle rotation will be applied first!

Reference: http://en.wikipedia.org

Parameters:

angle - the angle in radians

axis - the rotation axis (needs to be normalized)

dest - will hold the result

Returns:

dest

See Also:

• rotate(float, float, float, float, Matrix4f)

unproject

Vector4f unproject(float winX,
 float winY,
 float winZ,
 int[] viewport,
 Vector4f dest)

Unproject the given window coordinates (winX, winY, winZ) by this matrix using the specified viewport.

This method first converts the given window coordinates to normalized device coordinates in the range [-1..1] and then transforms those NDC coordinates by the inverse of this matrix.

The depth range of winZ is assumed to be [0..1], which is also the OpenGL default.

As a necessary computation step for unprojecting, this method computes the inverse of this matrix. In order to avoid computing the matrix inverse with every invocation, the inverse of this matrix can be built once outside using invert(Matrix4f) and then the method unprojectInv() can be invoked on it.

Parameters:

winX - the x-coordinate in window coordinates (pixels)

winY - the y-coordinate in window coordinates (pixels)

winZ - the z-coordinate, which is the depth value in [0..1]

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

• unprojectInv(float, float, float, int[], Vector4f)
• invert(Matrix4f)

unproject

Vector3f unproject(float winX,
 float winY,
 float winZ,
 int[] viewport,
 Vector3f dest)

Unproject the given window coordinates (winX, winY, winZ) by this matrix using the specified viewport.

This method first converts the given window coordinates to normalized device coordinates in the range [-1..1] and then transforms those NDC coordinates by the inverse of this matrix.

The depth range of winZ is assumed to be [0..1], which is also the OpenGL default.

As a necessary computation step for unprojecting, this method computes the inverse of this matrix. In order to avoid computing the matrix inverse with every invocation, the inverse of this matrix can be built once outside using invert(Matrix4f) and then the method unprojectInv() can be invoked on it.

Parameters:

winX - the x-coordinate in window coordinates (pixels)

winY - the y-coordinate in window coordinates (pixels)

winZ - the z-coordinate, which is the depth value in [0..1]

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

• unprojectInv(float, float, float, int[], Vector3f)
• invert(Matrix4f)

unproject

Vector4f unproject(Vector3fc winCoords,
 int[] viewport,
 Vector4f dest)

Unproject the given window coordinates winCoords by this matrix using the specified viewport.

This method first converts the given window coordinates to normalized device coordinates in the range [-1..1] and then transforms those NDC coordinates by the inverse of this matrix.

The depth range of winCoords.z is assumed to be [0..1], which is also the OpenGL default.

As a necessary computation step for unprojecting, this method computes the inverse of this matrix. In order to avoid computing the matrix inverse with every invocation, the inverse of this matrix can be built once outside using invert(Matrix4f) and then the method unprojectInv() can be invoked on it.

Parameters:

winCoords - the window coordinates to unproject

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

• unprojectInv(float, float, float, int[], Vector4f)
• unproject(float, float, float, int[], Vector4f)
• invert(Matrix4f)

unproject

Vector3f unproject(Vector3fc winCoords,
 int[] viewport,
 Vector3f dest)

Unproject the given window coordinates winCoords by this matrix using the specified viewport.

This method first converts the given window coordinates to normalized device coordinates in the range [-1..1] and then transforms those NDC coordinates by the inverse of this matrix.

The depth range of winCoords.z is assumed to be [0..1], which is also the OpenGL default.

As a necessary computation step for unprojecting, this method computes the inverse of this matrix. In order to avoid computing the matrix inverse with every invocation, the inverse of this matrix can be built once outside using invert(Matrix4f) and then the method unprojectInv() can be invoked on it.

Parameters:

winCoords - the window coordinates to unproject

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

• unprojectInv(float, float, float, int[], Vector3f)
• unproject(float, float, float, int[], Vector3f)
• invert(Matrix4f)

unprojectRay

Matrix4f unprojectRay(float winX,
 float winY,
 int[] viewport,
 Vector3f originDest,
 Vector3f dirDest)

Unproject the given 2D window coordinates (winX, winY) by this matrix using the specified viewport and compute the origin and the direction of the resulting ray which starts at NDC z = -1.0 and goes through NDC z = +1.0.

This method first converts the given window coordinates to normalized device coordinates in the range [-1..1] and then transforms those NDC coordinates by the inverse of this matrix.

As a necessary computation step for unprojecting, this method computes the inverse of this matrix. In order to avoid computing the matrix inverse with every invocation, the inverse of this matrix can be built once outside using invert(Matrix4f) and then the method unprojectInvRay() can be invoked on it.

Parameters:

winX - the x-coordinate in window coordinates (pixels)

winY - the y-coordinate in window coordinates (pixels)

viewport - the viewport described by [x, y, width, height]

originDest - will hold the ray origin

dirDest - will hold the (unnormalized) ray direction

Returns:

this

See Also:

• unprojectInvRay(float, float, int[], Vector3f, Vector3f)
• invert(Matrix4f)

unprojectRay

Matrix4f unprojectRay(Vector2fc winCoords,
 int[] viewport,
 Vector3f originDest,
 Vector3f dirDest)

Unproject the given 2D window coordinates winCoords by this matrix using the specified viewport and compute the origin and the direction of the resulting ray which starts at NDC z = -1.0 and goes through NDC z = +1.0.

This method first converts the given window coordinates to normalized device coordinates in the range [-1..1] and then transforms those NDC coordinates by the inverse of this matrix.

As a necessary computation step for unprojecting, this method computes the inverse of this matrix. In order to avoid computing the matrix inverse with every invocation, the inverse of this matrix can be built once outside using invert(Matrix4f) and then the method unprojectInvRay() can be invoked on it.

Parameters:

winCoords - the window coordinates to unproject

viewport - the viewport described by [x, y, width, height]

originDest - will hold the ray origin

dirDest - will hold the (unnormalized) ray direction

Returns:

this

See Also:

• unprojectInvRay(float, float, int[], Vector3f, Vector3f)
• unprojectRay(float, float, int[], Vector3f, Vector3f)
• invert(Matrix4f)

unprojectInv

Vector4f unprojectInv(Vector3fc winCoords,
 int[] viewport,
 Vector4f dest)

Unproject the given window coordinates winCoords by this matrix using the specified viewport.

This method differs from unproject() in that it assumes that this is already the inverse matrix of the original projection matrix. It exists to avoid recomputing the matrix inverse with every invocation.

The depth range of winCoords.z is assumed to be [0..1], which is also the OpenGL default.

This method reads the four viewport parameters from the given int[].

Parameters:

winCoords - the window coordinates to unproject

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

• unproject(Vector3fc, int[], Vector4f)

unprojectInv

Vector4f unprojectInv(float winX,
 float winY,
 float winZ,
 int[] viewport,
 Vector4f dest)

Unproject the given window coordinates (winX, winY, winZ) by this matrix using the specified viewport.

This method differs from unproject() in that it assumes that this is already the inverse matrix of the original projection matrix. It exists to avoid recomputing the matrix inverse with every invocation.

The depth range of winZ is assumed to be [0..1], which is also the OpenGL default.

Parameters:

winX - the x-coordinate in window coordinates (pixels)

winY - the y-coordinate in window coordinates (pixels)

winZ - the z-coordinate, which is the depth value in [0..1]

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

• unproject(float, float, float, int[], Vector4f)

unprojectInvRay

Matrix4f unprojectInvRay(Vector2fc winCoords,
 int[] viewport,
 Vector3f originDest,
 Vector3f dirDest)

Unproject the given window coordinates winCoords by this matrix using the specified viewport and compute the origin and the direction of the resulting ray which starts at NDC z = -1.0 and goes through NDC z = +1.0.

This method differs from unprojectRay() in that it assumes that this is already the inverse matrix of the original projection matrix. It exists to avoid recomputing the matrix inverse with every invocation.

Parameters:

winCoords - the window coordinates to unproject

viewport - the viewport described by [x, y, width, height]

originDest - will hold the ray origin

dirDest - will hold the (unnormalized) ray direction

Returns:

this

See Also:

• unprojectRay(Vector2fc, int[], Vector3f, Vector3f)

unprojectInvRay

Matrix4f unprojectInvRay(float winX,
 float winY,
 int[] viewport,
 Vector3f originDest,
 Vector3f dirDest)

Unproject the given 2D window coordinates (winX, winY) by this matrix using the specified viewport and compute the origin and the direction of the resulting ray which starts at NDC z = -1.0 and goes through NDC z = +1.0.

This method differs from unprojectRay() in that it assumes that this is already the inverse matrix of the original projection matrix. It exists to avoid recomputing the matrix inverse with every invocation.

Parameters:

winX - the x-coordinate in window coordinates (pixels)

winY - the y-coordinate in window coordinates (pixels)

viewport - the viewport described by [x, y, width, height]

originDest - will hold the ray origin

dirDest - will hold the (unnormalized) ray direction

Returns:

this

See Also:

• unprojectRay(float, float, int[], Vector3f, Vector3f)

unprojectInv

Vector3f unprojectInv(Vector3fc winCoords,
 int[] viewport,
 Vector3f dest)

Unproject the given window coordinates winCoords by this matrix using the specified viewport.

This method differs from unproject() in that it assumes that this is already the inverse matrix of the original projection matrix. It exists to avoid recomputing the matrix inverse with every invocation.

The depth range of winCoords.z is assumed to be [0..1], which is also the OpenGL default.

Parameters:

winCoords - the window coordinates to unproject

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

• unproject(Vector3fc, int[], Vector3f)

unprojectInv

Vector3f unprojectInv(float winX,
 float winY,
 float winZ,
 int[] viewport,
 Vector3f dest)

Unproject the given window coordinates (winX, winY, winZ) by this matrix using the specified viewport.

This method differs from unproject() in that it assumes that this is already the inverse matrix of the original projection matrix. It exists to avoid recomputing the matrix inverse with every invocation.

The depth range of winZ is assumed to be [0..1], which is also the OpenGL default.

Parameters:

winX - the x-coordinate in window coordinates (pixels)

winY - the y-coordinate in window coordinates (pixels)

winZ - the z-coordinate, which is the depth value in [0..1]

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

• unproject(float, float, float, int[], Vector3f)

project

Vector4f project(float x,
 float y,
 float z,
 int[] viewport,
 Vector4f winCoordsDest)

Project the given (x, y, z) position via this matrix using the specified viewport and store the resulting window coordinates in winCoordsDest.

This method transforms the given coordinates by this matrix including perspective division to obtain normalized device coordinates, and then translates these into window coordinates by using the given viewport settings [x, y, width, height].

The depth range of the returned winCoordsDest.z will be [0..1], which is also the OpenGL default.

Parameters:

x - the x-coordinate of the position to project

y - the y-coordinate of the position to project

z - the z-coordinate of the position to project

viewport - the viewport described by [x, y, width, height]

winCoordsDest - will hold the projected window coordinates

Returns:

winCoordsDest

project

Vector3f project(float x,
 float y,
 float z,
 int[] viewport,
 Vector3f winCoordsDest)

Project the given (x, y, z) position via this matrix using the specified viewport and store the resulting window coordinates in winCoordsDest.

This method transforms the given coordinates by this matrix including perspective division to obtain normalized device coordinates, and then translates these into window coordinates by using the given viewport settings [x, y, width, height].

The depth range of the returned winCoordsDest.z will be [0..1], which is also the OpenGL default.

Parameters:

x - the x-coordinate of the position to project

y - the y-coordinate of the position to project

z - the z-coordinate of the position to project

viewport - the viewport described by [x, y, width, height]

winCoordsDest - will hold the projected window coordinates

Returns:

winCoordsDest

project

Vector4f project(Vector3fc position,
 int[] viewport,
 Vector4f winCoordsDest)

Project the given position via this matrix using the specified viewport and store the resulting window coordinates in winCoordsDest.

This method transforms the given coordinates by this matrix including perspective division to obtain normalized device coordinates, and then translates these into window coordinates by using the given viewport settings [x, y, width, height].

The depth range of the returned winCoordsDest.z will be [0..1], which is also the OpenGL default.

Parameters:

position - the position to project into window coordinates

viewport - the viewport described by [x, y, width, height]

winCoordsDest - will hold the projected window coordinates

Returns:

winCoordsDest

See Also:

• project(float, float, float, int[], Vector4f)

project

Vector3f project(Vector3fc position,
 int[] viewport,
 Vector3f winCoordsDest)

Project the given position via this matrix using the specified viewport and store the resulting window coordinates in winCoordsDest.

This method transforms the given coordinates by this matrix including perspective division to obtain normalized device coordinates, and then translates these into window coordinates by using the given viewport settings [x, y, width, height].

The depth range of the returned winCoordsDest.z will be [0..1], which is also the OpenGL default.

Parameters:

position - the position to project into window coordinates

viewport - the viewport described by [x, y, width, height]

winCoordsDest - will hold the projected window coordinates

Returns:

winCoordsDest

See Also:

• project(float, float, float, int[], Vector4f)

reflect

Matrix4f reflect(float a,
 float b,
 float c,
 float d,
 Matrix4f dest)

Apply a mirror/reflection transformation to this matrix that reflects about the given plane specified via the equation x*a + y*b + z*c + d = 0 and store the result in dest.

The vector (a, b, c) must be a unit vector.

If M is this matrix and R the reflection matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the reflection will be applied first!

Reference: msdn.microsoft.com

Parameters:

a - the x factor in the plane equation

b - the y factor in the plane equation

c - the z factor in the plane equation

d - the constant in the plane equation

dest - will hold the result

Returns:

dest

reflect

Matrix4f reflect(float nx,
 float ny,
 float nz,
 float px,
 float py,
 float pz,
 Matrix4f dest)

Apply a mirror/reflection transformation to this matrix that reflects about the given plane specified via the plane normal and a point on the plane, and store the result in dest.

If M is this matrix and R the reflection matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the reflection will be applied first!

Parameters:

nx - the x-coordinate of the plane normal

ny - the y-coordinate of the plane normal

nz - the z-coordinate of the plane normal

px - the x-coordinate of a point on the plane

py - the y-coordinate of a point on the plane

pz - the z-coordinate of a point on the plane

dest - will hold the result

Returns:

dest

reflect

Matrix4f reflect(Quaternionfc orientation,
 Vector3fc point,
 Matrix4f dest)

Apply a mirror/reflection transformation to this matrix that reflects about a plane specified via the plane orientation and a point on the plane, and store the result in dest.

This method can be used to build a reflection transformation based on the orientation of a mirror object in the scene. It is assumed that the default mirror plane's normal is (0, 0, 1). So, if the given Quaternionfc is the identity (does not apply any additional rotation), the reflection plane will be z=0, offset by the given point.

If M is this matrix and R the reflection matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the reflection will be applied first!

Parameters:

orientation - the plane orientation relative to an implied normal vector of (0, 0, 1)

point - a point on the plane

dest - will hold the result

Returns:

dest

reflect

Matrix4f reflect(Vector3fc normal,
 Vector3fc point,
 Matrix4f dest)

Apply a mirror/reflection transformation to this matrix that reflects about the given plane specified via the plane normal and a point on the plane, and store the result in dest.

If M is this matrix and R the reflection matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the reflection will be applied first!

Parameters:

normal - the plane normal

point - a point on the plane

dest - will hold the result

Returns:

dest

getRow

Vector4f getRow(int row,
 Vector4f dest)
         throws IndexOutOfBoundsException

Get the row at the given row index, starting with 0.

Parameters:

row - the row index in [0..3]

dest - will hold the row components

Returns:

the passed in destination

Throws:

IndexOutOfBoundsException - if row is not in [0..3]

getRow

Vector3f getRow(int row,
 Vector3f dest)
         throws IndexOutOfBoundsException

Get the first three components of the row at the given row index, starting with 0.

Parameters:

row - the row index in [0..3]

dest - will hold the first three row components

Returns:

the passed in destination

Throws:

IndexOutOfBoundsException - if row is not in [0..3]

getColumn

Vector4f getColumn(int column,
 Vector4f dest)
            throws IndexOutOfBoundsException

Get the column at the given column index, starting with 0.

Parameters:

column - the column index in [0..3]

dest - will hold the column components

Returns:

the passed in destination

Throws:

IndexOutOfBoundsException - if column is not in [0..3]

getColumn

Vector3f getColumn(int column,
 Vector3f dest)
            throws IndexOutOfBoundsException

Get the first three components of the column at the given column index, starting with 0.

Parameters:

column - the column index in [0..3]

dest - will hold the first three column components

Returns:

the passed in destination

Throws:

IndexOutOfBoundsException - if column is not in [0..3]

get

float get(int column,
 int row)

Get the matrix element value at the given column and row.

Parameters:

column - the colum index in [0..3]

row - the row index in [0..3]

Returns:

the element value

getRowColumn

float getRowColumn(int row,
 int column)

Get the matrix element value at the given row and column.

Parameters:

row - the row index in [0..3]

column - the colum index in [0..3]

Returns:

the element value

normal

Matrix4f normal(Matrix4f dest)

Compute a normal matrix from the upper left 3x3 submatrix of this and store it into the upper left 3x3 submatrix of dest. All other values of dest will be set to identity.

The normal matrix of m is the transpose of the inverse of m.

Parameters:

dest - will hold the result

Returns:

dest

normal

Matrix3f normal(Matrix3f dest)

Compute a normal matrix from the upper left 3x3 submatrix of this and store it into dest.

The normal matrix of m is the transpose of the inverse of m.

Parameters:

dest - will hold the result

Returns:

dest

See Also:

• Matrix3f.set(Matrix4fc)
• get3x3(Matrix3f)

cofactor3x3

Matrix3f cofactor3x3(Matrix3f dest)

Compute the cofactor matrix of the upper left 3x3 submatrix of this and store it into dest.

The cofactor matrix can be used instead of normal(Matrix3f) to transform normals when the orientation of the normals with respect to the surface should be preserved.

Parameters:

dest - will hold the result

Returns:

dest

cofactor3x3

Matrix4f cofactor3x3(Matrix4f dest)

Compute the cofactor matrix of the upper left 3x3 submatrix of this and store it into dest. All other values of dest will be set to identity.

The cofactor matrix can be used instead of normal(Matrix4f) to transform normals when the orientation of the normals with respect to the surface should be preserved.

Parameters:

dest - will hold the result

Returns:

dest

normalize3x3

Matrix4f normalize3x3(Matrix4f dest)

Normalize the upper left 3x3 submatrix of this matrix and store the result in dest.

The resulting matrix will map unit vectors to unit vectors, though a pair of orthogonal input unit vectors need not be mapped to a pair of orthogonal output vectors if the original matrix was not orthogonal itself (i.e. had skewing).

Parameters:

dest - will hold the result

Returns:

dest

normalize3x3

Matrix3f normalize3x3(Matrix3f dest)

Normalize the upper left 3x3 submatrix of this matrix and store the result in dest.

The resulting matrix will map unit vectors to unit vectors, though a pair of orthogonal input unit vectors need not be mapped to a pair of orthogonal output vectors if the original matrix was not orthogonal itself (i.e. had skewing).

Parameters:

dest - will hold the result

Returns:

dest

frustumPlane

Vector4f frustumPlane(int plane,
 Vector4f planeEquation)

Calculate a frustum plane of this matrix, which can be a projection matrix or a combined modelview-projection matrix, and store the result in the given planeEquation.

Generally, this method computes the frustum plane in the local frame of any coordinate system that existed before this transformation was applied to it in order to yield homogeneous clipping space.

The frustum plane will be given in the form of a general plane equation: a*x + b*y + c*z + d = 0, where the given Vector4f components will hold the (a, b, c, d) values of the equation.

The plane normal, which is (a, b, c), is directed "inwards" of the frustum. Any plane/point test using a*x + b*y + c*z + d therefore will yield a result greater than zero if the point is within the frustum (i.e. at the positive side of the frustum plane).

For performing frustum culling, the class FrustumIntersection should be used instead of manually obtaining the frustum planes and testing them against points, spheres or axis-aligned boxes.

Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

plane - one of the six possible planes, given as numeric constants PLANE_NX, PLANE_PX, PLANE_NY, PLANE_PY, PLANE_NZ and PLANE_PZ

planeEquation - will hold the computed plane equation. The plane equation will be normalized, meaning that (a, b, c) will be a unit vector

Returns:

planeEquation

frustumCorner

Vector3f frustumCorner(int corner,
 Vector3f point)

Compute the corner coordinates of the frustum defined by this matrix, which can be a projection matrix or a combined modelview-projection matrix, and store the result in the given point.

Generally, this method computes the frustum corners in the local frame of any coordinate system that existed before this transformation was applied to it in order to yield homogeneous clipping space.

Reference: http://geomalgorithms.com

Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

corner - one of the eight possible corners, given as numeric constants CORNER_NXNYNZ, CORNER_PXNYNZ, CORNER_PXPYNZ, CORNER_NXPYNZ, CORNER_PXNYPZ, CORNER_NXNYPZ, CORNER_NXPYPZ, CORNER_PXPYPZ

point - will hold the resulting corner point coordinates

Returns:

point

perspectiveOrigin

Vector3f perspectiveOrigin(Vector3f origin)

Compute the eye/origin of the perspective frustum transformation defined by this matrix, which can be a projection matrix or a combined modelview-projection matrix, and store the result in the given origin.

Note that this method will only work using perspective projections obtained via one of the perspective methods, such as perspective() or frustum().

Generally, this method computes the origin in the local frame of any coordinate system that existed before this transformation was applied to it in order to yield homogeneous clipping space.

This method is equivalent to calling: invert(new Matrix4f()).transformProject(0, 0, -1, 0, origin) and in the case of an already available inverse of this matrix, the method perspectiveInvOrigin(Vector3f) on the inverse of the matrix should be used instead.

Reference: http://geomalgorithms.com

Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

origin - will hold the origin of the coordinate system before applying this perspective projection transformation

Returns:

origin

perspectiveInvOrigin

Vector3f perspectiveInvOrigin(Vector3f dest)

Compute the eye/origin of the inverse of the perspective frustum transformation defined by this matrix, which can be the inverse of a projection matrix or the inverse of a combined modelview-projection matrix, and store the result in the given dest.

Note that this method will only work using perspective projections obtained via one of the perspective methods, such as perspective() or frustum().

If the inverse of the modelview-projection matrix is not available, then calling perspectiveOrigin(Vector3f) on the original modelview-projection matrix is preferred.

Parameters:

dest - will hold the result

Returns:

dest

See Also:

• perspectiveOrigin(Vector3f)

perspectiveFov

float perspectiveFov()

Return the vertical field-of-view angle in radians of this perspective transformation matrix.

Note that this method will only work using perspective projections obtained via one of the perspective methods, such as perspective() or frustum().

For orthogonal transformations this method will return 0.0.

Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Returns:

the vertical field-of-view angle in radians

perspectiveNear

float perspectiveNear()

Extract the near clip plane distance from this perspective projection matrix.

This method only works if this is a perspective projection matrix, for example obtained via perspective(float, float, float, float, Matrix4f).

Returns:

the near clip plane distance

perspectiveFar

float perspectiveFar()

Extract the far clip plane distance from this perspective projection matrix.

This method only works if this is a perspective projection matrix, for example obtained via perspective(float, float, float, float, Matrix4f).

Returns:

the far clip plane distance

frustumRayDir

Vector3f frustumRayDir(float x,
 float y,
 Vector3f dir)

Obtain the direction of a ray starting at the center of the coordinate system and going through the near frustum plane.

This method computes the dir vector in the local frame of any coordinate system that existed before this transformation was applied to it in order to yield homogeneous clipping space.

The parameters x and y are used to interpolate the generated ray direction from the bottom-left to the top-right frustum corners.

For optimal efficiency when building many ray directions over the whole frustum, it is recommended to use this method only in order to compute the four corner rays at (0, 0), (1, 0), (0, 1) and (1, 1) and then bilinearly interpolating between them; or to use the FrustumRayBuilder.

Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

x - the interpolation factor along the left-to-right frustum planes, within [0..1]

y - the interpolation factor along the bottom-to-top frustum planes, within [0..1]

dir - will hold the normalized ray direction in the local frame of the coordinate system before transforming to homogeneous clipping space using this matrix

Returns:

dir

positiveZ

Vector3f positiveZ(Vector3f dir)

Obtain the direction of +Z before the transformation represented by this matrix is applied.

This method uses the rotation component of the upper left 3x3 submatrix to obtain the direction that is transformed to +Z by this matrix.

This method is equivalent to the following code:

 Matrix4f inv = new Matrix4f(this).invert();
 inv.transformDirection(dir.set(0, 0, 1)).normalize();
 

If this is already an orthogonal matrix, then consider using normalizedPositiveZ(Vector3f) instead.

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +Z

Returns:

dir

normalizedPositiveZ

Vector3f normalizedPositiveZ(Vector3f dir)

Obtain the direction of +Z before the transformation represented by this orthogonal matrix is applied. This method only produces correct results if this is an orthogonal matrix.

This method uses the rotation component of the upper left 3x3 submatrix to obtain the direction that is transformed to +Z by this matrix.

This method is equivalent to the following code:

 Matrix4f inv = new Matrix4f(this).transpose();
 inv.transformDirection(dir.set(0, 0, 1));
 

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +Z

Returns:

dir

positiveX

Vector3f positiveX(Vector3f dir)

Obtain the direction of +X before the transformation represented by this matrix is applied.

This method uses the rotation component of the upper left 3x3 submatrix to obtain the direction that is transformed to +X by this matrix.

This method is equivalent to the following code:

 Matrix4f inv = new Matrix4f(this).invert();
 inv.transformDirection(dir.set(1, 0, 0)).normalize();
 

If this is already an orthogonal matrix, then consider using normalizedPositiveX(Vector3f) instead.

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +X

Returns:

dir

normalizedPositiveX

Vector3f normalizedPositiveX(Vector3f dir)

Obtain the direction of +X before the transformation represented by this orthogonal matrix is applied. This method only produces correct results if this is an orthogonal matrix.

This method uses the rotation component of the upper left 3x3 submatrix to obtain the direction that is transformed to +X by this matrix.

This method is equivalent to the following code:

 Matrix4f inv = new Matrix4f(this).transpose();
 inv.transformDirection(dir.set(1, 0, 0));
 

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +X

Returns:

dir

positiveY

Vector3f positiveY(Vector3f dir)

Obtain the direction of +Y before the transformation represented by this matrix is applied.

This method uses the rotation component of the upper left 3x3 submatrix to obtain the direction that is transformed to +Y by this matrix.

This method is equivalent to the following code:

 Matrix4f inv = new Matrix4f(this).invert();
 inv.transformDirection(dir.set(0, 1, 0)).normalize();
 

If this is already an orthogonal matrix, then consider using normalizedPositiveY(Vector3f) instead.

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +Y

Returns:

dir

normalizedPositiveY

Vector3f normalizedPositiveY(Vector3f dir)

Obtain the direction of +Y before the transformation represented by this orthogonal matrix is applied. This method only produces correct results if this is an orthogonal matrix.

This method uses the rotation component of the upper left 3x3 submatrix to obtain the direction that is transformed to +Y by this matrix.

This method is equivalent to the following code:

 Matrix4f inv = new Matrix4f(this).transpose();
 inv.transformDirection(dir.set(0, 1, 0));
 

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +Y

Returns:

dir

originAffine

Vector3f originAffine(Vector3f origin)

Obtain the position that gets transformed to the origin by this affine matrix. This can be used to get the position of the "camera" from a given view transformation matrix.

This method only works with affine matrices.

This method is equivalent to the following code:

 Matrix4f inv = new Matrix4f(this).invertAffine();
 inv.transformPosition(origin.set(0, 0, 0));
 

Parameters:

origin - will hold the position transformed to the origin

Returns:

origin

origin

Vector3f origin(Vector3f origin)

Obtain the position that gets transformed to the origin by this matrix. This can be used to get the position of the "camera" from a given view/projection transformation matrix.

This method is equivalent to the following code:

 Matrix4f inv = new Matrix4f(this).invert();
 inv.transformPosition(origin.set(0, 0, 0));
 

Parameters:

origin - will hold the position transformed to the origin

Returns:

origin

shadow

Matrix4f shadow(Vector4f light,
 float a,
 float b,
 float c,
 float d,
 Matrix4f dest)

Apply a projection transformation to this matrix that projects onto the plane specified via the general plane equation x*a + y*b + z*c + d = 0 as if casting a shadow from a given light position/direction light and store the result in dest.

If light.w is 0.0 the light is being treated as a directional light; if it is 1.0 it is a point light.

If M is this matrix and S the shadow matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the shadow projection will be applied first!

Reference: ftp.sgi.com

Parameters:

light - the light's vector

a - the x factor in the plane equation

b - the y factor in the plane equation

c - the z factor in the plane equation

d - the constant in the plane equation

dest - will hold the result

Returns:

dest

shadow

Matrix4f shadow(float lightX,
 float lightY,
 float lightZ,
 float lightW,
 float a,
 float b,
 float c,
 float d,
 Matrix4f dest)

Apply a projection transformation to this matrix that projects onto the plane specified via the general plane equation x*a + y*b + z*c + d = 0 as if casting a shadow from a given light position/direction (lightX, lightY, lightZ, lightW) and store the result in dest.

If lightW is 0.0 the light is being treated as a directional light; if it is 1.0 it is a point light.

If M is this matrix and S the shadow matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the shadow projection will be applied first!

Reference: ftp.sgi.com

Parameters:

lightX - the x-component of the light's vector

lightY - the y-component of the light's vector

lightZ - the z-component of the light's vector

lightW - the w-component of the light's vector

a - the x factor in the plane equation

b - the y factor in the plane equation

c - the z factor in the plane equation

d - the constant in the plane equation

dest - will hold the result

Returns:

dest

shadow

Matrix4f shadow(Vector4f light,
 Matrix4fc planeTransform,
 Matrix4f dest)

Apply a projection transformation to this matrix that projects onto the plane with the general plane equation y = 0 as if casting a shadow from a given light position/direction light and store the result in dest.

Before the shadow projection is applied, the plane is transformed via the specified planeTransformation.

If light.w is 0.0 the light is being treated as a directional light; if it is 1.0 it is a point light.

If M is this matrix and S the shadow matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the shadow projection will be applied first!

Parameters:

light - the light's vector

planeTransform - the transformation to transform the implied plane y = 0 before applying the projection

dest - will hold the result

Returns:

dest

shadow

Matrix4f shadow(float lightX,
 float lightY,
 float lightZ,
 float lightW,
 Matrix4fc planeTransform,
 Matrix4f dest)

Apply a projection transformation to this matrix that projects onto the plane with the general plane equation y = 0 as if casting a shadow from a given light position/direction (lightX, lightY, lightZ, lightW) and store the result in dest.

Before the shadow projection is applied, the plane is transformed via the specified planeTransformation.

If lightW is 0.0 the light is being treated as a directional light; if it is 1.0 it is a point light.

If M is this matrix and S the shadow matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the shadow projection will be applied first!

Parameters:

lightX - the x-component of the light vector

lightY - the y-component of the light vector

lightZ - the z-component of the light vector

lightW - the w-component of the light vector

planeTransform - the transformation to transform the implied plane y = 0 before applying the projection

dest - will hold the result

Returns:

dest

pick

Matrix4f pick(float x,
 float y,
 float width,
 float height,
 int[] viewport,
 Matrix4f dest)

Apply a picking transformation to this matrix using the given window coordinates (x, y) as the pick center and the given (width, height) as the size of the picking region in window coordinates, and store the result in dest.

Parameters:

x - the x coordinate of the picking region center in window coordinates

y - the y coordinate of the picking region center in window coordinates

width - the width of the picking region in window coordinates

height - the height of the picking region in window coordinates

viewport - the viewport described by [x, y, width, height]

dest - the destination matrix, which will hold the result

Returns:

dest

isAffine

boolean isAffine()

Determine whether this matrix describes an affine transformation. This is the case iff its last row is equal to (0, 0, 0, 1).

Returns:

true iff this matrix is affine; false otherwise

arcball

Matrix4f arcball(float radius,
 float centerX,
 float centerY,
 float centerZ,
 float angleX,
 float angleY,
 Matrix4f dest)

Apply an arcball view transformation to this matrix with the given radius and center (centerX, centerY, centerZ) position of the arcball and the specified X and Y rotation angles, and store the result in dest.

This method is equivalent to calling: translate(0, 0, -radius, dest).rotateX(angleX).rotateY(angleY).translate(-centerX, -centerY, -centerZ)

Parameters:

radius - the arcball radius

centerX - the x coordinate of the center position of the arcball

centerY - the y coordinate of the center position of the arcball

centerZ - the z coordinate of the center position of the arcball

angleX - the rotation angle around the X axis in radians

angleY - the rotation angle around the Y axis in radians

dest - will hold the result

Returns:

dest

arcball

Matrix4f arcball(float radius,
 Vector3fc center,
 float angleX,
 float angleY,
 Matrix4f dest)

Apply an arcball view transformation to this matrix with the given radius and center position of the arcball and the specified X and Y rotation angles, and store the result in dest.

This method is equivalent to calling: translate(0, 0, -radius).rotateX(angleX).rotateY(angleY).translate(-center.x, -center.y, -center.z)

Parameters:

radius - the arcball radius

center - the center position of the arcball

angleX - the rotation angle around the X axis in radians

angleY - the rotation angle around the Y axis in radians

dest - will hold the result

Returns:

dest

frustumAabb

Matrix4f frustumAabb(Vector3f min,
 Vector3f max)

Compute the axis-aligned bounding box of the frustum described by this matrix and store the minimum corner coordinates in the given min and the maximum corner coordinates in the given max vector.

The matrix this is assumed to be the inverse of the origial view-projection matrix for which to compute the axis-aligned bounding box in world-space.

The axis-aligned bounding box of the unit frustum is (-1, -1, -1), (1, 1, 1).

Parameters:

min - will hold the minimum corner coordinates of the axis-aligned bounding box

max - will hold the maximum corner coordinates of the axis-aligned bounding box

Returns:

this

projectedGridRange

Matrix4f projectedGridRange(Matrix4fc projector,
 float sLower,
 float sUpper,
 Matrix4f dest)

Compute the range matrix for the Projected Grid transformation as described in chapter "2.4.2 Creating the range conversion matrix" of the paper Real-time water rendering - Introducing the projected grid concept based on the inverse of the view-projection matrix which is assumed to be this, and store that range matrix into dest.

If the projected grid will not be visible then this method returns null.

This method uses the y = 0 plane for the projection.

Parameters:

projector - the projector view-projection transformation

sLower - the lower (smallest) Y-coordinate which any transformed vertex might have while still being visible on the projected grid

sUpper - the upper (highest) Y-coordinate which any transformed vertex might have while still being visible on the projected grid

dest - will hold the resulting range matrix

Returns:

the computed range matrix; or null if the projected grid will not be visible

perspectiveFrustumSlice

Matrix4f perspectiveFrustumSlice(float near,
 float far,
 Matrix4f dest)

Change the near and far clip plane distances of this perspective frustum transformation matrix and store the result in dest.

This method only works if this is a perspective projection frustum transformation, for example obtained via perspective() or frustum().

Parameters:

near - the new near clip plane distance

far - the new far clip plane distance

dest - will hold the resulting matrix

Returns:

dest

See Also:

• perspective(float, float, float, float, Matrix4f)
• frustum(float, float, float, float, float, float, Matrix4f)

orthoCrop

Matrix4f orthoCrop(Matrix4fc view,
 Matrix4f dest)

Build an ortographic projection transformation that fits the view-projection transformation represented by this into the given affine view transformation.

The transformation represented by this must be given as the inverse of a typical combined camera view-projection transformation, whose projection can be either orthographic or perspective.

The view must be an affine transformation which in the application of Cascaded Shadow Maps is usually the light view transformation. It be obtained via any affine transformation or for example via lookAt().

Reference: OpenGL SDK - Cascaded Shadow Maps

Parameters:

view - the view transformation to build a corresponding orthographic projection to fit the frustum of this

dest - will hold the crop projection transformation

Returns:

dest

transformAab

Matrix4f transformAab(float minX,
 float minY,
 float minZ,
 float maxX,
 float maxY,
 float maxZ,
 Vector3f outMin,
 Vector3f outMax)

Transform the axis-aligned box given as the minimum corner (minX, minY, minZ) and maximum corner (maxX, maxY, maxZ) by this affine matrix and compute the axis-aligned box of the result whose minimum corner is stored in outMin and maximum corner stored in outMax.

Reference: http://dev.theomader.com

Parameters:

minX - the x coordinate of the minimum corner of the axis-aligned box

minY - the y coordinate of the minimum corner of the axis-aligned box

minZ - the z coordinate of the minimum corner of the axis-aligned box

maxX - the x coordinate of the maximum corner of the axis-aligned box

maxY - the y coordinate of the maximum corner of the axis-aligned box

maxZ - the y coordinate of the maximum corner of the axis-aligned box

outMin - will hold the minimum corner of the resulting axis-aligned box

outMax - will hold the maximum corner of the resulting axis-aligned box

Returns:

this

transformAab

Matrix4f transformAab(Vector3fc min,
 Vector3fc max,
 Vector3f outMin,
 Vector3f outMax)

Transform the axis-aligned box given as the minimum corner min and maximum corner max by this affine matrix and compute the axis-aligned box of the result whose minimum corner is stored in outMin and maximum corner stored in outMax.

Parameters:

min - the minimum corner of the axis-aligned box

max - the maximum corner of the axis-aligned box

outMin - will hold the minimum corner of the resulting axis-aligned box

outMax - will hold the maximum corner of the resulting axis-aligned box

Returns:

this

lerp

Matrix4f lerp(Matrix4fc other,
 float t,
 Matrix4f dest)

Linearly interpolate this and other using the given interpolation factor t and store the result in dest.

If t is 0.0 then the result is this. If the interpolation factor is 1.0 then the result is other.

Parameters:

other - the other matrix

t - the interpolation factor between 0.0 and 1.0

dest - will hold the result

Returns:

dest

rotateTowards

Matrix4f rotateTowards(Vector3fc dir,
 Vector3fc up,
 Matrix4f dest)

Apply a model transformation to this matrix for a right-handed coordinate system, that aligns the local +Z axis with dir and store the result in dest.

If M is this matrix and L the lookat matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookat transformation will be applied first!

This method is equivalent to calling: mulAffine(new Matrix4f().lookAt(new Vector3f(), new Vector3f(dir).negate(), up).invertAffine(), dest)

Parameters:

dir - the direction to rotate towards

up - the up vector

dest - will hold the result

Returns:

dest

See Also:

• rotateTowards(float, float, float, float, float, float, Matrix4f)

rotateTowards

Matrix4f rotateTowards(float dirX,
 float dirY,
 float dirZ,
 float upX,
 float upY,
 float upZ,
 Matrix4f dest)

Apply a model transformation to this matrix for a right-handed coordinate system, that aligns the local +Z axis with (dirX, dirY, dirZ) and store the result in dest.

If M is this matrix and L the lookat matrix, then the new matrix will be M * L. So when transforming a vector v with the new matrix by using M * L * v, the lookat transformation will be applied first!

This method is equivalent to calling: mulAffine(new Matrix4f().lookAt(0, 0, 0, -dirX, -dirY, -dirZ, upX, upY, upZ).invertAffine(), dest)

Parameters:

dirX - the x-coordinate of the direction to rotate towards

dirY - the y-coordinate of the direction to rotate towards

dirZ - the z-coordinate of the direction to rotate towards

upX - the x-coordinate of the up vector

upY - the y-coordinate of the up vector

upZ - the z-coordinate of the up vector

dest - will hold the result

Returns:

dest

See Also:

• rotateTowards(Vector3fc, Vector3fc, Matrix4f)

getEulerAnglesXYZ

Vector3f getEulerAnglesXYZ(Vector3f dest)

Extract the Euler angles from the rotation represented by the upper left 3x3 submatrix of this and store the extracted Euler angles in dest.

This method assumes that the upper left of this only represents a rotation without scaling.

The Euler angles are always returned as the angle around X in the Vector3f.x field, the angle around Y in the Vector3f.y field and the angle around Z in the Vector3f.z field of the supplied Vector3f instance.

Note that the returned Euler angles must be applied in the order X * Y * Z to obtain the identical matrix. This means that calling rotateXYZ(float, float, float, Matrix4f) using the obtained Euler angles will yield the same rotation as the original matrix from which the Euler angles were obtained, so in the below code the matrix m2 should be identical to m (disregarding possible floating-point inaccuracies).

 Matrix4f m = ...; // <- matrix only representing rotation
 Matrix4f n = new Matrix4f();
 n.rotateXYZ(m.getEulerAnglesXYZ(new Vector3f()));
 

Reference: http://en.wikipedia.org/

Parameters:

dest - will hold the extracted Euler angles

Returns:

dest

getEulerAnglesZYX

Vector3f getEulerAnglesZYX(Vector3f dest)

Extract the Euler angles from the rotation represented by the upper left 3x3 submatrix of this and store the extracted Euler angles in dest.

This method assumes that the upper left of this only represents a rotation without scaling.

The Euler angles are always returned as the angle around X in the Vector3f.x field, the angle around Y in the Vector3f.y field and the angle around Z in the Vector3f.z field of the supplied Vector3f instance.

Note that the returned Euler angles must be applied in the order Z * Y * X to obtain the identical matrix. This means that calling rotateZYX(float, float, float, Matrix4f) using the obtained Euler angles will yield the same rotation as the original matrix from which the Euler angles were obtained, so in the below code the matrix m2 should be identical to m (disregarding possible floating-point inaccuracies).

 Matrix4f m = ...; // <- matrix only representing rotation
 Matrix4f n = new Matrix4f();
 n.rotateZYX(m.getEulerAnglesZYX(new Vector3f()));
 

Reference: http://nghiaho.com/

Parameters:

dest - will hold the extracted Euler angles

Returns:

dest

testPoint

boolean testPoint(float x,
 float y,
 float z)

Test whether the given point (x, y, z) is within the frustum defined by this matrix.

This method assumes this matrix to be a transformation from any arbitrary coordinate system/space M into standard OpenGL clip space and tests whether the given point with the coordinates (x, y, z) given in space M is within the clip space.

When testing multiple points using the same transformation matrix, FrustumIntersection should be used instead.

Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

x - the x-coordinate of the point

y - the y-coordinate of the point

z - the z-coordinate of the point

Returns:

true if the given point is inside the frustum; false otherwise

testSphere

boolean testSphere(float x,
 float y,
 float z,
 float r)

Test whether the given sphere is partly or completely within or outside of the frustum defined by this matrix.

This method assumes this matrix to be a transformation from any arbitrary coordinate system/space M into standard OpenGL clip space and tests whether the given sphere with the coordinates (x, y, z) given in space M is within the clip space.

When testing multiple spheres using the same transformation matrix, or more sophisticated/optimized intersection algorithms are required, FrustumIntersection should be used instead.

The algorithm implemented by this method is conservative. This means that in certain circumstances a false positive can occur, when the method returns true for spheres that are actually not visible. See iquilezles.org for an examination of this problem.

Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

x - the x-coordinate of the sphere's center

y - the y-coordinate of the sphere's center

z - the z-coordinate of the sphere's center

r - the sphere's radius

Returns:

true if the given sphere is partly or completely inside the frustum; false otherwise

testAab

boolean testAab(float minX,
 float minY,
 float minZ,
 float maxX,
 float maxY,
 float maxZ)

Test whether the given axis-aligned box is partly or completely within or outside of the frustum defined by this matrix. The box is specified via its min and max corner coordinates.

This method assumes this matrix to be a transformation from any arbitrary coordinate system/space M into standard OpenGL clip space and tests whether the given axis-aligned box with its minimum corner coordinates (minX, minY, minZ) and maximum corner coordinates (maxX, maxY, maxZ) given in space M is within the clip space.

When testing multiple axis-aligned boxes using the same transformation matrix, or more sophisticated/optimized intersection algorithms are required, FrustumIntersection should be used instead.

The algorithm implemented by this method is conservative. This means that in certain circumstances a false positive can occur, when the method returns -1 for boxes that are actually not visible/do not intersect the frustum. See iquilezles.org for an examination of this problem.

Reference: Efficient View Frustum Culling
Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

minX - the x-coordinate of the minimum corner

minY - the y-coordinate of the minimum corner

minZ - the z-coordinate of the minimum corner

maxX - the x-coordinate of the maximum corner

maxY - the y-coordinate of the maximum corner

maxZ - the z-coordinate of the maximum corner

Returns:

true if the axis-aligned box is completely or partly inside of the frustum; false otherwise

obliqueZ

Matrix4f obliqueZ(float a,
 float b,
 Matrix4f dest)

Apply an oblique projection transformation to this matrix with the given values for a and b and store the result in dest.

If M is this matrix and O the oblique transformation matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the oblique transformation will be applied first!

The oblique transformation is defined as:

 x' = x + a*z
 y' = y + a*z
 z' = z
 

or in matrix form:

 1 0 a 0
 0 1 b 0
 0 0 1 0
 0 0 0 1
 

Parameters:

a - the value for the z factor that applies to x

b - the value for the z factor that applies to y

dest - will hold the result

Returns:

dest

withLookAtUp

Matrix4f withLookAtUp(Vector3fc up,
 Matrix4f dest)

Apply a transformation to this matrix to ensure that the local Y axis (as obtained by positiveY(Vector3f)) will be coplanar to the plane spanned by the local Z axis (as obtained by positiveZ(Vector3f)) and the given vector up, and store the result in dest.

This effectively ensures that the resulting matrix will be equal to the one obtained from calling Matrix4f.setLookAt(Vector3fc, Vector3fc, Vector3fc) with the current local origin of this matrix (as obtained by originAffine(Vector3f)), the sum of this position and the negated local Z axis as well as the given vector up.

This method must only be called on isAffine() matrices.

Parameters:

up - the up vector

dest - will hold the result

Returns:

this

withLookAtUp

Matrix4f withLookAtUp(float upX,
 float upY,
 float upZ,
 Matrix4f dest)

Apply a transformation to this matrix to ensure that the local Y axis (as obtained by positiveY(Vector3f)) will be coplanar to the plane spanned by the local Z axis (as obtained by positiveZ(Vector3f)) and the given vector (upX, upY, upZ), and store the result in dest.

This effectively ensures that the resulting matrix will be equal to the one obtained from calling Matrix4f.setLookAt(float, float, float, float, float, float, float, float, float) called with the current local origin of this matrix (as obtained by originAffine(Vector3f)), the sum of this position and the negated local Z axis as well as the given vector (upX, upY, upZ).

This method must only be called on isAffine() matrices.

Parameters:

upX - the x coordinate of the up vector

upY - the y coordinate of the up vector

upZ - the z coordinate of the up vector

dest - will hold the result

Returns:

this

mapXZY

Matrix4f mapXZY(Matrix4f dest)

Multiply this by the matrix

 1 0 0 0
 0 0 1 0
 0 1 0 0
 0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapXZnY

Matrix4f mapXZnY(Matrix4f dest)

Multiply this by the matrix

 1 0  0 0
 0 0 -1 0
 0 1  0 0
 0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapXnYnZ

Matrix4f mapXnYnZ(Matrix4f dest)

Multiply this by the matrix

 1  0  0 0
 0 -1  0 0
 0  0 -1 0
 0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapXnZY

Matrix4f mapXnZY(Matrix4f dest)

Multiply this by the matrix

 1  0 0 0
 0  0 1 0
 0 -1 0 0
 0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapXnZnY

Matrix4f mapXnZnY(Matrix4f dest)

Multiply this by the matrix

 1  0  0 0
 0  0 -1 0
 0 -1  0 0
 0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapYXZ

Matrix4f mapYXZ(Matrix4f dest)

Multiply this by the matrix

 0 1 0 0
 1 0 0 0
 0 0 1 0
 0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapYXnZ

Matrix4f mapYXnZ(Matrix4f dest)

Multiply this by the matrix

 0 1  0 0
 1 0  0 0
 0 0 -1 0
 0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapYZX

Matrix4f mapYZX(Matrix4f dest)

Multiply this by the matrix

 0 0 1 0
 1 0 0 0
 0 1 0 0
 0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapYZnX

Matrix4f mapYZnX(Matrix4f dest)

Multiply this by the matrix

 0 0 -1 0
 1 0  0 0
 0 1  0 0
 0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapYnXZ

Matrix4f mapYnXZ(Matrix4f dest)

Multiply this by the matrix

 0 -1 0 0
 1  0 0 0
 0  0 1 0
 0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapYnXnZ

Matrix4f mapYnXnZ(Matrix4f dest)

Multiply this by the matrix

 0 -1  0 0
 1  0  0 0
 0  0 -1 0
 0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapYnZX

Matrix4f mapYnZX(Matrix4f dest)

Multiply this by the matrix

 0  0 1 0
 1  0 0 0
 0 -1 0 0
 0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapYnZnX

Matrix4f mapYnZnX(Matrix4f dest)

Multiply this by the matrix

 0  0 -1 0
 1  0  0 0
 0 -1  0 0
 0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapZXY

Matrix4f mapZXY(Matrix4f dest)

Multiply this by the matrix

 0 1 0 0
 0 0 1 0
 1 0 0 0
 0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapZXnY

Matrix4f mapZXnY(Matrix4f dest)

Multiply this by the matrix

 0 1  0 0
 0 0 -1 0
 1 0  0 0
 0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapZYX

Matrix4f mapZYX(Matrix4f dest)

Multiply this by the matrix

 0 0 1 0
 0 1 0 0
 1 0 0 0
 0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapZYnX

Matrix4f mapZYnX(Matrix4f dest)

Multiply this by the matrix

 0 0 -1 0
 0 1  0 0
 1 0  0 0
 0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapZnXY

Matrix4f mapZnXY(Matrix4f dest)

Multiply this by the matrix

 0 -1 0 0
 0  0 1 0
 1  0 0 0
 0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapZnXnY

Matrix4f mapZnXnY(Matrix4f dest)

Multiply this by the matrix

 0 -1  0 0
 0  0 -1 0
 1  0  0 0
 0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapZnYX

Matrix4f mapZnYX(Matrix4f dest)

Multiply this by the matrix

 0  0 1 0
 0 -1 0 0
 1  0 0 0
 0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapZnYnX

Matrix4f mapZnYnX(Matrix4f dest)

Multiply this by the matrix

 0  0 -1 0
 0 -1  0 0
 1  0  0 0
 0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnXYnZ

Matrix4f mapnXYnZ(Matrix4f dest)

Multiply this by the matrix

 -1 0  0 0
  0 1  0 0
  0 0 -1 0
  0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnXZY

Matrix4f mapnXZY(Matrix4f dest)

Multiply this by the matrix

 -1 0 0 0
  0 0 1 0
  0 1 0 0
  0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnXZnY

Matrix4f mapnXZnY(Matrix4f dest)

Multiply this by the matrix

 -1 0  0 0
  0 0 -1 0
  0 1  0 0
  0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnXnYZ

Matrix4f mapnXnYZ(Matrix4f dest)

Multiply this by the matrix

 -1  0 0 0
  0 -1 0 0
  0  0 1 0
  0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnXnYnZ

Matrix4f mapnXnYnZ(Matrix4f dest)

Multiply this by the matrix

 -1  0  0 0
  0 -1  0 0
  0  0 -1 0
  0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnXnZY

Matrix4f mapnXnZY(Matrix4f dest)

Multiply this by the matrix

 -1  0 0 0
  0  0 1 0
  0 -1 0 0
  0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnXnZnY

Matrix4f mapnXnZnY(Matrix4f dest)

Multiply this by the matrix

 -1  0  0 0
  0  0 -1 0
  0 -1  0 0
  0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnYXZ

Matrix4f mapnYXZ(Matrix4f dest)

Multiply this by the matrix

  0 1 0 0
 -1 0 0 0
  0 0 1 0
  0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnYXnZ

Matrix4f mapnYXnZ(Matrix4f dest)

Multiply this by the matrix

  0 1  0 0
 -1 0  0 0
  0 0 -1 0
  0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnYZX

Matrix4f mapnYZX(Matrix4f dest)

Multiply this by the matrix

  0 0 1 0
 -1 0 0 0
  0 1 0 0
  0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnYZnX

Matrix4f mapnYZnX(Matrix4f dest)

Multiply this by the matrix

  0 0 -1 0
 -1 0  0 0
  0 1  0 0
  0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnYnXZ

Matrix4f mapnYnXZ(Matrix4f dest)

Multiply this by the matrix

  0 -1 0 0
 -1  0 0 0
  0  0 1 0
  0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnYnXnZ

Matrix4f mapnYnXnZ(Matrix4f dest)

Multiply this by the matrix

  0 -1  0 0
 -1  0  0 0
  0  0 -1 0
  0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnYnZX

Matrix4f mapnYnZX(Matrix4f dest)

Multiply this by the matrix

  0  0 1 0
 -1  0 0 0
  0 -1 0 0
  0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnYnZnX

Matrix4f mapnYnZnX(Matrix4f dest)

Multiply this by the matrix

  0  0 -1 0
 -1  0  0 0
  0 -1  0 0
  0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnZXY

Matrix4f mapnZXY(Matrix4f dest)

Multiply this by the matrix

  0 1 0 0
  0 0 1 0
 -1 0 0 0
  0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnZXnY

Matrix4f mapnZXnY(Matrix4f dest)

Multiply this by the matrix

  0 1  0 0
  0 0 -1 0
 -1 0  0 0
  0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnZYX

Matrix4f mapnZYX(Matrix4f dest)

Multiply this by the matrix

  0 0 1 0
  0 1 0 0
 -1 0 0 0
  0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnZYnX

Matrix4f mapnZYnX(Matrix4f dest)

Multiply this by the matrix

  0 0 -1 0
  0 1  0 0
 -1 0  0 0
  0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnZnXY

Matrix4f mapnZnXY(Matrix4f dest)

Multiply this by the matrix

  0 -1 0 0
  0  0 1 0
 -1  0 0 0
  0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnZnXnY

Matrix4f mapnZnXnY(Matrix4f dest)

Multiply this by the matrix

  0 -1  0 0
  0  0 -1 0
 -1  0  0 0
  0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnZnYX

Matrix4f mapnZnYX(Matrix4f dest)

Multiply this by the matrix

  0  0 1 0
  0 -1 0 0
 -1  0 0 0
  0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mapnZnYnX

Matrix4f mapnZnYnX(Matrix4f dest)

Multiply this by the matrix

  0  0 -1 0
  0 -1  0 0
 -1  0  0 0
  0  0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

negateX

Matrix4f negateX(Matrix4f dest)

Multiply this by the matrix

 -1 0 0 0
  0 1 0 0
  0 0 1 0
  0 0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

negateY

Matrix4f negateY(Matrix4f dest)

Multiply this by the matrix

 1  0 0 0
 0 -1 0 0
 0  0 1 0
 0  0 0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

negateZ

Matrix4f negateZ(Matrix4f dest)

Multiply this by the matrix

 1 0  0 0
 0 1  0 0
 0 0 -1 0
 0 0  0 1
 

and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

equals

boolean equals(Matrix4fc m,
 float delta)

Compare the matrix elements of this matrix with the given matrix using the given delta and return whether all of them are equal within a maximum difference of delta.

Please note that this method is not used by any data structure such as ArrayList HashSet or HashMap and their operations, such as ArrayList.contains(Object) or HashSet.remove(Object), since those data structures only use the Object.equals(Object) and Object.hashCode() methods.

Parameters:

m - the other matrix

delta - the allowed maximum difference

Returns:

true whether all of the matrix elements are equal; false otherwise

isFinite

boolean isFinite()

Determine whether all matrix elements are finite floating-point values, that is, they are not NaN and not infinity.

Returns:

true if all components are finite floating-point values; false otherwise