Union Matrix

#[repr(C)]
pub union Matrix {
    /* private fields */
}

This is a matrix data type that uses the SIMD instruction.

Using the sse2 instruction.

Implementations

impl Matrix

pub const ZERO: Self

All elements are zeros.

pub const IDENTITY: Self

Identity matrix.

impl Matrix

pub fn new( m00: f32, m01: f32, m02: f32, m03: f32, m10: f32, m11: f32, m12: f32, m13: f32, m20: f32, m21: f32, m22: f32, m23: f32, m30: f32, m31: f32, m32: f32, m33: f32, ) -> Self

Creates with given elements.

pub fn diagonal(diagonal: Vector) -> Self

Creates a diagonal matrix.

pub const fn from_columns( x_axis: Vector, y_axis: Vector, z_axis: Vector, w_axis: Vector, ) -> Self

Creates with given column vectors.

pub fn from_column_array(arr: [f32; 16]) -> Self

Creates from a given array.

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

Stores the value in an array.

pub fn from_column_slice(slice: &[f32]) -> Self

Creates from a given array of slice.

Panics

When the use-assertion feature is enabled, it will panic! if the array slice has less than sixteen elements.

pub fn load_float3x3(val: Float3x3) -> Self

Loads a value from a given Float4x4.

pub fn store_float3x3(self) -> Float3x3

Stores the value in a Float4x4.

pub fn load_float4x4(val: Float4x4) -> Self

Loads a value from a given Float4x4.

pub fn store_float4x4(self) -> Float4x4

Stores the value in a Float4x4.

pub fn from_translation(translation: Vector) -> Self

Create a matrix with the given translation.

pub fn from_rotation_translation( rotation: Quaternion, translation: Vector, ) -> Self

Creates a matrix with the given rotation and translation.

※ The given rotation must be normalized.

Panics

When the use-assertion feature is enabled, it will panic! if the given quaternion is not a normalized quaternion.

pub fn from_scale_rotation_translation( scale: Vector, rotation: Quaternion, translation: Vector, ) -> Self

Creates a matrix with the given scale, rotation and translation.

※ The given rotation must be normalized.

Panics

When the use-assertion feature is enabled, it will panic! if the given quaternion is not a normalized quaternion.

pub fn from_rotation_x(angle: f32) -> Self

Creates a matrix rotated by a given x-axis angle.

※ The angles given are in radians.

pub fn from_rotation_y(angle: f32) -> Self

Creates a matrix rotated by a given y-axis angle.

※ The angles given are in radians.

pub fn from_rotation_z(angle: f32) -> Self

Creates a matrix rotated by a given z-axis angle.

※ The angles given are in radians.

pub fn look_to_rh(eye: Vector, dir: Vector, up: Vector) -> Self

Create a right-handed coordinate view matrix with the given eye, dir, and up.

※ The given dir and up must be unit vectors.

Panics

When the use-assertion feature is enabled, it will panic! if the given dir and up is not unit vectors.

pub fn look_to_lh(eye: Vector, dir: Vector, up: Vector) -> Self

Create a left-handed coordinate view matrix with the given eye, dir, and up.

※ The given dir and up must be unit vectors.

Panics

When the use-assertion feature is enabled, it will panic! if the given dir and up is not unit vectors.

pub fn look_at_rh(eye: Vector, at: Vector, up: Vector) -> Self

Create a right-handed coordinate view matrix with the given eye, at, and up.

※ The given position of eye and at must be different.

Panics

When the use-assertion feature is enabled, it will panic! if the given eye and at are equal.

pub fn look_at_lh(eye: Vector, at: Vector, up: Vector) -> Self

Create a left-handed coordinate view matrix with the given eye, at, and up.

※ The given position of eye and at must be different.

Panics

When the use-assertion feature is enabled, it will panic! if the given eye and at are equal.

pub fn perspective_rh( fov_y: f32, aspect_ratio: f32, z_near: f32, z_far: f32, ) -> Self

Create a right-handed coordinate perspective projection matrix with the given fov_y, aspect_ratio, z_near, z_far.

※ The depth of the created frustum ranges from 0.0 to 1.0.
※ The given fov_y is in radians.
※ The given value of z_near and z_far must be different.

Panics

When the use-assertion feature is enabled, it will panic! if the given z_near and z_far are equal.

pub fn perspective_lh( fov_y: f32, aspect_ratio: f32, z_near: f32, z_far: f32, ) -> Self

Create a left-handed coordinate perspective projection matrix with the given fov_y, aspect_ratio, z_near, z_far.

※ The depth of the created frustum ranges from 0.0 to 1.0.
※ The given fov_y is in radians.
※ The given value of z_near and z_far must be different.

Panics

When the use-assertion feature is enabled, it will panic! if the given z_near and z_far are equal.

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

Create a right-handed coordinate orthographic projection matrix with the given left, right, bottom, top, near, far.

※ The depth of the created frustum ranges from 0.0 to 1.0.
※ The given value of left and right must be different.
※ The given value of bottom and top must be different.
※ The given value of near and far must be different.

Panics

When the use-assertion feature is enabled, it will panic! if the given left and right are equal or bottom and top are equal or near and far are equal.

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

Create a left-handed coordinate orthographic projection matrix with the given left, right, bottom, top, near, far.

※ The depth of the created frustum ranges from 0.0 to 1.0.
※ The given value of left and right must be different.
※ The given value of bottom and top must be different.
※ The given value of near and far must be different.

Panics

When the use-assertion feature is enabled, it will panic! if the given left and right are equal or bottom and top are equal or near and far are equal.

impl Matrix

pub fn get_x_axis(&self) -> &Vector

Get the x-axis of a matrix.

pub fn set_x_axis(&mut self, v: Vector)

Set the x-axis of a matrix.

pub fn get_y_axis(&self) -> &Vector

Get the y-axis of a matrix.

pub fn set_y_axis(&mut self, v: Vector)

Set the y-axis of a matrix.

pub fn get_z_axis(&self) -> &Vector

Get the z-axis of a matrix.

pub fn set_z_axis(&mut self, v: Vector)

Set the z-axis of a matrix.

pub fn get_w_axis(&self) -> &Vector

Get the w-axis of a matrix.

pub fn set_w_axis(&mut self, v: Vector)

Set the x-axis of a matrix.

pub fn transpose(self) -> Self

Transpose of a matrix.

pub fn determinant(self) -> Vector

Determinant of a matrix.

pub fn determinant_into(self) -> f32

Determinant of a matrix.

pub fn inverse(self) -> Self

Inverse of a matrix.

Panics

When the use-assertion feature is enabled, it will panic! if the determinant of a matrix is less than or equal to f32::EPSILON.

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

Inverse of a matrix.

Returns None if the determinant of a matrix is less than or equal to f32::EPSILON.

Trait Implementations

impl Add for Matrix

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

Adds two matrices.

type Output = Matrix

The resulting type after applying the + operator.

impl AddAssign for Matrix

fn add_assign(&mut self, rhs: Self)

Adds two matrices. (assign)

impl Clone for Matrix

fn clone(&self) -> Matrix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Matrix

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

Formats the value using the given formatter.

impl Default for Matrix

fn default() -> Self

Returns the “default value” for a type.

impl From<[f32; 16]> for Matrix

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

Converts to this type from the input type.

impl From<Float3x3> for Matrix

fn from(value: Float3x3) -> Self

Converts to this type from the input type.

impl From<Float4x4> for Matrix

fn from(value: Float4x4) -> Self

Converts to this type from the input type.

impl Into<[f32; 16]> for Matrix

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

Converts this type into the (usually inferred) input type.

impl Into<Float3x3> for Matrix

fn into(self) -> Float3x3

Converts this type into the (usually inferred) input type.

impl Into<Float4x4> for Matrix

fn into(self) -> Float4x4

Converts this type into the (usually inferred) input type.

impl Mul<Matrix> for f32

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

Multiplies each element of a matrix by a scalar value.

type Output = Matrix

The resulting type after applying the * operator.

impl Mul<Vector> for Matrix

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

Transformation of the vector.

type Output = Vector

The resulting type after applying the * operator.

impl Mul<f32> for Matrix

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

Multiplies each element of a matrix by a scalar value.

type Output = Matrix

The resulting type after applying the * operator.

impl Mul for Matrix

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

Multiplies two matrices.

type Output = Matrix

The resulting type after applying the * operator.

impl MulAssign for Matrix

fn mul_assign(&mut self, rhs: Self)

Multiplies two matrices. (assign)

impl Neg for Matrix

fn neg(self) -> Self::Output

Nagative.

type Output = Matrix

The resulting type after applying the - operator.

impl Sub for Matrix

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

Subtracts two matrices.

type Output = Matrix

The resulting type after applying the - operator.

impl SubAssign for Matrix

fn sub_assign(&mut self, rhs: Self)

Subtracts two matrices. (assign)

impl Copy for Matrix