Struct glam::f32::Mat3

#[repr(C)]pub struct Mat3(_);

A 3x3 column major matrix.

This 3x3 matrix type features convenience methods for creating and using linear and affine transformations.

Linear transformations including 3D rotation and scale can be created using methods such as Self::from_diagonal(), Self::from_quat(), Self::from_axis_angle(), Self::from_rotation_x(), Self::from_rotation_y(), or Self::from_rotation_z().

The resulting matrices can be use to transform 3D vectors using regular vector multiplication.

Affine transformations including 2D translation, rotation and scale can be created using methods such as Self::from_translation(), Self::from_angle(), Self::from_scale() and Self::from_scale_angle_translation().

The Self::transform_point2() and Self::transform_vector2() convenience methods are provided for performing affine transforms on 2D vectors and points. These multiply 2D inputs as 3D vectors with an implicit z value of 1 for points and 0 for vectors respectively. These methods assume that Self contains a valid affine transform.

Implementations

impl Mat3

pub const ZERO: Self

A 3x3 matrix with all elements set to 0.0.

pub const IDENTITY: Self

A 3x3 identity matrix, where all diagonal elements are 1, and all off-diagonal elements are 0.

pub const fn zero() -> Self

👎 Deprecated:

use Mat3::ZERO instead

Creates a 3x3 matrix with all elements set to 0.0.

pub const fn identity() -> Self

👎 Deprecated:

use Mat3::IDENTITY instead

Creates a 3x3 identity matrix.

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

Creates a 3x3 matrix from three column vectors.

pub fn from_cols_array(m: &[f32; 9]) -> Self

Creates a 3x3 matrix from a [S; 9] 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) -> [f32; 9]

Creates a [S; 9] 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: &[[f32; 3]; 3]) -> Self

Creates a 3x3 matrix from a [[S; 3]; 3] 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) -> [[f32; 3]; 3]

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

pub fn from_diagonal(diagonal: Vec3) -> Self

Creates a 3x3 matrix with its diagonal set to diagonal and all other entries set to 0. The resulting matrix is a 3D scale transfom.

pub fn from_quat(rotation: Quat) -> Self

Creates a 3D rotation matrix from the given quaternion.

pub fn from_axis_angle(axis: Vec3, angle: f32) -> Self

Creates a 3D rotation matrix from a normalized rotation axis and angle (in radians).

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

Creates a 3D rotation matrix from the given yaw (around y), pitch (around x) and roll (around z) in radians.

pub fn from_rotation_x(angle: f32) -> Self

Creates a 3D rotation matrix from angle (in radians) around the x axis.

pub fn from_rotation_y(angle: f32) -> Self

Creates a 3D rotation matrix from angle (in radians) around the y axis.

pub fn from_rotation_z(angle: f32) -> Self

Creates a 3D rotation matrix from angle (in radians) around the z axis.

pub fn from_translation(translation: Vec2) -> Self

Creates an affine transformation matrix from the given 2D translation.

The resulting matrix can be used to transform 2D points and vectors. See [Self::transform_point3()] and [Self::transform_vector3()].

pub fn from_angle(angle: f32) -> Self

Creates an affine transformation matrix from the given 2D rotation angle (in radians).

The resulting matrix can be used to transform 2D points and vectors. See Self::transform_point2() and Self::transform_vector2().

pub fn from_scale_angle_translation(
    scale: Vec2,
    angle: f32,
    translation: Vec2
) -> Self

Creates an affine transformation matrix from the given 2D scale, rotation angle (in radians) and translation.

The resulting matrix can be used to transform 2D points and vectors. See Self::transform_point2() and Self::transform_vector2().

pub fn from_scale(scale: Vec2) -> Self

Creates an affine transformation matrix from the given non-uniform 2D scale.

The resulting matrix can be used to transform 2D points and vectors. See Self::transform_point2() and Self::transform_vector2().

pub fn col(&self, index: usize) -> Vec3

Returns the matrix column for the given index.

Panics

Panics if index is greater than 2.

pub fn row(&self, index: usize) -> Vec3

Returns the matrix row for the given index.

Panics

Panics if index is greater than 2.

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

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 mul_vec3(&self, other: Vec3) -> Vec3

Transforms a 3D vector.

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

Multiplies two 3x3 matrices.

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

Adds two 3x3 matrices.

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

Subtracts two 3x3 matrices.

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

Multiplies a 3x3 matrix by a scalar.

pub fn transform_point2(&self, other: Vec2) -> Vec2

Transforms the given 2D vector as a point.

This is the equivalent of multiplying other as a 3D vector where z is 1.

This method assumes that self contains a valid affine transform.

pub fn transform_vector2(&self, other: Vec2) -> Vec2

Rotates the given 2D vector.

This is the equivalent of multiplying other as a 3D vector where z is 0.

This method assumes that self contains a valid affine transform.

pub fn abs_diff_eq(&self, other: Self, max_abs_diff: f32) -> 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 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 mul_vec3a(&self, other: Vec3A) -> Vec3A

Transforms a Vec3A.

pub fn as_f64(&self) -> DMat3

Trait Implementations

impl Add<Mat3> for Mat3

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AsMut<[f32; 9]> for Mat3

fn as_mut(&mut self) -> &mut [f32; 9]

Performs the conversion.

impl AsRef<[f32; 9]> for Mat3

fn as_ref(&self) -> &[f32; 9]

Performs the conversion.

impl Clone for Mat3

fn clone(&self) -> Mat3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Mat3

impl Debug for Mat3

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

Formats the value using the given formatter.

impl Default for Mat3

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Mat3

type Target = Vector3x3<Vec3>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Mat3

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

Mutably dereferences the value.

impl Display for Mat3

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

Formats the value using the given formatter.

impl From<Mat3> for Mat2

fn from(m: Mat3) -> Mat2

Creates a 2x2 matrix from the top left submatrix of the given 3x3 matrix.

impl From<Mat4> for Mat3

fn from(m: Mat4) -> Mat3

Creates a 3x3 matrix from the top left submatrix of the given 4x4 matrix.

impl Mul<Mat3> for Mat3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, other: Vec3) -> Vec3

Performs the * operation.

impl Mul<Vec3A> for Mat3

type Output = Vec3A

The resulting type after applying the * operator.

fn mul(self, other: Vec3A) -> Vec3A

Performs the * operation.

impl Mul<f32> for Mat3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq<Mat3> for Mat3

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<Mat3> for Mat3

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 Mat3> for Mat3

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<Mat3> for Mat3

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

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

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.