#[repr(transparent)]pub struct DVec2(_);
Expand description
A 2-dimensional vector.
Implementations
sourceimpl DVec2
impl DVec2
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 minimum 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 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) -> 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(slice: &[f64]) -> DVec2
pub fn from_slice(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(self, slice: &mut [f64])
pub fn write_to_slice(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 perp_dot(self, other: DVec2) -> f64
pub fn perp_dot(self, other: DVec2) -> f64
The perpendicular dot product of self
and other
.
Also known as the wedge product, 2d cross product, and determinant.
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
.
Panics
Will panic if self
is zero length when glam_assert
is enabled.
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 project_onto(self, other: DVec2) -> DVec2
pub fn project_onto(self, other: DVec2) -> DVec2
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: DVec2) -> DVec2
pub fn reject_from(self, other: DVec2) -> DVec2
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: DVec2) -> DVec2
pub fn project_onto_normalized(self, other: DVec2) -> DVec2
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: DVec2) -> DVec2
pub fn reject_from_normalized(self, other: DVec2) -> DVec2
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) -> 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 fract(self) -> DVec2
pub fn fract(self) -> DVec2
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) -> 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
Panics
Will panic if min
is greater than max
when glam_assert
is enabled.
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
sourcepub fn add_assign(&mut self, other: DVec2)
pub fn add_assign(&mut self, other: DVec2)
Performs the +=
operation. Read more
sourceimpl AddAssign<f64> for DVec2
impl AddAssign<f64> for DVec2
sourcepub fn add_assign(&mut self, other: f64)
pub fn add_assign(&mut self, other: f64)
Performs the +=
operation. Read more
impl AsStd140 for DVec2
impl AsStd140 for DVec2
pub fn as_std140(&self) -> <DVec2 as AsStd140>::Output
pub fn as_std140(&self) -> <DVec2 as AsStd140>::Output
Convert this value into the std140
version of itself.
pub fn from_std140(value: <DVec2 as AsStd140>::Output) -> DVec2
pub fn from_std140(value: <DVec2 as AsStd140>::Output) -> DVec2
Converts from std140
version of self to self.
fn std140_size_static() -> usize
fn std140_size_static() -> usize
Returns the size of the std140
version of this type. Useful for
pre-sizing buffers. Read more
impl AsStd430 for DVec2
impl AsStd430 for DVec2
pub fn as_std430(&self) -> <DVec2 as AsStd430>::Output
pub fn as_std430(&self) -> <DVec2 as AsStd430>::Output
Convert this value into the std430
version of itself.
pub fn from_std430(value: <DVec2 as AsStd430>::Output) -> DVec2
pub fn from_std430(value: <DVec2 as AsStd430>::Output) -> DVec2
Converts from std430
version of self to self.
fn std430_size_static() -> usize
fn std430_size_static() -> usize
Returns the size of the std430
version of this type. Useful for
pre-sizing buffers. Read more
sourceimpl<'de> Deserialize<'de> for DVec2
impl<'de> Deserialize<'de> for DVec2
sourcepub fn deserialize<D>(
deserializer: D
) -> Result<DVec2, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
pub fn deserialize<D>(
deserializer: D
) -> Result<DVec2, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl DivAssign<DVec2> for DVec2
impl DivAssign<DVec2> for DVec2
sourcepub fn div_assign(&mut self, other: DVec2)
pub fn div_assign(&mut self, other: DVec2)
Performs the /=
operation. Read more
sourceimpl DivAssign<f64> for DVec2
impl DivAssign<f64> for DVec2
sourcepub fn div_assign(&mut self, other: f64)
pub fn div_assign(&mut self, other: f64)
Performs the /=
operation. Read more
sourceimpl MulAssign<DVec2> for DVec2
impl MulAssign<DVec2> for DVec2
sourcepub fn mul_assign(&mut self, other: DVec2)
pub fn mul_assign(&mut self, other: DVec2)
Performs the *=
operation. Read more
sourceimpl MulAssign<f64> for DVec2
impl MulAssign<f64> for DVec2
sourcepub fn mul_assign(&mut self, other: f64)
pub fn mul_assign(&mut self, other: f64)
Performs the *=
operation. Read more
sourceimpl RemAssign<DVec2> for DVec2
impl RemAssign<DVec2> for DVec2
sourcepub fn rem_assign(&mut self, other: DVec2)
pub fn rem_assign(&mut self, other: DVec2)
Performs the %=
operation. Read more
sourceimpl RemAssign<f64> for DVec2
impl RemAssign<f64> for DVec2
sourcepub fn rem_assign(&mut self, other: f64)
pub fn rem_assign(&mut self, other: f64)
Performs the %=
operation. Read more
sourceimpl Serialize for DVec2
impl Serialize for DVec2
sourcepub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
sourceimpl SubAssign<DVec2> for DVec2
impl SubAssign<DVec2> for DVec2
sourcepub fn sub_assign(&mut self, other: DVec2)
pub fn sub_assign(&mut self, other: DVec2)
Performs the -=
operation. Read more
sourceimpl SubAssign<f64> for DVec2
impl SubAssign<f64> for DVec2
sourcepub fn sub_assign(&mut self, other: f64)
pub fn sub_assign(&mut self, other: f64)
Performs the -=
operation. Read more
sourceimpl Vec2Swizzles for DVec2
impl Vec2Swizzles for DVec2
type Vec3 = DVec3
type Vec4 = DVec4
pub fn xxxx(self) -> DVec4
pub fn xxxy(self) -> DVec4
pub fn xxyx(self) -> DVec4
pub fn xxyy(self) -> DVec4
pub fn xyxx(self) -> DVec4
pub fn xyxy(self) -> DVec4
pub fn xyyx(self) -> DVec4
pub fn xyyy(self) -> DVec4
pub fn yxxx(self) -> DVec4
pub fn yxxy(self) -> DVec4
pub fn yxyx(self) -> DVec4
pub fn yxyy(self) -> DVec4
pub fn yyxx(self) -> DVec4
pub fn yyxy(self) -> DVec4
pub fn yyyx(self) -> DVec4
pub fn yyyy(self) -> DVec4
pub fn xxx(self) -> DVec3
pub fn xxy(self) -> DVec3
pub fn xyx(self) -> DVec3
pub fn xyy(self) -> DVec3
pub fn yxx(self) -> DVec3
pub fn yxy(self) -> DVec3
pub fn yyx(self) -> DVec3
pub fn yyy(self) -> DVec3
pub fn xx(self) -> DVec2
pub fn yx(self) -> DVec2
pub fn yy(self) -> DVec2
fn xy(self) -> Self
impl Copy for DVec2
impl Pod 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 · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<I, A>impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<I, A>impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
pub fn from_world(_world: &mut World) -> T
pub fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
impl<T> GlslArray for T where
T: Glsl,
impl<T> GlslArray for T where
T: Glsl,
type ArraySize = DimensionNil
type ArraySize = DimensionNil
Type-level linked list of array dimensions, ordered outer to inner.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> Serialize for T where
T: Serialize + ?Sized,
impl<T> Serialize for T where
T: Serialize + ?Sized,
pub fn erased_serialize(
&self,
serializer: &mut dyn Serializer
) -> Result<Ok, Error>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>ⓘNotable traits for Box<I, A>impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
impl<T> WriteStd140 for T where
T: AsStd140,
impl<T> WriteStd140 for T where
T: AsStd140,
pub fn std140_size(&self) -> usize
pub fn std140_size(&self) -> usize
The space required to write this value using std140
layout rules. This
does not include alignment padding that may be needed before or after
this type when written as part of a larger buffer. Read more
impl<T> WriteStd430 for T where
T: AsStd430,
impl<T> WriteStd430 for T where
T: AsStd430,
pub fn std430_size(&self) -> usize
pub fn std430_size(&self) -> usize
The space required to write this value using std430
layout rules. This
does not include alignment padding that may be needed before or after
this type when written as part of a larger buffer. Read more