#[repr(C)]pub struct IVec3 {
pub x: i32,
pub y: i32,
pub z: i32,
}
Expand description
A 3-dimensional vector.
Fields§
§x: i32
§y: i32
§z: i32
Implementations§
source§impl IVec3
impl IVec3
sourcepub fn select(mask: BVec3, if_true: Self, if_false: Self) -> Self
pub fn select(mask: BVec3, 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: [i32; 3]) -> Self
pub const fn from_array(a: [i32; 3]) -> Self
Creates a new vector from an array.
sourcepub const fn from_slice(slice: &[i32]) -> Self
pub const fn from_slice(slice: &[i32]) -> Self
Creates a vector from the first 3 values in slice
.
§Panics
Panics if slice
is less than 3 elements long.
sourcepub fn write_to_slice(self, slice: &mut [i32])
pub fn write_to_slice(self, slice: &mut [i32])
Writes the elements of self
to the first 3 elements in slice
.
§Panics
Panics if slice
is less than 3 elements long.
sourcepub fn truncate(self) -> IVec2
pub fn truncate(self) -> IVec2
Creates a 2D vector from the x
and y
elements of self
, discarding z
.
Truncation may also be performed by using self.xy()
.
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 i32::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) -> i32
pub fn min_element(self) -> i32
Returns the horizontal minimum of self
.
In other words this computes min(x, y, ..)
.
sourcepub fn max_element(self) -> i32
pub fn max_element(self) -> i32
Returns the horizontal maximum of self
.
In other words this computes max(x, y, ..)
.
sourcepub fn element_sum(self) -> i32
pub fn element_sum(self) -> i32
Returns the sum of all elements of self
.
In other words, this computes self.x + self.y + ..
.
sourcepub fn element_product(self) -> i32
pub fn element_product(self) -> i32
Returns the product of all elements of self
.
In other words, this computes self.x * self.y * ..
.
sourcepub fn cmpeq(self, rhs: Self) -> BVec3
pub fn cmpeq(self, rhs: Self) -> BVec3
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) -> BVec3
pub fn cmpne(self, rhs: Self) -> BVec3
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) -> BVec3
pub fn cmpge(self, rhs: Self) -> BVec3
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) -> BVec3
pub fn cmpgt(self, rhs: Self) -> BVec3
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) -> BVec3
pub fn cmple(self, rhs: Self) -> BVec3
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) -> BVec3
pub fn cmplt(self, rhs: Self) -> BVec3
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 abs(self) -> Self
pub fn abs(self) -> Self
Returns a vector containing the absolute value of each element of self
.
sourcepub fn signum(self) -> Self
pub fn signum(self) -> Self
Returns a vector with elements representing the sign of self
.
0
if the number is zero1
if the number is positive-1
if the number is negative
sourcepub fn is_negative_bitmask(self) -> u32
pub fn is_negative_bitmask(self) -> u32
Returns a bitmask with the lowest 3 bits set to the sign bits from the elements of self
.
A negative element results in a 1
bit and a positive element in a 0
bit. Element x
goes
into the first lowest bit, element y
into the second, etc.
sourcepub fn length_squared(self) -> i32
pub fn length_squared(self) -> i32
Computes the squared length of self
.
sourcepub fn distance_squared(self, rhs: Self) -> i32
pub fn distance_squared(self, rhs: Self) -> i32
Compute the squared euclidean distance between two points in space.
sourcepub fn div_euclid(self, rhs: Self) -> Self
pub fn div_euclid(self, rhs: Self) -> Self
Returns the element-wise quotient of [Euclidean division] of self
by rhs
.
§Panics
This function will panic if any rhs
element is 0 or the division results in overflow.
sourcepub fn rem_euclid(self, rhs: Self) -> Self
pub fn rem_euclid(self, rhs: Self) -> Self
Returns the element-wise remainder of Euclidean division of self
by rhs
.
§Panics
This function will panic if any rhs
element is 0 or the division results in overflow.
sourcepub fn as_i16vec3(&self) -> I16Vec3
pub fn as_i16vec3(&self) -> I16Vec3
Casts all elements of self
to i16
.
sourcepub fn as_u16vec3(&self) -> U16Vec3
pub fn as_u16vec3(&self) -> U16Vec3
Casts all elements of self
to u16
.
sourcepub fn as_i64vec3(&self) -> I64Vec3
pub fn as_i64vec3(&self) -> I64Vec3
Casts all elements of self
to i64
.
sourcepub fn as_u64vec3(&self) -> U64Vec3
pub fn as_u64vec3(&self) -> U64Vec3
Casts all elements of self
to u64
.
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 wrapping_add_unsigned(self, rhs: UVec3) -> Self
pub const fn wrapping_add_unsigned(self, rhs: UVec3) -> Self
Returns a vector containing the wrapping addition of self
and unsigned vector rhs
.
In other words this computes [self.x.wrapping_add_unsigned(rhs.x), self.y.wrapping_add_unsigned(rhs.y), ..]
.
sourcepub const fn wrapping_sub_unsigned(self, rhs: UVec3) -> Self
pub const fn wrapping_sub_unsigned(self, rhs: UVec3) -> Self
Returns a vector containing the wrapping subtraction of self
and unsigned vector rhs
.
In other words this computes [self.x.wrapping_sub_unsigned(rhs.x), self.y.wrapping_sub_unsigned(rhs.y), ..]
.
sourcepub const fn saturating_add_unsigned(self, rhs: UVec3) -> Self
pub const fn saturating_add_unsigned(self, rhs: UVec3) -> Self
In other words this computes [self.x.saturating_add_unsigned(rhs.x), self.y.saturating_add_unsigned(rhs.y), ..]
.
sourcepub const fn saturating_sub_unsigned(self, rhs: UVec3) -> Self
pub const fn saturating_sub_unsigned(self, rhs: UVec3) -> Self
Returns a vector containing the saturating subtraction of self
and unsigned vector rhs
.
In other words this computes [self.x.saturating_sub_unsigned(rhs.x), self.y.saturating_sub_unsigned(rhs.y), ..]
.
Trait Implementations§
source§impl AddAssign<i32> for IVec3
impl AddAssign<i32> for IVec3
source§fn add_assign(&mut self, rhs: i32)
fn add_assign(&mut self, rhs: i32)
+=
operation. Read moresource§impl AddAssign for IVec3
impl AddAssign for IVec3
source§fn add_assign(&mut self, rhs: Self)
fn add_assign(&mut self, rhs: Self)
+=
operation. Read moresource§impl<'de> Deserialize<'de> for IVec3
impl<'de> Deserialize<'de> for IVec3
source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
source§impl Distribution<IVec3> for Standard
impl Distribution<IVec3> for Standard
source§impl DivAssign<i32> for IVec3
impl DivAssign<i32> for IVec3
source§fn div_assign(&mut self, rhs: i32)
fn div_assign(&mut self, rhs: i32)
/=
operation. Read moresource§impl DivAssign for IVec3
impl DivAssign for IVec3
source§fn div_assign(&mut self, rhs: Self)
fn div_assign(&mut self, rhs: Self)
/=
operation. Read moresource§impl MulAssign<i32> for IVec3
impl MulAssign<i32> for IVec3
source§fn mul_assign(&mut self, rhs: i32)
fn mul_assign(&mut self, rhs: i32)
*=
operation. Read moresource§impl MulAssign for IVec3
impl MulAssign for IVec3
source§fn mul_assign(&mut self, rhs: Self)
fn mul_assign(&mut self, rhs: Self)
*=
operation. Read moresource§impl PartialEq for IVec3
impl PartialEq for IVec3
source§impl RemAssign<i32> for IVec3
impl RemAssign<i32> for IVec3
source§fn rem_assign(&mut self, rhs: i32)
fn rem_assign(&mut self, rhs: i32)
%=
operation. Read moresource§impl RemAssign for IVec3
impl RemAssign for IVec3
source§fn rem_assign(&mut self, rhs: Self)
fn rem_assign(&mut self, rhs: Self)
%=
operation. Read moresource§impl SubAssign<i32> for IVec3
impl SubAssign<i32> for IVec3
source§fn sub_assign(&mut self, rhs: i32)
fn sub_assign(&mut self, rhs: i32)
-=
operation. Read moresource§impl SubAssign for IVec3
impl SubAssign for IVec3
source§fn sub_assign(&mut self, rhs: IVec3)
fn sub_assign(&mut self, rhs: IVec3)
-=
operation. Read moresource§impl Vec3Swizzles for IVec3
impl Vec3Swizzles for IVec3
type Vec2 = IVec2
type Vec4 = IVec4
fn xx(self) -> IVec2
fn xy(self) -> IVec2
fn xz(self) -> IVec2
fn yx(self) -> IVec2
fn yy(self) -> IVec2
fn yz(self) -> IVec2
fn zx(self) -> IVec2
fn zy(self) -> IVec2
fn zz(self) -> IVec2
fn xxx(self) -> IVec3
fn xxy(self) -> IVec3
fn xxz(self) -> IVec3
fn xyx(self) -> IVec3
fn xyy(self) -> IVec3
fn xyz(self) -> IVec3
fn xzx(self) -> IVec3
fn xzy(self) -> IVec3
fn xzz(self) -> IVec3
fn yxx(self) -> IVec3
fn yxy(self) -> IVec3
fn yxz(self) -> IVec3
fn yyx(self) -> IVec3
fn yyy(self) -> IVec3
fn yyz(self) -> IVec3
fn yzx(self) -> IVec3
fn yzy(self) -> IVec3
fn yzz(self) -> IVec3
fn zxx(self) -> IVec3
fn zxy(self) -> IVec3
fn zxz(self) -> IVec3
fn zyx(self) -> IVec3
fn zyy(self) -> IVec3
fn zyz(self) -> IVec3
fn zzx(self) -> IVec3
fn zzy(self) -> IVec3
fn zzz(self) -> IVec3
fn xxxx(self) -> IVec4
fn xxxy(self) -> IVec4
fn xxxz(self) -> IVec4
fn xxyx(self) -> IVec4
fn xxyy(self) -> IVec4
fn xxyz(self) -> IVec4
fn xxzx(self) -> IVec4
fn xxzy(self) -> IVec4
fn xxzz(self) -> IVec4
fn xyxx(self) -> IVec4
fn xyxy(self) -> IVec4
fn xyxz(self) -> IVec4
fn xyyx(self) -> IVec4
fn xyyy(self) -> IVec4
fn xyyz(self) -> IVec4
fn xyzx(self) -> IVec4
fn xyzy(self) -> IVec4
fn xyzz(self) -> IVec4
fn xzxx(self) -> IVec4
fn xzxy(self) -> IVec4
fn xzxz(self) -> IVec4
fn xzyx(self) -> IVec4
fn xzyy(self) -> IVec4
fn xzyz(self) -> IVec4
fn xzzx(self) -> IVec4
fn xzzy(self) -> IVec4
fn xzzz(self) -> IVec4
fn yxxx(self) -> IVec4
fn yxxy(self) -> IVec4
fn yxxz(self) -> IVec4
fn yxyx(self) -> IVec4
fn yxyy(self) -> IVec4
fn yxyz(self) -> IVec4
fn yxzx(self) -> IVec4
fn yxzy(self) -> IVec4
fn yxzz(self) -> IVec4
fn yyxx(self) -> IVec4
fn yyxy(self) -> IVec4
fn yyxz(self) -> IVec4
fn yyyx(self) -> IVec4
fn yyyy(self) -> IVec4
fn yyyz(self) -> IVec4
fn yyzx(self) -> IVec4
fn yyzy(self) -> IVec4
fn yyzz(self) -> IVec4
fn yzxx(self) -> IVec4
fn yzxy(self) -> IVec4
fn yzxz(self) -> IVec4
fn yzyx(self) -> IVec4
fn yzyy(self) -> IVec4
fn yzyz(self) -> IVec4
fn yzzx(self) -> IVec4
fn yzzy(self) -> IVec4
fn yzzz(self) -> IVec4
fn zxxx(self) -> IVec4
fn zxxy(self) -> IVec4
fn zxxz(self) -> IVec4
fn zxyx(self) -> IVec4
fn zxyy(self) -> IVec4
fn zxyz(self) -> IVec4
fn zxzx(self) -> IVec4
fn zxzy(self) -> IVec4
fn zxzz(self) -> IVec4
fn zyxx(self) -> IVec4
fn zyxy(self) -> IVec4
fn zyxz(self) -> IVec4
fn zyyx(self) -> IVec4
fn zyyy(self) -> IVec4
fn zyyz(self) -> IVec4
fn zyzx(self) -> IVec4
fn zyzy(self) -> IVec4
fn zyzz(self) -> IVec4
fn zzxx(self) -> IVec4
fn zzxy(self) -> IVec4
fn zzxz(self) -> IVec4
fn zzyx(self) -> IVec4
fn zzyy(self) -> IVec4
fn zzyz(self) -> IVec4
fn zzzx(self) -> IVec4
fn zzzy(self) -> IVec4
fn zzzz(self) -> IVec4
impl Copy for IVec3
impl Eq for IVec3
impl Pod for IVec3
impl StructuralPartialEq for IVec3
Auto Trait Implementations§
impl Freeze for IVec3
impl RefUnwindSafe for IVec3
impl Send for IVec3
impl Sync for IVec3
impl Unpin for IVec3
impl UnwindSafe for IVec3
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
§type Bits = T
type Bits = T
Self
must have the same layout as the specified Bits
except for
the possible invalid bit patterns being checked during
is_valid_bit_pattern
.source§fn is_valid_bit_pattern(_bits: &T) -> bool
fn is_valid_bit_pattern(_bits: &T) -> bool
bits
as &Self
.