Struct rfw_math::UVec2

#[repr(transparent)]
pub struct UVec2(_);

A 2-dimensional vector.

Implementations

impl UVec2

pub const ZERO: UVec2

All zeroes.

pub const ONE: UVec2

All ones.

pub const X: UVec2

[1, 0]: a unit-length vector pointing along the positive X axis.

pub const Y: UVec2

[0, 1]: a unit-length vector pointing along the positive Y axis.

pub const AXES: [UVec2; 2]

The unit axes.

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

Creates a new vector.

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

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

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

[x, y]

pub fn splat(v: u32) -> UVec2

Creates a vector with all elements set to v.

pub fn select(mask: BVec2, if_true: UVec2, if_false: UVec2) -> UVec2

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 fn dot(self, other: UVec2) -> u32

Computes the dot product of self and other.

pub fn min(self, other: UVec2) -> UVec2

Returns a vector containing the mininum values for each element of self and other.

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

pub fn max(self, other: UVec2) -> UVec2

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

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

Component-wise clamping of values, similar to f32::clamp.

Each element in min must be less-or-equal to the corresponing 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 cmpeq(self, other: UVec2) -> 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.

pub fn cmpne(self, other: UVec2) -> 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.

pub fn cmpge(self, other: UVec2) -> 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.

pub fn cmpgt(self, other: UVec2) -> 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.

pub fn cmple(self, other: UVec2) -> 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.

pub fn cmplt(self, other: UVec2) -> 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.

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

Creates a vector from the first N values in slice.

Panics

Panics if slice is less than N elements long.

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

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

Panics

Panics if slice is less than N elements long.

pub fn as_f32(&self) -> Vec2

Casts all elements of self to f32.

pub fn as_f64(&self) -> DVec2

Casts all elements of self to f64.

pub fn as_i32(&self) -> IVec2

Casts all elements of self to i32.

Trait Implementations

impl Add<UVec2> for UVec2

type Output = UVec2

The resulting type after applying the + operator.

pub fn add(self, other: UVec2) -> UVec2

Performs the + operation.

impl Add<u32> for UVec2

type Output = UVec2

The resulting type after applying the + operator.

pub fn add(self, other: u32) -> UVec2

Performs the + operation.

impl AddAssign<UVec2> for UVec2

pub fn add_assign(&mut self, other: UVec2)

Performs the += operation.

impl AddAssign<u32> for UVec2

pub fn add_assign(&mut self, other: u32)

Performs the += operation.

impl AsMut<[u32; 2]> for UVec2

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

Performs the conversion.

impl AsRef<[u32; 2]> for UVec2

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

Performs the conversion.

impl Clone for UVec2

pub 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

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

Formats the value using the given formatter.

impl Default for UVec2

pub fn default() -> UVec2

Returns the “default value” for a type.

impl Deref for UVec2

type Target = XY<u32>

The resulting type after dereferencing.

pub fn deref(&self) -> &<UVec2 as Deref>::Target

Dereferences the value.

impl DerefMut for UVec2

pub fn deref_mut(&mut self) -> &mut <UVec2 as Deref>::Target

Mutably dereferences the value.

impl Display for UVec2

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

Formats the value using the given formatter.

impl Div<UVec2> for UVec2

type Output = UVec2

The resulting type after applying the / operator.

pub fn div(self, other: UVec2) -> UVec2

Performs the / operation.

impl Div<u32> for UVec2

type Output = UVec2

The resulting type after applying the / operator.

pub fn div(self, other: u32) -> UVec2

Performs the / operation.

impl DivAssign<UVec2> for UVec2

pub fn div_assign(&mut self, other: UVec2)

Performs the /= operation.

impl DivAssign<u32> for UVec2

pub fn div_assign(&mut self, other: u32)

Performs the /= operation.

impl From<[u32; 2]> for UVec2

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

Performs the conversion.

impl From<(u32, u32)> for UVec2

pub fn from(t: (u32, u32)) -> UVec2

Performs the conversion.

impl From<UVec2> for XY<u32>

pub fn from(t: UVec2) -> XY<u32>

Performs the conversion.

impl From<UVec3> for UVec2

pub fn from(v: UVec3) -> UVec2

Creates a Vec2 from the x and y elements of self, discarding z.

impl From<UVec4> for UVec2

pub fn from(v: UVec4) -> UVec2

Creates a 2D vector from the x and y elements of self, discarding z and w.

impl From<XY<u32>> for UVec2

pub fn from(t: XY<u32>) -> UVec2

Performs the conversion.

impl Hash for UVec2

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Index<usize> for UVec2

type Output = u32

The returned type after indexing.

pub fn index(&self, index: usize) -> &<UVec2 as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for UVec2

pub fn index_mut(
    &mut self,
    index: usize
) -> &mut <UVec2 as Index<usize>>::Output

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

impl Mul<UVec2> for UVec2

type Output = UVec2

The resulting type after applying the * operator.

pub fn mul(self, other: UVec2) -> UVec2

Performs the * operation.

impl Mul<u32> for UVec2

type Output = UVec2

The resulting type after applying the * operator.

pub fn mul(self, other: u32) -> UVec2

Performs the * operation.

impl MulAssign<UVec2> for UVec2

pub fn mul_assign(&mut self, other: UVec2)

Performs the *= operation.

impl MulAssign<u32> for UVec2

pub fn mul_assign(&mut self, other: u32)

Performs the *= operation.

impl PartialEq<UVec2> for UVec2

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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

pub fn product<I>(iter: I) -> UVec2 where
    I: Iterator<Item = &'a UVec2>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Sub<UVec2> for UVec2

type Output = UVec2

The resulting type after applying the - operator.

pub fn sub(self, other: UVec2) -> UVec2

Performs the - operation.

impl Sub<u32> for UVec2

type Output = UVec2

The resulting type after applying the - operator.

pub fn sub(self, other: u32) -> UVec2

Performs the - operation.

impl SubAssign<UVec2> for UVec2

pub fn sub_assign(&mut self, other: UVec2)

Performs the -= operation.

impl SubAssign<u32> for UVec2

pub fn sub_assign(&mut self, other: u32)

Performs the -= operation.

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

pub fn sum<I>(iter: I) -> UVec2 where
    I: Iterator<Item = &'a UVec2>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Vec2Swizzles for UVec2

type Vec3 = UVec3

type Vec4 = UVec4

pub fn xxxx(self) -> UVec4

pub fn xxxy(self) -> UVec4

pub fn xxyx(self) -> UVec4

pub fn xxyy(self) -> UVec4

pub fn xyxx(self) -> UVec4

pub fn xyxy(self) -> UVec4

pub fn xyyx(self) -> UVec4

pub fn xyyy(self) -> UVec4

pub fn yxxx(self) -> UVec4

pub fn yxxy(self) -> UVec4

pub fn yxyx(self) -> UVec4

pub fn yxyy(self) -> UVec4

pub fn yyxx(self) -> UVec4

pub fn yyxy(self) -> UVec4

pub fn yyyx(self) -> UVec4

pub fn yyyy(self) -> UVec4

pub fn xxx(self) -> UVec3

pub fn xxy(self) -> UVec3

pub fn xyx(self) -> UVec3

pub fn xyy(self) -> UVec3

pub fn yxx(self) -> UVec3

pub fn yxy(self) -> UVec3

pub fn yyx(self) -> UVec3

pub fn yyy(self) -> UVec3

pub fn xx(self) -> UVec2

pub fn yx(self) -> UVec2

pub fn yy(self) -> UVec2

fn xy(self) -> Self

impl Copy for UVec2

impl Eq for UVec2