Struct hektor::Mat4

#[repr(C)]
pub struct Mat4 { /* fields omitted */ }

A 4x4 column-major Matrix.

There's four columns, and each column is itself a Vec4.

Methods

impl Mat4

Accessors

pub fn x_axis(self) -> Vec4

Obtains the x_axis column of this matrix

pub fn y_axis(self) -> Vec4

Obtains the y_axis column of this matrix

pub fn z_axis(self) -> Vec4

Obtains the z_axis column of this matrix

pub fn w_axis(self) -> Vec4

Obtains the w_axis column of this matrix

pub fn x_axis_mut(&mut self) -> &mut Vec4

&mut to the x_axis column of this matrix

pub fn y_axis_mut(&mut self) -> &mut Vec4

&mut to the y_axis column of this matrix

pub fn z_axis_mut(&mut self) -> &mut Vec4

&mut to the z_axis column of this matrix

pub fn w_axis_mut(&mut self) -> &mut Vec4

&mut to the w_axis column of this matrix

impl Mat4

Constructors

pub fn new(x_axis: Vec4, y_axis: Vec4, z_axis: Vec4, w_axis: Vec4) -> Self

Combines the columns given into a new Mat4

pub fn splat(v: f32) -> Self

Splats the given value across all columns.

pub fn diagonal(x: f32, y: f32, z: f32, w: f32) -> Self

Forms a diagonal matrix from the values given.

pub fn to_mat3(self) -> Mat3

Down-converts to a Mat3

pub fn determinant(self) -> f32

Determinant of the matrix.

This gives the scale factor of a unit hyper-cube in the matrix's modified coordinate space:

• Positive means that the output orientation is generally similar.
• Negative means that the output orientation is flipped.
• Zero means that the output loses at least 1 dimension (meaning that hyper-cubes become cubes, squares, lines, or points).

pub fn transpose(self) -> Self

Transpose the matrix.

This "flips" it along the diagonal. The diagonal values stay the same.

pub fn inverse(self) -> Option<Self>

Gives the inverse matrix, if it exists.

m * m.inverse() and m.inverse() * m should both give an identity matrix as the output. As we all known, with floating point there's usually a little bit of rounding error possible so it may not work perfectly.

Failure

There's no inverse if the determinant is zero.

Trait Implementations

impl CanDeterminant for Mat4

fn determinant(self) -> f32

See determinant for info.

impl Display for Mat4

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

Display formats without labels in a 4 line style similar to standard math notation.

Passes the formatter along to the fields, so you can use any normal f32 Display format arguments that you like.

impl Debug for Mat4

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

Debug formats with each axis labeled and then shown as a 4-tuple in one long line.

Passes the formatter along to the fields, so you can use any normal f32 Debug format arguments that you like.

impl UpperExp for Mat4

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

UpperExp formats like Display, but with the upper exponent.

Passes the formatter along to the fields, so you can use any normal f32 UpperExp format arguments that you like.

impl LowerExp for Mat4

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

LowerExp formats like Display, but with the lower exponent.

Passes the formatter along to the fields, so you can use any normal f32 LowerExp format arguments that you like.

impl PartialEq<Mat4> for Mat4

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

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

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

This method tests for !=.

impl Add<Mat4> for Mat4

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f32> for Mat4

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Mat4> for f32

type Output = Mat4

The resulting type after applying the + operator.

fn add(self, rhs: Mat4) -> Mat4

Performs the + operation.

impl Sub<Mat4> for Mat4

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f32> for Mat4

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> Self

Performs the - operation.

impl Sub<Mat4> for f32

type Output = Mat4

The resulting type after applying the - operator.

fn sub(self, rhs: Mat4) -> Mat4

Performs the - operation.

impl Mul<f32> for Mat4

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Mat4> for f32

type Output = Mat4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec4> for Mat4

type Output = Vec4

The resulting type after applying the * operator.

fn mul(self, v4: Vec4) -> Vec4

Performs the * operation.

impl Mul<Mat4> for Mat4

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Mat4

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl AddAssign<Mat4> for Mat4

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AddAssign<f32> for Mat4

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl SubAssign<Mat4> for Mat4

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl SubAssign<f32> for Mat4

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl MulAssign<f32> for Mat4

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign<Mat4> for Mat4

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Index<usize> for Mat4

type Output = Vec4

The returned type after indexing.

fn index(&self, index: usize) -> &Vec4

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Mat4

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

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

impl Copy for Mat4

impl AsRef<[Vec4; 4]> for Mat4

fn as_ref(&self) -> &[Vec4; 4]

Performs the conversion.

impl AsMut<[Vec4; 4]> for Mat4

fn as_mut(&mut self) -> &mut [Vec4; 4]

Performs the conversion.

impl From<[f32; 16]> for Mat4

fn from(
    [xx, xy, xz, xw, yx, yy, yz, yw, zx, zy, zz, zw, wx, wy, wz, ww]: [f32; 16]
) -> Self

Performs the conversion.

impl From<Mat4> for [f32; 16]

fn from(
    Mat4 { x_axis: x_axis, y_axis: y_axis, z_axis: z_axis, w_axis: w_axis }: Mat4
) -> Self

Performs the conversion.

impl Clone for Mat4

fn clone(&self) -> Mat4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Mat4

fn default() -> Mat4

Returns the "default value" for a type.

impl Pod for Mat4

impl Zeroable for Mat4

fn zeroed() -> Self

Calls zeroed.