Struct ultraviolet::mat::Mat2[−][src]

#[repr(C)]pub struct Mat2 {
    pub cols: [Vec2; 2],
}

Expand description

A 2x2 square matrix.

Useful for performing linear transformations (rotation, scaling) on 2d vectors.

Fields

cols: [Vec2; 2]

Implementations

`impl Mat2`[src]

`pub const fn new(col1: Vec2, col2: Vec2) -> Self`[src]

`pub fn identity() -> Self`[src]

`pub fn into_homogeneous(self) -> Mat3`[src]

Turn this into a homogeneous 2d transformation matrix.

`pub fn transpose(&mut self)`[src]

`pub fn transposed(&self) -> Self`[src]

`pub fn determinant(&self) -> f32`[src]

`pub fn adjugate(&self) -> Self`[src]

The adjugate of this matrix, i.e. the transpose of the cofactor matrix.

This is equivalent to the inverse but without dividing by the determinant of the matrix, which can be useful in some contexts for better performance.

One such case is when this matrix is interpreted as a a homogeneous transformation matrix, in which case uniform scaling will not affect the resulting projected 3d version of transformed points or vectors.

`pub fn inverse(&mut self)`[src]

If this matrix is not currently invertable, this function will return an invalid inverse. This status is not checked by the library.

`pub fn inversed(&self) -> Self`[src]

If this matrix is not currently invertable, this function will return an invalid inverse. This status is not checked by the library.

`pub fn layout() -> Layout`[src]

`pub fn as_array(&self) -> &[f32; 4]`[src]

`pub fn as_component_array(&self) -> &[Vec2; 2]`[src]

`pub fn as_slice(&self) -> &[f32]`[src]

`pub fn as_component_slice(&self) -> &[Vec2]`[src]

`pub fn as_byte_slice(&self) -> &[u8]`[src]

`pub fn as_mut_slice(&mut self) -> &mut [f32]`[src]

`pub fn as_mut_component_slice(&mut self) -> &mut [Vec2]`[src]

`pub fn as_mut_byte_slice(&mut self) -> &mut [u8]`[src]

`pub const fn as_ptr(&self) -> *const f32`[src]

Returns a constant unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

`pub fn as_mut_ptr(&mut self) -> *mut f32`[src]

Returns a mutable unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

Trait Implementations

`impl Add<Mat2> for Mat2`[src]

`type Output = Self`

The resulting type after applying the + operator.

`fn add(self, rhs: Mat2) -> Self`[src]

Performs the + operation. Read more

`impl AddAssign<Mat2> for Mat2`[src]

`fn add_assign(&mut self, rhs: Mat2)`[src]

Performs the += operation. Read more

`impl Clone for Mat2`[src]

`fn clone(&self) -> Mat2`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl Debug for Mat2`[src]

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

Formats the value using the given formatter. Read more

`impl Default for Mat2`[src]

`fn default() -> Self`[src]

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

`impl<'de> Deserialize<'de> for Mat2`[src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>,` [src]

Deserialize this value from the given Serde deserializer. Read more

`impl From<&'_ [f32; 4]> for Mat2`[src]

`fn from(comps: &[f32; 4]) -> Self`[src]

Performs the conversion.

`impl From<[[f32; 2]; 2]> for Mat2`[src]

`fn from(comps: [[f32; 2]; 2]) -> Self`[src]

Performs the conversion.

`impl From<[f32; 4]> for Mat2`[src]

`fn from(comps: [f32; 4]) -> Self`[src]

Performs the conversion.

`impl From<ColumnMatrix2<f32>> for Mat2`[src]

`fn from(v: ColumnMatrix2<f32>) -> Self`[src]

Performs the conversion.

`impl From<Rotor2> for Mat2`[src]

`fn from(rotor: Rotor2) -> Mat2`[src]

Performs the conversion.

`impl Index<usize> for Mat2`[src]

`type Output = Vec2`

The returned type after indexing.

`fn index(&self, index: usize) -> &Self::Output`[src]

Performs the indexing (container[index]) operation. Read more

`impl IndexMut<usize> for Mat2`[src]

`fn index_mut(&mut self, index: usize) -> &mut Self::Output`[src]

Performs the mutable indexing (container[index]) operation. Read more

`impl Mul<Mat2> for Mat2`[src]

`type Output = Self`

The resulting type after applying the * operator.

`fn mul(self, rhs: Self) -> Self`[src]

Performs the * operation. Read more

`impl Mul<Vec2> for Mat2`[src]

`type Output = Vec2`

The resulting type after applying the * operator.

`fn mul(self, rhs: Vec2) -> Vec2`[src]

Performs the * operation. Read more

`impl Mul<f32> for Mat2`[src]

`type Output = Mat2`

The resulting type after applying the * operator.

`fn mul(self, rhs: f32) -> Mat2`[src]

Performs the * operation. Read more

`impl PartialEq<Mat2> for Mat2`[src]

`fn eq(&self, other: &Mat2) -> bool`[src]

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

`fn ne(&self, other: &Mat2) -> bool`[src]

This method tests for !=.

`impl Serialize for Mat2`[src]

`fn serialize<T>(&self, serializer: T) -> Result<T::Ok, T::Error> where T: Serializer,` [src]

Serialize this value into the given Serde serializer. Read more

`impl Zeroable for Mat2`[src]

`fn zeroed() -> Self`[src]

Calls zeroed. Read more

`impl Copy for Mat2`[src]

`impl Pod for Mat2`[src]

`impl StructuralPartialEq for Mat2`[src]

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> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

Gets the TypeId of self. Read more

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

Performs the conversion.

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

Performs the conversion.

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

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

`pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

Performs the conversion.

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

Performs the conversion.

Struct ultraviolet::mat::Mat2[−][src]

Fields

Implementations

impl Mat2[src]

pub const fn new(col1: Vec2, col2: Vec2) -> Self[src]

pub fn identity() -> Self[src]

pub fn into_homogeneous(self) -> Mat3[src]

pub fn transpose(&mut self)[src]

pub fn transposed(&self) -> Self[src]

pub fn determinant(&self) -> f32[src]

pub fn adjugate(&self) -> Self[src]

pub fn inverse(&mut self)[src]

pub fn inversed(&self) -> Self[src]

pub fn layout() -> Layout[src]

pub fn as_array(&self) -> &[f32; 4][src]

pub fn as_component_array(&self) -> &[Vec2; 2][src]

pub fn as_slice(&self) -> &[f32][src]

pub fn as_component_slice(&self) -> &[Vec2][src]

pub fn as_byte_slice(&self) -> &[u8][src]

pub fn as_mut_slice(&mut self) -> &mut [f32][src]

pub fn as_mut_component_slice(&mut self) -> &mut [Vec2][src]

pub fn as_mut_byte_slice(&mut self) -> &mut [u8][src]

pub const fn as_ptr(&self) -> *const f32[src]

Safety

pub fn as_mut_ptr(&mut self) -> *mut f32[src]

Safety

Trait Implementations

impl Add<Mat2> for Mat2[src]

type Output = Self

fn add(self, rhs: Mat2) -> Self[src]

impl AddAssign<Mat2> for Mat2[src]

fn add_assign(&mut self, rhs: Mat2)[src]

impl Clone for Mat2[src]

fn clone(&self) -> Mat2[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Mat2[src]

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

impl Default for Mat2[src]

fn default() -> Self[src]

impl<'de> Deserialize<'de> for Mat2[src]

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>, [src]

impl From<&'_ [f32; 4]> for Mat2[src]

fn from(comps: &[f32; 4]) -> Self[src]

impl From<[[f32; 2]; 2]> for Mat2[src]

fn from(comps: [[f32; 2]; 2]) -> Self[src]

impl From<[f32; 4]> for Mat2[src]

fn from(comps: [f32; 4]) -> Self[src]

impl From<ColumnMatrix2<f32>> for Mat2[src]

fn from(v: ColumnMatrix2<f32>) -> Self[src]

impl From<Rotor2> for Mat2[src]

fn from(rotor: Rotor2) -> Mat2[src]

impl Index<usize> for Mat2[src]

type Output = Vec2

fn index(&self, index: usize) -> &Self::Output[src]

impl IndexMut<usize> for Mat2[src]

fn index_mut(&mut self, index: usize) -> &mut Self::Output[src]

impl Mul<Mat2> for Mat2[src]

type Output = Self

fn mul(self, rhs: Self) -> Self[src]

impl Mul<Vec2> for Mat2[src]

type Output = Vec2

fn mul(self, rhs: Vec2) -> Vec2[src]

impl Mul<f32> for Mat2[src]

type Output = Mat2

fn mul(self, rhs: f32) -> Mat2[src]

impl PartialEq<Mat2> for Mat2[src]

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

fn ne(&self, other: &Mat2) -> bool[src]

impl Serialize for Mat2[src]

fn serialize<T>(&self, serializer: T) -> Result<T::Ok, T::Error> where T: Serializer, [src]

impl Zeroable for Mat2[src]

fn zeroed() -> Self[src]

impl Copy for Mat2[src]

impl Pod for Mat2[src]

impl StructuralPartialEq for Mat2[src]

Auto Trait Implementations

impl RefUnwindSafe for Mat2

impl Send for Mat2

impl Sync for Mat2

impl Unpin for Mat2

`impl Mat2`[src]

`pub const fn new(col1: Vec2, col2: Vec2) -> Self`[src]

`pub fn identity() -> Self`[src]

`pub fn into_homogeneous(self) -> Mat3`[src]

`pub fn transpose(&mut self)`[src]

`pub fn transposed(&self) -> Self`[src]

`pub fn determinant(&self) -> f32`[src]

`pub fn adjugate(&self) -> Self`[src]

`pub fn inverse(&mut self)`[src]

`pub fn inversed(&self) -> Self`[src]

`pub fn layout() -> Layout`[src]

`pub fn as_array(&self) -> &[f32; 4]`[src]

`pub fn as_component_array(&self) -> &[Vec2; 2]`[src]

`pub fn as_slice(&self) -> &[f32]`[src]

`pub fn as_component_slice(&self) -> &[Vec2]`[src]

`pub fn as_byte_slice(&self) -> &[u8]`[src]

`pub fn as_mut_slice(&mut self) -> &mut [f32]`[src]

`pub fn as_mut_component_slice(&mut self) -> &mut [Vec2]`[src]

`pub fn as_mut_byte_slice(&mut self) -> &mut [u8]`[src]

`pub const fn as_ptr(&self) -> *const f32`[src]

`pub fn as_mut_ptr(&mut self) -> *mut f32`[src]

`impl Add<Mat2> for Mat2`[src]

`type Output = Self`

`fn add(self, rhs: Mat2) -> Self`[src]

`impl AddAssign<Mat2> for Mat2`[src]

`fn add_assign(&mut self, rhs: Mat2)`[src]

`impl Clone for Mat2`[src]

`fn clone(&self) -> Mat2`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

`impl Debug for Mat2`[src]

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

`impl Default for Mat2`[src]

`fn default() -> Self`[src]

`impl<'de> Deserialize<'de> for Mat2`[src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>,` [src]

`impl From<&'_ [f32; 4]> for Mat2`[src]

`fn from(comps: &[f32; 4]) -> Self`[src]

`impl From<[[f32; 2]; 2]> for Mat2`[src]

`fn from(comps: [[f32; 2]; 2]) -> Self`[src]

`impl From<[f32; 4]> for Mat2`[src]

`fn from(comps: [f32; 4]) -> Self`[src]

`impl From<ColumnMatrix2<f32>> for Mat2`[src]

`fn from(v: ColumnMatrix2<f32>) -> Self`[src]

`impl From<Rotor2> for Mat2`[src]

`fn from(rotor: Rotor2) -> Mat2`[src]

`impl Index<usize> for Mat2`[src]

`type Output = Vec2`

`fn index(&self, index: usize) -> &Self::Output`[src]

`impl IndexMut<usize> for Mat2`[src]

`fn index_mut(&mut self, index: usize) -> &mut Self::Output`[src]

`impl Mul<Mat2> for Mat2`[src]

`type Output = Self`

`fn mul(self, rhs: Self) -> Self`[src]

`impl Mul<Vec2> for Mat2`[src]

`type Output = Vec2`

`fn mul(self, rhs: Vec2) -> Vec2`[src]

`impl Mul<f32> for Mat2`[src]

`type Output = Mat2`

`fn mul(self, rhs: f32) -> Mat2`[src]

`impl PartialEq<Mat2> for Mat2`[src]

`fn eq(&self, other: &Mat2) -> bool`[src]

`fn ne(&self, other: &Mat2) -> bool`[src]

`impl Serialize for Mat2`[src]

`fn serialize<T>(&self, serializer: T) -> Result<T::Ok, T::Error> where T: Serializer,` [src]

`impl Zeroable for Mat2`[src]

`fn zeroed() -> Self`[src]

`impl Copy for Mat2`[src]

`impl Pod for Mat2`[src]

`impl StructuralPartialEq for Mat2`[src]

`impl RefUnwindSafe for Mat2`

`impl Send for Mat2`

`impl Sync for Mat2`

`impl Unpin for Mat2`

`impl UnwindSafe for Mat2`

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]