Struct oxid::framework::math::Mat2

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

Implementations

impl Mat2

pub const fn zero() -> Mat2

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

pub const fn identity() -> Mat2

Creates a 2x2 identity matrix.

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

Creates a 2x2 matrix from two column vectors.

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

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

Creates a 2x2 matrix from a [[f32; 2]; 2] 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 [[f32; 2]; 2] storing data in column major order. If you require data in row major order transpose the matrix first.

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

Creates a 2x2 matrix containing the given scale and rotation of angle (in radians).

pub fn from_angle(angle: f32) -> Mat2

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

pub fn from_scale(scale: Vec2) -> Mat2

Creates a 2x2 matrix containing the given non-uniform scale.

pub fn set_x_axis(&mut self, x: Vec2)

👎Deprecated since 0.10.0:

please use .x_axis instead

pub fn set_y_axis(&mut self, y: Vec2)

👎Deprecated since 0.10.0:

please use .y_axis instead

pub fn x_axis(&self) -> Vec2

👎Deprecated since 0.10.0:

please use .x_axis instead

pub fn y_axis(&self) -> Vec2

👎Deprecated since 0.10.0:

please use .y_axis instead

pub fn x_axis_mut(&mut self) -> &mut Vec2

👎Deprecated since 0.10.0:

please use .x_axis instead

pub fn y_axis_mut(&mut self) -> &mut Vec2

👎Deprecated since 0.10.0:

please use .x_axis instead

pub fn transpose(&self) -> Mat2

Returns the transpose of self.

pub fn determinant(&self) -> f32

Returns the determinant of self.

pub fn inverse(&self) -> Mat2

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

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

Multiplies two 2x2 matrices.

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

Adds two 2x2 matrices.

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

Subtracts two 2x2 matrices.

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

Multiplies a 2x2 matrix by a scalar.

pub fn abs_diff_eq(&self, other: Mat2, 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 Mat2’s 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 on floating point comparisons see https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/

Trait Implementations

impl Add<Mat2> for Mat2

type Output = Mat2

The resulting type after applying the + operator.

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

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, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Mat2

fn default() -> Mat2

Returns the “default value” for a type.

impl Deref for Mat2

type Target = XYAxes

The resulting type after dereferencing.

fn deref(&self) -> &<Mat2 as Deref>::Target

Dereferences the value.

impl DerefMut for Mat2

fn deref_mut(&mut self) -> &mut <Mat2 as Deref>::Target

Mutably dereferences the value.

impl Display for Mat2

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

Formats the value using the given formatter.

impl Mul<Mat2> for Mat2

type Output = Mat2

The resulting type after applying the * operator.

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

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

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq<Mat2> for Mat2

fn eq(&self, other: &Mat2) -> bool

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

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.

impl PartialOrd<Mat2> for Mat2

fn partial_cmp(&self, other: &Mat2) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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) -> Mat2where
    I: Iterator<Item = &'a Mat2>,

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

impl Sub<Mat2> for Mat2

type Output = Mat2

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

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

impl Copy for Mat2

impl StructuralPartialEq for Mat2