#[repr(C)]pub struct Mat3(_);
Expand description
A 3x3 column major matrix.
This 3x3 matrix type features convenience methods for creating and using linear and
affine transformations. If you are primarily dealing with 2D affine transformations the
Affine2
type is much faster and more space efficient than using a
3x3 matrix.
Linear transformations including 3D rotation and scale can be created using methods
such as Self::from_diagonal()
, Self::from_quat()
, Self::from_axis_angle()
,
Self::from_rotation_x()
, Self::from_rotation_y()
, or
Self::from_rotation_z()
.
The resulting matrices can be use to transform 3D vectors using regular vector multiplication.
Affine transformations including 2D translation, rotation and scale can be created
using methods such as Self::from_translation()
, Self::from_angle()
,
Self::from_scale()
and Self::from_scale_angle_translation()
.
The Self::transform_point2()
and Self::transform_vector2()
convenience methods
are provided for performing affine transforms on 2D vectors and points. These multiply
2D inputs as 3D vectors with an implicit z
value of 1
for points and 0
for
vectors respectively. These methods assume that Self
contains a valid affine
transform.
Implementations
sourceimpl Mat3
impl Mat3
sourcepub const IDENTITY: Mat3 = Self(InnerF32::IDENTITY)
pub const IDENTITY: Mat3 = Self(InnerF32::IDENTITY)
A 3x3 identity matrix, where all diagonal elements are 1
, and all off-diagonal
elements are 0
.
sourcepub fn from_cols(x_axis: Vec3, y_axis: Vec3, z_axis: Vec3) -> Mat3
pub fn from_cols(x_axis: Vec3, y_axis: Vec3, z_axis: Vec3) -> Mat3
Creates a 3x3 matrix from three column vectors.
sourcepub fn from_cols_array(m: &[f32; 9]) -> Mat3
pub fn from_cols_array(m: &[f32; 9]) -> Mat3
Creates a 3x3 matrix from a [S; 9]
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; 9]
pub fn to_cols_array(&self) -> [f32; 9]
Creates a [S; 9]
array storing data in column major order.
If you require data in row major order transpose
the matrix first.
sourcepub fn from_cols_array_2d(m: &[[f32; 3]; 3]) -> Mat3
pub fn from_cols_array_2d(m: &[[f32; 3]; 3]) -> Mat3
Creates a 3x3 matrix from a [[S; 3]; 3]
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; 3]; 3]
pub fn to_cols_array_2d(&self) -> [[f32; 3]; 3]
Creates a [[S; 3]; 3]
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: Vec3) -> Mat3
pub fn from_diagonal(diagonal: Vec3) -> Mat3
Creates a 3x3 matrix with its diagonal set to diagonal
and all other entries set to 0.
The resulting matrix is a 3D scale transfom.
sourcepub fn from_mat4(m: Mat4) -> Mat3
pub fn from_mat4(m: Mat4) -> Mat3
Creates a 3x3 matrix from a 4x4 matrix, discarding the 3rd row and column.
sourcepub fn from_quat(rotation: Quat) -> Mat3
pub fn from_quat(rotation: Quat) -> Mat3
Creates a 3D rotation matrix from the given quaternion.
Panics
Will panic if rotation
is not normalized when glam_assert
is enabled.
sourcepub fn from_axis_angle(axis: Vec3, angle: f32) -> Mat3
pub fn from_axis_angle(axis: Vec3, angle: f32) -> Mat3
Creates a 3D rotation matrix from a normalized rotation axis
and angle
(in
radians).
Panics
Will panic if axis
is not normalized when glam_assert
is enabled.
sourcepub fn from_euler(order: EulerRot, a: f32, b: f32, c: f32) -> Mat3
pub fn from_euler(order: EulerRot, a: f32, b: f32, c: f32) -> Mat3
Creates a 3D rotation matrix from the given euler rotation sequence and the angles (in radians).
sourcepub fn from_rotation_x(angle: f32) -> Mat3
pub fn from_rotation_x(angle: f32) -> Mat3
Creates a 3D rotation matrix from angle
(in radians) around the x axis.
sourcepub fn from_rotation_y(angle: f32) -> Mat3
pub fn from_rotation_y(angle: f32) -> Mat3
Creates a 3D rotation matrix from angle
(in radians) around the y axis.
sourcepub fn from_rotation_z(angle: f32) -> Mat3
pub fn from_rotation_z(angle: f32) -> Mat3
Creates a 3D rotation matrix from angle
(in radians) around the z axis.
sourcepub fn from_translation(translation: Vec2) -> Mat3
pub fn from_translation(translation: Vec2) -> Mat3
Creates an affine transformation matrix from the given 2D translation
.
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
sourcepub fn from_angle(angle: f32) -> Mat3
pub fn from_angle(angle: f32) -> Mat3
Creates an affine transformation matrix from the given 2D rotation angle
(in
radians).
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
sourcepub fn from_scale_angle_translation(
scale: Vec2,
angle: f32,
translation: Vec2
) -> Mat3
pub fn from_scale_angle_translation(
scale: Vec2,
angle: f32,
translation: Vec2
) -> Mat3
Creates an affine transformation matrix from the given 2D scale
, rotation angle
(in
radians) and translation
.
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
sourcepub fn from_scale(scale: Vec2) -> Mat3
pub fn from_scale(scale: Vec2) -> Mat3
Creates an affine transformation matrix from the given non-uniform 2D scale
.
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
Panics
Will panic if all elements of scale
are zero when glam_assert
is enabled.
sourcepub fn from_mat2(m: Mat2) -> Mat3
pub fn from_mat2(m: Mat2) -> Mat3
Creates an affine transformation matrix from the given 2x2 matrix.
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
sourcepub fn from_cols_slice(slice: &[f32]) -> Mat3
pub fn from_cols_slice(slice: &[f32]) -> Mat3
Creates a 3x3 matrix from the first 9 values in slice
.
Panics
Panics if slice
is less than 9 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 9 elements in slice
.
Panics
Panics if slice
is less than 9 elements long.
sourcepub fn col_mut(&mut self, index: usize) -> &mut Vec3
pub fn col_mut(&mut self, index: usize) -> &mut Vec3
Returns a mutable reference to the matrix column for the given index
.
Panics
Panics if index
is greater than 2.
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) -> Mat3
pub fn inverse(&self) -> Mat3
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, other: f32) -> Mat3
pub fn mul_scalar(&self, other: f32) -> Mat3
Multiplies a 3x3 matrix by a scalar.
sourcepub fn transform_point2(&self, other: Vec2) -> Vec2
pub fn transform_point2(&self, other: Vec2) -> Vec2
Transforms the given 2D vector as a point.
This is the equivalent of multiplying other
as a 3D vector where z
is 1
.
This method assumes that self
contains a valid affine transform.
sourcepub fn transform_vector2(&self, other: Vec2) -> Vec2
pub fn transform_vector2(&self, other: Vec2) -> Vec2
Rotates the given 2D vector.
This is the equivalent of multiplying other
as a 3D vector where z
is 0
.
This method assumes that self
contains a valid affine transform.
sourcepub fn abs_diff_eq(&self, other: Mat3, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(&self, other: Mat3, 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 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_dmat3(&self) -> DMat3
Trait Implementations
sourceimpl AddAssign<Mat3> for Mat3
impl AddAssign<Mat3> for Mat3
sourcefn add_assign(&mut self, other: Mat3)
fn add_assign(&mut self, other: Mat3)
Performs the +=
operation. Read more
sourceimpl<'de> Deserialize<'de> for Mat3
impl<'de> Deserialize<'de> for Mat3
sourcefn deserialize<D>(
deserializer: D
) -> Result<Mat3, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<Mat3, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl FromReflect for Mat3
impl FromReflect for Mat3
sourcefn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Mat3>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Mat3>
Constructs a concrete instance of Self
from a reflected value.
sourceimpl GetTypeRegistration for Mat3
impl GetTypeRegistration for Mat3
sourceimpl MulAssign<Mat3> for Mat3
impl MulAssign<Mat3> for Mat3
sourcefn mul_assign(&mut self, other: Mat3)
fn mul_assign(&mut self, other: Mat3)
Performs the *=
operation. Read more
sourceimpl MulAssign<f32> for Mat3
impl MulAssign<f32> for Mat3
sourcefn mul_assign(&mut self, other: f32)
fn mul_assign(&mut self, other: f32)
Performs the *=
operation. Read more
sourceimpl Reflect for Mat3
impl Reflect for Mat3
sourcefn any_mut(&mut self) -> &mut (dyn Any + 'static)
fn any_mut(&mut self) -> &mut (dyn Any + 'static)
Returns the value as a &mut dyn Any
.
sourcefn 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
sourcefn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
Applies a reflected value to this value. Read more
sourcefn 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
sourcefn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
Returns an enumeration of “kinds” of type. Read more
sourcefn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
Returns a mutable enumeration of “kinds” of type. Read more
sourcefn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
Returns a hash of the value (which includes the type). Read more
sourcefn 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
sourcefn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
Returns a serializable version of the value. Read more
sourceimpl Serialize for Mat3
impl Serialize for Mat3
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
sourceimpl SubAssign<Mat3> for Mat3
impl SubAssign<Mat3> for Mat3
sourcefn sub_assign(&mut self, other: Mat3)
fn sub_assign(&mut self, other: Mat3)
Performs the -=
operation. Read more
impl Copy for Mat3
impl Pod for Mat3
Auto Trait Implementations
impl RefUnwindSafe for Mat3
impl Send for Mat3
impl Sync for Mat3
impl Unpin for Mat3
impl UnwindSafe for Mat3
Blanket Implementations
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
sourceimpl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
sourcefn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
sourceimpl<T> GetPath for T where
T: Reflect,
impl<T> GetPath for T where
T: Reflect,
sourcefn 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
sourcefn 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
sourcefn 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
.
sourcefn 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>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<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>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
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