Struct glam::f32::Mat2

source ·
#[repr(transparent)]
pub struct Mat2(/* private fields */);
Expand description

A 2x2 column major matrix.

SIMD vector types are used for storage on supported platforms.

This type is 16 byte aligned.

Implementations§

source§

impl Mat2

source

pub const ZERO: Self = _

A 2x2 matrix with all elements set to 0.0.

source

pub const IDENTITY: Self = _

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

source

pub const NAN: Self = _

All NAN:s.

source

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

Creates a 2x2 matrix from two column vectors.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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

source

pub fn from_angle(angle: f32) -> Self

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

source

pub fn from_mat3(m: Mat3) -> Self

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

source

pub fn from_mat3a(m: Mat3A) -> Self

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

source

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.

source

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.

source

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

Returns the matrix column for the given index.

Panics

Panics if index is greater than 1.

source

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.

source

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

Returns the matrix row for the given index.

Panics

Panics if index is greater than 1.

source

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.

source

pub fn is_nan(&self) -> bool

Returns true if any elements are NaN.

source

pub fn transpose(&self) -> Self

Returns the transpose of self.

source

pub fn determinant(&self) -> f32

Returns the determinant of self.

source

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.

source

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

Transforms a 2D vector.

source

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

Multiplies two 2x2 matrices.

source

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

Adds two 2x2 matrices.

source

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

Subtracts two 2x2 matrices.

source

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

Multiplies a 2x2 matrix by a scalar.

source

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.

source

pub fn as_dmat2(&self) -> DMat2

Trait Implementations§

source§

impl Add<Mat2> for Mat2

§

type Output = Mat2

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl AddAssign<Mat2> for Mat2

source§

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more
source§

impl AsMut<[f32; 4]> for Mat2

source§

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

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

impl AsRef<[f32; 4]> for Mat2

source§

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

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

impl Clone for Mat2

source§

fn clone(&self) -> Mat2

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Mat2

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Mat2

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Deref for Mat2

§

type Target = Cols2<Vec2>

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl DerefMut for Mat2

source§

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

Mutably dereferences the value.
source§

impl Display for Mat2

source§

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

Formats the value using the given formatter. Read more
source§

impl Mul<Mat2> for Mat2

§

type Output = Mat2

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Mul<Mat2> for f32

§

type Output = Mat2

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Mul<Vec2> for Mat2

§

type Output = Vec2

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Mul<f32> for Mat2

§

type Output = Mat2

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl MulAssign<Mat2> for Mat2

source§

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation. Read more
source§

impl MulAssign<f32> for Mat2

source§

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation. Read more
source§

impl Neg for Mat2

§

type Output = Mat2

The resulting type after applying the - operator.
source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
source§

impl PartialEq<Mat2> for Mat2

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

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

impl Product<Mat2> for Mat2

source§

fn product<I>(iter: I) -> Selfwhere I: Iterator<Item = Self>,

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

impl Sub<Mat2> for Mat2

§

type Output = Mat2

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl SubAssign<Mat2> for Mat2

source§

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more
source§

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

source§

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

Method which takes an iterator and generates Self from the elements by “summing up” the items.
source§

impl Sum<Mat2> for Mat2

source§

fn sum<I>(iter: I) -> Selfwhere I: Iterator<Item = Self>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.
source§

impl Copy for Mat2

Auto Trait Implementations§

§

impl RefUnwindSafe for Mat2

§

impl Send for Mat2

§

impl Sync for Mat2

§

impl Unpin for Mat2

§

impl UnwindSafe for Mat2

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.