Struct glam::i32::IVec2

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

A 2-dimensional vector.

Implementations

impl IVec2

pub const ZERO: Self

All zeroes.

pub const ONE: Self

All ones.

pub const X: Self

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

pub const Y: Self

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

pub const AXES: [Self; 2]

The unit axes.

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

Creates a new vector.

pub fn extend(self, z: i32) -> IVec3

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

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

[x, y]

pub fn splat(v: i32) -> Self

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

Computes the dot product of self and other.

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

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

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

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) -> 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, other: Self) -> 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: Self) -> 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: Self) -> 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: Self) -> 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: Self) -> 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: Self) -> 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: &[i32]) -> Self

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

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

Panics

Panics if slice is less than N elements long.

pub fn abs(self) -> Self

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

pub fn signum(self) -> Self

Returns a vector with elements representing the sign of self.

• 1.0 if the number is positive, +0.0 or INFINITY
• -1.0 if the number is negative, -0.0 or NEG_INFINITY
• NAN if the number is NAN

pub fn perp(self) -> Self

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

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

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

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

Casts all elements of self to u32.

Trait Implementations

impl Add<IVec2> for IVec2

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: IVec2) -> Self

Performs the + operation.

impl Add<IVec2> for i32

type Output = IVec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i32> for IVec2

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: i32) -> Self

Performs the + operation.

impl AddAssign<IVec2> for IVec2

fn add_assign(&mut self, other: IVec2)

Performs the += operation.

impl AddAssign<i32> for IVec2

fn add_assign(&mut self, other: i32)

Performs the += operation.

impl AsMut<[i32; 2]> for IVec2

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

Performs the conversion.

impl AsRef<[i32; 2]> for IVec2

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

Performs the conversion.

impl Clone for IVec2

fn clone(&self) -> IVec2

Returns a copy 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

Formats the value using the given formatter.

impl Default for IVec2

fn default() -> Self

Returns the “default value” for a type.

impl Deref for IVec2

type Target = XY<i32>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for IVec2

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for IVec2

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

Formats the value using the given formatter.

impl Div<IVec2> for IVec2

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: IVec2) -> Self

Performs the / operation.

impl Div<IVec2> for i32

type Output = IVec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i32> for IVec2

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: i32) -> Self

Performs the / operation.

impl DivAssign<IVec2> for IVec2

fn div_assign(&mut self, other: IVec2)

Performs the /= operation.

impl DivAssign<i32> for IVec2

fn div_assign(&mut self, other: i32)

Performs the /= operation.

impl From<[i32; 2]> for IVec2

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

Performs the conversion.

impl From<(i32, i32)> for IVec2

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

Performs the conversion.

impl From<IVec2> for (i32, i32)

fn from(v: IVec2) -> Self

Performs the conversion.

impl From<IVec2> for [i32; 2]

fn from(v: IVec2) -> Self

Performs the conversion.

impl From<IVec3> for IVec2

fn from(v: IVec3) -> Self

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

impl From<IVec4> for IVec2

fn from(v: IVec4) -> Self

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

impl Hash for IVec2

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, 

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) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for IVec2

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

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

impl Mul<IVec2> for IVec2

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: IVec2) -> Self

Performs the * operation.

impl Mul<IVec2> for i32

type Output = IVec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i32> for IVec2

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: i32) -> Self

Performs the * operation.

impl MulAssign<IVec2> for IVec2

fn mul_assign(&mut self, other: IVec2)

Performs the *= operation.

impl MulAssign<i32> for IVec2

fn mul_assign(&mut self, other: i32)

Performs the *= operation.

impl Neg for IVec2

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<IVec2> for IVec2

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

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

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

impl Sub<IVec2> for IVec2

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: IVec2) -> Self

Performs the - operation.

impl Sub<IVec2> for i32

type Output = IVec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<i32> for IVec2

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: i32) -> Self

Performs the - operation.

impl SubAssign<IVec2> for IVec2

fn sub_assign(&mut self, other: IVec2)

Performs the -= operation.

impl SubAssign<i32> for IVec2

fn sub_assign(&mut self, other: i32)

Performs the -= operation.

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

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

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

impl Vec2Swizzles for IVec2

type Vec3 = IVec3

type Vec4 = IVec4

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

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 xx(self) -> Self

fn yx(self) -> Self

fn yy(self) -> Self

fn xy(self) -> Self

impl Copy for IVec2

impl Eq for IVec2