Struct glam::i32::IVec3

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

A 3-dimensional vector.

Implementations

impl IVec3

pub const ZERO: Self

All zeroes.

pub const ONE: Self

All ones.

pub const X: Self

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

pub const Y: Self

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

pub const Z: Self

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

pub const AXES: [Self; 3]

The unit axes.

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

Creates a new 3D vector.

pub const fn unit_x() -> Self

👎 Deprecated:

Use Vec3::X instead

Creates a vector with values [x: 1.0, y: 0.0, z: 0.0].

pub const fn unit_y() -> Self

👎 Deprecated:

Use Vec3::Y instead

Creates a vector with values [x: 0.0, y: 1.0, z: 0.0].

pub const fn unit_z() -> Self

👎 Deprecated:

Use Vec3::Z instead

Creates a vector with values [x: 0.0, y: 0.0, z: 1.0].

pub fn extend(self, w: i32) -> IVec4

Creates a 4D vector from self and the given w value.

pub fn truncate(self) -> IVec2

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

Truncation may also be performed by using self.xy() or Vec2::from().

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

Computes the cross product of self and other.

pub const fn zero() -> Self

👎 Deprecated:

use ZERO constant instead

Creates a vector with all elements set to 0.0.

pub const fn one() -> Self

👎 Deprecated:

use ONE constant instead

Creates a vector with all elements set to 1.0.

pub fn splat(v: i32) -> Self

Creates a vector with all elements set to v.

pub fn select(mask: BVec3, if_true: IVec3, if_false: IVec3) -> IVec3

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 [std::f32::clamp].

Each element in min must be less-or-equal to the corresponing element in max.

If the glam-assert feature is enabled, the function will panic if the contract is not met, otherwise the behavior is undefined.

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) -> BVec3

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) -> BVec3

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) -> BVec3

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) -> BVec3

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) -> BVec3

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) -> BVec3

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_unaligned(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_unaligned(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 as_f32(&self) -> Vec3

Casts all elements of self to f32.

pub fn as_f64(&self) -> DVec3

Casts all elements of self to f64.

pub fn as_u32(&self) -> UVec3

Casts all elements of self to u32.

Trait Implementations

impl Add<IVec3> for IVec3

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<IVec3> for IVec3

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AsMut<[i32; 3]> for IVec3

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

Performs the conversion.

impl AsRef<[i32; 3]> for IVec3

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

Performs the conversion.

impl Clone for IVec3

fn clone(&self) -> IVec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for IVec3

impl Debug for IVec3

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

Formats the value using the given formatter.

impl Default for IVec3

fn default() -> Self

Returns the “default value” for a type.

impl Deref for IVec3

type Target = XYZ<i32>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for IVec3

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

Mutably dereferences the value.

impl Display for IVec3

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

Formats the value using the given formatter.

impl Div<IVec3> for IVec3

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i32> for IVec3

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<IVec3> for IVec3

fn div_assign(&mut self, other: IVec3)

Performs the /= operation.

impl DivAssign<i32> for IVec3

fn div_assign(&mut self, other: i32)

Performs the /= operation.

impl Eq for IVec3

impl From<[i32; 3]> for IVec3

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

Performs the conversion.

impl From<(IVec2, i32)> for IVec3

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

Performs the conversion.

impl From<(i32, i32, i32)> for IVec3

fn from(t: (i32, i32, i32)) -> 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 IVec3

fn from(v: IVec4) -> Self

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

impl Hash for IVec3

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

Feeds this value into the given Hasher.

pub 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 IVec3

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 IVec3

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

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

impl Mul<IVec3> for IVec3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i32> for IVec3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<IVec3> for IVec3

fn mul_assign(&mut self, other: IVec3)

Performs the *= operation.

impl MulAssign<i32> for IVec3

fn mul_assign(&mut self, other: i32)

Performs the *= operation.

impl Neg for IVec3

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<IVec3> for IVec3

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<IVec3> for IVec3

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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

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<IVec3> for IVec3

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<IVec3> for IVec3

fn sub_assign(&mut self, other: IVec3)

Performs the -= operation.

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

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 Vec3Swizzles for IVec3

type Vec2 = IVec2

type Vec4 = IVec4

fn xxxx(self) -> IVec4

fn xxxy(self) -> IVec4

fn xxxz(self) -> IVec4

fn xxyx(self) -> IVec4

fn xxyy(self) -> IVec4

fn xxyz(self) -> IVec4

fn xxzx(self) -> IVec4

fn xxzy(self) -> IVec4

fn xxzz(self) -> IVec4

fn xyxx(self) -> IVec4

fn xyxy(self) -> IVec4

fn xyxz(self) -> IVec4

fn xyyx(self) -> IVec4

fn xyyy(self) -> IVec4

fn xyyz(self) -> IVec4

fn xyzx(self) -> IVec4

fn xyzy(self) -> IVec4

fn xyzz(self) -> IVec4

fn xzxx(self) -> IVec4

fn xzxy(self) -> IVec4

fn xzxz(self) -> IVec4

fn xzyx(self) -> IVec4

fn xzyy(self) -> IVec4

fn xzyz(self) -> IVec4

fn xzzx(self) -> IVec4

fn xzzy(self) -> IVec4

fn xzzz(self) -> IVec4

fn yxxx(self) -> IVec4

fn yxxy(self) -> IVec4

fn yxxz(self) -> IVec4

fn yxyx(self) -> IVec4

fn yxyy(self) -> IVec4

fn yxyz(self) -> IVec4

fn yxzx(self) -> IVec4

fn yxzy(self) -> IVec4

fn yxzz(self) -> IVec4

fn yyxx(self) -> IVec4

fn yyxy(self) -> IVec4

fn yyxz(self) -> IVec4

fn yyyx(self) -> IVec4

fn yyyy(self) -> IVec4

fn yyyz(self) -> IVec4

fn yyzx(self) -> IVec4

fn yyzy(self) -> IVec4

fn yyzz(self) -> IVec4

fn yzxx(self) -> IVec4

fn yzxy(self) -> IVec4

fn yzxz(self) -> IVec4

fn yzyx(self) -> IVec4

fn yzyy(self) -> IVec4

fn yzyz(self) -> IVec4

fn yzzx(self) -> IVec4

fn yzzy(self) -> IVec4

fn yzzz(self) -> IVec4

fn zxxx(self) -> IVec4

fn zxxy(self) -> IVec4

fn zxxz(self) -> IVec4

fn zxyx(self) -> IVec4

fn zxyy(self) -> IVec4

fn zxyz(self) -> IVec4

fn zxzx(self) -> IVec4

fn zxzy(self) -> IVec4

fn zxzz(self) -> IVec4

fn zyxx(self) -> IVec4

fn zyxy(self) -> IVec4

fn zyxz(self) -> IVec4

fn zyyx(self) -> IVec4

fn zyyy(self) -> IVec4

fn zyyz(self) -> IVec4

fn zyzx(self) -> IVec4

fn zyzy(self) -> IVec4

fn zyzz(self) -> IVec4

fn zzxx(self) -> IVec4

fn zzxy(self) -> IVec4

fn zzxz(self) -> IVec4

fn zzyx(self) -> IVec4

fn zzyy(self) -> IVec4

fn zzyz(self) -> IVec4

fn zzzx(self) -> IVec4

fn zzzy(self) -> IVec4

fn zzzz(self) -> IVec4

fn xxx(self) -> Self

fn xxy(self) -> Self

fn xxz(self) -> Self

fn xyx(self) -> Self

fn xyy(self) -> Self

fn xzx(self) -> Self

fn xzy(self) -> Self

fn xzz(self) -> Self

fn yxx(self) -> Self

fn yxy(self) -> Self

fn yxz(self) -> Self

fn yyx(self) -> Self

fn yyy(self) -> Self

fn yyz(self) -> Self

fn yzx(self) -> Self

fn yzy(self) -> Self

fn yzz(self) -> Self

fn zxx(self) -> Self

fn zxy(self) -> Self

fn zxz(self) -> Self

fn zyx(self) -> Self

fn zyy(self) -> Self

fn zyz(self) -> Self

fn zzx(self) -> Self

fn zzy(self) -> Self

fn zzz(self) -> Self

fn xx(self) -> IVec2

fn xy(self) -> IVec2

fn xz(self) -> IVec2

fn yx(self) -> IVec2

fn yy(self) -> IVec2

fn yz(self) -> IVec2

fn zx(self) -> IVec2

fn zy(self) -> IVec2

fn zz(self) -> IVec2

fn xyz(self) -> Self