#[repr(transparent)]pub struct DVec2(_);
Expand description
A 2-dimensional vector.
Implementations
sourceimpl DVec2
impl DVec2
sourcepub const X: DVec2 = Self(XYF64::X)
pub const X: DVec2 = Self(XYF64::X)
[1, 0]
: a unit-length vector pointing along the positive X axis.
sourcepub const Y: DVec2 = Self(XYF64::Y)
pub const Y: DVec2 = Self(XYF64::Y)
[0, 1]
: a unit-length vector pointing along the positive Y axis.
sourcepub const fn unit_x() -> DVec2
👎 Deprecated: Use Vec2::X instead
pub const fn unit_x() -> DVec2
Use Vec2::X instead
Creates a vector with values [x: 1.0, y: 0.0]
.
sourcepub const fn unit_y() -> DVec2
👎 Deprecated: Use Vec2::Y instead
pub const fn unit_y() -> DVec2
Use Vec2::Y instead
Creates a vector with values [x: 0.0, y: 1.0]
.
sourcepub const fn zero() -> DVec2
👎 Deprecated: use ZERO constant instead
pub const fn zero() -> DVec2
use ZERO constant instead
Creates a vector with all elements set to 0.0
.
sourcepub const fn one() -> DVec2
👎 Deprecated: use ONE constant instead
pub const fn one() -> DVec2
use ONE constant instead
Creates a vector with all elements set to 1.0
.
sourcepub fn select(mask: BVec2, if_true: DVec2, if_false: DVec2) -> DVec2
pub fn select(mask: BVec2, if_true: DVec2, if_false: DVec2) -> DVec2
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: DVec2) -> DVec2
pub fn min(self, other: DVec2) -> DVec2
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), ..]
.
sourcepub fn max(self, other: DVec2) -> DVec2
pub fn max(self, other: DVec2) -> DVec2
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: DVec2, max: DVec2) -> DVec2
pub fn clamp(self, min: DVec2, max: DVec2) -> DVec2
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.
sourcepub fn min_element(self) -> f64
pub fn min_element(self) -> f64
Returns the horizontal minimum of self
.
In other words this computes min(x, y, ..)
.
sourcepub fn max_element(self) -> f64
pub fn max_element(self) -> f64
Returns the horizontal maximum of self
.
In other words this computes max(x, y, ..)
.
sourcepub fn cmpeq(self, other: DVec2) -> BVec2
pub fn cmpeq(self, other: DVec2) -> BVec2
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: DVec2) -> BVec2
pub fn cmpne(self, other: DVec2) -> BVec2
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: DVec2) -> BVec2
pub fn cmpge(self, other: DVec2) -> BVec2
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: DVec2) -> BVec2
pub fn cmpgt(self, other: DVec2) -> BVec2
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: DVec2) -> BVec2
pub fn cmple(self, other: DVec2) -> BVec2
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: DVec2) -> BVec2
pub fn cmplt(self, other: DVec2) -> BVec2
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_unaligned(slice: &[f64]) -> DVec2
pub fn from_slice_unaligned(slice: &[f64]) -> DVec2
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_unaligned(self, slice: &mut [f64])
pub fn write_to_slice_unaligned(self, slice: &mut [f64])
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) -> DVec2
pub fn abs(self) -> DVec2
Returns a vector containing the absolute value of each element of self
.
sourcepub fn signum(self) -> DVec2
pub fn signum(self) -> DVec2
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
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) -> BVec2
pub fn is_nan_mask(self) -> BVec2
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) -> f64
pub fn length_squared(self) -> f64
Computes the squared length of self
.
This is faster than length()
as it avoids a square root operation.
sourcepub fn length_recip(self) -> f64
pub fn length_recip(self) -> f64
Computes 1.0 / length()
.
For valid results, self
must not be of length zero.
sourcepub fn distance(self, other: DVec2) -> f64
pub fn distance(self, other: DVec2) -> f64
Computes the Euclidean distance between two points in space.
sourcepub fn distance_squared(self, other: DVec2) -> f64
pub fn distance_squared(self, other: DVec2) -> f64
Compute the squared euclidean distance between two points in space.
sourcepub fn normalize(self) -> DVec2
pub fn normalize(self) -> DVec2
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
.
sourcepub fn try_normalize(self) -> Option<DVec2>
pub fn try_normalize(self) -> Option<DVec2>
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) -> DVec2
pub fn normalize_or_zero(self) -> DVec2
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 round(self) -> DVec2
pub fn round(self) -> DVec2
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) -> DVec2
pub fn floor(self) -> DVec2
Returns a vector containing the largest integer less than or equal to a number for each
element of self
.
sourcepub fn ceil(self) -> DVec2
pub fn ceil(self) -> DVec2
Returns a vector containing the smallest integer greater than or equal to a number for
each element of self
.
sourcepub fn exp(self) -> DVec2
pub fn exp(self) -> DVec2
Returns a vector containing e^self
(the exponential function) for each element of
self
.
sourcepub fn powf(self, n: f64) -> DVec2
pub fn powf(self, n: f64) -> DVec2
Returns a vector containing each element of self
raised to the power of n
.
sourcepub fn recip(self) -> DVec2
pub fn recip(self) -> DVec2
Returns a vector containing the reciprocal 1.0/n
of each element of self
.
sourcepub fn lerp(self, other: DVec2, s: f64) -> DVec2
pub fn lerp(self, other: DVec2, s: f64) -> DVec2
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
.
sourcepub fn abs_diff_eq(self, other: DVec2, max_abs_diff: f64) -> bool
pub fn abs_diff_eq(self, other: DVec2, max_abs_diff: f64) -> 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: f64, max: f64) -> DVec2
pub fn clamp_length(self, min: f64, max: f64) -> DVec2
Returns a vector with a length no less than min
and no more than max
sourcepub fn clamp_length_max(self, max: f64) -> DVec2
pub fn clamp_length_max(self, max: f64) -> DVec2
Returns a vector with a length no more than max
sourcepub fn clamp_length_min(self, min: f64) -> DVec2
pub fn clamp_length_min(self, min: f64) -> DVec2
Returns a vector with a length no less than min
sourcepub fn angle_between(self, other: DVec2) -> f64
pub fn angle_between(self, other: DVec2) -> f64
Returns the angle (in radians) between self
and other
.
The input vectors do not need to be unit length however they must be non-zero.
Trait Implementations
sourceimpl AddAssign<DVec2> for DVec2
impl AddAssign<DVec2> for DVec2
sourcefn add_assign(&mut self, other: DVec2)
fn add_assign(&mut self, other: DVec2)
Performs the +=
operation. Read more
sourceimpl DivAssign<DVec2> for DVec2
impl DivAssign<DVec2> for DVec2
sourcefn div_assign(&mut self, other: DVec2)
fn div_assign(&mut self, other: DVec2)
Performs the /=
operation. Read more
sourceimpl DivAssign<f64> for DVec2
impl DivAssign<f64> for DVec2
sourcefn div_assign(&mut self, other: f64)
fn div_assign(&mut self, other: f64)
Performs the /=
operation. Read more
sourceimpl MulAssign<DVec2> for DVec2
impl MulAssign<DVec2> for DVec2
sourcefn mul_assign(&mut self, other: DVec2)
fn mul_assign(&mut self, other: DVec2)
Performs the *=
operation. Read more
sourceimpl MulAssign<f64> for DVec2
impl MulAssign<f64> for DVec2
sourcefn mul_assign(&mut self, other: f64)
fn mul_assign(&mut self, other: f64)
Performs the *=
operation. Read more
sourceimpl PartialOrd<DVec2> for DVec2
impl PartialOrd<DVec2> for DVec2
sourcefn partial_cmp(&self, other: &DVec2) -> Option<Ordering>
fn partial_cmp(&self, other: &DVec2) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl SubAssign<DVec2> for DVec2
impl SubAssign<DVec2> for DVec2
sourcefn sub_assign(&mut self, other: DVec2)
fn sub_assign(&mut self, other: DVec2)
Performs the -=
operation. Read more
sourceimpl Vec2Swizzles for DVec2
impl Vec2Swizzles for DVec2
type Vec3 = DVec3
type Vec4 = DVec4
fn xxxx(self) -> DVec4
fn xxxy(self) -> DVec4
fn xxyx(self) -> DVec4
fn xxyy(self) -> DVec4
fn xyxx(self) -> DVec4
fn xyxy(self) -> DVec4
fn xyyx(self) -> DVec4
fn xyyy(self) -> DVec4
fn yxxx(self) -> DVec4
fn yxxy(self) -> DVec4
fn yxyx(self) -> DVec4
fn yxyy(self) -> DVec4
fn yyxx(self) -> DVec4
fn yyxy(self) -> DVec4
fn yyyx(self) -> DVec4
fn yyyy(self) -> DVec4
fn xxx(self) -> DVec3
fn xxy(self) -> DVec3
fn xyx(self) -> DVec3
fn xyy(self) -> DVec3
fn yxx(self) -> DVec3
fn yxy(self) -> DVec3
fn yyx(self) -> DVec3
fn yyy(self) -> DVec3
fn xx(self) -> DVec2
fn yx(self) -> DVec2
fn yy(self) -> DVec2
fn xy(self) -> Self
impl Copy for DVec2
Auto Trait Implementations
impl RefUnwindSafe for DVec2
impl Send for DVec2
impl Sync for DVec2
impl Unpin for DVec2
impl UnwindSafe for DVec2
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more