[−][src]Struct glam::Vec3A
A 3-dimensional vector with SIMD support.
This type uses 16 byte aligned SIMD vector4 types 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 fn new(x: f32, y: f32, z: f32) -> Self
[src]
Creates a new Vec3A
.
pub const fn zero() -> Self
[src]
Creates a Vec3A
with all elements set to 0.0
.
pub const fn one() -> Self
[src]
Creates a Vec3A
with all elements set to 1.0
.
pub const fn unit_x() -> Self
[src]
Creates a Vec3A
with values [x: 1.0, y: 0.0, z: 0.0]
.
pub const fn unit_y() -> Self
[src]
Creates a Vec3A
with values [x: 0.0, y: 1.0, z: 0.0]
.
pub const fn unit_z() -> Self
[src]
Creates a Vec3A
with values [x: 0.0, y: 0.0, z: 1.0]
.
pub fn splat(v: f32) -> Self
[src]
Creates a Vec3A
with all elements set to v
.
pub fn extend(self, w: f32) -> Vec4
[src]
Creates a Vec4
from self
and the given w
value.
pub fn truncate(self) -> Vec2
[src]
Creates a Vec2
from the first three elements of self
,
removing z
.
pub fn x(self) -> f32
[src]
Returns element x
.
pub fn y(self) -> f32
[src]
Returns element y
.
pub fn z(self) -> f32
[src]
Returns element z
.
pub fn x_mut(&mut self) -> &mut f32
[src]
Returns a mutable reference to element x
.
pub fn y_mut(&mut self) -> &mut f32
[src]
Returns a mutable reference to element y
.
pub fn z_mut(&mut self) -> &mut f32
[src]
Returns a mutable reference to element z
.
pub fn set_x(&mut self, x: f32)
[src]
Sets element x
.
pub fn set_y(&mut self, y: f32)
[src]
Sets element y
.
pub fn set_z(&mut self, z: f32)
[src]
Sets element z
.
pub fn dot(self, other: Self) -> f32
[src]
Computes the dot product of self
and other
.
pub fn cross(self, other: Self) -> Self
[src]
Computes the cross product of self
and other
.
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 generally faster than Vec3A::length()
as it avoids a square
root operation.
pub fn length_reciprocal(self) -> f32
[src]
please use Vec3A::length_recip
instead
pub fn length_recip(self) -> f32
[src]
Computes 1.0 / Vec3A::length()
.
For valid results, self
must not be of length zero.
pub fn normalize(self) -> Self
[src]
Returns self
normalized to length 1.0.
For valid results, self
must not be of length zero.
pub fn min(self, other: Self) -> Self
[src]
Returns the vertical minimum of self
and other
.
In other words, this computes
[x: min(x1, x2), y: min(y1, y2), z: min(z1, z2)]
,
taking the minimum of each element individually.
pub fn max(self, other: Self) -> Self
[src]
Returns the vertical maximum of self
and other
.
In other words, this computes
[x: max(x1, x2), y: max(y1, y2), z: max(z1, z2)]
,
taking the maximum of each element individually.
pub fn min_element(self) -> f32
[src]
Returns the horizontal minimum of self
's elements.
In other words, this computes min(x, y, z)
.
pub fn max_element(self) -> f32
[src]
Returns the horizontal maximum of self
's elements.
In other words, this computes max(x, y, z)
.
pub fn cmpeq(self, other: Self) -> Vec3AMask
[src]
Performs a vertical ==
comparison between self
and other
,
returning a Vec3AMask
of the results.
In other words, this computes [x1 == x2, y1 == y2, z1 == z2, w1 == w2]
.
pub fn cmpne(self, other: Self) -> Vec3AMask
[src]
Performs a vertical !=
comparison between self
and other
,
returning a Vec3AMask
of the results.
In other words, this computes [x1 != x2, y1 != y2, z1 != z2, w1 != w2]
.
pub fn cmpge(self, other: Self) -> Vec3AMask
[src]
Performs a vertical >=
comparison between self
and other
,
returning a Vec3AMask
of the results.
In other words, this computes [x1 >= x2, y1 >= y2, z1 >= z2, w1 >= w2]
.
pub fn cmpgt(self, other: Self) -> Vec3AMask
[src]
Performs a vertical >
comparison between self
and other
,
returning a Vec3AMask
of the results.
In other words, this computes [x1 > x2, y1 > y2, z1 > z2, w1 > w2]
.
pub fn cmple(self, other: Self) -> Vec3AMask
[src]
Performs a vertical <=
comparison between self
and other
,
returning a Vec3AMask
of the results.
In other words, this computes [x1 <= x2, y1 <= y2, z1 <= z2, w1 <= w2]
.
pub fn cmplt(self, other: Self) -> Vec3AMask
[src]
Performs a vertical <
comparison between self
and other
,
returning a Vec3AMask
of the results.
In other words, this computes [x1 < x2, y1 < y2, z1 < z2, w1 < w2]
.
pub fn from_slice_unaligned(slice: &[f32]) -> Self
[src]
Creates a Vec3A
from the first four values in slice
.
Panics
Panics if slice
is less than three elements long.
pub fn write_to_slice_unaligned(self, slice: &mut [f32])
[src]
Writes the elements of self
to the first three elements in slice
.
Panics
Panics if slice
is less than three elements long.
pub fn abs(self) -> Self
[src]
Returns a Vec3A
containing the absolute value of each element of self
.
pub fn round(self) -> Self
[src]
Returns a Vec3A
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 Vec3A
containing the largest integer less than or equal to a number for each
element of self
.
pub fn ceil(self) -> Self
[src]
Returns a Vec3A
containing the smallest integer greater than or equal to a number for each
element of self
.
pub fn is_nan(self) -> Vec3AMask
[src]
Performs is_nan()
on each element of self, returning a Vec3AMask
of the results.
In other words, this computes [x.is_nan(), y.is_nan(), z.is_nan()]
.
pub fn sign(self) -> Self
[src]
please use Vec3A::signum
instead
pub fn signum(self) -> Self
[src]
Returns a Vec3A
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 reciprocal(self) -> Self
[src]
please use Vec3A::recip
instead
pub fn recip(self) -> Self
[src]
Returns a Vec3A
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 is_normalized(self) -> bool
[src]
Returns whether self
of length 1.0
or not.
Uses a precision threshold of 1e-6
.
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 Vec3A
's 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 on floating point comparisons see https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/
pub fn angle_between(self, other: Self) -> f32
[src]
Returns the angle between two vectors, in radians.
The vectors do not need to be unit length, but this function does
perform a sqrt
.
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 Display for Vec3A
[src]
impl Div<Vec3A> for Vec3A
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, other: Self) -> Self
[src]
impl Div<Vec3A> for f32
[src]
type Output = Vec3A
The resulting type after applying the /
operator.
fn div(self, other: Vec3A) -> Vec3A
[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: Self)
[src]
impl DivAssign<f32> for Vec3A
[src]
fn div_assign(&mut self, other: f32)
[src]
impl From<[f32; 3]> for Vec3A
[src]
impl From<(f32, f32, f32)> for Vec3A
[src]
impl From<Vec3> for Vec3A
[src]
impl From<Vec3A> for Vec3
[src]
impl From<Vec3A> for __m128
[src]
impl From<Vec3A> for (f32, f32, f32)
[src]
impl From<Vec3A> for [f32; 3]
[src]
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: Self) -> Self
[src]
impl Mul<Vec3A> for f32
[src]
type Output = Vec3A
The resulting type after applying the *
operator.
fn mul(self, other: Vec3A) -> Vec3A
[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: Self)
[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]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl Sub<Vec3A> for Vec3A
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, other: Self) -> Self
[src]
impl SubAssign<Vec3A> for Vec3A
[src]
fn sub_assign(&mut self, other: Self)
[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,
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.
fn to_owned(&self) -> T
[src]
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.
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>,