Struct Vector4

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

An owning representation of a 4-component Euclidean vector.

Like Vec4, the Vector4 object represents a Euclidean vector in 4D. Unlike the Vec4, this is an owning representation that stores the actual content of the vector.

Fields

x: f32

The X-component of the vector.

y: f32

The Y-component of the vector.

z: f32

The Z-component of the vector.

w: f32

The W-component of the vector.

Implementations

impl Vector4

pub const ZERO: Vector4 = _

A constant for a Null vector, which has magnitude 0 and exists at the origin.

pub const UNIT_X: Vector4 = _

A constant for a unit vector in the positive X-direction.

pub const UNIT_Y: Vector4 = _

A constant for a unit vector in the positive Y-direction.

pub const UNIT_Z: Vector4 = _

A constant for a unit vector in the positive Z-direction.

pub const UNIT_W: Vector4 = _

A constant for a unit vector in the positive W-direction.

pub const NEG_UNIT_X: Vector4 = _

A constant for a unit vector in the negative X-direction.

pub const NEG_UNIT_Y: Vector4 = _

A constant for a unit vector in the negative Y-direction.

pub const NEG_UNIT_Z: Vector4 = _

A constant for a unit vector in the negative Z-direction.

pub const NEG_UNIT_W: Vector4 = _

A constant for a unit vector in the negative W-direction.

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

Constructs this vector from an x, y, z, and w coordinate.

Parameters

• x - the x-component
• y - the y-component
• z - the z-component
• w - the w-component

pub const fn uniform(v: f32) -> Self

Constructs this vector with a uniform value v.

Parameters

• v - the value to uniformly apply

pub const fn from_array(array: &[f32; 4]) -> Self

Constructs this vector from a 4-component f32 array.

Parameters

• array - an array containing 4 f32 values.

pub const fn from_slice(slice: &[f32]) -> Result<Self, VecError>

Constructs this vector from a slice of floats.

This will return VecError if slice.len() is not equal to 2.

Parameters

• slice - the slice to read from

pub const unsafe fn from_slice_unchecked(slice: &[f32]) -> Self

Constructs this vector from a slice of floats.

Parameters

• slice - the slice to read from

Safety

slice.len() must be greater or equal to 2, otherwise this will access an out-of-bounds entry and panic.

pub const fn from_vec4(other: &Vec4) -> Self

Constructs this vector from a Vec4

Parameters

• other - the other vector

pub fn from_vec4i(other: &Vec4i) -> Self

Constructs this vector from a Vec4i

Parameters

• other - the other vector

pub fn from_vec4u(other: &Vec4u) -> Self

Constructs this vector from a Vec4u

Parameters

• other - the other vector

pub const unsafe fn from_ptr(ptr: *const f32) -> Self

Constructs this vector from a pointer to floating point values.

Parameters

• ptr - the pointer to the start of a contiguous sequence of floats

Safety

This function requires that ptr be non-null and point to the start of a contiguous sequence of 4 f32 values.

impl Vector4

pub const fn as_vec4(&self) -> &Vec4

Returns this vector as a Vec4.

Unlike the implicit Deref, this function is const and can be used in constant expressions.

pub fn as_mut_vec4(&mut self) -> &mut Vec4

Returns this vector as a mutable Vec4.

pub const fn as_slice(&self) -> &[f32]

Returns this vector as a slice of f32.

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

Returns this vector as a mutable slice of f32.

Methods from Deref<Target = Vec4>

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

Returns this Vec4 as a slice of f32.

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

Returns this Vec4 as a mutable slice of f32.

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

Returns this vector as a ptr of f32.

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

Returns this vector as a mutable ptr of f32.

pub fn iter(&self) -> impl Iterator<Item = &f32>

Returns an iterator over the vector.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut f32>

Returns a mutable iterator over the vector.

pub fn x(&self) -> f32

Returns the X-coordinate of this 4-component vector.

pub fn y(&self) -> f32

Returns the Y-coordinate of this 4-component vector.

pub fn z(&self) -> f32

Returns the Z-coordinate of this 4-component vector.

pub fn w(&self) -> f32

Returns the W-coordinate of this 4-component vector.

pub fn xy(&self) -> &Vec2

Returns the xy coordinates of this vector as a Vec2.

pub fn yz(&self) -> &Vec2

Returns the yz coordinates of this vector as a Vec2.

pub fn zw(&self) -> &Vec2

Returns the zw coordinates of this vector as a Vec2.

pub fn xyz(&self) -> &Vec3

Returns the xyz coordinates of this vector as a Vec2.

pub fn yzw(&self) -> &Vec3

Returns the yz coordinates of this vector as a Vec2.

pub fn x_mut(&mut self) -> &mut f32

Returns a mutable reference to the X-coordinate of this 3-component vector.

pub fn y_mut(&mut self) -> &mut f32

Returns a mutable reference to the Y-coordinate of this 3-component vector.

pub fn z_mut(&mut self) -> &mut f32

Returns a mutable reference to the Z-coordinate of this 3-component vector.

pub fn w_mut(&mut self) -> &mut f32

Returns a mutable reference to the W-coordinate of this 3-component vector.

pub fn xy_mut(&mut self) -> &mut Vec2

Returns a mutable reference to the xy coordinates of this vector.

pub fn yz_mut(&mut self) -> &mut Vec2

Returns a mutable reference to the yz coordinates of this vector.

pub fn zw_mut(&mut self) -> &mut Vec2

Returns a mutable reference to the zw coordinates of this vector.

pub fn xyz_mut(&mut self) -> &mut Vec3

Returns a mutable reference to the yz coordinates of this vector.

pub fn yzw_mut(&mut self) -> &mut Vec3

Returns a mutable reference to the zw coordinates of this vector.

pub fn square_magnitude(&self) -> f32

Computes the square magnitude of this two-component vector.

pub fn magnitude(&self) -> f32

Computes the magnitude of this vector.

Where possible, consider using Vec4::square_magnitude as this will avoid the need to compute the square-root.

pub fn is_normalized(&self) -> bool

Queries whether this vector is normalized (e.g. has a magnitude of 1).

pub fn normalize(&mut self)

Normalizes this vector.

pub fn normalized(&self) -> Vector4

Returns normalized vector.

pub fn is_finite(&self) -> bool

Returns whether all components of this Vec are finite.

Example

Basic use:

let finite = Vector4::UNIT_X;
let not_finite = Vector4::new(f32::INFINITY, 3.0, 0.0, -1.0);

assert!(finite.is_finite());
assert!(!not_finite.is_finite());

pub fn is_infinite(&self) -> bool

Returns whether any component of this vec are infinite.

This is the inverse operation of is_finite.

Example

Basic use:

let finite = Vector4::UNIT_X;
let not_finite = Vector4::new(f32::INFINITY, 3.0, 0.0, -1.0);

assert!(!finite.is_infinite());
assert!(not_finite.is_infinite());

pub fn is_nan(&self) -> bool

Returns whether any component of this vec are nan.

pub fn abs(&self) -> Vector4

Computes the absolute value of self

pub fn min(&self, rhs: &Vec4) -> Vector4

Computes the minimum of each vector.

Parameters

• lhs - the left vector
• rhs - the right vector

pub fn max(&self, rhs: &Vec4) -> Vector4

Computes the maximum of each vector.

Parameters

• lhs - the left vector
• rhs - the right vector

pub fn set_x(&mut self, x: f32)

Sets the x-component

Parameters

• x - the X-component

pub fn set_y(&mut self, y: f32)

Sets the y-component

Parameters

• y - the Y-component

pub fn set_z(&mut self, z: f32)

Sets the z-component

Parameters

• z - theZ-component

pub fn set_w(&mut self, w: f32)

Sets the w-component

Parameters

• w - the W-component

pub fn set_xy(&mut self, xy: &Vec2)

Sets the X and Y components of this vector

Parameters

• xy - the X and Y components of the Vec4

pub fn set_yz(&mut self, yz: &Vec2)

Sets the Y and Z components of this vector

Parameters

• yz - the Y and Z components of the Vec4

pub fn set_zw(&mut self, zw: &Vec2)

Sets the Z and W components of this vector

Parameters

• zw - the Z and W components of the Vec4

pub fn set_xyz(&mut self, xyz: &Vec3)

Sets the X, Y, and Z components of this vector

Parameters

• xyz - the X, Y, and Z components of the Vec4`

pub fn set_yzw(&mut self, yzw: &Vec3)

Sets the Y, Z and W components of this vector

Parameters

• yzw - the Y, Z, and W components of the Vec4

pub fn set(&mut self, other: &Vec4)

Sets all the components of this vector the values from other.

Parameters

• other - the other Vec3 to set.

Trait Implementations

impl Add<&Vec4> for &Vector4

type Output = Vector4

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Vec4> for Vector4

type Output = Vector4

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Vector4> for &Vec4

type Output = Vector4

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Vector4> for Vector4

type Output = Vector4

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vector4> for &Vec4

type Output = Vector4

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vector4> for &Vector4

type Output = Vector4

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for &Vector4

type Output = Vector4

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Vector4

type Output = Vector4

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&Vec4> for Vector4

fn add_assign(&mut self, rhs: &Vec4)

Performs the += operation.

impl AddAssign<&Vector4> for Vec4

fn add_assign(&mut self, rhs: &Vector4)

Performs the += operation.

impl AddAssign<&Vector4> for Vector4

fn add_assign(&mut self, rhs: &Self)

Performs the += operation.

impl AddAssign<Vector4> for Vec4

fn add_assign(&mut self, rhs: Vector4)

Performs the += operation.

impl AddAssign for Vector4

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AsMut<Vec4> for Vector4

fn as_mut(&mut self) -> &mut Vec4

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Vec4> for Vector4

fn as_ref(&self) -> &Vec4

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Vec4> for Vector4

fn borrow(&self) -> &Vec4

Immutably borrows from an owned value.

impl BorrowMut<Vec4> for Vector4

fn borrow_mut(&mut self) -> &mut Vec4

Mutably borrows from an owned value.

impl Clone for Vector4

fn clone(&self) -> Vector4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector4

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

Formats the value using the given formatter.

impl Default for Vector4

fn default() -> Vector4

Returns the “default value” for a type.

impl Deref for Vector4

type Target = Vec4

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Vector4

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Vector4

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

Formats the value using the given formatter.

impl Div<f32> for &Vector4

type Output = Vector4

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Vector4

type Output = Vector4

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vector4

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<&Vec4> for Vector4

fn from(value: &Vec4) -> Self

Converts to this type from the input type.

impl From<&Vec4i> for Vector4

fn from(value: &Vec4i) -> Self

Converts to this type from the input type.

impl From<&Vec4u> for Vector4

fn from(value: &Vec4u) -> Self

Converts to this type from the input type.

impl From<Vector4> for Quaternion

fn from(vec: Vector4) -> Self

Converts to this type from the input type.

impl Lerp<Vec4> for Vector4

type Output = Vector4

The output of this operation.

fn lerp(&self, rhs: &Vec4, alpha: f32) -> Self::Output

Interpolates between two different states

impl Lerp<Vector4> for Vec4

type Output = Vector4

The output of this operation.

fn lerp(&self, rhs: &Vector4, alpha: f32) -> Self::Output

Interpolates between two different states

impl Lerp for Vector4

type Output = Vector4

The output of this operation.

fn lerp(&self, rhs: &Self, alpha: f32) -> Self::Output

Interpolates between two different states

impl Mul<&Vector4> for f32

type Output = Vector4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector4> for f32

type Output = Vector4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for &Vector4

type Output = Vector4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vector4

type Output = Vector4

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vector4

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl PartialEq for Vector4

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Vector4

fn partial_cmp(&self, other: &Vector4) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem<f32> for &Vector4

type Output = Vector4

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<f32> for Vector4

type Output = Vector4

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<f32> for Vector4

fn rem_assign(&mut self, rhs: f32)

Performs the %= operation.

impl Sub<&Vec4> for &Vector4

type Output = Vector4

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Vec4> for Vector4

type Output = Vector4

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Vector4> for &Vec4

type Output = Vector4

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Vector4> for Vector4

type Output = Vector4

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vector4> for &Vec4

type Output = Vector4

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vector4> for &Vector4

type Output = Vector4

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for &Vector4

type Output = Vector4

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Vector4

type Output = Vector4

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&Vec4> for Vector4

fn sub_assign(&mut self, rhs: &Vec4)

Performs the -= operation.

impl SubAssign<&Vector4> for Vec4

fn sub_assign(&mut self, rhs: &Vector4)

Performs the -= operation.

impl SubAssign<&Vector4> for Vector4

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation.

impl SubAssign<Vector4> for Vec4

fn sub_assign(&mut self, rhs: Vector4)

Performs the -= operation.

impl SubAssign for Vector4

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Vector4

impl StructuralPartialEq for Vector4