aboutsummaryrefslogtreecommitdiff
path: root/src/u32/uvec2.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/u32/uvec2.rs')
-rw-r--r--src/u32/uvec2.rs259
1 files changed, 254 insertions, 5 deletions
diff --git a/src/u32/uvec2.rs b/src/u32/uvec2.rs
index d0c838e..39fbf9a 100644
--- a/src/u32/uvec2.rs
+++ b/src/u32/uvec2.rs
@@ -1,6 +1,6 @@
// Generated from vec.rs.tera template. Edit the template, not the generated file.
-use crate::{BVec2, UVec3};
+use crate::{BVec2, I16Vec2, I64Vec2, IVec2, U16Vec2, U64Vec2, UVec3};
#[cfg(not(target_arch = "spirv"))]
use core::fmt;
@@ -9,6 +9,7 @@ use core::{f32, ops::*};
/// Creates a 2-dimensional vector.
#[inline(always)]
+#[must_use]
pub const fn uvec2(x: u32, y: u32) -> UVec2 {
UVec2::new(x, y)
}
@@ -31,10 +32,16 @@ impl UVec2 {
/// All ones.
pub const ONE: Self = Self::splat(1);
- /// A unit-length vector pointing along the positive X axis.
+ /// All `u32::MIN`.
+ pub const MIN: Self = Self::splat(u32::MIN);
+
+ /// All `u32::MAX`.
+ pub const MAX: Self = Self::splat(u32::MAX);
+
+ /// A unit vector pointing along the positive X axis.
pub const X: Self = Self::new(1, 0);
- /// A unit-length vector pointing along the positive Y axis.
+ /// A unit vector pointing along the positive Y axis.
pub const Y: Self = Self::new(0, 1);
/// The unit axes.
@@ -42,12 +49,14 @@ impl UVec2 {
/// Creates a new vector.
#[inline(always)]
+ #[must_use]
pub const fn new(x: u32, y: u32) -> Self {
Self { x, y }
}
/// Creates a vector with all elements set to `v`.
#[inline]
+ #[must_use]
pub const fn splat(v: u32) -> Self {
Self { x: v, y: v }
}
@@ -58,21 +67,24 @@ impl UVec2 {
/// A true element in the mask uses the corresponding element from `if_true`, and false
/// uses the element from `if_false`.
#[inline]
+ #[must_use]
pub fn select(mask: BVec2, if_true: Self, if_false: Self) -> Self {
Self {
- x: if mask.x { if_true.x } else { if_false.x },
- y: if mask.y { if_true.y } else { if_false.y },
+ x: if mask.test(0) { if_true.x } else { if_false.x },
+ y: if mask.test(1) { if_true.y } else { if_false.y },
}
}
/// Creates a new vector from an array.
#[inline]
+ #[must_use]
pub const fn from_array(a: [u32; 2]) -> Self {
Self::new(a[0], a[1])
}
/// `[x, y]`
#[inline]
+ #[must_use]
pub const fn to_array(&self) -> [u32; 2] {
[self.x, self.y]
}
@@ -83,6 +95,7 @@ impl UVec2 {
///
/// Panics if `slice` is less than 2 elements long.
#[inline]
+ #[must_use]
pub const fn from_slice(slice: &[u32]) -> Self {
Self::new(slice[0], slice[1])
}
@@ -100,18 +113,21 @@ impl UVec2 {
/// Creates a 3D vector from `self` and the given `z` value.
#[inline]
+ #[must_use]
pub const fn extend(self, z: u32) -> UVec3 {
UVec3::new(self.x, self.y, z)
}
/// Computes the dot product of `self` and `rhs`.
#[inline]
+ #[must_use]
pub fn dot(self, rhs: Self) -> u32 {
(self.x * rhs.x) + (self.y * rhs.y)
}
/// Returns a vector where every component is the dot product of `self` and `rhs`.
#[inline]
+ #[must_use]
pub fn dot_into_vec(self, rhs: Self) -> Self {
Self::splat(self.dot(rhs))
}
@@ -120,6 +136,7 @@ impl UVec2 {
///
/// In other words this computes `[self.x.min(rhs.x), self.y.min(rhs.y), ..]`.
#[inline]
+ #[must_use]
pub fn min(self, rhs: Self) -> Self {
Self {
x: self.x.min(rhs.x),
@@ -131,6 +148,7 @@ impl UVec2 {
///
/// In other words this computes `[self.x.max(rhs.x), self.y.max(rhs.y), ..]`.
#[inline]
+ #[must_use]
pub fn max(self, rhs: Self) -> Self {
Self {
x: self.x.max(rhs.x),
@@ -146,6 +164,7 @@ impl UVec2 {
///
/// Will panic if `min` is greater than `max` when `glam_assert` is enabled.
#[inline]
+ #[must_use]
pub fn clamp(self, min: Self, max: Self) -> Self {
glam_assert!(min.cmple(max).all(), "clamp: expected min <= max");
self.max(min).min(max)
@@ -155,6 +174,7 @@ impl UVec2 {
///
/// In other words this computes `min(x, y, ..)`.
#[inline]
+ #[must_use]
pub fn min_element(self) -> u32 {
self.x.min(self.y)
}
@@ -163,6 +183,7 @@ impl UVec2 {
///
/// In other words this computes `max(x, y, ..)`.
#[inline]
+ #[must_use]
pub fn max_element(self) -> u32 {
self.x.max(self.y)
}
@@ -173,6 +194,7 @@ impl UVec2 {
/// In other words, this computes `[self.x == rhs.x, self.y == rhs.y, ..]` for all
/// elements.
#[inline]
+ #[must_use]
pub fn cmpeq(self, rhs: Self) -> BVec2 {
BVec2::new(self.x.eq(&rhs.x), self.y.eq(&rhs.y))
}
@@ -183,6 +205,7 @@ impl UVec2 {
/// In other words this computes `[self.x != rhs.x, self.y != rhs.y, ..]` for all
/// elements.
#[inline]
+ #[must_use]
pub fn cmpne(self, rhs: Self) -> BVec2 {
BVec2::new(self.x.ne(&rhs.x), self.y.ne(&rhs.y))
}
@@ -193,6 +216,7 @@ impl UVec2 {
/// In other words this computes `[self.x >= rhs.x, self.y >= rhs.y, ..]` for all
/// elements.
#[inline]
+ #[must_use]
pub fn cmpge(self, rhs: Self) -> BVec2 {
BVec2::new(self.x.ge(&rhs.x), self.y.ge(&rhs.y))
}
@@ -203,6 +227,7 @@ impl UVec2 {
/// In other words this computes `[self.x > rhs.x, self.y > rhs.y, ..]` for all
/// elements.
#[inline]
+ #[must_use]
pub fn cmpgt(self, rhs: Self) -> BVec2 {
BVec2::new(self.x.gt(&rhs.x), self.y.gt(&rhs.y))
}
@@ -213,6 +238,7 @@ impl UVec2 {
/// In other words this computes `[self.x <= rhs.x, self.y <= rhs.y, ..]` for all
/// elements.
#[inline]
+ #[must_use]
pub fn cmple(self, rhs: Self) -> BVec2 {
BVec2::new(self.x.le(&rhs.x), self.y.le(&rhs.y))
}
@@ -223,27 +249,163 @@ impl UVec2 {
/// In other words this computes `[self.x < rhs.x, self.y < rhs.y, ..]` for all
/// elements.
#[inline]
+ #[must_use]
pub fn cmplt(self, rhs: Self) -> BVec2 {
BVec2::new(self.x.lt(&rhs.x), self.y.lt(&rhs.y))
}
+ /// Computes the squared length of `self`.
+ #[doc(alias = "magnitude2")]
+ #[inline]
+ #[must_use]
+ pub fn length_squared(self) -> u32 {
+ self.dot(self)
+ }
+
/// Casts all elements of `self` to `f32`.
#[inline]
+ #[must_use]
pub fn as_vec2(&self) -> crate::Vec2 {
crate::Vec2::new(self.x as f32, self.y as f32)
}
/// Casts all elements of `self` to `f64`.
#[inline]
+ #[must_use]
pub fn as_dvec2(&self) -> crate::DVec2 {
crate::DVec2::new(self.x as f64, self.y as f64)
}
+ /// Casts all elements of `self` to `i16`.
+ #[inline]
+ #[must_use]
+ pub fn as_i16vec2(&self) -> crate::I16Vec2 {
+ crate::I16Vec2::new(self.x as i16, self.y as i16)
+ }
+
+ /// Casts all elements of `self` to `u16`.
+ #[inline]
+ #[must_use]
+ pub fn as_u16vec2(&self) -> crate::U16Vec2 {
+ crate::U16Vec2::new(self.x as u16, self.y as u16)
+ }
+
/// Casts all elements of `self` to `i32`.
#[inline]
+ #[must_use]
pub fn as_ivec2(&self) -> crate::IVec2 {
crate::IVec2::new(self.x as i32, self.y as i32)
}
+
+ /// Casts all elements of `self` to `i64`.
+ #[inline]
+ #[must_use]
+ pub fn as_i64vec2(&self) -> crate::I64Vec2 {
+ crate::I64Vec2::new(self.x as i64, self.y as i64)
+ }
+
+ /// Casts all elements of `self` to `u64`.
+ #[inline]
+ #[must_use]
+ pub fn as_u64vec2(&self) -> crate::U64Vec2 {
+ crate::U64Vec2::new(self.x as u64, self.y as u64)
+ }
+
+ /// 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), ..]`.
+ #[inline]
+ #[must_use]
+ pub const fn wrapping_add(self, rhs: Self) -> Self {
+ Self {
+ x: self.x.wrapping_add(rhs.x),
+ y: self.y.wrapping_add(rhs.y),
+ }
+ }
+
+ /// 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), ..]`.
+ #[inline]
+ #[must_use]
+ pub const fn wrapping_sub(self, rhs: Self) -> Self {
+ Self {
+ x: self.x.wrapping_sub(rhs.x),
+ y: self.y.wrapping_sub(rhs.y),
+ }
+ }
+
+ /// 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), ..]`.
+ #[inline]
+ #[must_use]
+ pub const fn wrapping_mul(self, rhs: Self) -> Self {
+ Self {
+ x: self.x.wrapping_mul(rhs.x),
+ y: self.y.wrapping_mul(rhs.y),
+ }
+ }
+
+ /// 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), ..]`.
+ #[inline]
+ #[must_use]
+ pub const fn wrapping_div(self, rhs: Self) -> Self {
+ Self {
+ x: self.x.wrapping_div(rhs.x),
+ y: self.y.wrapping_div(rhs.y),
+ }
+ }
+
+ /// 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), ..]`.
+ #[inline]
+ #[must_use]
+ pub const fn saturating_add(self, rhs: Self) -> Self {
+ Self {
+ x: self.x.saturating_add(rhs.x),
+ y: self.y.saturating_add(rhs.y),
+ }
+ }
+
+ /// 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), ..]`.
+ #[inline]
+ #[must_use]
+ pub const fn saturating_sub(self, rhs: Self) -> Self {
+ Self {
+ x: self.x.saturating_sub(rhs.x),
+ y: self.y.saturating_sub(rhs.y),
+ }
+ }
+
+ /// 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), ..]`.
+ #[inline]
+ #[must_use]
+ pub const fn saturating_mul(self, rhs: Self) -> Self {
+ Self {
+ x: self.x.saturating_mul(rhs.x),
+ y: self.y.saturating_mul(rhs.y),
+ }
+ }
+
+ /// 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), ..]`.
+ #[inline]
+ #[must_use]
+ pub const fn saturating_div(self, rhs: Self) -> Self {
+ Self {
+ x: self.x.saturating_div(rhs.x),
+ y: self.y.saturating_div(rhs.y),
+ }
+ }
}
impl Default for UVec2 {
@@ -697,6 +859,28 @@ impl Shr<i32> for UVec2 {
}
}
+impl Shl<i64> for UVec2 {
+ type Output = Self;
+ #[inline]
+ fn shl(self, rhs: i64) -> Self::Output {
+ Self {
+ x: self.x.shl(rhs),
+ y: self.y.shl(rhs),
+ }
+ }
+}
+
+impl Shr<i64> for UVec2 {
+ type Output = Self;
+ #[inline]
+ fn shr(self, rhs: i64) -> Self::Output {
+ Self {
+ x: self.x.shr(rhs),
+ y: self.y.shr(rhs),
+ }
+ }
+}
+
impl Shl<u8> for UVec2 {
type Output = Self;
#[inline]
@@ -763,6 +947,28 @@ impl Shr<u32> for UVec2 {
}
}
+impl Shl<u64> for UVec2 {
+ type Output = Self;
+ #[inline]
+ fn shl(self, rhs: u64) -> Self::Output {
+ Self {
+ x: self.x.shl(rhs),
+ y: self.y.shl(rhs),
+ }
+ }
+}
+
+impl Shr<u64> for UVec2 {
+ type Output = Self;
+ #[inline]
+ fn shr(self, rhs: u64) -> Self::Output {
+ Self {
+ x: self.x.shr(rhs),
+ y: self.y.shr(rhs),
+ }
+ }
+}
+
impl Shl<crate::IVec2> for UVec2 {
type Output = Self;
#[inline]
@@ -874,3 +1080,46 @@ impl From<UVec2> for (u32, u32) {
(v.x, v.y)
}
}
+
+impl From<U16Vec2> for UVec2 {
+ #[inline]
+ fn from(v: U16Vec2) -> Self {
+ Self::new(u32::from(v.x), u32::from(v.y))
+ }
+}
+
+impl TryFrom<I16Vec2> for UVec2 {
+ type Error = core::num::TryFromIntError;
+
+ #[inline]
+ fn try_from(v: I16Vec2) -> Result<Self, Self::Error> {
+ Ok(Self::new(u32::try_from(v.x)?, u32::try_from(v.y)?))
+ }
+}
+
+impl TryFrom<IVec2> for UVec2 {
+ type Error = core::num::TryFromIntError;
+
+ #[inline]
+ fn try_from(v: IVec2) -> Result<Self, Self::Error> {
+ Ok(Self::new(u32::try_from(v.x)?, u32::try_from(v.y)?))
+ }
+}
+
+impl TryFrom<I64Vec2> for UVec2 {
+ type Error = core::num::TryFromIntError;
+
+ #[inline]
+ fn try_from(v: I64Vec2) -> Result<Self, Self::Error> {
+ Ok(Self::new(u32::try_from(v.x)?, u32::try_from(v.y)?))
+ }
+}
+
+impl TryFrom<U64Vec2> for UVec2 {
+ type Error = core::num::TryFromIntError;
+
+ #[inline]
+ fn try_from(v: U64Vec2) -> Result<Self, Self::Error> {
+ Ok(Self::new(u32::try_from(v.x)?, u32::try_from(v.y)?))
+ }
+}