Struct glam::f64::DMat4

#[repr(transparent)]pub struct DMat4(_);

A 4x4 column major matrix.

Implementations

impl DMat4

pub const fn zero() -> Self

Creates a 4x4 matrix with all elements set to 0.0.

pub const fn identity() -> Self

Creates a 4x4 identity matrix.

pub fn from_cols(
    x_axis: DVec4,
    y_axis: DVec4,
    z_axis: DVec4,
    w_axis: DVec4
) -> Self

Creates a 4x4 matrix from four column vectors.

pub fn from_cols_array(m: &[f64; 16]) -> Self

Creates a 4x4 matrix from a [S; 16] array stored in column major order. If your data is stored in row major you will need to transpose the returned matrix.

pub fn to_cols_array(&self) -> [f64; 16]

Creates a [S; 16] array storing data in column major order. If you require data in row major order transpose the matrix first.

pub fn from_cols_array_2d(m: &[[f64; 4]; 4]) -> Self

Creates a 4x4 matrix from a [[S; 4]; 4] 2D array stored in column major order. If your data is in row major order you will need to transpose the returned matrix.

pub fn to_cols_array_2d(&self) -> [[f64; 4]; 4]

Creates a [[S; 4]; 4] 2D array storing data in column major order. If you require data in row major order transpose the matrix first.

pub fn from_scale_rotation_translation(
    scale: DVec3,
    rotation: DQuat,
    translation: DVec3
) -> Self

Creates a 4x4 homogeneous transformation matrix from the given scale, rotation and translation.

pub fn from_rotation_translation(rotation: DQuat, translation: DVec3) -> Self

Creates a 4x4 homogeneous transformation matrix from the given translation.

pub fn to_scale_rotation_translation(&self) -> (DVec3, DQuat, DVec3)

Extracts scale, rotation and translation from self. The input matrix is expected to be a 4x4 homogeneous transformation matrix otherwise the output will be invalid.

pub fn from_quat(rotation: DQuat) -> Self

Creates a 4x4 homogeneous transformation matrix from the given rotation.

pub fn from_translation(translation: DVec3) -> Self

Creates a 4x4 homogeneous transformation matrix from the given translation.

pub fn from_axis_angle(axis: DVec3, angle: f64) -> Self

Creates a 4x4 homogeneous transformation matrix containing a rotation around a normalized rotation axis of angle (in radians).

pub fn from_rotation_ypr(yaw: f64, pitch: f64, roll: f64) -> Self

Creates a 4x4 homogeneous transformation matrix containing a rotation around the given Euler angles (in radians).

pub fn from_rotation_x(angle: f64) -> Self

Creates a 4x4 homogeneous transformation matrix containing a rotation around the x axis of angle (in radians).

pub fn from_rotation_y(angle: f64) -> Self

Creates a 4x4 homogeneous transformation matrix containing a rotation around the y axis of angle (in radians).

pub fn from_rotation_z(angle: f64) -> Self

Creates a 4x4 homogeneous transformation matrix containing a rotation around the z axis of angle (in radians).

pub fn from_scale(scale: DVec3) -> Self

Creates a 4x4 homogeneous transformation matrix containing the given non-uniform scale.

pub fn is_finite(&self) -> bool

Returns true if, and only if, all elements are finite. If any element is either NaN, positive or negative infinity, this will return false.

pub fn is_nan(&self) -> bool

Returns true if any elements are NaN.

pub fn transpose(&self) -> Self

Returns the transpose of self.

pub fn determinant(&self) -> f64

Returns the determinant of self.

pub fn inverse(&self) -> Self

Returns the inverse of self.

If the matrix is not invertible the returned matrix will be invalid.

pub fn look_at_lh(eye: DVec3, center: DVec3, up: DVec3) -> Self

Creates a left-handed view matrix using a camera position, an up direction, and a focal point.

pub fn look_at_rh(eye: DVec3, center: DVec3, up: DVec3) -> Self

Creates a right-handed view matrix using a camera position, an up direction, and a focal point.

pub fn perspective_rh_gl(
    fov_y_radians: f64,
    aspect_ratio: f64,
    z_near: f64,
    z_far: f64
) -> Self

Creates a right-handed perspective projection matrix with [-1,1] depth range. This is the same as the OpenGL gluPerspective function. See https://www.khronos.org/registry/OpenGL-Refpages/gl2.1/xhtml/gluPerspective.xml

pub fn perspective_lh(
    fov_y_radians: f64,
    aspect_ratio: f64,
    z_near: f64,
    z_far: f64
) -> Self

Creates a left-handed perspective projection matrix with [0,1] depth range.

pub fn perspective_rh(
    fov_y_radians: f64,
    aspect_ratio: f64,
    z_near: f64,
    z_far: f64
) -> Self

Creates a right-handed perspective projection matrix with [0,1] depth range.

pub fn perspective_infinite_lh(
    fov_y_radians: f64,
    aspect_ratio: f64,
    z_near: f64
) -> Self

Creates an infinite left-handed perspective projection matrix with [0,1] depth range.

pub fn perspective_infinite_reverse_lh(
    fov_y_radians: f64,
    aspect_ratio: f64,
    z_near: f64
) -> Self

Creates an infinite left-handed perspective projection matrix with [0,1] depth range.

pub fn perspective_infinite_rh(
    fov_y_radians: f64,
    aspect_ratio: f64,
    z_near: f64
) -> Self

Creates an infinite right-handed perspective projection matrix with [0,1] depth range.

pub fn perspective_infinite_reverse_rh(
    fov_y_radians: f64,
    aspect_ratio: f64,
    z_near: f64
) -> Self

Creates an infinite reverse right-handed perspective projection matrix with [0,1] depth range.

pub fn orthographic_rh_gl(
    left: f64,
    right: f64,
    bottom: f64,
    top: f64,
    near: f64,
    far: f64
) -> Self

Creates a right-handed orthographic projection matrix with [-1,1] depth range. This is the same as the OpenGL glOrtho function in OpenGL. See https://www.khronos.org/registry/OpenGL-Refpages/gl2.1/xhtml/glOrtho.xml

pub fn orthographic_lh(
    left: f64,
    right: f64,
    bottom: f64,
    top: f64,
    near: f64,
    far: f64
) -> Self

Creates a left-handed orthographic projection matrix with [0,1] depth range.

pub fn orthographic_rh(
    left: f64,
    right: f64,
    bottom: f64,
    top: f64,
    near: f64,
    far: f64
) -> Self

Creates a right-handed orthographic projection matrix with [0,1] depth range.

pub fn mul_vec4(&self, other: DVec4) -> DVec4

Transforms a 4D vector.

pub fn mul_mat4(&self, other: &Self) -> Self

Multiplies two 4x4 matrices.

pub fn add_mat4(&self, other: &Self) -> Self

Adds two 4x4 matrices.

pub fn sub_mat4(&self, other: &Self) -> Self

Subtracts two 4x4 matrices.

pub fn mul_scalar(&self, other: f64) -> Self

Multiplies this matrix by a scalar value.

pub fn transform_point3(&self, other: DVec3) -> DVec3

Transforms the given 3D vector as a point.

This is the equivalent of multiplying the 3D vector as a 4D vector where w is 1.0. Perspective correction is performed meaning the resulting x, y and z values are divided by w.

pub fn transform_vector3(&self, other: DVec3) -> DVec3

Transforms the give 3D vector as a direction.

This is the equivalent of multiplying the 3D vector as a 4D vector where w is 0.0.

pub fn abs_diff_eq(&self, other: Self, max_abs_diff: f64) -> bool

Returns true if the absolute difference of all elements between self and other is less than or equal to max_abs_diff.

This can be used to compare if two 4x4 matrices contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more see comparing floating point numbers.

pub fn as_f32(&self) -> Mat4

Trait Implementations

impl Add<DMat4> for DMat4

type Output = Self

The resulting type after applying the + operator.

pub fn add(self, other: Self) -> Self

Performs the + operation.

impl AsMut<[f64; 16]> for DMat4

pub fn as_mut(&mut self) -> &mut [f64; 16]

Performs the conversion.

impl AsRef<[f64; 16]> for DMat4

pub fn as_ref(&self) -> &[f64; 16]

Performs the conversion.

impl Clone for DMat4

pub fn clone(&self) -> DMat4

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for DMat4

impl Debug for DMat4

pub fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DMat4

pub fn default() -> Self

Returns the "default value" for a type.

impl Deref for DMat4

type Target = Vector4x4<DVec4>

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for DMat4

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for DMat4

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Mul<DMat4> for DMat4

type Output = Self

The resulting type after applying the * operator.

pub fn mul(self, other: Self) -> Self

Performs the * operation.

impl Mul<DVec4> for DMat4

type Output = DVec4

The resulting type after applying the * operator.

pub fn mul(self, other: DVec4) -> DVec4

Performs the * operation.

impl Mul<f64> for DMat4

type Output = Self

The resulting type after applying the * operator.

pub fn mul(self, other: f64) -> Self

Performs the * operation.

impl PartialEq<DMat4> for DMat4

pub fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<DMat4> for DMat4

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Product<&'a DMat4> for DMat4

pub fn product<I>(iter: I) -> Self where
    I: Iterator<Item = &'a Self>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Sub<DMat4> for DMat4

type Output = Self

The resulting type after applying the - operator.

pub fn sub(self, other: Self) -> Self

Performs the - operation.

impl<'a> Sum<&'a DMat4> for DMat4

pub fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = &'a Self>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.