Struct glam::f32::Vec3A

#[repr(transparent)]pub struct Vec3A(_);

A 3-dimensional vector with SIMD support.

This type is 16 byte aligned. A SIMD vector type is used for storage on supported platforms for better performance than the Vec3 type.

It is possible to convert between Vec3 and Vec3A types using From trait implementations.

Implementations

impl Vec3A

pub const ZERO: Self

All zeroes.

pub const ONE: Self

All ones.

pub const X: Self

[1, 0, 0]: a unit-length vector pointing along the positive X axis.

pub const Y: Self

[0, 1, 0]: a unit-length vector pointing along the positive Y axis.

pub const Z: Self

[0, 0, 1]: a unit-length vector pointing along the positive Z axis.

pub const AXES: [Self; 3]

The unit axes.

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

Creates a new 3D vector.

pub const fn unit_x() -> Self

👎 Deprecated:

Use Vec3::X instead

Creates a vector with values [x: 1.0, y: 0.0, z: 0.0].

pub const fn unit_y() -> Self

👎 Deprecated:

Use Vec3::Y instead

Creates a vector with values [x: 0.0, y: 1.0, z: 0.0].

pub const fn unit_z() -> Self

👎 Deprecated:

Use Vec3::Z instead

Creates a vector with values [x: 0.0, y: 0.0, z: 1.0].

pub fn extend(self, w: f32) -> Vec4

Creates a 4D vector from self and the given w value.

pub fn truncate(self) -> Vec2

Creates a Vec2 from the x and y elements of self, discarding z.

Truncation may also be performed by using self.xy() or Vec2::from().

pub fn cross(self, other: Self) -> Self

Computes the cross product of self and other.

pub const fn zero() -> Self

👎 Deprecated:

use ZERO constant instead

Creates a vector with all elements set to 0.0.

pub const fn one() -> Self

👎 Deprecated:

use ONE constant instead

Creates a vector with all elements set to 1.0.

pub fn splat(v: f32) -> Self

Creates a vector with all elements set to v.

pub fn select(mask: BVec3A, if_true: Vec3A, if_false: Vec3A) -> Vec3A

Creates a vector from the elements in if_true and if_false, selecting which to use for each element of self.

A true element in the mask uses the corresponding element from if_true, and false uses the element from if_false.

pub fn dot(self, other: Self) -> f32

Computes the dot product of self and other.

pub fn min(self, other: Self) -> Self

Returns a vector containing the mininum values for each element of self and other.

In other words this computes [self.x.max(other.x), self.y.max(other.y), ..].

pub fn max(self, other: Self) -> Self

Returns a vector containing the maximum values for each element of self and other.

In other words this computes [self.x.max(other.x), self.y.max(other.y), ..].

pub fn clamp(self, min: Self, max: Self) -> Self

Component-wise clamping of values, similar to [std::f32::clamp].

Each element in min must be less-or-equal to the corresponing element in max.

If the glam-assert feature is enabled, the function will panic if the contract is not met, otherwise the behavior is undefined.

pub fn min_element(self) -> f32

Returns the horizontal minimum of self.

In other words this computes min(x, y, ..).

pub fn max_element(self) -> f32

Returns the horizontal maximum of self.

In other words this computes max(x, y, ..).

pub fn cmpeq(self, other: Self) -> BVec3A

Returns a vector mask containing the result of a == comparison for each element of self and other.

In other words, this computes [self.x == other.x, self.y == other.y, ..] for all elements.

pub fn cmpne(self, other: Self) -> BVec3A

Returns a vector mask containing the result of a != comparison for each element of self and other.

In other words this computes [self.x != other.x, self.y != other.y, ..] for all elements.

pub fn cmpge(self, other: Self) -> BVec3A

Returns a vector mask containing the result of a >= comparison for each element of self and other.

In other words this computes [self.x >= other.x, self.y >= other.y, ..] for all elements.

pub fn cmpgt(self, other: Self) -> BVec3A

Returns a vector mask containing the result of a > comparison for each element of self and other.

In other words this computes [self.x > other.x, self.y > other.y, ..] for all elements.

pub fn cmple(self, other: Self) -> BVec3A

Returns a vector mask containing the result of a <= comparison for each element of self and other.

In other words this computes [self.x <= other.x, self.y <= other.y, ..] for all elements.

pub fn cmplt(self, other: Self) -> BVec3A

Returns a vector mask containing the result of a < comparison for each element of self and other.

In other words this computes [self.x < other.x, self.y < other.y, ..] for all elements.

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

Creates a vector from the first N values in slice.

Panics

Panics if slice is less than N elements long.

pub fn write_to_slice_unaligned(self, slice: &mut [f32])

Writes the elements of self to the first N elements in slice.

Panics

Panics if slice is less than N elements long.

pub fn abs(self) -> Self

Returns a vector containing the absolute value of each element of self.

pub fn signum(self) -> Self

Returns a vector with elements representing the sign of self.

• 1.0 if the number is positive, +0.0 or INFINITY
• -1.0 if the number is negative, -0.0 or NEG_INFINITY
• NAN if the number is NAN

pub fn is_finite(self) -> bool

Returns true if, and only if, all elements are finite. If any element is either NaN, positive or negative infinity, this will return false.

pub fn is_nan(self) -> bool

Returns true if any elements are NaN.

pub fn is_nan_mask(self) -> BVec3A

Performs is_nan on each element of self, returning a vector mask of the results.

In other words, this computes [x.is_nan(), y.is_nan(), z.is_nan(), w.is_nan()].

pub fn length(self) -> f32

Computes the length of self.

pub fn length_squared(self) -> f32

Computes the squared length of self.

This is faster than length() as it avoids a square root operation.

pub fn length_recip(self) -> f32

Computes 1.0 / length().

For valid results, self must not be of length zero.

pub fn distance(self, other: Self) -> f32

Computes the Euclidean distance between two points in space.

pub fn distance_squared(self, other: Self) -> f32

Compute the squared euclidean distance between two points in space.

pub fn normalize(self) -> Self

Returns self normalized to length 1.0.

For valid results, self must not be of length zero, nor very close to zero.

See also Self::try_normalize and Self::normalize_or_zero.

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

Returns self normalized to length 1.0 if possible, else returns None.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be None.

See also Self::normalize_or_zero.

pub fn normalize_or_zero(self) -> Self

Returns self normalized to length 1.0 if possible, else returns zero.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be zero.

See also Self::try_normalize.

pub fn is_normalized(self) -> bool

Returns whether self is length 1.0 or not.

Uses a precision threshold of 1e-6.

pub fn round(self) -> Self

Returns a vector containing the nearest integer to a number for each element of self. Round half-way cases away from 0.0.

pub fn floor(self) -> Self

Returns a vector containing the largest integer less than or equal to a number for each element of self.

pub fn ceil(self) -> Self

Returns a vector containing the smallest integer greater than or equal to a number for each element of self.

pub fn exp(self) -> Self

Returns a vector containing e^self (the exponential function) for each element of self.

pub fn powf(self, n: f32) -> Self

Returns a vector containing each element of self raised to the power of n.

pub fn recip(self) -> Self

Returns a vector containing the reciprocal 1.0/n of each element of self.

pub fn lerp(self, other: Self, s: f32) -> Self

Performs a linear interpolation between self and other based on the value s.

When s is 0.0, the result will be equal to self. When s is 1.0, the result will be equal to other.

pub fn abs_diff_eq(self, other: Self, max_abs_diff: f32) -> bool

Returns true if the absolute difference of all elements between self and other is less than or equal to max_abs_diff.

This can be used to compare if two vectors contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more see comparing floating point numbers.

pub fn clamp_length(self, min: f32, max: f32) -> Self

Returns a vector with a length no less than min and no more than max

pub fn clamp_length_max(self, max: f32) -> Self

Returns a vector with a length no more than max

pub fn clamp_length_min(self, min: f32) -> Self

Returns a vector with a length no less than min

pub fn angle_between(self, other: Self) -> f32

Returns the angle (in radians) between two vectors.

The input vectors do not need to be unit length however they must be non-zero.

pub fn any_orthogonal_vector(&self) -> Self

Returns somes vector that is orthogonal to the given one.

The input vector must be finite and non-zero.

The output vector is not necessarily unit-length. For that use Self::any_orthonormal_vector instead.

pub fn any_orthonormal_vector(&self) -> Self

Returns any unit-length vector that is orthogonal to the given one. The input vector must be finite and non-zero.

pub fn any_orthonormal_pair(&self) -> (Self, Self)

Given a unit-length vector return two other vectors that together form an orthonormal basis. That is, all three vectors are orthogonal to each other and are normalized.

pub fn as_f64(&self) -> DVec3

Casts all elements of self to f64.

pub fn as_i32(&self) -> IVec3

Casts all elements of self to i32.

pub fn as_u32(&self) -> UVec3

Casts all elements of self to u32.

Trait Implementations

impl Add<Vec3A> for Vec3A

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign<Vec3A> for Vec3A

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AsMut<[f32; 3]> for Vec3A

fn as_mut(&mut self) -> &mut [f32; 3]

Performs the conversion.

impl AsRef<[f32; 3]> for Vec3A

fn as_ref(&self) -> &[f32; 3]

Performs the conversion.

impl Clone for Vec3A

fn clone(&self) -> Vec3A

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec3A

impl Debug for Vec3A

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

Formats the value using the given formatter.

impl Default for Vec3A

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Vec3A

type Target = XYZ<f32>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Vec3A

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

Mutably dereferences the value.

impl Display for Vec3A

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

Formats the value using the given formatter.

impl Div<Vec3A> for Vec3A

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Vec3A) -> Self

Performs the / operation.

impl Div<f32> for Vec3A

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: f32) -> Self

Performs the / operation.

impl DivAssign<Vec3A> for Vec3A

fn div_assign(&mut self, other: Vec3A)

Performs the /= operation.

impl DivAssign<f32> for Vec3A

fn div_assign(&mut self, other: f32)

Performs the /= operation.

impl From<[f32; 3]> for Vec3A

fn from(a: [f32; 3]) -> Self

Performs the conversion.

impl From<(Vec2, f32)> for Vec3A

fn from((v, z): (Vec2, f32)) -> Self

Performs the conversion.

impl From<(f32, f32, f32)> for Vec3A

fn from(t: (f32, f32, f32)) -> Self

Performs the conversion.

impl From<Vec3> for Vec3A

fn from(v: Vec3) -> Self

Performs the conversion.

impl From<Vec3A> for Vec2

fn from(v: Vec3A) -> Self

Creates a Vec2 from the x and y elements of self, discarding z.

impl From<Vec3A> for Vec3

fn from(v: Vec3A) -> Self

Performs the conversion.

impl From<Vec4> for Vec3A

fn from(v: Vec4) -> Self

Creates a Vec3A from the x, y and z elements of self discarding w.

On architectures where SIMD is supported such as SSE2 on x86_64 this conversion is a noop.

impl From<__m128> for Vec3A

fn from(t: __m128) -> Self

Performs the conversion.

impl Index<usize> for Vec3A

type Output = f32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec3A

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

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

impl Mul<Vec3A> for Mat3

type Output = Vec3A

The resulting type after applying the * operator.

fn mul(self, other: Vec3A) -> Vec3A

Performs the * operation.

impl Mul<Vec3A> for Quat

type Output = Vec3A

The resulting type after applying the * operator.

fn mul(self, other: Vec3A) -> Self::Output

Performs the * operation.

impl Mul<Vec3A> for Vec3A

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Vec3A) -> Self

Performs the * operation.

impl Mul<f32> for Vec3A

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: f32) -> Self

Performs the * operation.

impl MulAssign<Vec3A> for Vec3A

fn mul_assign(&mut self, other: Vec3A)

Performs the *= operation.

impl MulAssign<f32> for Vec3A

fn mul_assign(&mut self, other: f32)

Performs the *= operation.

impl Neg for Vec3A

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<Vec3A> for Vec3A

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Vec3A> for Vec3A

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<'a> Product<&'a Vec3A> for Vec3A

fn product<I>(iter: I) -> Self where
    I: Iterator<Item = &'a Self>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Sub<Vec3A> for Vec3A

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Vec3A) -> Self

Performs the - operation.

impl SubAssign<Vec3A> for Vec3A

fn sub_assign(&mut self, other: Vec3A)

Performs the -= operation.

impl<'a> Sum<&'a Vec3A> for Vec3A

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = &'a Self>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Vec3Swizzles for Vec3A

type Vec2 = Vec2

type Vec4 = Vec4

fn xxxx(self) -> Vec4

fn xxxy(self) -> Vec4

fn xxxz(self) -> Vec4

fn xxyx(self) -> Vec4

fn xxyy(self) -> Vec4

fn xxyz(self) -> Vec4

fn xxzx(self) -> Vec4

fn xxzy(self) -> Vec4

fn xxzz(self) -> Vec4

fn xyxx(self) -> Vec4

fn xyxy(self) -> Vec4

fn xyxz(self) -> Vec4

fn xyyx(self) -> Vec4

fn xyyy(self) -> Vec4

fn xyyz(self) -> Vec4

fn xyzx(self) -> Vec4

fn xyzy(self) -> Vec4

fn xyzz(self) -> Vec4

fn xzxx(self) -> Vec4

fn xzxy(self) -> Vec4

fn xzxz(self) -> Vec4

fn xzyx(self) -> Vec4

fn xzyy(self) -> Vec4

fn xzyz(self) -> Vec4

fn xzzx(self) -> Vec4

fn xzzy(self) -> Vec4

fn xzzz(self) -> Vec4

fn yxxx(self) -> Vec4

fn yxxy(self) -> Vec4

fn yxxz(self) -> Vec4

fn yxyx(self) -> Vec4

fn yxyy(self) -> Vec4

fn yxyz(self) -> Vec4

fn yxzx(self) -> Vec4

fn yxzy(self) -> Vec4

fn yxzz(self) -> Vec4

fn yyxx(self) -> Vec4

fn yyxy(self) -> Vec4

fn yyxz(self) -> Vec4

fn yyyx(self) -> Vec4

fn yyyy(self) -> Vec4

fn yyyz(self) -> Vec4

fn yyzx(self) -> Vec4

fn yyzy(self) -> Vec4

fn yyzz(self) -> Vec4

fn yzxx(self) -> Vec4

fn yzxy(self) -> Vec4

fn yzxz(self) -> Vec4

fn yzyx(self) -> Vec4

fn yzyy(self) -> Vec4

fn yzyz(self) -> Vec4

fn yzzx(self) -> Vec4

fn yzzy(self) -> Vec4

fn yzzz(self) -> Vec4

fn zxxx(self) -> Vec4

fn zxxy(self) -> Vec4

fn zxxz(self) -> Vec4

fn zxyx(self) -> Vec4

fn zxyy(self) -> Vec4

fn zxyz(self) -> Vec4

fn zxzx(self) -> Vec4

fn zxzy(self) -> Vec4

fn zxzz(self) -> Vec4

fn zyxx(self) -> Vec4

fn zyxy(self) -> Vec4

fn zyxz(self) -> Vec4

fn zyyx(self) -> Vec4

fn zyyy(self) -> Vec4

fn zyyz(self) -> Vec4

fn zyzx(self) -> Vec4

fn zyzy(self) -> Vec4

fn zyzz(self) -> Vec4

fn zzxx(self) -> Vec4

fn zzxy(self) -> Vec4

fn zzxz(self) -> Vec4

fn zzyx(self) -> Vec4

fn zzyy(self) -> Vec4

fn zzyz(self) -> Vec4

fn zzzx(self) -> Vec4

fn zzzy(self) -> Vec4

fn zzzz(self) -> Vec4

fn xxx(self) -> Self

fn xxy(self) -> Self

fn xxz(self) -> Self

fn xyx(self) -> Self

fn xyy(self) -> Self

fn xzx(self) -> Self

fn xzy(self) -> Self

fn xzz(self) -> Self

fn yxx(self) -> Self

fn yxy(self) -> Self

fn yxz(self) -> Self

fn yyx(self) -> Self

fn yyy(self) -> Self

fn yyz(self) -> Self

fn yzx(self) -> Self

fn yzy(self) -> Self

fn yzz(self) -> Self

fn zxx(self) -> Self

fn zxy(self) -> Self

fn zxz(self) -> Self

fn zyx(self) -> Self

fn zyy(self) -> Self

fn zyz(self) -> Self

fn zzx(self) -> Self

fn zzy(self) -> Self

fn zzz(self) -> Self

fn xx(self) -> Vec2

fn xy(self) -> Vec2

fn xz(self) -> Vec2

fn yx(self) -> Vec2

fn yy(self) -> Vec2

fn yz(self) -> Vec2

fn zx(self) -> Vec2

fn zy(self) -> Vec2

fn zz(self) -> Vec2

fn xyz(self) -> Self