Struct ultraviolet::mat::Mat3x8

#[repr(C)]pub struct Mat3x8 {
    pub cols: [Vec3x8; 3],
}

A 3x3 square matrix.

Useful for performing linear transformations (rotation, scaling) on 3d vectors, or for performing arbitrary transformations (linear + translation, projection, etc) on homogeneous 2d vectors

Fields

cols: [Vec3x8; 3]

Implementations

impl Mat3x8

pub const fn new(col1: Vec3x8, col2: Vec3x8, col3: Vec3x8) -> Self

pub fn from_translation(trans: Vec2x8) -> Self

Assumes homogeneous 2d coordinates.

pub fn from_scale_homogeneous(scale: f32x8) -> Self

Assumes homogeneous 2d coordinates.

pub fn from_nonuniform_scale_homogeneous(scale: Vec2x8) -> Self

Assumes homogeneous 2d coordinates.

pub fn from_rotation_homogeneous(angle: f32x8) -> Self

Builds a homogeneous 2d rotation matrix (in the xy plane) from a given angle in radians.

pub fn from_scale(scale: f32x8) -> Self

pub fn from_nonuniform_scale(scale: Vec3x8) -> Self

pub fn identity() -> Self

pub fn from_euler_angles(roll: f32x8, pitch: f32x8, yaw: f32x8) -> Self

Angles are applied in the order roll -> pitch -> yaw.

• Yaw is rotation inside the xz plane ("around the y axis")
• Pitch is rotation inside the yz plane ("around the x axis")
• Roll is rotation inside the xy plane ("around the z axis")

Important: This function assumes a right-handed, y-up coordinate space where:

• +X axis points right
• +Y axis points up
• +Z axis points towards the viewer (i.e. out of the screen)

This means that you may see unexpected behavior when used with OpenGL or DirectX as they use a different coordinate system. You should use the appropriate projection matrix in projection module to fit your use case to remedy this.

pub fn from_rotation_x(angle: f32x8) -> Self

Create a new rotation matrix from a rotation "about the x axis". This is here as a convenience function for users coming from other libraries; it is more proper to think of this as a rotation in the yz plane.

Important: This function assumes a right-handed, y-up coordinate space where:

• +X axis points right
• +Y axis points up
• +Z axis points towards the viewer (i.e. out of the screen)

This means that you may see unexpected behavior when used with OpenGL or DirectX as they use a different coordinate system. You should use the appropriate projection matrix in projection module to fit your use case to remedy this.

pub fn from_rotation_y(angle: f32x8) -> Self

Create a new rotation matrix from a rotation "about the y axis". This is here as a convenience function for users coming from other libraries; it is more proper to think of this as a rotation in the xz plane.

Important: This function assumes a right-handed, y-up coordinate space where:

• +X axis points right
• +Y axis points up
• +Z axis points towards the viewer (i.e. out of the screen)

This means that you may see unexpected behavior when used with OpenGL or DirectX as they use a different coordinate system. You should use the appropriate projection matrix in projection module to fit your use case to remedy this.

pub fn from_rotation_z(angle: f32x8) -> Self

Create a new rotation matrix from a rotation "about the z axis". This is here as a convenience function for users coming from other libraries; it is more proper to think of this as a rotation in the xy plane.

Important: This function assumes a right-handed, y-up coordinate space where:

• +X axis points right
• +Y axis points up
• +Z axis points towards the viewer (i.e. out of the screen)

This means that you may see unexpected behavior when used with OpenGL or DirectX as they use a different coordinate system. You should use the appropriate projection matrix in projection module to fit your use case to remedy this.

pub fn from_angle_plane(angle: f32x8, plane: Bivec3x8) -> Self

Construct a rotation matrix given a bivector which defines a plane and rotation orientation, and a rotation angle.

plane must be normalized!

This is the equivalent of an axis-angle rotation.

pub fn into_homogeneous(self) -> Mat4x8

pub fn determinant(&self) -> f32x8

pub fn adjugate(&self) -> Self

The adjugate of this matrix, i.e. the transpose of the cofactor matrix.

This is equivalent to the inverse but without dividing by the determinant of the matrix, which can be useful in some contexts for better performance.

One such case is when this matrix is interpreted as a a homogeneous transformation matrix, in which case uniform scaling will not affect the resulting projected 3d version of transformed points or vectors.

pub fn inverse(&mut self)

If this matrix is not currently invertable, this function will return an invalid inverse. This status is not checked by the library.

pub fn inversed(&self) -> Self

If this matrix is not currently invertable, this function will return an invalid inverse. This status is not checked by the library.

pub fn transpose(&mut self)

pub fn transposed(&self) -> Self

pub fn transform_vec2(&self, vec: Vec2x8) -> Vec2x8

Transform a Vec2 by self, interpreting it as a vector.

pub fn transform_point2(&self, point: Vec2x8) -> Vec2x8

Transform a Vec2 by self, interpreting it as a point.

pub fn layout() -> Layout

pub fn as_array(&self) -> &[f32x8; 9]

pub fn as_component_array(&self) -> &[Vec3x8; 3]

pub fn as_slice(&self) -> &[f32x8]

pub fn as_component_slice(&self) -> &[Vec3x8]

pub fn as_byte_slice(&self) -> &[u8]

pub fn as_mut_slice(&mut self) -> &mut [f32x8]

pub fn as_mut_component_slice(&mut self) -> &mut [Vec3x8]

pub fn as_mut_byte_slice(&mut self) -> &mut [u8]

pub const fn as_ptr(&self) -> *const f32x8

Returns a constant unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

pub fn as_mut_ptr(&mut self) -> *mut f32x8

Returns a mutable unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

impl Mat3x8

pub fn into_rotor3(self) -> Rotor3x8

If self is a rotation matrix, return a Rotor3 representing the same rotation.

If self is not a rotation matrix, the returned value is a Rotor3 with undefied properties. The fact that self is a rotation matrix is not checked by the library.

Trait Implementations

impl Add<Mat3x8> for Mat3x8

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Mat3x8> for Mat3x8

fn add_assign(&mut self, rhs: Mat3x8)

Performs the += operation.

impl Clone for Mat3x8

fn clone(&self) -> Mat3x8

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Mat3x8

impl Debug for Mat3x8

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

Formats the value using the given formatter.

impl Default for Mat3x8

fn default() -> Self

Returns the "default value" for a type.

impl<'_> From<&'_ [f32x8; 9]> for Mat3x8

fn from(comps: &[f32x8; 9]) -> Self

Performs the conversion.

impl From<[[f32x8; 3]; 3]> for Mat3x8

fn from(comps: [[f32x8; 3]; 3]) -> Self

Performs the conversion.

impl From<[f32x8; 9]> for Mat3x8

fn from(comps: [f32x8; 9]) -> Self

Performs the conversion.

impl From<Mat3x8> for [[f32x8; 3]; 3]

fn from(mat3: Mat3x8) -> Self

Performs the conversion.

impl From<Rotor3x8> for Mat3x8

fn from(rotor: Rotor3x8) -> Mat3x8

Performs the conversion.

impl Index<usize> for Mat3x8

type Output = Vec3x8

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Mat3x8

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

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

impl Mul<Mat3x8> for Mat3x8

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Mat3x8> for f32x8

type Output = Mat3x8

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3x8> for Mat3x8

type Output = Vec3x8

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32x8> for Mat3x8

type Output = Mat3x8

The resulting type after applying the * operator.

fn mul(self, rhs: f32x8) -> Mat3x8

Performs the * operation.