Struct glam::f32::Mat3

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

A 3x3 column major matrix.

Implementations

impl Mat3

pub const fn zero() -> Self

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

pub const fn identity() -> Self

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_scale_angle_translation(
    scale: Vec2,
    angle: f32,
    translation: Vec2
) -> Self

Creates a 3x3 homogeneous transformation matrix from the given scale, rotation angle (in radians) and translation.

The resulting matrix can be used to transform 2D points and vectors.

pub fn from_quat(rotation: Quat) -> Self

Creates a 3x3 rotation matrix from the given quaternion.

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

Creates a 3x3 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 3x3 rotation matrix from the given Euler angles (in radians).

pub fn from_rotation_x(angle: f32) -> Self

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

pub fn from_rotation_y(angle: f32) -> Self

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

pub fn from_rotation_z(angle: f32) -> Self

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

pub fn from_scale(scale: Vec3) -> Self

Creates a 3x3 non-uniform scale matrix.

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 the 2D vector as a 3D vector where z is 1.0.

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

Rotates the given 2D vector. This is the equivalent of multiplying the 2D vector as a 3D vector where z is 0.0.

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 transform_point2_as_vec3a(&self, other: Vec2) -> Vec2

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

pub fn as_f64(&self) -> DMat3

Trait Implementations

impl Add<Mat3> for Mat3

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AsMut<[f32; 9]> for Mat3

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

Performs the conversion.

impl AsRef<[f32; 9]> for Mat3

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

Performs the conversion.

impl Clone for Mat3

pub 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

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

Formats the value using the given formatter.

impl Default for Mat3

pub fn default() -> Self

Returns the "default value" for a type.

impl Deref for Mat3

type Target = Vector3x3<Vec3>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Mat3

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

Mutably dereferences the value.

impl Display for Mat3

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

Formats the value using the given formatter.

impl Mul<Mat3> for Mat3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3A> for Mat3

type Output = Vec3A

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Mat3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq<Mat3> for Mat3

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

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

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

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

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

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.