Struct duku::Mat4

#[repr(C)]pub struct Mat4 {
    pub x: Vec4,
    pub y: Vec4,
    pub z: Vec4,
    pub w: Vec4,
}

4x4 Matrix.

Used for transforming vectors

Is column-major

Examples

let vector = Vec3::new(2.0, 0.0, 0.0);
let matrix = Mat4::scale([5.0, 1.0, 1.0]);
let scaled = matrix * vector;

Fields

x: Vec4

the X column

y: Vec4

the Y column

z: Vec4

the Z column

w: Vec4

the W column

Implementations

impl Mat4

pub fn columns(
    x: impl Into<Vec4>,
    y: impl Into<Vec4>,
    z: impl Into<Vec4>,
    w: impl Into<Vec4>
) -> Self

Create matrix from column vectors

pub fn rows(
    x: impl Into<Vec4>,
    y: impl Into<Vec4>,
    z: impl Into<Vec4>,
    w: impl Into<Vec4>
) -> Self

Create matrix from row vectors

pub fn identity() -> Self

Create identity matrix

pub fn translation(vector: impl Into<Vec3>) -> Self

Create translation matrix

Translation matrix moves vectors around

pub fn scale(vector: impl Into<Vec3>) -> Self

Create scale matrix

Scale matrix scales vectors

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

Create rotation matrix with euler angles

This rotation's yaw, pitch and roll are z, y and x

pub fn axis_rotation(axis: impl Into<Vec3>, angle: f32) -> Self

Create rotation matrix around axis

This rotates vectors around axis by the angle

pub fn look_rotation(forward: impl Into<Vec3>, up: impl Into<Vec3>) -> Self

Create rotation matrix to rotate towards direction

up is used as a guide to try aligning to

pub fn perspective(fov: f32, aspect: f32, near: f32, far: f32) -> Self

Create perspective projection matrix

This is a left-handed matrix with Z in range of [0; 1]

pub fn orthographic(width: f32, height: f32, near: f32, far: f32) -> Self

Create orthographic projection matrix

This is a left-handed matrix with Z in range of [0; 1]

pub fn compose(position: Vec3, scale: Vec3, rotation: Quat) -> Self

Create matrix from position, scale and rotation

Oposite of decompose.

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

Calculate the inverse of the matrix

pub fn decompose(self) -> (Vec3, Vec3, Quat)

Separate translation, scale and rotation parts of the matrix

pub const fn rx(&self) -> Vec4

Access the X row of the matrix

pub const fn ry(&self) -> Vec4

Access the Y row of the matrix

pub const fn rz(&self) -> Vec4

Access the Z row of the matrix

pub const fn rw(&self) -> Vec4

Access the W row of the matrix

Trait Implementations

impl Clone for Mat4

pub fn clone(&self) -> Mat4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Mat4

impl Debug for Mat4

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

Formats the value using the given formatter.

impl Default for Mat4

pub fn default() -> Mat4

Returns the "default value" for a type.

impl From<[f32; 16]> for Mat4

pub fn from(m: [f32; 16]) -> Self

Performs the conversion.

impl From<Mat4> for Quat

pub fn from(m: Mat4) -> Self

Performs the conversion.

impl From<Quat> for Mat4

pub fn from(q: Quat) -> Self

Performs the conversion.

impl Index<usize> for Mat4

type Output = Vec4

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Mat4

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

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

impl Into<[f32; 16]> for Mat4

pub fn into(self) -> [f32; 16]

Performs the conversion.

impl Mul<Mat4> for Mat4

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for Mat4

type Output = Vec3

The resulting type after applying the * operator.

pub fn mul(self, rhs: Vec3) -> Self::Output

Performs the * operation.

impl Mul<Vec4> for Mat4

type Output = Vec4

The resulting type after applying the * operator.

pub fn mul(self, rhs: Vec4) -> Self::Output

Performs the * operation.

impl Mul<f32> for Mat4

type Output = Mat4

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Mat4> for Mat4

pub fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl PartialEq<Mat4> for Mat4

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

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

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

This method tests for !=.

impl StructuralPartialEq for Mat4