pub struct Vec4(_);Expand description
A 4-dimensional vector.
This type uses 16 byte aligned SIMD vector type for storage on supported platforms.
Implementations
sourceimpl Vec4
impl Vec4
sourcepub const X: Vec4 = Self(Vector4Const::X)
pub const X: Vec4 = Self(Vector4Const::X)
[1, 0, 0, 0]: a unit-length vector pointing along the positive X axis.
sourcepub const Y: Vec4 = Self(Vector4Const::Y)
pub const Y: Vec4 = Self(Vector4Const::Y)
[0, 1, 0, 0]: a unit-length vector pointing along the positive Y axis.
sourcepub const Z: Vec4 = Self(Vector4Const::Z)
pub const Z: Vec4 = Self(Vector4Const::Z)
[0, 0, 1, 0]: a unit-length vector pointing along the positive Z axis.
sourcepub const W: Vec4 = Self(Vector4Const::W)
pub const W: Vec4 = Self(Vector4Const::W)
[0, 0, 0, 1]: a unit-length vector pointing along the positive W axis.
sourcepub fn truncate(self) -> Vec3
pub fn truncate(self) -> Vec3
Creates a Vec3 from the x, y and z elements of self, discarding w.
Truncation to Vec3 may also be performed by using self.xyz() or Vec3::from().
To truncate to Vec3A use Vec3A::from().
sourcepub fn select(mask: BVec4, if_true: Vec4, if_false: Vec4) -> Vec4
pub fn select(mask: BVec4, if_true: Vec4, if_false: Vec4) -> Vec4
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.
sourcepub fn min(self, other: Vec4) -> Vec4
pub fn min(self, other: Vec4) -> Vec4
Returns a vector containing the minimum values for each element of self and other.
In other words this computes [self.x.min(other.x), self.y.min(other.y), ..].
sourcepub fn max(self, other: Vec4) -> Vec4
pub fn max(self, other: Vec4) -> Vec4
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), ..].
sourcepub fn clamp(self, min: Vec4, max: Vec4) -> Vec4
pub fn clamp(self, min: Vec4, max: Vec4) -> Vec4
Component-wise clamping of values, similar to f32::clamp.
Each element in min must be less-or-equal to the corresponding element in max.
Panics
Will panic if min is greater than max when glam_assert is enabled.
sourcepub fn min_element(self) -> f32
pub fn min_element(self) -> f32
Returns the horizontal minimum of self.
In other words this computes min(x, y, ..).
sourcepub fn max_element(self) -> f32
pub fn max_element(self) -> f32
Returns the horizontal maximum of self.
In other words this computes max(x, y, ..).
sourcepub fn cmpeq(self, other: Vec4) -> BVec4
pub fn cmpeq(self, other: Vec4) -> BVec4
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.
sourcepub fn cmpne(self, other: Vec4) -> BVec4
pub fn cmpne(self, other: Vec4) -> BVec4
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.
sourcepub fn cmpge(self, other: Vec4) -> BVec4
pub fn cmpge(self, other: Vec4) -> BVec4
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.
sourcepub fn cmpgt(self, other: Vec4) -> BVec4
pub fn cmpgt(self, other: Vec4) -> BVec4
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.
sourcepub fn cmple(self, other: Vec4) -> BVec4
pub fn cmple(self, other: Vec4) -> BVec4
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.
sourcepub fn cmplt(self, other: Vec4) -> BVec4
pub fn cmplt(self, other: Vec4) -> BVec4
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.
sourcepub fn from_slice(slice: &[f32]) -> Vec4
pub fn from_slice(slice: &[f32]) -> Vec4
Creates a vector from the first N values in slice.
Panics
Panics if slice is less than N elements long.
sourcepub fn write_to_slice(self, slice: &mut [f32])
pub fn write_to_slice(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.
sourcepub fn abs(self) -> Vec4
pub fn abs(self) -> Vec4
Returns a vector containing the absolute value of each element of self.
sourcepub fn signum(self) -> Vec4
pub fn signum(self) -> Vec4
Returns a vector with elements representing the sign of self.
1.0if the number is positive,+0.0orINFINITY-1.0if the number is negative,-0.0orNEG_INFINITYNANif the number isNAN
sourcepub fn is_finite(self) -> bool
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.
sourcepub fn is_nan_mask(self) -> BVec4
pub fn is_nan_mask(self) -> BVec4
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()].
sourcepub fn length_squared(self) -> f32
pub fn length_squared(self) -> f32
Computes the squared length of self.
This is faster than length() as it avoids a square root operation.
sourcepub fn length_recip(self) -> f32
pub fn length_recip(self) -> f32
Computes 1.0 / length().
For valid results, self must not be of length zero.
sourcepub fn distance(self, other: Vec4) -> f32
pub fn distance(self, other: Vec4) -> f32
Computes the Euclidean distance between two points in space.
sourcepub fn distance_squared(self, other: Vec4) -> f32
pub fn distance_squared(self, other: Vec4) -> f32
Compute the squared euclidean distance between two points in space.
sourcepub fn normalize(self) -> Vec4
pub fn normalize(self) -> Vec4
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.
Panics
Will panic if self is zero length when glam_assert is enabled.
sourcepub fn try_normalize(self) -> Option<Vec4>
pub fn try_normalize(self) -> Option<Vec4>
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.
sourcepub fn normalize_or_zero(self) -> Vec4
pub fn normalize_or_zero(self) -> Vec4
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.
sourcepub fn is_normalized(self) -> bool
pub fn is_normalized(self) -> bool
Returns whether self is length 1.0 or not.
Uses a precision threshold of 1e-6.
sourcepub fn project_onto(self, other: Vec4) -> Vec4
pub fn project_onto(self, other: Vec4) -> Vec4
Returns the vector projection of self onto other.
other must be of non-zero length.
Panics
Will panic if other is zero length when glam_assert is enabled.
sourcepub fn reject_from(self, other: Vec4) -> Vec4
pub fn reject_from(self, other: Vec4) -> Vec4
Returns the vector rejection of self from other.
The vector rejection is the vector perpendicular to the projection of self onto
other, in other words the result of self - self.project_onto(other).
other must be of non-zero length.
Panics
Will panic if other has a length of zero when glam_assert is enabled.
sourcepub fn project_onto_normalized(self, other: Vec4) -> Vec4
pub fn project_onto_normalized(self, other: Vec4) -> Vec4
Returns the vector projection of self onto other.
other must be normalized.
Panics
Will panic if other is not normalized when glam_assert is enabled.
sourcepub fn reject_from_normalized(self, other: Vec4) -> Vec4
pub fn reject_from_normalized(self, other: Vec4) -> Vec4
Returns the vector rejection of self from other.
The vector rejection is the vector perpendicular to the projection of self onto
other, in other words the result of self - self.project_onto(other).
other must be normalized.
Panics
Will panic if other is not normalized when glam_assert is enabled.
sourcepub fn round(self) -> Vec4
pub fn round(self) -> Vec4
Returns a vector containing the nearest integer to a number for each element of self.
Round half-way cases away from 0.0.
sourcepub fn floor(self) -> Vec4
pub fn floor(self) -> Vec4
Returns a vector containing the largest integer less than or equal to a number for each
element of self.
sourcepub fn ceil(self) -> Vec4
pub fn ceil(self) -> Vec4
Returns a vector containing the smallest integer greater than or equal to a number for
each element of self.
sourcepub fn fract(self) -> Vec4
pub fn fract(self) -> Vec4
Returns a vector containing the fractional part of the vector, e.g. self - self.floor().
Note that this is fast but not precise for large numbers.
sourcepub fn exp(self) -> Vec4
pub fn exp(self) -> Vec4
Returns a vector containing e^self (the exponential function) for each element of
self.
sourcepub fn powf(self, n: f32) -> Vec4
pub fn powf(self, n: f32) -> Vec4
Returns a vector containing each element of self raised to the power of n.
sourcepub fn recip(self) -> Vec4
pub fn recip(self) -> Vec4
Returns a vector containing the reciprocal 1.0/n of each element of self.
sourcepub fn lerp(self, other: Vec4, s: f32) -> Vec4
pub fn lerp(self, other: Vec4, s: f32) -> Vec4
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. When s is outside of range [0,1], the result is linearly
extrapolated.
sourcepub fn abs_diff_eq(self, other: Vec4, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(self, other: Vec4, 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.
sourcepub fn clamp_length(self, min: f32, max: f32) -> Vec4
pub fn clamp_length(self, min: f32, max: f32) -> Vec4
Returns a vector with a length no less than min and no more than max
Panics
Will panic if min is greater than max when glam_assert is enabled.
sourcepub fn clamp_length_max(self, max: f32) -> Vec4
pub fn clamp_length_max(self, max: f32) -> Vec4
Returns a vector with a length no more than max
sourcepub fn clamp_length_min(self, min: f32) -> Vec4
pub fn clamp_length_min(self, min: f32) -> Vec4
Returns a vector with a length no less than min
sourcepub fn mul_add(self, a: Vec4, b: Vec4) -> Vec4
pub fn mul_add(self, a: Vec4, b: Vec4) -> Vec4
Fused multiply-add. Computes (self * a) + b element-wise with only one rounding
error, yielding a more accurate result than an unfused multiply-add.
Using mul_add may be more performant than an unfused multiply-add if the target
architecture has a dedicated fma CPU instruction. However, this is not always true,
and will be heavily dependant on designing algorithms with specific target hardware in
mind.
Trait Implementations
sourceimpl AddAssign<Vec4> for Vec4
impl AddAssign<Vec4> for Vec4
sourcefn add_assign(&mut self, other: Vec4)
fn add_assign(&mut self, other: Vec4)
+= operation. Read moresourceimpl AddAssign<f32> for Vec4
impl AddAssign<f32> for Vec4
sourcefn add_assign(&mut self, other: f32)
fn add_assign(&mut self, other: f32)
+= operation. Read moresourceimpl<'de> Deserialize<'de> for Vec4
impl<'de> Deserialize<'de> for Vec4
sourcefn deserialize<D>(
deserializer: D
) -> Result<Vec4, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<Vec4, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
sourceimpl DivAssign<Vec4> for Vec4
impl DivAssign<Vec4> for Vec4
sourcefn div_assign(&mut self, other: Vec4)
fn div_assign(&mut self, other: Vec4)
/= operation. Read moresourceimpl DivAssign<f32> for Vec4
impl DivAssign<f32> for Vec4
sourcefn div_assign(&mut self, other: f32)
fn div_assign(&mut self, other: f32)
/= operation. Read moresourceimpl From<ColorRgba8> for Vec4
impl From<ColorRgba8> for Vec4
Linear RGBA in 0-1 from sRGBA
sourcefn from(c: ColorRgba8) -> Vec4
fn from(c: ColorRgba8) -> Vec4
sourceimpl From<Vec4> for ColorRgba8
impl From<Vec4> for ColorRgba8
sRGBA from linear RGBA in [0-1] range
sourcefn from(v: Vec4) -> ColorRgba8
fn from(v: Vec4) -> ColorRgba8
sourceimpl MulAssign<Vec4> for Vec4
impl MulAssign<Vec4> for Vec4
sourcefn mul_assign(&mut self, other: Vec4)
fn mul_assign(&mut self, other: Vec4)
*= operation. Read moresourceimpl MulAssign<f32> for Vec4
impl MulAssign<f32> for Vec4
sourcefn mul_assign(&mut self, other: f32)
fn mul_assign(&mut self, other: f32)
*= operation. Read moresourceimpl<'a, C> Readable<'a, C> for Vec4where
C: Context,
impl<'a, C> Readable<'a, C> for Vec4where
C: Context,
fn read_from<R>(reader: &mut R) -> Result<Vec4, <C as Context>::Error>where
R: Reader<'a, C>,
fn minimum_bytes_needed() -> usize
fn read_from_buffer_with_ctx(
context: C,
buffer: &'a [u8]
) -> Result<Self, <C as Context>::Error>
fn read_with_length_from_buffer_with_ctx(
context: C,
buffer: &'a [u8]
) -> (Result<Self, <C as Context>::Error>, usize)
fn read_from_buffer_copying_data_with_ctx(
context: C,
buffer: &[u8]
) -> Result<Self, <C as Context>::Error>
fn read_with_length_from_buffer_copying_data_with_ctx(
context: C,
buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)
fn read_with_length_from_buffer_copying_data_with_ctx_mut(
context: &mut C,
buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)
fn read_from_stream_unbuffered_with_ctx<S>(
context: C,
stream: S
) -> Result<Self, <C as Context>::Error>where
S: Read,
fn read_from_stream_buffered_with_ctx<S>(
context: C,
stream: S
) -> Result<Self, <C as Context>::Error>where
S: Read,
fn read_from_file_with_ctx(
context: C,
path: impl AsRef<Path>
) -> Result<Self, <C as Context>::Error>
sourceimpl RemAssign<Vec4> for Vec4
impl RemAssign<Vec4> for Vec4
sourcefn rem_assign(&mut self, other: Vec4)
fn rem_assign(&mut self, other: Vec4)
%= operation. Read moresourceimpl RemAssign<f32> for Vec4
impl RemAssign<f32> for Vec4
sourcefn rem_assign(&mut self, other: f32)
fn rem_assign(&mut self, other: f32)
%= operation. Read moresourceimpl Serialize for Vec4
impl Serialize for Vec4
sourcefn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
sourceimpl SubAssign<Vec4> for Vec4
impl SubAssign<Vec4> for Vec4
sourcefn sub_assign(&mut self, other: Vec4)
fn sub_assign(&mut self, other: Vec4)
-= operation. Read moresourceimpl SubAssign<f32> for Vec4
impl SubAssign<f32> for Vec4
sourcefn sub_assign(&mut self, other: f32)
fn sub_assign(&mut self, other: f32)
-= operation. Read moresourceimpl ValueConverterTrait<Vec4> for ValueConverter
impl ValueConverterTrait<Vec4> for ValueConverter
sourcefn into_value(v: Vec4) -> Value
fn into_value(v: Vec4) -> Value
Value enum.sourcefn from_value(v: &Value) -> Vec4
fn from_value(v: &Value) -> Vec4
Value enum.sourceimpl Vec4Ext for Vec4
impl Vec4Ext for Vec4
sourcefn step_select(self, value: Vec4, less: Vec4, greater_or_equal: Vec4) -> Vec4
fn step_select(self, value: Vec4, less: Vec4, greater_or_equal: Vec4) -> Vec4
true and false based on the result of value[i] < self[i]sourcefn has_equal_components(self, max_abs_diff: f32) -> bool
fn has_equal_components(self, max_abs_diff: f32) -> bool
max_abs_diff