#[repr(transparent)]pub struct Mat2(_);
Expand description
A 2x2 column major matrix.
Implementations
sourceimpl Mat2
impl Mat2
sourcepub const ZERO: Mat2 = Self::from_cols(Vec2::ZERO, Vec2::ZERO)
pub const ZERO: Mat2 = Self::from_cols(Vec2::ZERO, Vec2::ZERO)
A 2x2 matrix with all elements set to 0.0
.
sourcepub const IDENTITY: Mat2 = Self::from_cols(Vec2::X, Vec2::Y)
pub const IDENTITY: Mat2 = Self::from_cols(Vec2::X, Vec2::Y)
A 2x2 identity matrix, where all diagonal elements are 1
, and all off-diagonal elements are 0
.
sourcepub const fn from_cols(x_axis: Vec2, y_axis: Vec2) -> Mat2
pub const fn from_cols(x_axis: Vec2, y_axis: Vec2) -> Mat2
Creates a 2x2 matrix from two column vectors.
sourcepub const fn from_cols_array(m: &[f32; 4]) -> Mat2
pub const fn from_cols_array(m: &[f32; 4]) -> Mat2
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.
sourcepub fn to_cols_array(&self) -> [f32; 4]
pub 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.
sourcepub const fn from_cols_array_2d(m: &[[f32; 2]; 2]) -> Mat2
pub const fn from_cols_array_2d(m: &[[f32; 2]; 2]) -> Mat2
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.
sourcepub fn to_cols_array_2d(&self) -> [[f32; 2]; 2]
pub 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.
sourcepub fn from_diagonal(diagonal: Vec2) -> Mat2
pub fn from_diagonal(diagonal: Vec2) -> Mat2
Creates a 2x2 matrix with its diagonal set to diagonal
and all other entries set to 0.
sourcepub fn from_scale_angle(scale: Vec2, angle: f32) -> Mat2
pub fn from_scale_angle(scale: Vec2, angle: f32) -> Mat2
Creates a 2x2 matrix containing the combining non-uniform scale
and rotation of
angle
(in radians).
sourcepub fn from_angle(angle: f32) -> Mat2
pub fn from_angle(angle: f32) -> Mat2
Creates a 2x2 matrix containing a rotation of angle
(in radians).
sourcepub fn from_mat3(m: Mat3) -> Mat2
pub fn from_mat3(m: Mat3) -> Mat2
Creates a 2x2 matrix from a 3x3 matrix, discarding the 2nd row and column.
sourcepub const fn from_cols_slice(slice: &[f32]) -> Mat2
pub const fn from_cols_slice(slice: &[f32]) -> Mat2
Creates a 2x2 matrix from the first 4 values in slice
.
Panics
Panics if slice
is less than 4 elements long.
sourcepub fn write_cols_to_slice(self, slice: &mut [f32])
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.
sourcepub fn col_mut(&mut self, index: usize) -> &mut Vec2
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.
sourcepub fn is_finite(&self) -> bool
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
.
sourcepub fn determinant(&self) -> f32
pub fn determinant(&self) -> f32
Returns the determinant of self
.
sourcepub fn inverse(&self) -> Mat2
pub fn inverse(&self) -> Mat2
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.
sourcepub fn mul_scalar(&self, rhs: f32) -> Mat2
pub fn mul_scalar(&self, rhs: f32) -> Mat2
Multiplies a 2x2 matrix by a scalar.
sourcepub fn abs_diff_eq(&self, rhs: Mat2, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(&self, rhs: Mat2, 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 as_dmat2(&self) -> DMat2
Trait Implementations
sourceimpl AddAssign<Mat2> for Mat2
impl AddAssign<Mat2> for Mat2
sourcefn add_assign(&mut self, rhs: Mat2)
fn add_assign(&mut self, rhs: Mat2)
Performs the +=
operation. Read more
impl AsMutMatrixParts<f32, 2, 2> for Mat2 where
Mat2: AsMut<[f32; 4]>,
f32: MatrixScalar,
impl AsMutMatrixParts<f32, 2, 2> for Mat2 where
Mat2: AsMut<[f32; 4]>,
f32: MatrixScalar,
impl AsRefMatrixParts<f32, 2, 2> for Mat2 where
Mat2: AsRef<[f32; 4]>,
f32: MatrixScalar,
impl AsRefMatrixParts<f32, 2, 2> for Mat2 where
Mat2: AsRef<[f32; 4]>,
f32: MatrixScalar,
impl CreateFrom for Mat2 where
Mat2: ShaderType,
Mat2: FromMatrixParts<f32, 2, 2>,
f32: MatrixScalar,
f32: CreateFrom,
<Mat2 as ShaderType>::ExtraMetadata == MatrixMetadata,
impl CreateFrom for Mat2 where
Mat2: ShaderType,
Mat2: FromMatrixParts<f32, 2, 2>,
f32: MatrixScalar,
f32: CreateFrom,
<Mat2 as ShaderType>::ExtraMetadata == MatrixMetadata,
fn create_from<B>(reader: &mut Reader<B>) -> Mat2 where
B: BufferRef,
sourceimpl<'de> Deserialize<'de> for Mat2
impl<'de> Deserialize<'de> for Mat2
sourcefn deserialize<D>(
deserializer: D
) -> Result<Mat2, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<Mat2, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl FromMatrixParts<f32, 2, 2> for Mat2
impl FromMatrixParts<f32, 2, 2> for Mat2
impl FromReflect for Mat2 where
Vec2: FromReflect,
impl FromReflect for Mat2 where
Vec2: FromReflect,
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Mat2>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Mat2>
Constructs a concrete instance of Self
from a reflected value.
impl GetTypeRegistration for Mat2
impl GetTypeRegistration for Mat2
sourceimpl MulAssign<Mat2> for Mat2
impl MulAssign<Mat2> for Mat2
sourcefn mul_assign(&mut self, rhs: Mat2)
fn mul_assign(&mut self, rhs: Mat2)
Performs the *=
operation. Read more
sourceimpl MulAssign<f32> for Mat2
impl MulAssign<f32> for Mat2
sourcefn mul_assign(&mut self, rhs: f32)
fn mul_assign(&mut self, rhs: f32)
Performs the *=
operation. Read more
sourceimpl PartialEq<Mat2> for Mat2
impl PartialEq<Mat2> for Mat2
impl ReadFrom for Mat2 where
Mat2: ShaderType,
Mat2: AsMutMatrixParts<f32, 2, 2>,
f32: MatrixScalar,
f32: ReadFrom,
<Mat2 as ShaderType>::ExtraMetadata == MatrixMetadata,
impl ReadFrom for Mat2 where
Mat2: ShaderType,
Mat2: AsMutMatrixParts<f32, 2, 2>,
f32: MatrixScalar,
f32: ReadFrom,
<Mat2 as ShaderType>::ExtraMetadata == MatrixMetadata,
impl Reflect for Mat2
impl Reflect for Mat2
fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
fn into_any(self: Box<Mat2, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<Mat2, Global>) -> Box<dyn Any + 'static, Global>
Returns the value as a Box<dyn Any>
.
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Returns the value as a &mut dyn Any
.
fn as_reflect(&self) -> &(dyn Reflect + 'static)
fn as_reflect(&self) -> &(dyn Reflect + 'static)
Casts this type to a reflected value
fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
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 + 'static, Global>
fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
Clones the value as a Reflect
trait object. Read more
fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
Performs a type-checked assignment of a reflected value to this value. Read more
fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
Applies a reflected value to this value. Read more
fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
Returns an enumeration of “kinds” of type. Read more
fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
Returns a mutable enumeration of “kinds” of type. Read more
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
Returns a “partial equality” comparison result. Read more
fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
Returns a hash of the value (which includes the type). Read more
fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
Returns a serializable version of the value. Read more
sourceimpl Serialize for Mat2
impl Serialize for Mat2
sourcefn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
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. Read more
impl ShaderSize for Mat2 where
f32: ShaderSize,
impl ShaderSize for Mat2 where
f32: ShaderSize,
const SHADER_SIZE: NonZeroU64 =
const SHADER_SIZE: NonZeroU64 =
Represents WGSL Size (equivalent to ShaderType::min_size
)
impl ShaderType for Mat2 where
f32: ShaderSize,
impl ShaderType for Mat2 where
f32: ShaderSize,
fn min_size() -> NonZeroU64
fn min_size() -> NonZeroU64
Represents the minimum size of Self
(equivalent to GPUBufferBindingLayout.minBindingSize) Read more
fn size(&self) -> NonZeroU64
fn size(&self) -> NonZeroU64
Returns the size of Self
at runtime Read more
fn assert_uniform_compat()
fn assert_uniform_compat()
Asserts that Self
meets the requirements of the
uniform address space restrictions on stored values and the
uniform address space layout constraints Read more
impl Struct for Mat2
impl Struct for Mat2
fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
Returns a reference to the value of the field named name
as a &dyn Reflect
. Read more
fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>
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
. Read more
fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>
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
. Read more
fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
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
. Read more
fn iter_fields(&self) -> FieldIter<'_>ⓘNotable traits for FieldIter<'a>impl<'a> Iterator for FieldIter<'a> type Item = &'a (dyn Reflect + 'static);
fn iter_fields(&self) -> FieldIter<'_>ⓘNotable traits for FieldIter<'a>impl<'a> Iterator for FieldIter<'a> type Item = &'a (dyn Reflect + 'static);
Returns an iterator over the values of the struct’s fields.
fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
Clones the struct into a DynamicStruct
.
sourceimpl SubAssign<Mat2> for Mat2
impl SubAssign<Mat2> for Mat2
sourcefn sub_assign(&mut self, rhs: Mat2)
fn sub_assign(&mut self, rhs: Mat2)
Performs the -=
operation. Read more
impl WriteInto for Mat2 where
Mat2: ShaderType,
Mat2: AsRefMatrixParts<f32, 2, 2>,
f32: MatrixScalar,
f32: WriteInto,
<Mat2 as ShaderType>::ExtraMetadata == MatrixMetadata,
impl WriteInto for Mat2 where
Mat2: ShaderType,
Mat2: AsRefMatrixParts<f32, 2, 2>,
f32: MatrixScalar,
f32: WriteInto,
<Mat2 as ShaderType>::ExtraMetadata == MatrixMetadata,
fn write_into<B>(&self, writer: &mut Writer<B>) where
B: BufferMut,
impl Copy for Mat2
impl Pod 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
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
Return the T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> CheckedBitPattern for T where
T: AnyBitPattern,
impl<T> CheckedBitPattern for T where
T: AnyBitPattern,
type Bits = T
type Bits = T
Self
must have the same layout as the specified Bits
except for
the possible invalid bit patterns being checked during is_valid_bit_pattern
. Read more
fn is_valid_bit_pattern(_bits: &T) -> bool
fn is_valid_bit_pattern(_bits: &T) -> bool
If this function returns true, then it must be valid to reinterpret bits
as &Self
.
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
impl<S> GetField for S where
S: Struct,
impl<S> GetField for S where
S: Struct,
impl<T> GetPath for T where
T: Reflect,
impl<T> GetPath for T where
T: Reflect,
fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
Returns a reference to the value specified by path
. Read more
fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
Returns a mutable reference to the value specified by path
. Read more
fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,
fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,
Returns a statically typed reference to the value specified by path
.
fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,
fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,
Returns a statically typed mutable reference to the value specified by
path
. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> Serialize for T where
T: Serialize + ?Sized,
impl<T> Serialize for T where
T: Serialize + ?Sized,
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more