Struct glam::f32::Mat2

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

A 2x2 column major matrix.

Implementations

impl Mat2

pub const ZERO: Self

A 2x2 matrix with all elements set to 0.0.

pub const IDENTITY: Self

A 2x2 identity matrix, where all diagonal elements are 1, and all off-diagonal elements are 0.

pub const fn zero() -> Self

👎 Deprecated:

use Mat2::ZERO instead

Creates a 2x2 matrix with all elements set to 0.0.

pub const fn identity() -> Self

👎 Deprecated:

use Mat2::IDENTITY instead

Creates a 2x2 identity matrix.

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

Creates a 2x2 matrix from two column vectors.

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

Creates a 2x2 matrix from a [S; 4] 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; 4]

Creates a [S; 4] 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; 2]; 2]) -> Self

Creates a 2x2 matrix from a [[S; 2]; 2] 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; 2]; 2]

Creates a [[S; 2]; 2] 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: Vec2) -> Self

Creates a 2x2 matrix with its diagonal set to diagonal and all other entries set to 0.

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

Creates a 2x2 matrix containing the combining non-uniform scale and rotation of angle (in radians).

pub fn from_angle(angle: f32) -> Self

Creates a 2x2 matrix containing a rotation of angle (in radians).

pub fn from_scale(scale: Vec2) -> Self

👎 Deprecated:

Use from_diagonal() instead

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

Returns the matrix column for the given index.

Panics

Panics if index is greater than 1.

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

Returns the matrix row for the given index.

Panics

Panics if index is greater than 1.

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

Transforms a 2D vector.

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

Multiplies two 2x2 matrices.

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

Adds two 2x2 matrices.

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

Subtracts two 2x2 matrices.

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

Multiplies a 2x2 matrix by a scalar.

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 as_f64(&self) -> DMat2

Trait Implementations

impl Add<Mat2> for Mat2

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AsMut<[f32; 4]> for Mat2

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

Performs the conversion.

impl AsRef<[f32; 4]> for Mat2

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

Performs the conversion.

impl Clone for Mat2

fn clone(&self) -> Mat2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Mat2

impl Debug for Mat2

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

Formats the value using the given formatter.

impl Default for Mat2

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Mat2

type Target = Vector2x2<Vec2>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Mat2

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

Mutably dereferences the value.

impl Display for Mat2

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 Mul<Mat2> for Mat2

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for Mat2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Mat2

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq<Mat2> for Mat2

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

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

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

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

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

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.