#[repr(C)]pub struct U16Vec2 {
pub x: u16,
pub y: u16,
}
Expand description
A 2-dimensional vector.
Fields§
§x: u16
§y: u16
Implementations§
Source§impl U16Vec2
impl U16Vec2
Sourcepub fn map<F>(self, f: F) -> Self
pub fn map<F>(self, f: F) -> Self
Returns a vector containing each element of self
modified by a mapping function f
.
Sourcepub fn select(mask: BVec2, if_true: Self, if_false: Self) -> Self
pub fn select(mask: BVec2, if_true: Self, if_false: Self) -> Self
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 const fn from_array(a: [u16; 2]) -> Self
pub const fn from_array(a: [u16; 2]) -> Self
Creates a new vector from an array.
Sourcepub const fn from_slice(slice: &[u16]) -> Self
pub const fn from_slice(slice: &[u16]) -> Self
Creates a vector from the first 2 values in slice
.
§Panics
Panics if slice
is less than 2 elements long.
Sourcepub fn write_to_slice(self, slice: &mut [u16])
pub fn write_to_slice(self, slice: &mut [u16])
Writes the elements of self
to the first 2 elements in slice
.
§Panics
Panics if slice
is less than 2 elements long.
Sourcepub const fn extend(self, z: u16) -> U16Vec3
pub const fn extend(self, z: u16) -> U16Vec3
Creates a 3D vector from self
and the given z
value.
Sourcepub fn dot_into_vec(self, rhs: Self) -> Self
pub fn dot_into_vec(self, rhs: Self) -> Self
Returns a vector where every component is the dot product of self
and rhs
.
Sourcepub fn min(self, rhs: Self) -> Self
pub fn min(self, rhs: Self) -> Self
Returns a vector containing the minimum values for each element of self
and rhs
.
In other words this computes [self.x.min(rhs.x), self.y.min(rhs.y), ..]
.
Sourcepub fn max(self, rhs: Self) -> Self
pub fn max(self, rhs: Self) -> Self
Returns a vector containing the maximum values for each element of self
and rhs
.
In other words this computes [self.x.max(rhs.x), self.y.max(rhs.y), ..]
.
Sourcepub fn clamp(self, min: Self, max: Self) -> Self
pub fn clamp(self, min: Self, max: Self) -> Self
Component-wise clamping of values, similar to u16::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) -> u16
pub fn min_element(self) -> u16
Returns the horizontal minimum of self
.
In other words this computes min(x, y, ..)
.
Sourcepub fn max_element(self) -> u16
pub fn max_element(self) -> u16
Returns the horizontal maximum of self
.
In other words this computes max(x, y, ..)
.
Sourcepub fn element_sum(self) -> u16
pub fn element_sum(self) -> u16
Returns the sum of all elements of self
.
In other words, this computes self.x + self.y + ..
.
Sourcepub fn element_product(self) -> u16
pub fn element_product(self) -> u16
Returns the product of all elements of self
.
In other words, this computes self.x * self.y * ..
.
Sourcepub fn cmpeq(self, rhs: Self) -> BVec2
pub fn cmpeq(self, rhs: Self) -> BVec2
Returns a vector mask containing the result of a ==
comparison for each element of
self
and rhs
.
In other words, this computes [self.x == rhs.x, self.y == rhs.y, ..]
for all
elements.
Sourcepub fn cmpne(self, rhs: Self) -> BVec2
pub fn cmpne(self, rhs: Self) -> BVec2
Returns a vector mask containing the result of a !=
comparison for each element of
self
and rhs
.
In other words this computes [self.x != rhs.x, self.y != rhs.y, ..]
for all
elements.
Sourcepub fn cmpge(self, rhs: Self) -> BVec2
pub fn cmpge(self, rhs: Self) -> BVec2
Returns a vector mask containing the result of a >=
comparison for each element of
self
and rhs
.
In other words this computes [self.x >= rhs.x, self.y >= rhs.y, ..]
for all
elements.
Sourcepub fn cmpgt(self, rhs: Self) -> BVec2
pub fn cmpgt(self, rhs: Self) -> BVec2
Returns a vector mask containing the result of a >
comparison for each element of
self
and rhs
.
In other words this computes [self.x > rhs.x, self.y > rhs.y, ..]
for all
elements.
Sourcepub fn cmple(self, rhs: Self) -> BVec2
pub fn cmple(self, rhs: Self) -> BVec2
Returns a vector mask containing the result of a <=
comparison for each element of
self
and rhs
.
In other words this computes [self.x <= rhs.x, self.y <= rhs.y, ..]
for all
elements.
Sourcepub fn cmplt(self, rhs: Self) -> BVec2
pub fn cmplt(self, rhs: Self) -> BVec2
Returns a vector mask containing the result of a <
comparison for each element of
self
and rhs
.
In other words this computes [self.x < rhs.x, self.y < rhs.y, ..]
for all
elements.
Sourcepub fn length_squared(self) -> u16
pub fn length_squared(self) -> u16
Computes the squared length of self
.
Sourcepub fn manhattan_distance(self, other: Self) -> u16
pub fn manhattan_distance(self, other: Self) -> u16
Computes the manhattan distance between two points.
§Overflow
This method may overflow if the result is greater than u16::MAX
.
See also checked_manhattan_distance
.
Sourcepub fn checked_manhattan_distance(self, other: Self) -> Option<u16>
pub fn checked_manhattan_distance(self, other: Self) -> Option<u16>
Computes the manhattan distance between two points.
This will returns None
if the result is greater than u16::MAX
.
Sourcepub fn chebyshev_distance(self, other: Self) -> u16
pub fn chebyshev_distance(self, other: Self) -> u16
Computes the chebyshev distance between two points.
Sourcepub fn as_i16vec2(&self) -> I16Vec2
pub fn as_i16vec2(&self) -> I16Vec2
Casts all elements of self
to i16
.
Sourcepub fn as_i64vec2(&self) -> I64Vec2
pub fn as_i64vec2(&self) -> I64Vec2
Casts all elements of self
to i64
.
Sourcepub fn as_u64vec2(&self) -> U64Vec2
pub fn as_u64vec2(&self) -> U64Vec2
Casts all elements of self
to u64
.
Sourcepub const fn checked_add(self, rhs: Self) -> Option<Self>
pub const fn checked_add(self, rhs: Self) -> Option<Self>
Returns a vector containing the wrapping addition of self
and rhs
.
In other words this computes Some([self.x + rhs.x, self.y + rhs.y, ..])
but returns None
on any overflow.
Sourcepub const fn checked_sub(self, rhs: Self) -> Option<Self>
pub const fn checked_sub(self, rhs: Self) -> Option<Self>
Returns a vector containing the wrapping subtraction of self
and rhs
.
In other words this computes Some([self.x - rhs.x, self.y - rhs.y, ..])
but returns None
on any overflow.
Sourcepub const fn checked_mul(self, rhs: Self) -> Option<Self>
pub const fn checked_mul(self, rhs: Self) -> Option<Self>
Returns a vector containing the wrapping multiplication of self
and rhs
.
In other words this computes Some([self.x * rhs.x, self.y * rhs.y, ..])
but returns None
on any overflow.
Sourcepub const fn checked_div(self, rhs: Self) -> Option<Self>
pub const fn checked_div(self, rhs: Self) -> Option<Self>
Returns a vector containing the wrapping division of self
and rhs
.
In other words this computes Some([self.x / rhs.x, self.y / rhs.y, ..])
but returns None
on any division by zero.
Sourcepub const fn wrapping_add(self, rhs: Self) -> Self
pub const fn wrapping_add(self, rhs: Self) -> Self
Returns a vector containing the wrapping addition of self
and rhs
.
In other words this computes [self.x.wrapping_add(rhs.x), self.y.wrapping_add(rhs.y), ..]
.
Sourcepub const fn wrapping_sub(self, rhs: Self) -> Self
pub const fn wrapping_sub(self, rhs: Self) -> Self
Returns a vector containing the wrapping subtraction of self
and rhs
.
In other words this computes [self.x.wrapping_sub(rhs.x), self.y.wrapping_sub(rhs.y), ..]
.
Sourcepub const fn wrapping_mul(self, rhs: Self) -> Self
pub const fn wrapping_mul(self, rhs: Self) -> Self
Returns a vector containing the wrapping multiplication of self
and rhs
.
In other words this computes [self.x.wrapping_mul(rhs.x), self.y.wrapping_mul(rhs.y), ..]
.
Sourcepub const fn wrapping_div(self, rhs: Self) -> Self
pub const fn wrapping_div(self, rhs: Self) -> Self
Returns a vector containing the wrapping division of self
and rhs
.
In other words this computes [self.x.wrapping_div(rhs.x), self.y.wrapping_div(rhs.y), ..]
.
Sourcepub const fn saturating_add(self, rhs: Self) -> Self
pub const fn saturating_add(self, rhs: Self) -> Self
Returns a vector containing the saturating addition of self
and rhs
.
In other words this computes [self.x.saturating_add(rhs.x), self.y.saturating_add(rhs.y), ..]
.
Sourcepub const fn saturating_sub(self, rhs: Self) -> Self
pub const fn saturating_sub(self, rhs: Self) -> Self
Returns a vector containing the saturating subtraction of self
and rhs
.
In other words this computes [self.x.saturating_sub(rhs.x), self.y.saturating_sub(rhs.y), ..]
.
Sourcepub const fn saturating_mul(self, rhs: Self) -> Self
pub const fn saturating_mul(self, rhs: Self) -> Self
Returns a vector containing the saturating multiplication of self
and rhs
.
In other words this computes [self.x.saturating_mul(rhs.x), self.y.saturating_mul(rhs.y), ..]
.
Sourcepub const fn saturating_div(self, rhs: Self) -> Self
pub const fn saturating_div(self, rhs: Self) -> Self
Returns a vector containing the saturating division of self
and rhs
.
In other words this computes [self.x.saturating_div(rhs.x), self.y.saturating_div(rhs.y), ..]
.
Sourcepub const fn checked_add_signed(self, rhs: I16Vec2) -> Option<Self>
pub const fn checked_add_signed(self, rhs: I16Vec2) -> Option<Self>
Returns a vector containing the wrapping addition of self
and signed vector rhs
.
In other words this computes Some([self.x + rhs.x, self.y + rhs.y, ..])
but returns None
on any overflow.
Sourcepub const fn wrapping_add_signed(self, rhs: I16Vec2) -> Self
pub const fn wrapping_add_signed(self, rhs: I16Vec2) -> Self
Returns a vector containing the wrapping addition of self
and signed vector rhs
.
In other words this computes [self.x.wrapping_add_signed(rhs.x), self.y.wrapping_add_signed(rhs.y), ..]
.
Sourcepub const fn saturating_add_signed(self, rhs: I16Vec2) -> Self
pub const fn saturating_add_signed(self, rhs: I16Vec2) -> Self
Returns a vector containing the saturating addition of self
and signed vector rhs
.
In other words this computes [self.x.saturating_add_signed(rhs.x), self.y.saturating_add_signed(rhs.y), ..]
.
Trait Implementations§
Source§impl AddAssign<&U16Vec2> for U16Vec2
impl AddAssign<&U16Vec2> for U16Vec2
Source§fn add_assign(&mut self, rhs: &U16Vec2)
fn add_assign(&mut self, rhs: &U16Vec2)
+=
operation. Read moreSource§impl AddAssign<&u16> for U16Vec2
impl AddAssign<&u16> for U16Vec2
Source§fn add_assign(&mut self, rhs: &u16)
fn add_assign(&mut self, rhs: &u16)
+=
operation. Read moreSource§impl AddAssign<u16> for U16Vec2
impl AddAssign<u16> for U16Vec2
Source§fn add_assign(&mut self, rhs: u16)
fn add_assign(&mut self, rhs: u16)
+=
operation. Read moreSource§impl AddAssign for U16Vec2
impl AddAssign for U16Vec2
Source§fn add_assign(&mut self, rhs: Self)
fn add_assign(&mut self, rhs: Self)
+=
operation. Read moreSource§impl DivAssign<&U16Vec2> for U16Vec2
impl DivAssign<&U16Vec2> for U16Vec2
Source§fn div_assign(&mut self, rhs: &U16Vec2)
fn div_assign(&mut self, rhs: &U16Vec2)
/=
operation. Read moreSource§impl DivAssign<&u16> for U16Vec2
impl DivAssign<&u16> for U16Vec2
Source§fn div_assign(&mut self, rhs: &u16)
fn div_assign(&mut self, rhs: &u16)
/=
operation. Read moreSource§impl DivAssign<u16> for U16Vec2
impl DivAssign<u16> for U16Vec2
Source§fn div_assign(&mut self, rhs: u16)
fn div_assign(&mut self, rhs: u16)
/=
operation. Read moreSource§impl DivAssign for U16Vec2
impl DivAssign for U16Vec2
Source§fn div_assign(&mut self, rhs: Self)
fn div_assign(&mut self, rhs: Self)
/=
operation. Read moreSource§impl MulAssign<&U16Vec2> for U16Vec2
impl MulAssign<&U16Vec2> for U16Vec2
Source§fn mul_assign(&mut self, rhs: &U16Vec2)
fn mul_assign(&mut self, rhs: &U16Vec2)
*=
operation. Read moreSource§impl MulAssign<&u16> for U16Vec2
impl MulAssign<&u16> for U16Vec2
Source§fn mul_assign(&mut self, rhs: &u16)
fn mul_assign(&mut self, rhs: &u16)
*=
operation. Read moreSource§impl MulAssign<u16> for U16Vec2
impl MulAssign<u16> for U16Vec2
Source§fn mul_assign(&mut self, rhs: u16)
fn mul_assign(&mut self, rhs: u16)
*=
operation. Read moreSource§impl MulAssign for U16Vec2
impl MulAssign for U16Vec2
Source§fn mul_assign(&mut self, rhs: Self)
fn mul_assign(&mut self, rhs: Self)
*=
operation. Read moreSource§impl RemAssign<&U16Vec2> for U16Vec2
impl RemAssign<&U16Vec2> for U16Vec2
Source§fn rem_assign(&mut self, rhs: &U16Vec2)
fn rem_assign(&mut self, rhs: &U16Vec2)
%=
operation. Read moreSource§impl RemAssign<&u16> for U16Vec2
impl RemAssign<&u16> for U16Vec2
Source§fn rem_assign(&mut self, rhs: &u16)
fn rem_assign(&mut self, rhs: &u16)
%=
operation. Read moreSource§impl RemAssign<u16> for U16Vec2
impl RemAssign<u16> for U16Vec2
Source§fn rem_assign(&mut self, rhs: u16)
fn rem_assign(&mut self, rhs: u16)
%=
operation. Read moreSource§impl RemAssign for U16Vec2
impl RemAssign for U16Vec2
Source§fn rem_assign(&mut self, rhs: Self)
fn rem_assign(&mut self, rhs: Self)
%=
operation. Read moreSource§impl SubAssign<&U16Vec2> for U16Vec2
impl SubAssign<&U16Vec2> for U16Vec2
Source§fn sub_assign(&mut self, rhs: &U16Vec2)
fn sub_assign(&mut self, rhs: &U16Vec2)
-=
operation. Read moreSource§impl SubAssign<&u16> for U16Vec2
impl SubAssign<&u16> for U16Vec2
Source§fn sub_assign(&mut self, rhs: &u16)
fn sub_assign(&mut self, rhs: &u16)
-=
operation. Read moreSource§impl SubAssign<u16> for U16Vec2
impl SubAssign<u16> for U16Vec2
Source§fn sub_assign(&mut self, rhs: u16)
fn sub_assign(&mut self, rhs: u16)
-=
operation. Read moreSource§impl SubAssign for U16Vec2
impl SubAssign for U16Vec2
Source§fn sub_assign(&mut self, rhs: U16Vec2)
fn sub_assign(&mut self, rhs: U16Vec2)
-=
operation. Read more