Struct bevy_math::DMat2

#[repr(C)]
pub struct DMat2 {
    pub x_axis: DVec2,
    pub y_axis: DVec2,
}

A 2x2 column major matrix.

Fields

x_axis: DVec2

y_axis: DVec2

Implementations

impl DMat2

pub const ZERO: DMat2 = _

A 2x2 matrix with all elements set to 0.0.

pub const IDENTITY: DMat2 = _

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

pub const NAN: DMat2 = _

All NAN:s.

pub const fn from_cols(x_axis: DVec2, y_axis: DVec2) -> DMat2

Creates a 2x2 matrix from two column vectors.

pub const fn from_cols_array(m: &[f64; 4]) -> DMat2

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

Creates a [f64; 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: &[[f64; 2]; 2]) -> DMat2

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

Creates a [[f64; 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: DVec2) -> DMat2

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

pub fn from_scale_angle(scale: DVec2, angle: f64) -> DMat2

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

pub fn from_angle(angle: f64) -> DMat2

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

pub fn from_mat3(m: DMat3) -> DMat2

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

pub const fn from_cols_slice(slice: &[f64]) -> DMat2

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 [f64])

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

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 DVec2

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

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

Returns the transpose of self.

pub fn determinant(&self) -> f64

Returns the determinant of self.

pub fn inverse(&self) -> DMat2

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: DVec2) -> DVec2

Transforms a 2D vector.

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

Multiplies two 2x2 matrices.

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

Adds two 2x2 matrices.

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

Subtracts two 2x2 matrices.

pub fn mul_scalar(&self, rhs: f64) -> DMat2

Multiplies a 2x2 matrix by a scalar.

pub fn div_scalar(&self, rhs: f64) -> DMat2

Divides a 2x2 matrix by a scalar.

pub fn abs_diff_eq(&self, rhs: DMat2, max_abs_diff: f64) -> 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) -> DMat2

Takes the absolute value of each element in self

pub fn as_mat2(&self) -> Mat2

Trait Implementations

impl Add for DMat2

type Output = DMat2

The resulting type after applying the + operator.

fn add(self, rhs: DMat2) -> <DMat2 as Add>::Output

Performs the + operation.

impl AddAssign for DMat2

fn add_assign(&mut self, rhs: DMat2)

Performs the += operation.

impl AsMut<[f64; 4]> for DMat2

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

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

impl AsRef<[f64; 4]> for DMat2

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

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

impl Clone for DMat2

fn clone(&self) -> DMat2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DMat2

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

Formats the value using the given formatter.

impl Default for DMat2

fn default() -> DMat2

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DMat2

fn deserialize<D>( deserializer: D ) -> Result<DMat2, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DMat2

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

Formats the value using the given formatter.

impl Div<f64> for DMat2

type Output = DMat2

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> <DMat2 as Div<f64>>::Output

Performs the / operation.

impl DivAssign<f64> for DMat2

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl FromReflect for DMat2

where DMat2: Any + Send + Sync, DVec2: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<DMat2>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for DMat2

where DMat2: Any + Send + Sync, DVec2: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Mul<DVec2> for DMat2

type Output = DVec2

The resulting type after applying the * operator.

fn mul(self, rhs: DVec2) -> <DMat2 as Mul<DVec2>>::Output

Performs the * operation.

impl Mul<f64> for DMat2

type Output = DMat2

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> <DMat2 as Mul<f64>>::Output

Performs the * operation.

impl Mul for DMat2

type Output = DMat2

The resulting type after applying the * operator.

fn mul(self, rhs: DMat2) -> <DMat2 as Mul>::Output

Performs the * operation.

impl MulAssign<f64> for DMat2

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl MulAssign for DMat2

fn mul_assign(&mut self, rhs: DMat2)

Performs the *= operation.

impl Neg for DMat2

type Output = DMat2

The resulting type after applying the - operator.

fn neg(self) -> <DMat2 as Neg>::Output

Performs the unary - operation.

impl PartialEq for DMat2

fn eq(&self, rhs: &DMat2) -> 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<'a> Product<&'a DMat2> for DMat2

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

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

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

impl Product for DMat2

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

where I: Iterator<Item = DMat2>,

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

impl Reflect for DMat2

where DMat2: Any + Send + Sync, DVec2: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<DMat2>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<DMat2>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply( &mut self, value: &(dyn Reflect + 'static) ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<DMat2>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for DMat2

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for DMat2

where DMat2: Any + Send + Sync, DVec2: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl Sub for DMat2

type Output = DMat2

The resulting type after applying the - operator.

fn sub(self, rhs: DMat2) -> <DMat2 as Sub>::Output

Performs the - operation.

impl SubAssign for DMat2

fn sub_assign(&mut self, rhs: DMat2)

Performs the -= operation.

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

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

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

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

impl Sum for DMat2

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

where I: Iterator<Item = DMat2>,

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

impl TypePath for DMat2

where DMat2: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for DMat2

where DMat2: Any + Send + Sync, DVec2: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Zeroable for DMat2

fn zeroed() -> Self

Calls zeroed.

impl Copy for DMat2

impl Pod for DMat2