Struct duku::Matrix4

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

4x4 Matrix.

Used for transforming vectors

Note: column-major

Example

let vector = Vector3::new(2.0, 0.0, 0.0);
let matrix = Matrix4::scale([5.0, 1.0, 1.0]);
assert_eq!(matrix * vector, Vector3::new(10.0, 0.0, 0.0));

Fields

x: Vector4

the X column

y: Vector4

the Y column

z: Vector4

the Z column

w: Vector4

the W column

Implementations

impl Matrix4

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

Create matrix from column vectors

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

Create matrix from row vectors

pub fn identity() -> Self

Create identity matrix

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

Create translation matrix

Translation matrix moves vectors around

Example

let vector = Vector3::new(2.0, 0.0, 0.0);
let matrix = Matrix4::translation([5.0, 1.0, 1.0]);
assert_eq!(matrix * vector, Vector3::new(7.0, 1.0, 1.0));

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

Create scale matrix

Scale matrix scales vectors

Example

let vector = Vector3::new(2.0, 0.0, 0.0);
let matrix = Matrix4::scale([5.0, 1.0, 1.0]);
assert_eq!(matrix * vector, Vector3::new(10.0, 0.0, 0.0));

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<Vector3>, angle: f32) -> Self

Create rotation matrix around axis

This rotates vectors around axis by the angle

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

Create rotation matrix to rotate towards direction

Note: 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

Note: 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

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

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

Calculate the inverse of the matrix

pub const fn rx(&self) -> Vector4

Access the X row of the matrix

pub const fn ry(&self) -> Vector4

Access the Y row of the matrix

pub const fn rz(&self) -> Vector4

Access the Z row of the matrix

pub const fn rw(&self) -> Vector4

Access the W row of the matrix

Trait Implementations

impl Clone for Matrix4

pub fn clone(&self) -> Matrix4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Matrix4

impl Debug for Matrix4

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

Formats the value using the given formatter.

impl From<[f32; 16]> for Matrix4

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

Performs the conversion.

impl From<Matrix4> for Quaternion

pub fn from(m: Matrix4) -> Self

Performs the conversion.

impl From<Matrix4> for Transform

pub fn from(m: Matrix4) -> Self

Performs the conversion.

impl From<Quaternion> for Matrix4

pub fn from(q: Quaternion) -> Self

Performs the conversion.

impl From<Transform> for Matrix4

pub fn from(t: Transform) -> Self

Performs the conversion.

impl Index<usize> for Matrix4

type Output = Vector4

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Matrix4

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

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

impl Into<[f32; 16]> for Matrix4

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

Performs the conversion.

impl Mul<Matrix4> for Matrix4

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector3> for Matrix4

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector4> for Matrix4

type Output = Vector4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Matrix4

type Output = Matrix4

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Matrix4> for Matrix4

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

Performs the *= operation.

impl PartialEq<Matrix4> for Matrix4

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

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

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

This method tests for !=.

impl StructuralPartialEq for Matrix4