Struct mini_math::Matrix4

source · [−]

#[repr(C)]
pub struct Matrix4(pub [Vector4; 4]);

Expand description

A 4x4 matrix, suitable for 3D transformations.

Tuple Fields

0: [Vector4; 4]

Implementations

source

impl Matrix4

source

pub const fn from_1d_array(a: [f32 ; 16]) -> Self

A new matrix from a 1D array.

source

pub const fn from_2d_array(a: [[f32 ; 4]; 4]) -> Self

A new matrix from a 2D array.

source

pub const fn identity() -> Self

The identity matrix.

source

pub const fn zero() -> Self

A matrix composed entirely of zeroes.

source

pub fn look_at(eye: Point, target: Point, up: Vector3) -> Self

A look-at matrix suitable for positioning a camera.

source

pub fn perspective(
    aspect_ratio: f32,
    fov_radians: f32,
    znear: f32,
    zfar: f32
) -> Self

A perspective matrix suitable for use as a camera projection.

source

pub fn orthographic(
    left: f32,
    right: f32,
    bottom: f32,
    top: f32,
    near: f32,
    far: f32
) -> Self

An orthographic matrix suitable for rendering user interfaces.

source

pub fn translation(v: Vector3) -> Self

A matrix that translates by the given vector.

source

pub fn rotation_x(angle_radians: f32) -> Self

A matrix that rotates around the x-axis.

source

pub fn rotation_y(angle_radians: f32) -> Self

A matrix that rotates around the y-axis.

source

pub fn rotation_z(angle_radians: f32) -> Self

A matrix that rotates around the z-axis.

source

pub fn rotation_axis_angle(axis: Vector3, angle_radians: f32) -> Self

A matrix that rotates around an arbitrary axis.

source

pub fn rotation_from_vector_to_vector(start: Vector3, end: Vector3) -> Self

A matrix that rotates from a given vector to another.

source

pub fn uniform_scale(scale: f32) -> Self

A matrix that scales uniformly in all dimensions.

source

pub fn row(&self, i: usize) -> Vector4

Obtain the specified row vector of this matrix.

source

pub fn column(&self, i: usize) -> Vector4

Obtain the specified column vector of this matrix.

source

pub fn transpose(&self) -> Self

The transpose of this matrix (i.e. this matrix flipped along the diagonal)

source

pub fn invert(&self) -> Self

The inverse of this matrix.

source

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

Trait Implementations

source

impl Clone for Matrix4

source

fn clone(&self) -> Matrix4

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Matrix4

source

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

Formats the value using the given formatter. Read more

source

impl Mul<&'_ Matrix4> for Matrix4

type Output = Self

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

impl Mul<Matrix4> for Matrix4

type Output = Self

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

impl Mul<Matrix4> for Point

type Output = Point

The resulting type after applying the * operator.

source

fn mul(self, rhs: Matrix4) -> Point

Performs the * operation. Read more

source

impl Mul<Matrix4> for Vector3

type Output = Vector3

The resulting type after applying the * operator.

source

fn mul(self, rhs: Matrix4) -> Vector3

Performs the * operation. Read more

source

impl Mul<Matrix4> for Vector4

type Output = Vector4

The resulting type after applying the * operator.

source

fn mul(self, rhs: Matrix4) -> Vector4

Performs the * operation. Read more

source

impl Mul<Point> for Matrix4

type Output = Point

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

impl Mul<Vector3> for Matrix4

type Output = Vector3

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

impl Mul<Vector4> for Matrix4

type Output = Vector4

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

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

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

source

fn ne(&self, other: &Matrix4) -> bool

This method tests for !=.

source

impl Copy for Matrix4

source

impl StructuralPartialEq for Matrix4

Auto Trait Implementations

impl RefUnwindSafe for Matrix4

impl Send for Matrix4

impl Sync for Matrix4

impl Unpin for Matrix4

impl UnwindSafe for Matrix4

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

pub fn clone_into(&self, target: &mut T)

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

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct mini_math::Matrix4

Tuple Fields

Implementations

impl Matrix4

pub const fn from_1d_array(a: [f32; 16]) -> Self

pub const fn from_2d_array(a: [[f32; 4]; 4]) -> Self

pub const fn identity() -> Self

pub const fn zero() -> Self

pub fn look_at(eye: Point, target: Point, up: Vector3) -> Self

pub fn perspective( aspect_ratio: f32, fov_radians: f32, znear: f32, zfar: f32) -> Self

pub fn orthographic( left: f32, right: f32, bottom: f32, top: f32, near: f32, far: f32) -> Self

pub fn translation(v: Vector3) -> Self

pub fn rotation_x(angle_radians: f32) -> Self

pub fn rotation_y(angle_radians: f32) -> Self

pub fn rotation_z(angle_radians: f32) -> Self

pub fn rotation_axis_angle(axis: Vector3, angle_radians: f32) -> Self

pub fn rotation_from_vector_to_vector(start: Vector3, end: Vector3) -> Self

pub fn uniform_scale(scale: f32) -> Self

pub fn row(&self, i: usize) -> Vector4

pub fn column(&self, i: usize) -> Vector4

pub fn transpose(&self) -> Self

pub fn invert(&self) -> Self

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

Trait Implementations

impl Clone for Matrix4

fn clone(&self) -> Matrix4

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

impl Debug for Matrix4

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

impl Mul<&'_ Matrix4> for Matrix4

type Output = Self

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

impl Mul<Matrix4> for Matrix4

type Output = Self

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

impl Mul<Matrix4> for Point

type Output = Point

fn mul(self, rhs: Matrix4) -> Point

impl Mul<Matrix4> for Vector3

type Output = Vector3

fn mul(self, rhs: Matrix4) -> Vector3

impl Mul<Matrix4> for Vector4

type Output = Vector4

fn mul(self, rhs: Matrix4) -> Vector4

impl Mul<Point> for Matrix4

type Output = Point

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

impl Mul<Vector3> for Matrix4

type Output = Vector3

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

impl Mul<Vector4> for Matrix4

type Output = Vector4

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

impl NearlyEqual for &Matrix4

fn nearly_equals(self, rhs: Self) -> bool

impl PartialEq<Matrix4> for Matrix4

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

fn ne(&self, other: &Matrix4) -> bool

impl Copy for Matrix4

impl StructuralPartialEq for Matrix4

Auto Trait Implementations

impl RefUnwindSafe for Matrix4

impl Send for Matrix4

impl Sync for Matrix4

impl Unpin for Matrix4

impl UnwindSafe for Matrix4

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub const fn from_1d_array(a: [f32 ; 16]) -> Self

pub const fn from_2d_array(a: [[f32 ; 4]; 4]) -> Self

pub fn perspective(
aspect_ratio: f32,
fov_radians: f32,
znear: f32,
zfar: f32
) -> Self

pub fn orthographic(
left: f32,
right: f32,
bottom: f32,
top: f32,
near: f32,
far: f32
) -> Self

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,