Struct IVec2

#[repr(C)]
pub struct IVec2 {
    pub x: i32,
    pub y: i32,
}

A 2-dimensional vector.

Fields

x: i32

y: i32

Implementations

impl IVec2

pub const ZERO: IVec2

All zeroes.

pub const ONE: IVec2

All ones.

pub const NEG_ONE: IVec2

All negative ones.

pub const MIN: IVec2

All i32::MIN.

pub const MAX: IVec2

All i32::MAX.

pub const X: IVec2

A unit vector pointing along the positive X axis.

pub const Y: IVec2

A unit vector pointing along the positive Y axis.

pub const NEG_X: IVec2

A unit vector pointing along the negative X axis.

pub const NEG_Y: IVec2

A unit vector pointing along the negative Y axis.

pub const AXES: [IVec2; 2]

The unit axes.

pub const fn new(x: i32, y: i32) -> IVec2

Creates a new vector.

pub const fn splat(v: i32) -> IVec2

Creates a vector with all elements set to v.

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

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: [i32; 2]) -> IVec2

Creates a new vector from an array.

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

[x, y]

pub const fn from_slice(slice: &[i32]) -> IVec2

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 [i32])

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: i32) -> IVec3

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

pub fn dot(self, rhs: IVec2) -> i32

Computes the dot product of self and rhs.

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

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

pub fn min(self, rhs: IVec2) -> IVec2

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: IVec2) -> IVec2

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: IVec2, max: IVec2) -> IVec2

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.

pub fn min_element(self) -> i32

Returns the horizontal minimum of self.

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

pub fn max_element(self) -> i32

Returns the horizontal maximum of self.

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

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

Returns a vector containing the absolute value of each element of self.

pub fn signum(self) -> IVec2

Returns a vector with elements representing the sign of self.

• 0 if the number is zero
• 1 if the number is positive
• -1 if the number is negative

pub fn is_negative_bitmask(self) -> u32

Returns a bitmask with the lowest 2 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.

pub fn length_squared(self) -> i32

Computes the squared length of self.

pub fn distance_squared(self, rhs: IVec2) -> i32

Compute the squared euclidean distance between two points in space.

pub fn div_euclid(self, rhs: IVec2) -> IVec2

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.

pub fn rem_euclid(self, rhs: IVec2) -> IVec2

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.

pub fn perp(self) -> IVec2

Returns a vector that is equal to self rotated by 90 degrees.

pub fn perp_dot(self, rhs: IVec2) -> i32

The perpendicular dot product of self and rhs. Also known as the wedge product, 2D cross product, and determinant.

pub fn rotate(self, rhs: IVec2) -> IVec2

Returns rhs rotated by the angle of self. If self is normalized, then this just rotation. This is what you usually want. Otherwise, it will be like a rotation with a multiplication by self’s length.

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_uvec2(&self) -> UVec2

Casts all elements of self to u32.

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: IVec2) -> IVec2

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: IVec2) -> IVec2

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: IVec2) -> IVec2

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: IVec2) -> IVec2

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: IVec2) -> IVec2

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: IVec2) -> IVec2

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: IVec2) -> IVec2

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: IVec2) -> IVec2

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

Trait Implementations

impl Add<IVec2> for i32

type Output = IVec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i32> for IVec2

type Output = IVec2

The resulting type after applying the + operator.

fn add(self, rhs: i32) -> IVec2

Performs the + operation.

impl Add for IVec2

type Output = IVec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<i32> for IVec2

fn add_assign(&mut self, rhs: i32)

Performs the += operation.

impl AddAssign for IVec2

fn add_assign(&mut self, rhs: IVec2)

Performs the += operation.

impl AsMut<[i32; 2]> for IVec2

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

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

impl AsRef<[i32; 2]> for IVec2

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

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

impl BitAnd<i32> for IVec2

type Output = IVec2

The resulting type after applying the & operator.

fn bitand(self, rhs: i32) -> <IVec2 as BitAnd<i32>>::Output

Performs the & operation.

impl BitAnd for IVec2

type Output = IVec2

The resulting type after applying the & operator.

fn bitand(self, rhs: IVec2) -> <IVec2 as BitAnd>::Output

Performs the & operation.

impl BitOr<i32> for IVec2

type Output = IVec2

The resulting type after applying the | operator.

fn bitor(self, rhs: i32) -> <IVec2 as BitOr<i32>>::Output

Performs the | operation.

impl BitOr for IVec2

type Output = IVec2

The resulting type after applying the | operator.

fn bitor(self, rhs: IVec2) -> <IVec2 as BitOr>::Output

Performs the | operation.

impl BitXor<i32> for IVec2

type Output = IVec2

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: i32) -> <IVec2 as BitXor<i32>>::Output

Performs the ^ operation.

impl BitXor for IVec2

type Output = IVec2

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: IVec2) -> <IVec2 as BitXor>::Output

Performs the ^ operation.

impl Clone for IVec2

fn clone(&self) -> IVec2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IVec2

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

Formats the value using the given formatter.

impl Default for IVec2

fn default() -> IVec2

Returns the “default value” for a type.

impl Display for IVec2

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

Formats the value using the given formatter.

impl Div<IVec2> for i32

type Output = IVec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i32> for IVec2

type Output = IVec2

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> IVec2

Performs the / operation.

impl Div for IVec2

type Output = IVec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<i32> for IVec2

fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

impl DivAssign for IVec2

fn div_assign(&mut self, rhs: IVec2)

Performs the /= operation.

impl From<[i32; 2]> for IVec2

fn from(a: [i32; 2]) -> IVec2

Converts to this type from the input type.

impl From<(i32, i32)> for IVec2

fn from(t: (i32, i32)) -> IVec2

Converts to this type from the input type.

impl From<IVec2> for [i32; 2]

fn from(v: IVec2) -> [i32; 2]

Converts to this type from the input type.

impl From<IVec2> for (i32, i32)

fn from(v: IVec2) -> (i32, i32)

Converts to this type from the input type.

impl From<IVec2> for DVec2

fn from(v: IVec2) -> DVec2

Converts to this type from the input type.

impl From<IVec2> for I64Vec2

fn from(v: IVec2) -> I64Vec2

Converts to this type from the input type.

impl Hash for IVec2

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for IVec2

type Output = i32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for IVec2

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

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

impl Mul<IVec2> for i32

type Output = IVec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i32> for IVec2

type Output = IVec2

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> IVec2

Performs the * operation.

impl Mul for IVec2

type Output = IVec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<i32> for IVec2

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl MulAssign for IVec2

fn mul_assign(&mut self, rhs: IVec2)

Performs the *= operation.

impl Neg for IVec2

type Output = IVec2

The resulting type after applying the - operator.

fn neg(self) -> IVec2

Performs the unary - operation.

impl Not for IVec2

type Output = IVec2

The resulting type after applying the ! operator.

fn not(self) -> <IVec2 as Not>::Output

Performs the unary ! operation.

impl PartialEq for IVec2

fn eq(&self, other: &IVec2) -> 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 IVec2> for IVec2

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

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

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

impl Product for IVec2

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

where I: Iterator<Item = IVec2>,

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

impl Rem<IVec2> for i32

type Output = IVec2

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<i32> for IVec2

type Output = IVec2

The resulting type after applying the % operator.

fn rem(self, rhs: i32) -> IVec2

Performs the % operation.

impl Rem for IVec2

type Output = IVec2

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<i32> for IVec2

fn rem_assign(&mut self, rhs: i32)

Performs the %= operation.

impl RemAssign for IVec2

fn rem_assign(&mut self, rhs: IVec2)

Performs the %= operation.

impl Shl<IVec2> for I64Vec2

type Output = I64Vec2

The resulting type after applying the << operator.

fn shl(self, rhs: IVec2) -> <I64Vec2 as Shl<IVec2>>::Output

Performs the << operation.

impl Shl<IVec2> for U64Vec2

type Output = U64Vec2

The resulting type after applying the << operator.

fn shl(self, rhs: IVec2) -> <U64Vec2 as Shl<IVec2>>::Output

Performs the << operation.

impl Shl<IVec2> for UVec2

type Output = UVec2

The resulting type after applying the << operator.

fn shl(self, rhs: IVec2) -> <UVec2 as Shl<IVec2>>::Output

Performs the << operation.

impl Shl<UVec2> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: UVec2) -> <IVec2 as Shl<UVec2>>::Output

Performs the << operation.

impl Shl<i16> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: i16) -> <IVec2 as Shl<i16>>::Output

Performs the << operation.

impl Shl<i32> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: i32) -> <IVec2 as Shl<i32>>::Output

Performs the << operation.

impl Shl<i64> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: i64) -> <IVec2 as Shl<i64>>::Output

Performs the << operation.

impl Shl<i8> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: i8) -> <IVec2 as Shl<i8>>::Output

Performs the << operation.

impl Shl<u16> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: u16) -> <IVec2 as Shl<u16>>::Output

Performs the << operation.

impl Shl<u32> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> <IVec2 as Shl<u32>>::Output

Performs the << operation.

impl Shl<u64> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: u64) -> <IVec2 as Shl<u64>>::Output

Performs the << operation.

impl Shl<u8> for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: u8) -> <IVec2 as Shl<u8>>::Output

Performs the << operation.

impl Shl for IVec2

type Output = IVec2

The resulting type after applying the << operator.

fn shl(self, rhs: IVec2) -> <IVec2 as Shl>::Output

Performs the << operation.

impl Shr<IVec2> for I64Vec2

type Output = I64Vec2

The resulting type after applying the >> operator.

fn shr(self, rhs: IVec2) -> <I64Vec2 as Shr<IVec2>>::Output

Performs the >> operation.

impl Shr<IVec2> for U64Vec2

type Output = U64Vec2

The resulting type after applying the >> operator.

fn shr(self, rhs: IVec2) -> <U64Vec2 as Shr<IVec2>>::Output

Performs the >> operation.

impl Shr<IVec2> for UVec2

type Output = UVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: IVec2) -> <UVec2 as Shr<IVec2>>::Output

Performs the >> operation.

impl Shr<UVec2> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: UVec2) -> <IVec2 as Shr<UVec2>>::Output

Performs the >> operation.

impl Shr<i16> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: i16) -> <IVec2 as Shr<i16>>::Output

Performs the >> operation.

impl Shr<i32> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: i32) -> <IVec2 as Shr<i32>>::Output

Performs the >> operation.

impl Shr<i64> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: i64) -> <IVec2 as Shr<i64>>::Output

Performs the >> operation.

impl Shr<i8> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: i8) -> <IVec2 as Shr<i8>>::Output

Performs the >> operation.

impl Shr<u16> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: u16) -> <IVec2 as Shr<u16>>::Output

Performs the >> operation.

impl Shr<u32> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> <IVec2 as Shr<u32>>::Output

Performs the >> operation.

impl Shr<u64> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: u64) -> <IVec2 as Shr<u64>>::Output

Performs the >> operation.

impl Shr<u8> for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: u8) -> <IVec2 as Shr<u8>>::Output

Performs the >> operation.

impl Shr for IVec2

type Output = IVec2

The resulting type after applying the >> operator.

fn shr(self, rhs: IVec2) -> <IVec2 as Shr>::Output

Performs the >> operation.

impl Sub<IVec2> for i32

type Output = IVec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<i32> for IVec2

type Output = IVec2

The resulting type after applying the - operator.

fn sub(self, rhs: i32) -> IVec2

Performs the - operation.

impl Sub for IVec2

type Output = IVec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<i32> for IVec2

fn sub_assign(&mut self, rhs: i32)

Performs the -= operation.

impl SubAssign for IVec2

fn sub_assign(&mut self, rhs: IVec2)

Performs the -= operation.

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

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

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

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

impl Sum for IVec2

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

where I: Iterator<Item = IVec2>,

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

impl TryFrom<I64Vec2> for IVec2

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: I64Vec2) -> Result<IVec2, <IVec2 as TryFrom<I64Vec2>>::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<UVec2, <UVec2 as TryFrom<IVec2>>::Error>

Performs the conversion.

impl TryFrom<U64Vec2> for IVec2

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: U64Vec2) -> Result<IVec2, <IVec2 as TryFrom<U64Vec2>>::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<IVec2, <IVec2 as TryFrom<UVec2>>::Error>

Performs the conversion.

impl Vec2Swizzles for IVec2

type Vec3 = IVec3

type Vec4 = IVec4

fn xx(self) -> IVec2

fn xy(self) -> IVec2

fn yx(self) -> IVec2

fn yy(self) -> IVec2

fn xxx(self) -> IVec3

fn xxy(self) -> IVec3

fn xyx(self) -> IVec3

fn xyy(self) -> IVec3

fn yxx(self) -> IVec3

fn yxy(self) -> IVec3

fn yyx(self) -> IVec3

fn yyy(self) -> IVec3

fn xxxx(self) -> IVec4

fn xxxy(self) -> IVec4

fn xxyx(self) -> IVec4

fn xxyy(self) -> IVec4

fn xyxx(self) -> IVec4

fn xyxy(self) -> IVec4

fn xyyx(self) -> IVec4

fn xyyy(self) -> IVec4

fn yxxx(self) -> IVec4

fn yxxy(self) -> IVec4

fn yxyx(self) -> IVec4

fn yxyy(self) -> IVec4

fn yyxx(self) -> IVec4

fn yyxy(self) -> IVec4

fn yyyx(self) -> IVec4

fn yyyy(self) -> IVec4

impl Copy for IVec2

impl Eq for IVec2

impl StructuralPartialEq for IVec2