Struct glam::f32::Vec3A [−][src]
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
[src]
pub const ZERO: Self
[src]
All zeroes.
pub const ONE: Self
[src]
All ones.
pub const X: Self
[src]
[1, 0, 0]
: a unit-length vector pointing along the positive X axis.
pub const Y: Self
[src]
[0, 1, 0]
: a unit-length vector pointing along the positive Y axis.
pub const Z: Self
[src]
[0, 0, 1]
: a unit-length vector pointing along the positive Z axis.
pub fn new(x: f32, y: f32, z: f32) -> Self
[src]
Creates a new 3D vector.
pub const fn unit_x() -> Self
[src]
Use Vec3::X instead
Creates a vector with values [x: 1.0, y: 0.0, z: 0.0]
.
pub const fn unit_y() -> Self
[src]
Use Vec3::Y instead
Creates a vector with values [x: 0.0, y: 1.0, z: 0.0]
.
pub const fn unit_z() -> Self
[src]
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
[src]
Creates a 4D vector from self
and the given w
value.
pub fn truncate(self) -> Vec2
[src]
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
[src]
Computes the cross product of self
and other
.
pub const fn zero() -> Self
[src]
use ZERO constant instead
Creates a vector with all elements set to 0.0
.
pub const fn one() -> Self
[src]
use ONE constant instead
Creates a vector with all elements set to 1.0
.
pub fn splat(v: f32) -> Self
[src]
Creates a vector with all elements set to v
.
pub fn select(mask: BVec3A, if_true: Vec3A, if_false: Vec3A) -> Vec3A
[src]
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
[src]
Computes the dot product of self
and other
.
pub fn min(self, other: Self) -> Self
[src]
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
[src]
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 min_element(self) -> f32
[src]
Returns the horizontal minimum of self
.
In other words this computes min(x, y, ..)
.
pub fn max_element(self) -> f32
[src]
Returns the horizontal maximum of self
.
In other words this computes max(x, y, ..)
.
pub fn cmpeq(self, other: Self) -> BVec3A
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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])
[src]
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
[src]
Returns a vector containing the absolute value of each element of self
.
pub fn signum(self) -> Self
[src]
Returns a vector with elements representing the sign of self
.
1.0
if the number is positive,+0.0
orINFINITY
-1.0
if the number is negative,-0.0
orNEG_INFINITY
NAN
if the number isNAN
pub fn is_finite(self) -> bool
[src]
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
[src]
Returns true
if any elements are NaN
.
pub fn is_nan_mask(self) -> BVec3A
[src]
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
[src]
Computes the length of self
.
pub fn length_squared(self) -> f32
[src]
Computes the squared length of self
.
This is faster than length()
as it avoids a square root operation.
pub fn length_recip(self) -> f32
[src]
Computes 1.0 / length()
.
For valid results, self
must not be of length zero.
pub fn distance(self, other: Self) -> f32
[src]
Computes the Euclidean distance between two points in space.
pub fn distance_squared(self, other: Self) -> f32
[src]
Compute the squared euclidean distance between two points in space.
pub fn normalize(self) -> Self
[src]
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>
[src]
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
[src]
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
[src]
Returns whether self
is length 1.0
or not.
Uses a precision threshold of 1e-6
.
pub fn round(self) -> Self
[src]
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
[src]
Returns a vector containing the largest integer less than or equal to a number for each
element of self
.
pub fn ceil(self) -> Self
[src]
Returns a vector containing the smallest integer greater than or equal to a number for
each element of self
.
pub fn exp(self) -> Self
[src]
Returns a vector containing e^self
(the exponential function) for each element of
self
.
pub fn powf(self, n: f32) -> Self
[src]
Returns a vector containing each element of self
raised to the power of n
.
pub fn recip(self) -> Self
[src]
Returns a vector containing the reciprocal 1.0/n
of each element of self
.
pub fn lerp(self, other: Self, s: f32) -> Self
[src]
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
[src]
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
[src]
Returns a vector with a length no less than min
and no more than max
pub fn clamp_length_max(self, max: f32) -> Self
[src]
Returns a vector with a length no more than max
pub fn clamp_length_min(self, min: f32) -> Self
[src]
Returns a vector with a length no less than min
pub fn angle_between(self, other: Self) -> f32
[src]
Returns the angle between two vectors, in radians.
The input vectors do not need to be unit length however they must be non-zero.
pub fn any_orthogonal_vector(&self) -> Self
[src]
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
[src]
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)
[src]
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
[src]
Casts all elements of self
to f64
.
pub fn as_i32(&self) -> IVec3
[src]
Casts all elements of self
to i32
.
pub fn as_u32(&self) -> UVec3
[src]
Casts all elements of self
to u32
.
Trait Implementations
impl Add<Vec3A> for Vec3A
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, other: Self) -> Self
[src]
impl AddAssign<Vec3A> for Vec3A
[src]
fn add_assign(&mut self, other: Self)
[src]
impl AsMut<[f32; 3]> for Vec3A
[src]
impl AsRef<[f32; 3]> for Vec3A
[src]
impl Clone for Vec3A
[src]
impl Copy for Vec3A
[src]
impl Debug for Vec3A
[src]
impl Default for Vec3A
[src]
impl Deref for Vec3A
[src]
impl DerefMut for Vec3A
[src]
impl Display for Vec3A
[src]
impl Div<Vec3A> for Vec3A
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, other: Vec3A) -> Self
[src]
impl Div<f32> for Vec3A
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, other: f32) -> Self
[src]
impl DivAssign<Vec3A> for Vec3A
[src]
fn div_assign(&mut self, other: Vec3A)
[src]
impl DivAssign<f32> for Vec3A
[src]
fn div_assign(&mut self, other: f32)
[src]
impl From<[f32; 3]> for Vec3A
[src]
impl From<(Vec2, f32)> for Vec3A
[src]
impl From<(f32, f32, f32)> for Vec3A
[src]
impl From<Vec3> for Vec3A
[src]
impl From<Vec3A> for Vec2
[src]
impl From<Vec3A> for Vec3
[src]
impl From<Vec4> for Vec3A
[src]
fn from(v: Vec4) -> Self
[src]
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
[src]
impl Index<usize> for Vec3A
[src]
type Output = f32
The returned type after indexing.
fn index(&self, index: usize) -> &Self::Output
[src]
impl IndexMut<usize> for Vec3A
[src]
impl Mul<Vec3A> for Mat3
[src]
type Output = Vec3A
The resulting type after applying the *
operator.
fn mul(self, other: Vec3A) -> Vec3A
[src]
impl Mul<Vec3A> for Quat
[src]
type Output = Vec3A
The resulting type after applying the *
operator.
fn mul(self, other: Vec3A) -> Self::Output
[src]
impl Mul<Vec3A> for Vec3A
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, other: Vec3A) -> Self
[src]
impl Mul<f32> for Vec3A
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, other: f32) -> Self
[src]
impl MulAssign<Vec3A> for Vec3A
[src]
fn mul_assign(&mut self, other: Vec3A)
[src]
impl MulAssign<f32> for Vec3A
[src]
fn mul_assign(&mut self, other: f32)
[src]
impl Neg for Vec3A
[src]
impl PartialEq<Vec3A> for Vec3A
[src]
impl PartialOrd<Vec3A> for Vec3A
[src]
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a> Product<&'a Vec3A> for Vec3A
[src]
impl Sub<Vec3A> for Vec3A
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, other: Vec3A) -> Self
[src]
impl SubAssign<Vec3A> for Vec3A
[src]
fn sub_assign(&mut self, other: Vec3A)
[src]
impl<'a> Sum<&'a Vec3A> for Vec3A
[src]
impl Vec3Swizzles for Vec3A
[src]
type Vec2 = Vec2
type Vec4 = Vec4
fn xxxx(self) -> Vec4
[src]
fn xxxy(self) -> Vec4
[src]
fn xxxz(self) -> Vec4
[src]
fn xxyx(self) -> Vec4
[src]
fn xxyy(self) -> Vec4
[src]
fn xxyz(self) -> Vec4
[src]
fn xxzx(self) -> Vec4
[src]
fn xxzy(self) -> Vec4
[src]
fn xxzz(self) -> Vec4
[src]
fn xyxx(self) -> Vec4
[src]
fn xyxy(self) -> Vec4
[src]
fn xyxz(self) -> Vec4
[src]
fn xyyx(self) -> Vec4
[src]
fn xyyy(self) -> Vec4
[src]
fn xyyz(self) -> Vec4
[src]
fn xyzx(self) -> Vec4
[src]
fn xyzy(self) -> Vec4
[src]
fn xyzz(self) -> Vec4
[src]
fn xzxx(self) -> Vec4
[src]
fn xzxy(self) -> Vec4
[src]
fn xzxz(self) -> Vec4
[src]
fn xzyx(self) -> Vec4
[src]
fn xzyy(self) -> Vec4
[src]
fn xzyz(self) -> Vec4
[src]
fn xzzx(self) -> Vec4
[src]
fn xzzy(self) -> Vec4
[src]
fn xzzz(self) -> Vec4
[src]
fn yxxx(self) -> Vec4
[src]
fn yxxy(self) -> Vec4
[src]
fn yxxz(self) -> Vec4
[src]
fn yxyx(self) -> Vec4
[src]
fn yxyy(self) -> Vec4
[src]
fn yxyz(self) -> Vec4
[src]
fn yxzx(self) -> Vec4
[src]
fn yxzy(self) -> Vec4
[src]
fn yxzz(self) -> Vec4
[src]
fn yyxx(self) -> Vec4
[src]
fn yyxy(self) -> Vec4
[src]
fn yyxz(self) -> Vec4
[src]
fn yyyx(self) -> Vec4
[src]
fn yyyy(self) -> Vec4
[src]
fn yyyz(self) -> Vec4
[src]
fn yyzx(self) -> Vec4
[src]
fn yyzy(self) -> Vec4
[src]
fn yyzz(self) -> Vec4
[src]
fn yzxx(self) -> Vec4
[src]
fn yzxy(self) -> Vec4
[src]
fn yzxz(self) -> Vec4
[src]
fn yzyx(self) -> Vec4
[src]
fn yzyy(self) -> Vec4
[src]
fn yzyz(self) -> Vec4
[src]
fn yzzx(self) -> Vec4
[src]
fn yzzy(self) -> Vec4
[src]
fn yzzz(self) -> Vec4
[src]
fn zxxx(self) -> Vec4
[src]
fn zxxy(self) -> Vec4
[src]
fn zxxz(self) -> Vec4
[src]
fn zxyx(self) -> Vec4
[src]
fn zxyy(self) -> Vec4
[src]
fn zxyz(self) -> Vec4
[src]
fn zxzx(self) -> Vec4
[src]
fn zxzy(self) -> Vec4
[src]
fn zxzz(self) -> Vec4
[src]
fn zyxx(self) -> Vec4
[src]
fn zyxy(self) -> Vec4
[src]
fn zyxz(self) -> Vec4
[src]
fn zyyx(self) -> Vec4
[src]
fn zyyy(self) -> Vec4
[src]
fn zyyz(self) -> Vec4
[src]
fn zyzx(self) -> Vec4
[src]
fn zyzy(self) -> Vec4
[src]
fn zyzz(self) -> Vec4
[src]
fn zzxx(self) -> Vec4
[src]
fn zzxy(self) -> Vec4
[src]
fn zzxz(self) -> Vec4
[src]
fn zzyx(self) -> Vec4
[src]
fn zzyy(self) -> Vec4
[src]
fn zzyz(self) -> Vec4
[src]
fn zzzx(self) -> Vec4
[src]
fn zzzy(self) -> Vec4
[src]
fn zzzz(self) -> Vec4
[src]
fn xxx(self) -> Self
[src]
fn xxy(self) -> Self
[src]
fn xxz(self) -> Self
[src]
fn xyx(self) -> Self
[src]
fn xyy(self) -> Self
[src]
fn xzx(self) -> Self
[src]
fn xzy(self) -> Self
[src]
fn xzz(self) -> Self
[src]
fn yxx(self) -> Self
[src]
fn yxy(self) -> Self
[src]
fn yxz(self) -> Self
[src]
fn yyx(self) -> Self
[src]
fn yyy(self) -> Self
[src]
fn yyz(self) -> Self
[src]
fn yzx(self) -> Self
[src]
fn yzy(self) -> Self
[src]
fn yzz(self) -> Self
[src]
fn zxx(self) -> Self
[src]
fn zxy(self) -> Self
[src]
fn zxz(self) -> Self
[src]
fn zyx(self) -> Self
[src]
fn zyy(self) -> Self
[src]
fn zyz(self) -> Self
[src]
fn zzx(self) -> Self
[src]
fn zzy(self) -> Self
[src]
fn zzz(self) -> Self
[src]
fn xx(self) -> Vec2
[src]
fn xy(self) -> Vec2
[src]
fn xz(self) -> Vec2
[src]
fn yx(self) -> Vec2
[src]
fn yy(self) -> Vec2
[src]
fn yz(self) -> Vec2
[src]
fn zx(self) -> Vec2
[src]
fn zy(self) -> Vec2
[src]
fn zz(self) -> Vec2
[src]
Auto Trait Implementations
impl RefUnwindSafe for Vec3A
impl Send for Vec3A
impl Sync for Vec3A
impl Unpin for Vec3A
impl UnwindSafe for Vec3A
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,