Struct Mat2

pub struct Mat2(/* private fields */);

A 2x2 column major matrix.

SIMD vector types are used for storage on supported platforms.

This type is 16 byte aligned.

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 NAN: Self = _

All NAN:s.

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

Creates a 2x2 matrix from two column vectors.

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

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

pub const fn to_cols_array(&self) -> [f32; 4]

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

pub const fn from_cols_array_2d(m: &[[f32; 2]; 2]) -> Self

Creates a 2x2 matrix from a [[f32; 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 const fn to_cols_array_2d(&self) -> [[f32; 2]; 2]

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

pub const 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_mat3(m: Mat3) -> Self

Creates a 2x2 matrix from a 3x3 matrix, discarding the 2nd row and column.

pub fn from_mat3_minor(m: Mat3, i: usize, j: usize) -> Self

Creates a 2x2 matrix from the minor of the given 3x3 matrix, discarding the ith column and jth row.

Panics

Panics if i or j is greater than 2.

pub fn from_mat3a(m: Mat3A) -> Self

Creates a 2x2 matrix from a 3x3 matrix, discarding the 2nd row and column.

pub fn from_mat3a_minor(m: Mat3A, i: usize, j: usize) -> Self

Creates a 2x2 matrix from the minor of the given 3x3 matrix, discarding the ith column and jth row.

Panics

Panics if i or j is greater than 2.

pub const fn from_cols_slice(slice: &[f32]) -> Self

Creates a 2x2 matrix from the first 4 values in slice.

Panics

Panics if slice is less than 4 elements long.

pub fn write_cols_to_slice(self, slice: &mut [f32])

Writes the columns of self to the first 4 elements in slice.

Panics

Panics if slice is less than 4 elements long.

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 col_mut(&mut self, index: usize) -> &mut Vec2

Returns a mutable reference to 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.

Panics

Will panic if the determinant of self is zero when glam_assert is enabled.

pub fn mul_vec2(&self, rhs: Vec2) -> Vec2

Transforms a 2D vector.

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

Multiplies two 2x2 matrices.

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

Adds two 2x2 matrices.

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

Subtracts two 2x2 matrices.

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

Multiplies a 2x2 matrix by a scalar.

pub fn div_scalar(&self, rhs: f32) -> Self

Divides a 2x2 matrix by a scalar.

pub fn abs_diff_eq(&self, rhs: Self, max_abs_diff: f32) -> bool

Returns true if the absolute difference of all elements between self and rhs 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 abs(&self) -> Self

Takes the absolute value of each element in self

pub fn as_dmat2(&self) -> DMat2

Trait Implementations

impl Add for Mat2

type Output = Mat2

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Mat2

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AsMut<[f32; 4]> for Mat2

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[f32; 4]> for Mat2

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Mat2

fn clone(&self) -> Mat2

Returns a copy of the value.

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

Performs copy-assignment from source.

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 = Cols2<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 Div<Mat2> for f32

type Output = Mat2

The resulting type after applying the / operator.

fn div(self, rhs: Mat2) -> Self::Output

Performs the / operation.

impl Div<f32> for Mat2

type Output = Mat2

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl DivAssign<f32> for Mat2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl Mul<Mat2> for f32

type Output = Mat2

The resulting type after applying the * operator.

fn mul(self, rhs: Mat2) -> Self::Output

Performs the * operation.

impl Mul<Vec2> for Mat2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Self::Output

Performs the * operation.

impl Mul<f32> for Mat2

type Output = Mat2

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl Mul for Mat2

type Output = Mat2

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign<f32> for Mat2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign for Mat2

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Mat2

type Output = Mat2

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Mat2

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn product<I>(iter: I) -> Self

where I: Iterator<Item = &'a Self>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl Product for Mat2

fn product<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl Sub for Mat2

type Output = Mat2

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Mat2

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

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

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = &'a Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for Mat2

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Zeroable for Mat2

fn zeroed() -> Self

Calls zeroed.

impl Copy for Mat2

impl Pod for Mat2