@lakuna/umath 1.3.5 → 1.3.6

package/dist/linalg/Matrix4.d.ts

@@ -4,127 +4,851 @@ import type { DualQuaternionLike } from "./DualQuaternion.js";
 import type FieldOfView from "../types/FieldOfView.js";
 import type { MatrixLike } from "./Matrix.js";
 import type SquareMatrix from "./SquareMatrix.js";
+/**
+ * Numbers arranged into four columns and four rows.
+ * @see [Matrix](https://en.wikipedia.org/wiki/Matrix_(mathematics))
+ */
 export interface Matrix4Like extends MatrixLike {
+    /** The value in the first column and first row. */
     0: number;
+    /** The value in the first column and second row. */
     1: number;
+    /** The value in the first column and third row. */
     2: number;
+    /** The value in the first column and fourth row. */
     3: number;
+    /** The value in the second column and first row. */
     4: number;
+    /** The value in the second column and second row. */
     5: number;
+    /** The value in the second column and third row. */
     6: number;
+    /** The value in the second column and fourth row. */
     7: number;
+    /** The value in the third column and first row. */
     8: number;
+    /** The value in the third column and second row. */
     9: number;
+    /** The value in the third column and third row. */
     10: number;
+    /** The value in the third column and fourth row. */
     11: number;
+    /** The value in the fourth column and first row. */
     12: number;
+    /** The value in the fourth column and second row. */
     13: number;
+    /** The value in the fourth column and third row. */
     14: number;
+    /** The value in the fourth column and fourth row. */
     15: number;
 }
-export declare function createMatrix4Like(): Matrix4Like;
-export declare function fromTranslation<T extends Matrix4Like>(vector: Vector3Like, out: T): T;
-export declare function fromScaling<T extends Matrix4Like>(vector: Vector3Like, out: T): T;
-export declare function identity<T extends Matrix4Like>(out: T): T;
-export declare function fromRotation<T extends Matrix4Like>(r: number, axis: Vector3Like, out: T): T;
-export declare function fromXRotation<T extends Matrix4Like>(r: number, out: T): T;
-export declare function fromYRotation<T extends Matrix4Like>(r: number, out: T): T;
-export declare function fromZRotation<T extends Matrix4Like>(r: number, out: T): T;
-export declare function fromRotationTranslation<T extends Matrix4Like>(rotation: QuaternionLike, translation: Vector3Like, out: T): T;
-export declare function fromRotationTranslationScale<T extends Matrix4Like>(rotation: QuaternionLike, translation: Vector3Like, scaling: Vector3Like, out: T): T;
-export declare function fromRotationTranslationScaleOrigin<T extends Matrix4Like>(rotation: QuaternionLike, translation: Vector3Like, scaling: Vector3Like, origin: Vector3Like, out: T): T;
-export declare function fromDualQuaternion<T extends Matrix4Like>(quaternion: DualQuaternionLike, out: T): T;
-export declare function frustum<T extends Matrix4Like>(left: number, right: number, bottom: number, top: number, near: number, far: number, out: T): T;
-export declare function perspective<T extends Matrix4Like>(fov: number, aspect: number, near: number, far: number, out: T): T;
-export declare function perspectiveFromFieldOfView<T extends Matrix4Like>(fov: FieldOfView, near: number, far: number, out: T): T;
-export declare function ortho<T extends Matrix4Like>(left: number, right: number, bottom: number, top: number, near: number, far: number, out: T): T;
-export declare function lookAt<T extends Matrix4Like>(eye: Vector3Like, center: Vector3Like, up: Vector3Like, out: T): T;
-export declare function targetTo<T extends Matrix4Like>(eye: Vector3Like, target: Vector3Like, up: Vector3Like, out: T): T;
-export declare function add<T extends Matrix4Like>(a: Matrix4Like, b: Matrix4Like, out: T): T;
-export declare function fromValues<T extends Matrix4Like>(c0r0: number, c0r1: number, c0r2: number, c0r3: number, c1r0: number, c1r1: number, c1r2: number, c1r3: number, c2r0: number, c2r1: number, c2r2: number, c2r3: number, c3r0: number, c3r1: number, c3r2: number, c3r3: number, out: T): T;
-export declare function equals(a: Matrix4Like, b: Matrix4Like): boolean;
-export declare function exactEquals(a: Matrix4Like, b: Matrix4Like): boolean;
-export declare function adjoint<T extends Matrix4Like>(matrix: Matrix4Like, out: T): T;
-export declare function copy<T extends Matrix4Like>(matrix: Matrix4Like, out: T): T;
-export declare function frob(matrix: Matrix4Like): number;
-export declare function multiply<T extends Matrix4Like>(a: Matrix4Like, b: Matrix4Like, out: T): T;
-export declare function multiplyScalar<T extends Matrix4Like>(matrix: Matrix4Like, scalar: number, out: T): T;
-export declare function multiplyScalarAndAdd<T extends Matrix4Like>(a: Matrix4Like, b: Matrix4Like, scalar: number, out: T): T;
-export declare function subtract<T extends Matrix4Like>(a: Matrix4Like, b: Matrix4Like, out: T): T;
-export declare function transpose<T extends Matrix4Like>(matrix: Matrix4Like, out: T): T;
-export declare function determinant(matrix: Matrix4Like): number;
-export declare function invert<T extends Matrix4Like>(matrix: Matrix4Like, out: T): T;
-export declare function scale<T extends Matrix4Like>(matrix: Matrix4Like, vector: Vector3Like, out: T): T;
-export declare function translate<T extends Matrix4Like>(matrix: Matrix4Like, vector: Vector3Like, out: T): T;
-export declare function rotate<T extends Matrix4Like>(matrix: Matrix4Like, radians: number, axis: Vector3Like, out: T): T;
-export declare function rotateX<T extends Matrix4Like>(matrix: Matrix4Like, r: number, out: T): T;
-export declare function rotateY<T extends Matrix4Like>(matrix: Matrix4Like, r: number, out: T): T;
-export declare function rotateZ<T extends Matrix4Like>(matrix: Matrix4Like, r: number, out: T): T;
-export declare function getTranslation<T extends Vector3Like>(matrix: Matrix4Like, out: T): T;
-export declare function setTranslation<T extends Matrix4Like>(matrix: Matrix4Like, translation: Vector3Like, out: T): T;
-export declare function getScaling<T extends Vector3Like>(matrix: Matrix4Like, out: T): T;
-export declare function getRotation<T extends QuaternionLike>(matrix: Matrix4Like, out: T): T;
+/**
+ * Create a 4x4 matrix-like object.
+ * @returns A 4x4 matrix-like object.
+ */
+export declare const createMatrix4Like: () => Matrix4Like;
+/**
+ * Create a transformation matrix that represents a translation by the given vector.
+ * @param vector - The translation vector.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const fromTranslation: <T extends Matrix4Like>(vector: Vector3Like, out: T) => T;
+/**
+ * Create a transformation matrix that represents a scaling by the given vector.
+ * @param vector - The scaling vector.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const fromScaling: <T extends Matrix4Like>(vector: Vector3Like, out: T) => T;
+/**
+ * Reset a matrix to identity.
+ * @param out - The matrix to store the result in.
+ * @returns The matrix.
+ * @see [Identity matrix](https://en.wikipedia.org/wiki/Identity_matrix)
+ */
+export declare const identity: <T extends Matrix4Like>(out: T) => T;
+/**
+ * Create a transformation matrix that represents a rotation by the given angle around the Z-axis.
+ * @param r - The angle in radians.
+ * @param axis - The axis to rotate around.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export declare const fromRotation: <T extends Matrix4Like>(r: number, axis: Vector3Like, out: T) => T;
+/**
+ * Create a transformation matrix that represents a rotation by the given angle around the X-axis.
+ * @param r - The angle in radians.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export declare const fromXRotation: <T extends Matrix4Like>(r: number, out: T) => T;
+/**
+ * Create a transformation matrix that represents a rotation by the given angle around the Y-axis.
+ * @param r - The angle in radians.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export declare const fromYRotation: <T extends Matrix4Like>(r: number, out: T) => T;
+/**
+ * Create a transformation matrix that represents a rotation by the given angle around the Z-axis.
+ * @param r - The angle in radians.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export declare const fromZRotation: <T extends Matrix4Like>(r: number, out: T) => T;
+/**
+ * Create a transformation matrix from the given rotation and translation.
+ * @param rotation - The rotation quaternion.
+ * @param translation - The translation vector.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Quaternion](https://en.wikipedia.org/wiki/Quaternion)
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const fromRotationTranslation: <T extends Matrix4Like>(rotation: QuaternionLike, translation: Vector3Like, out: T) => T;
+/**
+ * Create a transformation matrix from the given rotation, translation, and scale.
+ * @param rotation - The rotation quaternion.
+ * @param translation - The translation vector.
+ * @param scaling - The scaling vector.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Quaternion](https://en.wikipedia.org/wiki/Quaternion)
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const fromRotationTranslationScale: <T extends Matrix4Like>(rotation: QuaternionLike, translation: Vector3Like, scaling: Vector3Like, out: T) => T;
+/**
+ * Create a transformation matrix from the given rotation, translation, and scale around the given origin.
+ * @param rotation - The rotation quaternion.
+ * @param translation - The translation vector.
+ * @param scaling - The scaling vector.
+ * @param origin - The origin vector.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Quaternion](https://en.wikipedia.org/wiki/Quaternion)
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const fromRotationTranslationScaleOrigin: <T extends Matrix4Like>(rotation: QuaternionLike, translation: Vector3Like, scaling: Vector3Like, origin: Vector3Like, out: T) => T;
+/**
+ * Create a transformation matrix from a dual quaternion.
+ * @param quaternion - The dual quaternion.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Dual quaternion](https://en.wikipedia.org/wiki/Dual_quaternion)
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const fromDualQuaternion: <T extends Matrix4Like>(quaternion: DualQuaternionLike, out: T) => T;
+/**
+ * Generate a frustum matrix with the given bounds.
+ * @param left - The left bound of the frustum.
+ * @param right - The right bound of the frustum.
+ * @param bottom - The bottom bound of the frustum.
+ * @param top - The top bound of the frustum.
+ * @param near - The near bound of the frustum.
+ * @param far - The far bound of the frustum.
+ * @param out - The matrix to store the result in.
+ * @returns The frustum matrix.
+ * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+ * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+ */
+export declare const frustum: <T extends Matrix4Like>(left: number, right: number, bottom: number, top: number, near: number, far: number, out: T) => T;
+/**
+ * Create a perspective projection matrix with the given bounds.
+ * @param fov - The vertical field of view in radians.
+ * @param aspect - The aspect ratio (typically the width of the viewport divided by its height).
+ * @param near - The near bound of the frustum.
+ * @param far - The far bound of the frustum.
+ * @param out - The matrix to store the result in.
+ * @returns The perspective projection matrix.
+ * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+ * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+ */
+export declare const perspective: <T extends Matrix4Like>(fov: number, aspect: number, near: number, far: number, out: T) => T;
+/**
+ * Create a perspective projection matrix from a field of view. Useful for generating projection matrices to be used with the WebXR API.
+ * @param fov - The field of view.
+ * @param near - The near bound of the frustum.
+ * @param far - The far bound of the frustum.
+ * @param out - The matrix to store the result in.
+ * @returns The perspective projection matrix.
+ * @see [WebXR API](https://developer.mozilla.org/en-US/docs/Web/API/WebXR_Device_API)
+ * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+ * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+ */
+export declare const perspectiveFromFieldOfView: <T extends Matrix4Like>(fov: FieldOfView, near: number, far: number, out: T) => T;
+/**
+ * Generate an orthogonal projection matrix with the given bounds.
+ * @param left - The left bound of the frustum.
+ * @param right - The right bound of the frustum.
+ * @param bottom - The bottom bound of the frustum.
+ * @param top - The top bound of the frustum.
+ * @param near - The near bound of the frustum.
+ * @param far - The far bound of the frustum.
+ * @param out - The matrix to store the result in.
+ * @returns The frustum matrix.
+ * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+ * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+ */
+export declare const ortho: <T extends Matrix4Like>(left: number, right: number, bottom: number, top: number, near: number, far: number, out: T) => T;
+/**
+ * Generate a look-at matrix. If you want a matrix that actually makes an object look at another object, use `targetTo` instead.
+ * @param eye - The position of the viewer.
+ * @param center - The point that the viewer is looking at.
+ * @param up - The local up direction.
+ * @param out - The matrix to store the result in.
+ * @returns The look-at matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const lookAt: <T extends Matrix4Like>(eye: Vector3Like, center: Vector3Like, up: Vector3Like, out: T) => T;
+/**
+ * Create a matrix that makes something look at something else.
+ * @param eye - The position of the viewer.
+ * @param center - The point that the viewer is looking at.
+ * @param up - The local up direction.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const targetTo: <T extends Matrix4Like>(eye: Vector3Like, target: Vector3Like, up: Vector3Like, out: T) => T;
+/**
+ * Add two matrices.
+ * @param a - The augend.
+ * @param b - The addend.
+ * @param out - The matrix to store the result in.
+ * @returns The sum.
+ * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+ */
+export declare const add: <T extends Matrix4Like>(a: Matrix4Like, b: Matrix4Like, out: T) => T;
+/**
+ * Create a two-by-two matrix with the given values.
+ * @param c0r0 - The value in the first column and first row.
+ * @param c0r1 - The value in the first column and second row.
+ * @param c0r2 - The value in the first column and third row.
+ * @param c0r3 - The value in the first column and fourth row.
+ * @param c1r0 - The value in the second column and first row.
+ * @param c1r1 - The value in the second column and second row.
+ * @param c1r2 - The value in the second column and third row.
+ * @param c1r3 - The value in the second column and fourth row.
+ * @param c2r0 - The value in the third column and first row.
+ * @param c2r1 - The value in the third column and second row.
+ * @param c2r2 - The value in the third column and third row.
+ * @param c2r3 - The value in the third column and fourth row.
+ * @param c3r0 - The value in the fourth column and first row.
+ * @param c3r1 - The value in the fourth column and second row.
+ * @param c3r2 - The value in the fourth column and third row.
+ * @param c3r3 - The value in the fourth column and fourth row.
+ * @param out - The matrix to store the result in.
+ * @returns The matrix.
+ */
+export declare const fromValues: <T extends Matrix4Like>(c0r0: number, c0r1: number, c0r2: number, c0r3: number, c1r0: number, c1r1: number, c1r2: number, c1r3: number, c2r0: number, c2r1: number, c2r2: number, c2r3: number, c3r0: number, c3r1: number, c3r2: number, c3r3: number, out: T) => T;
+/**
+ * Determine whether or not two matrices are roughly equivalent.
+ * @param a - The first matrix.
+ * @param b - The second matrix.
+ * @returns Whether or not the matrices are equivalent.
+ */
+export declare const equals: (a: Matrix4Like, b: Matrix4Like) => boolean;
+/**
+ * Determine whether or not two matrices are exactly equivalent.
+ * @param a - The first matrix.
+ * @param b - The second matrix.
+ * @returns Whether the matrices are equivalent.
+ */
+export declare const exactEquals: (a: Matrix4Like, b: Matrix4Like) => boolean;
+/**
+ * Calculate the adjugate of a matrix.
+ * @param matrix - The matrix.
+ * @param out - The matrix to store the result in.
+ * @returns The adjugate of the matrix.
+ * @see [Adjugate matrix](https://en.wikipedia.org/wiki/Adjugate_matrix)
+ */
+export declare const adjoint: <T extends Matrix4Like>(matrix: Matrix4Like, out: T) => T;
+/**
+ * Copy the values of one matrix into another.
+ * @param matrix - The matrix to copy.
+ * @param out - The matrix to store the result in.
+ * @returns This matrix.
+ */
+export declare const copy: <T extends Matrix4Like>(matrix: Matrix4Like, out: T) => T;
+/**
+ * Calculate the Frobenius norm of a matrix.
+ * @param matrix - The matrix.
+ * @returns The Frobenius norm.
+ * @see [Matrix norm](https://en.wikipedia.org/wiki/Matrix_norm)
+ */
+export declare const frob: (matrix: Matrix4Like) => number;
+/**
+ * Multiply two matrices.
+ * @param a - The multiplicand.
+ * @param b - The multiplier.
+ * @param out - The matrix to store the result in.
+ * @returns The product.
+ * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+ */
+export declare const multiply: <T extends Matrix4Like>(a: Matrix4Like, b: Matrix4Like, out: T) => T;
+/**
+ * Multiply a matrix by a scalar value.
+ * @param matrix - The multiplicand.
+ * @param scalar - The multiplier.
+ * @param out - The matrix to store the result in.
+ * @returns The product.
+ * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+ */
+export declare const multiplyScalar: <T extends Matrix4Like>(matrix: Matrix4Like, scalar: number, out: T) => T;
+/**
+ * Add a matrix to another after multiplying the other by a scalar.
+ * @param a - The augend.
+ * @param b - The addend.
+ * @param scalar - The multiplier.
+ * @param out - The matrix to store the result in.
+ * @returns The sum.
+ * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+ * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+ */
+export declare const multiplyScalarAndAdd: <T extends Matrix4Like>(a: Matrix4Like, b: Matrix4Like, scalar: number, out: T) => T;
+/**
+ * Subtract two matrices.
+ * @param a - The minuend.
+ * @param b - The subtrahend.
+ * @param out - The matrix to store the result in.
+ * @returns The difference.
+ * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+ */
+export declare const subtract: <T extends Matrix4Like>(a: Matrix4Like, b: Matrix4Like, out: T) => T;
+/**
+ * Transpose a matrix.
+ * @param matrix - The matrix.
+ * @param out - The matrix to store the result in.
+ * @returns The transpose.
+ * @see [Transpose](https://en.wikipedia.org/wiki/Transpose)
+ */
+export declare const transpose: <T extends Matrix4Like>(matrix: Matrix4Like, out: T) => T;
+/**
+ * Calculate the determinant of a matrix.
+ * @param matrix - The matrix.
+ * @returns The determinant.
+ * @see [Determinant](https://en.wikipedia.org/wiki/Determinant)
+ */
+export declare const determinant: (matrix: Matrix4Like) => number;
+/**
+ * Invert a matrix.
+ * @param matrix - The matrix.
+ * @param out - The matrix to store the result in.
+ * @returns The inverted matrix.
+ * @see [Invertible matrix](https://en.wikipedia.org/wiki/Invertible_matrix)
+ */
+export declare const invert: <T extends Matrix4Like>(matrix: Matrix4Like, out: T) => T;
+/**
+ * Scale a matrix by the given vector.
+ * @param matrix - The matrix.
+ * @param vector - The scaling vector.
+ * @param out - The matrix to store the result in.
+ * @returns The scaled matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const scale: <T extends Matrix4Like>(matrix: Matrix4Like, vector: Vector3Like, out: T) => T;
+/**
+ * Translate a matrix by the given vector.
+ * @param matrix - The matrix.
+ * @param vector - The translation vector.
+ * @param out - The matrix to store the result in.
+ * @returns The translated matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const translate: <T extends Matrix4Like>(matrix: Matrix4Like, vector: Vector3Like, out: T) => T;
+/**
+ * Rotate a matrix by the given angle around the given axis.
+ * @param matrix - The matrix.
+ * @param radians - The angle in radians.
+ * @param axis - The axis.
+ * @param out - The matrix to store the result in.
+ * @returns The rotated matrix.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export declare const rotate: <T extends Matrix4Like>(matrix: Matrix4Like, radians: number, axis: Vector3Like, out: T) => T;
+/**
+ * Rotate a matrix by the given angle around the X-axis.
+ * @param matrix - The matrix.
+ * @param r - The angle in radians.
+ * @param out - The matrix to store the result in.
+ * @returns The rotated matrix.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export declare const rotateX: <T extends Matrix4Like>(matrix: Matrix4Like, r: number, out: T) => T;
+/**
+ * Rotate a matrix by the given angle around the Y-axis.
+ * @param matrix - The matrix.
+ * @param r - The angle in radians.
+ * @param out - The matrix to store the result in.
+ * @returns The rotated matrix.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export declare const rotateY: <T extends Matrix4Like>(matrix: Matrix4Like, r: number, out: T) => T;
+/**
+ * Rotate a matrix by the given angle around the Z-axis.
+ * @param matrix - The matrix.
+ * @param r - The angle in radians.
+ * @param out - The matrix to store the result in.
+ * @returns The rotated matrix.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export declare const rotateZ: <T extends Matrix4Like>(matrix: Matrix4Like, r: number, out: T) => T;
+/**
+ * Get the translation vector component of a transformation matrix.
+ * @param matrix - The matrix.
+ * @param out - The vector to store the result in.
+ * @returns The translation vector.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const getTranslation: <T extends Vector3Like>(matrix: Matrix4Like, out: T) => T;
+/**
+ * Set the translation vector component of a transformation matrix.
+ * @param matrix - The matrix.
+ * @param translation - The translation vector.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const setTranslation: <T extends Matrix4Like>(matrix: Matrix4Like, translation: Vector3Like, out: T) => T;
+/**
+ * Get the scaling factor of a transformation matrix.
+ * @param matrix - The matrix.
+ * @param out - The vector to store the result in.
+ * @returns The scaling vector.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export declare const getScaling: <T extends Vector3Like>(matrix: Matrix4Like, out: T) => T;
+/**
+ * Get the rotational component of a transformation matrix.
+ * @param matrix - The matrix.
+ * @param out - The quaternion to store the result in.
+ * @returns The rotation.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export declare const getRotation: <T extends QuaternionLike>(matrix: Matrix4Like, out: T) => T;
+/**
+ * A four-by-four matrix.
+ * @see [Matrix](https://en.wikipedia.org/wiki/Matrix_(mathematics))
+ */
 export default class Matrix4 extends Float32Array implements SquareMatrix, Matrix4Like {
+    /**
+     * Create a transformation matrix that represents a translation by the given vector.
+     * @param vector - The translation vector.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static fromTranslation<T extends Matrix4Like>(vector: Vector3Like, out?: T): T;
+    /**
+     * Create a transformation matrix that represents a scaling by the given vector.
+     * @param vector - The scaling vector.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static fromScaling<T extends Matrix4Like>(vector: Vector3Like, out?: T): T;
+    /**
+     * Create a transformation matrix that represents a rotation by the given angle around the Z-axis.
+     * @param r - The angle in radians.
+     * @param axis - The axis to rotate around.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     static fromRotation<T extends Matrix4Like>(r: number, axis: Vector3Like, out?: T): T;
+    /**
+     * Create a transformation matrix that represents a rotation by the given angle around the X-axis.
+     * @param r - The angle in radians.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     static fromXRotation<T extends Matrix4Like>(r: number, out?: T): T;
+    /**
+     * Create a transformation matrix that represents a rotation by the given angle around the Y-axis.
+     * @param r - The angle in radians.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     static fromYRotation<T extends Matrix4Like>(r: number, out?: T): T;
+    /**
+     * Create a transformation matrix that represents a rotation by the given angle around the Z-axis.
+     * @param r - The angle in radians.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     static fromZRotation<T extends Matrix4Like>(r: number, out?: T): T;
+    /**
+     * Create a transformation matrix from the given rotation and translation.
+     * @param rotation - The rotation quaternion.
+     * @param translation - The translation vector.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static fromRotationTranslation<T extends Matrix4Like>(rotation: QuaternionLike, translation: Vector3Like, out?: T): T;
+    /**
+     * Create a transformation matrix from the given rotation, translation, and scale.
+     * @param rotation - The rotation quaternion.
+     * @param translation - The translation vector.
+     * @param scaling - The scaling vector.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static fromRotationTranslationScale<T extends Matrix4Like>(rotation: QuaternionLike, translation: Vector3Like, scaling: Vector3Like, out?: T): T;
+    /**
+     * Create a transformation matrix from the given rotation, translation, and scale around the given origin.
+     * @param rotation - The rotation quaternion.
+     * @param translation - The translation vector.
+     * @param scaling - The scaling vector.
+     * @param origin - The origin vector.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static fromRotationTranslationScaleOrigin<T extends Matrix4Like>(rotation: QuaternionLike, translation: Vector3Like, scaling: Vector3Like, origin: Vector3Like, out?: T): T;
+    /**
+     * Create a transformation matrix from a dual quaternion.
+     * @param quaternion - The dual quaternion.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Dual quaternion](https://en.wikipedia.org/wiki/Dual_quaternion)
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static fromDualQuaternion<T extends Matrix4Like>(quaternion: DualQuaternionLike, out?: T): T;
+    /**
+     * Generate a frustum matrix with the given bounds.
+     * @param left - The left bound of the frustum.
+     * @param right - The right bound of the frustum.
+     * @param bottom - The bottom bound of the frustum.
+     * @param top - The top bound of the frustum.
+     * @param near - The near bound of the frustum.
+     * @param far - The far bound of the frustum.
+     * @param out - The matrix to store the result in.
+     * @returns The frustum matrix.
+     * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+     * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+     */
     static frustum<T extends Matrix4Like>(left: number, right: number, bottom: number, top: number, near: number, far: number, out?: T): T;
+    /**
+     * Create a perspective projection matrix with the given bounds.
+     * @param fov - The vertical field of view in radians.
+     * @param aspect - The aspect ratio (typically the width of the viewport divided by its height).
+     * @param near - The near bound of the frustum.
+     * @param far - The far bound of the frustum.
+     * @param out - The matrix to store the result in.
+     * @returns The perspective projection matrix.
+     * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+     * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+     */
     static perspective<T extends Matrix4Like>(fov: number, aspect: number, near: number, far: number, out?: T): T;
+    /**
+     * Create a perspective projection matrix from a field of view. Useful for generating projection matrices to be used with the WebXR API.
+     * @param fov - The field of view.
+     * @param near - The near bound of the frustum.
+     * @param far - The far bound of the frustum.
+     * @param out - The matrix to store the result in.
+     * @returns The perspective projection matrix.
+     * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+     * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+     * @see [WebXR API](https://developer.mozilla.org/en-US/docs/Web/API/WebXR_Device_API)
+     */
     static perspectiveFromFieldOfView<T extends Matrix4Like>(fov: FieldOfView, near: number, far: number, out?: T): T;
+    /**
+     * Generate an orthogonal projection matrix with the given bounds.
+     * @param left - The left bound of the frustum.
+     * @param right - The right bound of the frustum.
+     * @param bottom - The bottom bound of the frustum.
+     * @param top - The top bound of the frustum.
+     * @param near - The near bound of the frustum.
+     * @param far - The far bound of the frustum.
+     * @param out - The matrix to store the result in.
+     * @returns The frustum matrix.
+     * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+     * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+     */
     static ortho<T extends Matrix4Like>(left: number, right: number, bottom: number, top: number, near: number, far: number, out?: T): T;
+    /**
+     * Generate a look-at matrix. If you want a matrix that actually makes an object look at another object, use `targetTo` instead.
+     * @param eye - The position of the viewer.
+     * @param center - The point that the viewer is looking at.
+     * @param up - The local up direction.
+     * @param out - The matrix to store the result in.
+     * @returns The look-at matrix.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static lookAt<T extends Matrix4Like>(eye: Vector3Like, center: Vector3Like, up?: Vector3Like, out?: T): T;
+    /**
+     * Create a matrix that makes something look at something else.
+     * @param eye - The position of the viewer.
+     * @param target - The point that the viewer is looking at.
+     * @param up - The local up direction.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static targetTo<T extends Matrix4Like>(eye: Vector3Like, target: Vector3Like, up?: Vector3Like, out?: T): T;
+    /**
+     * Create a two-by-two matrix with the given values.
+     * @param c0r0 - The value in the first column and first row.
+     * @param c0r1 - The value in the first column and second row.
+     * @param c0r2 - The value in the first column and third row.
+     * @param c0r3 - The value in the first column and fourth row.
+     * @param c1r0 - The value in the second column and first row.
+     * @param c1r1 - The value in the second column and second row.
+     * @param c1r2 - The value in the second column and third row.
+     * @param c1r3 - The value in the second column and fourth row.
+     * @param c2r0 - The value in the third column and first row.
+     * @param c2r1 - The value in the third column and second row.
+     * @param c2r2 - The value in the third column and third row.
+     * @param c2r3 - The value in the third column and fourth row.
+     * @param c3r0 - The value in the fourth column and first row.
+     * @param c3r1 - The value in the fourth column and second row.
+     * @param c3r2 - The value in the fourth column and third row.
+     * @param c3r3 - The value in the fourth column and fourth row.
+     * @param out - The matrix to store the result in.
+     * @returns The matrix.
+     */
     static fromValues<T extends Matrix4Like>(c0r0: number, c0r1: number, c0r2: number, c0r3: number, c1r0: number, c1r1: number, c1r2: number, c1r3: number, c2r0: number, c2r1: number, c2r2: number, c2r3: number, c3r0: number, c3r1: number, c3r2: number, c3r3: number, out?: T): T;
+    /**
+     * Create a four-by-four identity matrix.
+     * @see [Identity matrix](https://en.wikipedia.org/wiki/Identity_matrix)
+     */
     constructor();
+    /** The value in the first column and first row. */
     0: number;
+    /** The value in the first column and second row. */
     1: number;
+    /** The value in the first column and third row. */
     2: number;
+    /** The value in the first column and fourth row. */
     3: number;
+    /** The value in the second column and first row. */
     4: number;
+    /** The value in the second column and second row. */
     5: number;
+    /** The value in the second column and third row. */
     6: number;
+    /** The value in the second column and fourth row. */
     7: number;
+    /** The value in the third column and first row. */
     8: number;
+    /** The value in the third column and second row. */
     9: number;
+    /** The value in the third column and third row. */
     10: number;
+    /** The value in the third column and fourth row. */
     11: number;
+    /** The value in the fourth column and first row. */
     12: number;
+    /** The value in the fourth column and second row. */
     13: number;
+    /** The value in the fourth column and third row. */
     14: number;
+    /** The value in the fourth column and fourth row. */
     15: number;
+    /** The number of columns in this matrix. */
     readonly width: 4;
+    /** The number of rows in this matrix. */
     readonly height: 4;
+    /**
+     * Determine whether or not this matrix is roughly equivalent to another.
+     * @param matrix - The other matrix.
+     * @returns Whether or not the matrices are equivalent.
+     */
     equals(matrix: Matrix4Like): boolean;
+    /**
+     * Determine whether or not this matrix is exactly equivalent to another.
+     * @param matrix - The other matrix.
+     * @returns Whether or not the matrices are equivalent.
+     */
     exactEquals(matrix: Matrix4Like): boolean;
+    /**
+     * Add two matrices of the same size.
+     * @param matrix - The other matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The sum of the matrices.
+     * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+     */
     add<T extends Matrix4Like>(matrix: Matrix4Like, out?: T): T;
+    /**
+     * Calculate the adjugate of this matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The adjugate of this matrix.
+     * @see [Adjugate matrix](https://en.wikipedia.org/wiki/Adjugate_matrix)
+     */
     adjoint<T extends Matrix4Like>(out?: T): T;
+    /**
+     * Copy the values from this matrix to another one.
+     * @param out - The matrix to store the result in.
+     * @returns The copy.
+     */
     clone<T extends Matrix4Like>(out?: T): T;
+    /**
+     * Copy the values of another matrix into this one.
+     * @param matrix - The matrix to copy.
+     * @returns This matrix.
+     */
     copy(matrix: Matrix4Like): this;
+    /**
+     * Get the Frobenius norm of this matrix.
+     * @see [Matrix norm](https://en.wikipedia.org/wiki/Matrix_norm)
+     */
     get frob(): number;
+    /**
+     * Multiply this matrix by another.
+     * @param matrix - The other matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The product of the matrices.
+     * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+     */
     multiply<T extends Matrix4Like>(matrix: Matrix4Like, out?: T): T;
+    /**
+     * Multiply this matrix by a scalar value.
+     * @param scalar - The scalar value.
+     * @param out - The matrix to store the result in.
+     * @returns The product of the matrix and the scalar value.
+     * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+     */
     multiplyScalar<T extends Matrix4Like>(scalar: number, out?: T): T;
+    /**
+     * Add this matrix to another after multiplying the other by a scalar.
+     * @param matrix - The other matrix.
+     * @param scalar - The scalar.
+     * @param out - The matrix to store the result in.
+     * @returns The sum.
+     * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+     * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+     */
     multiplyScalarAndAdd<T extends Matrix4Like>(matrix: Matrix4Like, scalar: number, out?: T): T;
+    /**
+     * Subtract another matrix from this one.
+     * @param matrix - The other matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The difference between the matrices.
+     * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+     */
     subtract<T extends Matrix4Like>(matrix: Matrix4Like, out?: T): T;
+    /**
+     * Transpose this matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The transpose of this matrix.
+     * @see [Transpose](https://en.wikipedia.org/wiki/Transpose)
+     */
     transpose<T extends Matrix4Like>(out?: T): T;
+    /**
+     * Get the determinant of this matrix.
+     * @see [Determinant](https://en.wikipedia.org/wiki/Determinant)
+     */
     get determinant(): number;
+    /**
+     * Reset this matrix to identity.
+     * @returns This matrix.
+     * @see [Identity matrix](https://en.wikipedia.org/wiki/Identity_matrix)
+     */
     identity(): this;
+    /**
+     * Invert this matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The inverted matrix.
+     * @see [Invertible matrix](https://en.wikipedia.org/wiki/Invertible_matrix)
+     */
     invert<T extends Matrix4Like>(out?: T): T;
+    /**
+     * Scale this matrix by the given vector.
+     * @param vector - The scaling vector.
+     * @param out - The matrix to store the result in.
+     * @returns The scaled matrix.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     scale<T extends Matrix4Like>(vector: Vector3Like, out?: T): T;
+    /**
+     * Translate this matrix by the given vector.
+     * @param vector - The translation vector.
+     * @param out - The matrix to store the result in.
+     * @returns The translated matrix.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     translate<T extends Matrix4Like>(vector: Vector3Like, out?: T): T;
+    /**
+     * Rotate this matrix by the given angle around the given axis.
+     * @param r - The angle in radians.
+     * @param axis - The axis.
+     * @param out - The matrix to store the result in.
+     * @returns The rotated matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     rotate<T extends Matrix4Like>(r: number, axis: Vector3Like, out?: T): T;
+    /**
+     * Rotate this matrix by the given angle around the X-axis.
+     * @param r - The angle in radians.
+     * @param out - The matrix to store the result in.
+     * @returns The rotated matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     rotateX<T extends Matrix4Like>(r: number, out?: T): T;
+    /**
+     * Rotate this matrix by the given angle around the Y-axis.
+     * @param r - The angle in radians.
+     * @param out - The matrix to store the result in.
+     * @returns The rotated matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     rotateY<T extends Matrix4Like>(r: number, out?: T): T;
+    /**
+     * Rotate this matrix by the given angle around the Z-axis.
+     * @param r - The angle in radians.
+     * @param out - The matrix to store the result in.
+     * @returns The rotated matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     rotateZ<T extends Matrix4Like>(r: number, out?: T): T;
+    /**
+     * Get the translation vector component of this transformation matrix.
+     * @param out - The vector to store the result in.
+     * @returns The translation.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     getTranslation<T extends Vector3Like>(out?: T): T;
+    /**
+     * Set the translation vector component of this transformation matrix.
+     * @param translation - The translation vector.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     setTranslation<T extends Matrix4Like>(translation: Vector3Like, out?: T): T;
+    /**
+     * Get the scaling vector component of this transformation matrix.
+     * @param out - The vector to store the result in.
+     * @returns The scaling.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     getScaling<T extends Vector3Like>(out?: T): T;
+    /**
+     * Get the scaling vector component of this transformation matrix.
+     * @param out - The quaternion to store the result in.
+     * @returns The rotation.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     getRotation<T extends QuaternionLike>(out?: T): T;
 }
 //# sourceMappingURL=Matrix4.d.ts.map