Struct UVec2

#[repr(C)]
pub struct UVec2 {
    pub x: u32,
    pub y: u32,
}

A 2-dimensional vector.

Fields

x: u32

y: u32

Implementations

impl UVec2

pub const ZERO: Self = _

All zeroes.

pub const ONE: Self = _

All ones.

pub const MIN: Self = _

All u32::MIN.

pub const MAX: Self = _

All u32::MAX.

pub const X: Self = _

A unit vector pointing along the positive X axis.

pub const Y: Self = _

A unit vector pointing along the positive Y axis.

pub const AXES: [Self; 2] = _

The unit axes.

pub const fn new(x: u32, y: u32) -> Self

Creates a new vector.

pub const fn splat(v: u32) -> Self

Creates a vector with all elements set to v.

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.

pub const fn from_array(a: [u32; 2]) -> Self

Creates a new vector from an array.

pub const fn to_array(&self) -> [u32; 2]

[x, y]

pub const fn from_slice(slice: &[u32]) -> Self

Creates a vector from the first 2 values in slice.

Panics

Panics if slice is less than 2 elements long.

pub fn write_to_slice(self, slice: &mut [u32])

Writes the elements of self to the first 2 elements in slice.

Panics

Panics if slice is less than 2 elements long.

pub const fn extend(self, z: u32) -> UVec3

Creates a 3D vector from self and the given z value.

pub fn with_x(self, x: u32) -> Self

Creates a 2D vector from self with the given value of x.

pub fn with_y(self, y: u32) -> Self

Creates a 2D vector from self with the given value of y.

pub fn dot(self, rhs: Self) -> u32

Computes the dot product of self and rhs.

pub fn dot_into_vec(self, rhs: Self) -> Self

Returns a vector where every component is the dot product of self and rhs.

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), ..].

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), ..].

pub fn clamp(self, min: Self, max: Self) -> Self

Component-wise clamping of values, similar to u32::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.

pub fn min_element(self) -> u32

Returns the horizontal minimum of self.

In other words this computes min(x, y, ..).

pub fn max_element(self) -> u32

Returns the horizontal maximum of self.

In other words this computes max(x, y, ..).

pub fn element_sum(self) -> u32

Returns the sum of all elements of self.

In other words, this computes self.x + self.y + ...

pub fn element_product(self) -> u32

Returns the product of all elements of self.

In other words, this computes self.x * self.y * ...

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.

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.

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.

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.

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.

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.

pub fn length_squared(self) -> u32

Computes the squared length of self.

pub fn as_vec2(&self) -> Vec2

Casts all elements of self to f32.

pub fn as_dvec2(&self) -> DVec2

Casts all elements of self to f64.

pub fn as_i16vec2(&self) -> I16Vec2

Casts all elements of self to i16.

pub fn as_u16vec2(&self) -> U16Vec2

Casts all elements of self to u16.

pub fn as_ivec2(&self) -> IVec2

Casts all elements of self to i32.

pub fn as_i64vec2(&self) -> I64Vec2

Casts all elements of self to i64.

pub fn as_u64vec2(&self) -> U64Vec2

Casts all elements of self to u64.

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), ..].

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), ..].

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), ..].

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), ..].

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), ..].

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), ..].

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), ..].

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), ..].

pub const fn wrapping_add_signed(self, rhs: IVec2) -> 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), ..].

pub const fn saturating_add_signed(self, rhs: IVec2) -> 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

impl Add<UVec2> for u32

type Output = UVec2

The resulting type after applying the + operator.

fn add(self, rhs: UVec2) -> UVec2

Performs the + operation.

impl Add<u32> for UVec2

type Output = UVec2

The resulting type after applying the + operator.

fn add(self, rhs: u32) -> Self

Performs the + operation.

impl Add for UVec2

type Output = UVec2

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl AddAssign<u32> for UVec2

fn add_assign(&mut self, rhs: u32)

Performs the += operation.

impl AddAssign for UVec2

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AsMut<[u32; 2]> for UVec2

fn as_mut(&mut self) -> &mut [u32; 2]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u32; 2]> for UVec2

fn as_ref(&self) -> &[u32; 2]

Converts this type into a shared reference of the (usually inferred) input type.

impl BitAnd<u32> for UVec2

type Output = UVec2

The resulting type after applying the & operator.

fn bitand(self, rhs: u32) -> Self::Output

Performs the & operation.

impl BitAnd for UVec2

type Output = UVec2

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr<u32> for UVec2

type Output = UVec2

The resulting type after applying the | operator.

fn bitor(self, rhs: u32) -> Self::Output

Performs the | operation.

impl BitOr for UVec2

type Output = UVec2

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor<u32> for UVec2

type Output = UVec2

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u32) -> Self::Output

Performs the ^ operation.

impl BitXor for UVec2

type Output = UVec2

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for UVec2

fn clone(&self) -> UVec2

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UVec2

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UVec2

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UVec2

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UVec2

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Distribution<UVec2> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> UVec2

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl Div<UVec2> for u32

type Output = UVec2

The resulting type after applying the / operator.

fn div(self, rhs: UVec2) -> UVec2

Performs the / operation.

impl Div<u32> for UVec2

type Output = UVec2

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self

Performs the / operation.

impl Div for UVec2

type Output = UVec2

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self

Performs the / operation.

impl DivAssign<u32> for UVec2

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl DivAssign for UVec2

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<[u32; 2]> for UVec2

fn from(a: [u32; 2]) -> Self

Converts to this type from the input type.

impl From<(u32, u32)> for UVec2

fn from(t: (u32, u32)) -> Self

Converts to this type from the input type.

impl From<BVec2> for UVec2

fn from(v: BVec2) -> Self

Converts to this type from the input type.

impl From<U16Vec2> for UVec2

fn from(v: U16Vec2) -> Self

Converts to this type from the input type.

impl From<UVec2> for [u32; 2]

fn from(v: UVec2) -> Self

Converts to this type from the input type.

impl From<UVec2> for (u32, u32)

fn from(v: UVec2) -> Self

Converts to this type from the input type.

impl From<UVec2> for DVec2

fn from(v: UVec2) -> Self

Converts to this type from the input type.

impl From<UVec2> for I64Vec2

fn from(v: UVec2) -> Self

Converts to this type from the input type.

impl From<UVec2> for U64Vec2

fn from(v: UVec2) -> Self

Converts to this type from the input type.

impl Hash for UVec2

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for UVec2

type Output = u32

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for UVec2

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Mul<UVec2> for u32

type Output = UVec2

The resulting type after applying the * operator.

fn mul(self, rhs: UVec2) -> UVec2

Performs the * operation.

impl Mul<u32> for UVec2

type Output = UVec2

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self

Performs the * operation.

impl Mul for UVec2

type Output = UVec2

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl MulAssign<u32> for UVec2

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation.

impl MulAssign for UVec2

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Not for UVec2

type Output = UVec2

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for UVec2

fn eq(&self, other: &UVec2) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Product<&'a UVec2> for UVec2

fn product<I>(iter: I) -> Self

where I: Iterator<Item = &'a Self>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl Product for UVec2

fn product<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl Rem<UVec2> for u32

type Output = UVec2

The resulting type after applying the % operator.

fn rem(self, rhs: UVec2) -> UVec2

Performs the % operation.

impl Rem<u32> for UVec2

type Output = UVec2

The resulting type after applying the % operator.

fn rem(self, rhs: u32) -> Self

Performs the % operation.

impl Rem for UVec2

type Output = UVec2

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self

Performs the % operation.

impl RemAssign<u32> for UVec2

fn rem_assign(&mut self, rhs: u32)

Performs the %= operation.

impl RemAssign for UVec2

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Serialize for UVec2

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Shl<IVec2> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: IVec2) -> Self::Output

Performs the << operation.

impl Shl<UVec2> for I16Vec2

type Output = I16Vec2

The resulting type after applying the << operator.

fn shl(self, rhs: UVec2) -> Self::Output

Performs the << operation.

impl Shl<UVec2> for I64Vec2

type Output = I64Vec2

The resulting type after applying the << operator.

fn shl(self, rhs: UVec2) -> Self::Output

Performs the << operation.

impl Shl<UVec2> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: UVec2) -> Self::Output

Performs the << operation.

impl Shl<UVec2> for U16Vec2

type Output = U16Vec2

The resulting type after applying the << operator.

fn shl(self, rhs: UVec2) -> Self::Output

Performs the << operation.

impl Shl<UVec2> for U64Vec2

type Output = U64Vec2

The resulting type after applying the << operator.

fn shl(self, rhs: UVec2) -> Self::Output

Performs the << operation.

impl Shl<i16> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: i16) -> Self::Output

Performs the << operation.

impl Shl<i32> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: i32) -> Self::Output

Performs the << operation.

impl Shl<i64> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: i64) -> Self::Output

Performs the << operation.

impl Shl<i8> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: i8) -> Self::Output

Performs the << operation.

impl Shl<u16> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: u16) -> Self::Output

Performs the << operation.

impl Shl<u32> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> Self::Output

Performs the << operation.

impl Shl<u64> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: u64) -> Self::Output

Performs the << operation.

impl Shl<u8> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: u8) -> Self::Output

Performs the << operation.

impl Shl for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: UVec2) -> Self::Output

Performs the << operation.

impl Shr<IVec2> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: IVec2) -> Self::Output

Performs the >> operation.

impl Shr<UVec2> for I16Vec2

type Output = I16Vec2

The resulting type after applying the >> operator.

fn shr(self, rhs: UVec2) -> Self::Output

Performs the >> operation.

impl Shr<UVec2> for I64Vec2

type Output = I64Vec2

The resulting type after applying the >> operator.

fn shr(self, rhs: UVec2) -> Self::Output

Performs the >> operation.

impl Shr<UVec2> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: UVec2) -> Self::Output

Performs the >> operation.

impl Shr<UVec2> for U16Vec2

type Output = U16Vec2

The resulting type after applying the >> operator.

fn shr(self, rhs: UVec2) -> Self::Output

Performs the >> operation.

impl Shr<UVec2> for U64Vec2

type Output = U64Vec2

The resulting type after applying the >> operator.

fn shr(self, rhs: UVec2) -> Self::Output

Performs the >> operation.

impl Shr<i16> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: i16) -> Self::Output

Performs the >> operation.

impl Shr<i32> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: i32) -> Self::Output

Performs the >> operation.

impl Shr<i64> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: i64) -> Self::Output

Performs the >> operation.

impl Shr<i8> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: i8) -> Self::Output

Performs the >> operation.

impl Shr<u16> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: u16) -> Self::Output

Performs the >> operation.

impl Shr<u32> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> Self::Output

Performs the >> operation.

impl Shr<u64> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: u64) -> Self::Output

Performs the >> operation.

impl Shr<u8> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: u8) -> Self::Output

Performs the >> operation.

impl Shr for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: UVec2) -> Self::Output

Performs the >> operation.

impl Sub<UVec2> for u32

type Output = UVec2

The resulting type after applying the - operator.

fn sub(self, rhs: UVec2) -> UVec2

Performs the - operation.

impl Sub<u32> for UVec2

type Output = UVec2

The resulting type after applying the - operator.

fn sub(self, rhs: u32) -> Self

Performs the - operation.

impl Sub for UVec2

type Output = UVec2

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl SubAssign<u32> for UVec2

fn sub_assign(&mut self, rhs: u32)

Performs the -= operation.

impl SubAssign for UVec2

fn sub_assign(&mut self, rhs: UVec2)

Performs the -= operation.

impl<'a> Sum<&'a UVec2> for UVec2

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = &'a Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for UVec2

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<I16Vec2> for UVec2

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: I16Vec2) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I64Vec2> for UVec2

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: I64Vec2) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<IVec2> for UVec2

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: IVec2) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<U64Vec2> for UVec2

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: U64Vec2) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<UVec2> for I16Vec2

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: UVec2) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<UVec2> for IVec2

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: UVec2) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<UVec2> for U16Vec2

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: UVec2) -> Result<Self, Self::Error>

Performs the conversion.

impl Vec2Swizzles for UVec2

type Vec3 = UVec3

type Vec4 = UVec4

fn xx(self) -> UVec2

fn xy(self) -> UVec2

fn yx(self) -> UVec2

fn yy(self) -> UVec2

fn xxx(self) -> UVec3

fn xxy(self) -> UVec3

fn xyx(self) -> UVec3

fn xyy(self) -> UVec3

fn yxx(self) -> UVec3

fn yxy(self) -> UVec3

fn yyx(self) -> UVec3

fn yyy(self) -> UVec3

fn xxxx(self) -> UVec4

fn xxxy(self) -> UVec4

fn xxyx(self) -> UVec4

fn xxyy(self) -> UVec4

fn xyxx(self) -> UVec4

fn xyxy(self) -> UVec4

fn xyyx(self) -> UVec4

fn xyyy(self) -> UVec4

fn yxxx(self) -> UVec4

fn yxxy(self) -> UVec4

fn yxyx(self) -> UVec4

fn yxyy(self) -> UVec4

fn yyxx(self) -> UVec4

fn yyxy(self) -> UVec4

fn yyyx(self) -> UVec4

fn yyyy(self) -> UVec4

impl Zeroable for UVec2

fn zeroed() -> Self

Calls zeroed.

impl Copy for UVec2

impl Eq for UVec2

impl Pod for UVec2

impl StructuralPartialEq for UVec2