Struct ultraviolet::mat::Mat2

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

A 2x2 square matrix.

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

Fields

cols: [Vec2; 2]

Implementations

impl Mat2

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

pub fn identity() -> Self

pub fn into_homogeneous(self) -> Mat3

Turn this into a homogeneous 2d transformation matrix.

pub fn transpose(&mut self)

pub fn transposed(&self) -> Self

pub fn determinant(&self) -> f32

pub fn adjugate(&self) -> Self

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)

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

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

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

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

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

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

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

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

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

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

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

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

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

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Mat2> for Mat2

fn add_assign(&mut self, rhs: Mat2)

Performs the += operation.

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 Copy for Mat2

impl Debug for Mat2

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

Formats the value using the given formatter.

impl Default for Mat2

fn default() -> Self

Returns the "default value" for a type.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl From<[f32; 4]> for Mat2

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

Performs the conversion.

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

fn from(mat2: Mat2) -> Self

Performs the conversion.

impl From<Rotor2> for Mat2

fn from(rotor: Rotor2) -> Mat2

Performs the conversion.

impl Index<usize> for Mat2

type Output = Vec2

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Mat2

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

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

impl Mul<Mat2> for Mat2

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl Mul<Mat2> for f32

type Output = Mat2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for Mat2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Vec2

Performs the * operation.

impl Mul<f32> for Mat2

type Output = Mat2

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq<Mat2> for Mat2

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.