Struct citro3d::math::Matrix4

pub struct Matrix4(/* private fields */);

A 4x4 row-major matrix of f32s.

Layout details

Rows are actually stored as WZYX in memory. There are helper functions for accessing the rows in XYZW form. The Debug implementation prints the shows in WZYX form

It is also guaranteed to have the same layout as citro3d_sys::C3D_Mtx

Implementations

impl Matrix4

pub fn from_cells_wzyx(cells: [f32; 16]) -> Self

Construct a Matrix4 from the cells

Note

This expects rows to be in WZYX order

pub fn from_rows(rows: [FVec4; 4]) -> Self

Construct a Matrix4 from its rows

pub fn from_raw(value: C3D_Mtx) -> Self

Create a new matrix from a raw citro3d_sys one

pub fn as_raw(&self) -> &C3D_Mtx

pub fn as_raw_mut(&mut self) -> &mut C3D_Mtx

pub fn into_raw(self) -> C3D_Mtx

pub fn rows_wzyx(self) -> [FVec4; 4]

Get the rows in raw (WZYX) form

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

Get the rows in XYZW form

pub fn zero() -> Self

Construct the zero matrix.

pub fn transpose(self) -> Matrix4

Transpose the matrix, swapping rows and columns.

pub fn translate(&mut self, x: f32, y: f32, z: f32)

Translate a transformation matrix by the given amounts in the X, Y, and Z directions.

pub fn scale(&mut self, x: f32, y: f32, z: f32)

Scale a transformation matrix by the given amounts in the X, Y, and Z directions.

pub fn rotate(&mut self, axis: FVec3, angle: f32)

Rotate a transformation matrix by the given angle around the given axis.

pub fn rotate_x(&mut self, angle: f32)

Rotate a transformation matrix by the given angle around the X axis.

pub fn rotate_y(&mut self, angle: f32)

Rotate a transformation matrix by the given angle around the Y axis.

pub fn rotate_z(&mut self, angle: f32)

Rotate a transformation matrix by the given angle around the Z axis.

pub fn inverse(self) -> Result<Self, Self>

Find the inverse of the matrix.

Errors

If the matrix has no inverse, it will be returned unchanged as an [Err].

pub fn identity() -> Self

Construct the identity matrix.

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

Construct a 4x4 matrix with the given values on the diagonal.

pub fn looking_at( camera_position: FVec3, camera_target: FVec3, camera_up: FVec3, coordinates: CoordinateOrientation ) -> Self

Construct a 3D transformation matrix for a camera, given its position, target, and upward direction.

Trait Implementations

impl Add for Matrix4

type Output = Matrix4

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Matrix4

fn clone(&self) -> Matrix4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Matrix4

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

Formats the value using the given formatter.

impl From<&Matrix4> for Uniform

fn from(value: &Matrix4) -> Self

Converts to this type from the input type.

impl From<Mat4> for Matrix4

Available on crate feature glam only.

fn from(mat: Mat4) -> Self

Converts to this type from the input type.

impl From<Matrix4> for Mat4

Available on crate feature glam only.

fn from(mat: Matrix4) -> Self

Converts to this type from the input type.

impl From<Matrix4> for Uniform

fn from(value: Matrix4) -> Self

Converts to this type from the input type.

impl From<Projection<Orthographic>> for Matrix4

fn from(projection: Projection<Orthographic>) -> Self

Converts to this type from the input type.

impl From<Projection<Perspective>> for Matrix4

fn from(projection: Projection<Perspective>) -> Self

Converts to this type from the input type.

impl Mul<FVec<3>> for &Matrix4

type Output = FVec<4>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<FVec<4>> for &Matrix4

type Output = FVec<4>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Matrix4> for &Matrix4

type Output = Matrix4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Matrix4

type Output = Matrix4

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Matrix4

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for Matrix4

type Output = Matrix4

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Matrix4