Struct nannou::geom::IVec2

source ·
pub struct IVec2(/* private fields */);
Expand description

A 2-dimensional vector.

Implementations§

source§

impl IVec2

source

pub const ZERO: IVec2 = _

All zeroes.

source

pub const ONE: IVec2 = _

All ones.

source

pub const X: IVec2 = _

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

source

pub const Y: IVec2 = _

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

source

pub const AXES: [IVec2; 2] = _

The unit axes.

source

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

Creates a new vector.

source

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

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

source

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

[x, y]

source

pub fn splat(v: i32) -> IVec2

Creates a vector with all elements set to v.

source

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.

source

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

Computes the dot product of self and other.

source

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

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

source

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

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

source

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

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.

source

pub fn min_element(self) -> i32

Returns the horizontal minimum of self.

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

source

pub fn max_element(self) -> i32

Returns the horizontal maximum of self.

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

Creates a vector from the first N values in slice.

Panics

Panics if slice is less than N elements long.

source

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.

source

pub fn abs(self) -> IVec2

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

source

pub fn signum(self) -> IVec2

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
source

pub fn perp(self) -> IVec2

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

source

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.

source

pub fn as_f32(&self) -> Vec2

Casts all elements of self to f32.

source

pub fn as_f64(&self) -> DVec2

Casts all elements of self to f64.

source

pub fn as_u32(&self) -> UVec2

Casts all elements of self to u32.

Trait Implementations§

source§

impl Add<i32> for IVec2

§

type Output = IVec2

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl Add for IVec2

§

type Output = IVec2

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl AddAssign<i32> for IVec2

source§

fn add_assign(&mut self, other: i32)

Performs the += operation. Read more
source§

impl AddAssign for IVec2

source§

fn add_assign(&mut self, other: IVec2)

Performs the += operation. Read more
source§

impl AsMut<[i32; 2]> for IVec2

source§

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

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

impl AsRef<[i32; 2]> for IVec2

source§

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

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

impl Clone for IVec2

source§

fn clone(&self) -> IVec2

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for IVec2

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for IVec2

source§

fn default() -> IVec2

Returns the “default value” for a type. Read more
source§

impl Deref for IVec2

§

type Target = XY<i32>

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl DerefMut for IVec2

source§

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

Mutably dereferences the value.
source§

impl<'de> Deserialize<'de> for IVec2

source§

fn deserialize<D>( deserializer: D ) -> Result<IVec2, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for IVec2

source§

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

Formats the value using the given formatter. Read more
source§

impl Distribution<IVec2> for Standard

source§

fn sample<R>(&self, rng: &mut R) -> IVec2
where R: Rng + ?Sized,

Generate a random value of T, using rng as the source of randomness.
source§

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>
where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness. Read more
source§

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>
where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more
source§

impl Div<i32> for IVec2

§

type Output = IVec2

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl Div for IVec2

§

type Output = IVec2

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl DivAssign<i32> for IVec2

source§

fn div_assign(&mut self, other: i32)

Performs the /= operation. Read more
source§

impl DivAssign for IVec2

source§

fn div_assign(&mut self, other: IVec2)

Performs the /= operation. Read more
source§

impl From<[i32; 2]> for IVec2

source§

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

Converts to this type from the input type.
source§

impl From<(i32, i32)> for IVec2

source§

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

Converts to this type from the input type.
source§

impl From<IVec2> for [i32; 2]

source§

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

Converts to this type from the input type.
source§

impl From<IVec2> for XY<i32>

source§

fn from(t: IVec2) -> XY<i32>

Converts to this type from the input type.
source§

impl From<IVec3> for IVec2

source§

fn from(v: IVec3) -> IVec2

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

source§

impl From<IVec4> for IVec2

source§

fn from(v: IVec4) -> IVec2

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

source§

impl From<XY<i32>> for IVec2

source§

fn from(t: XY<i32>) -> IVec2

Converts to this type from the input type.
source§

impl Hash for IVec2

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Index<usize> for IVec2

§

type Output = i32

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl IndexMut<usize> for IVec2

source§

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

Performs the mutable indexing (container[index]) operation. Read more
source§

impl Mul<i32> for IVec2

§

type Output = IVec2

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Mul for IVec2

§

type Output = IVec2

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl MulAssign<i32> for IVec2

source§

fn mul_assign(&mut self, other: i32)

Performs the *= operation. Read more
source§

impl MulAssign for IVec2

source§

fn mul_assign(&mut self, other: IVec2)

Performs the *= operation. Read more
source§

impl Neg for IVec2

§

type Output = IVec2

The resulting type after applying the - operator.
source§

fn neg(self) -> IVec2

Performs the unary - operation. Read more
source§

impl PartialEq for IVec2

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

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

impl Serialize for IVec2

source§

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Sub<i32> for IVec2

§

type Output = IVec2

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl Sub for IVec2

§

type Output = IVec2

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl SubAssign<i32> for IVec2

source§

fn sub_assign(&mut self, other: i32)

Performs the -= operation. Read more
source§

impl SubAssign for IVec2

source§

fn sub_assign(&mut self, other: IVec2)

Performs the -= operation. Read more
source§

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

source§

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

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

impl Vec2Swizzles for IVec2

§

type Vec3 = IVec3

§

type Vec4 = IVec4

source§

fn xxxx(self) -> IVec4

source§

fn xxxy(self) -> IVec4

source§

fn xxyx(self) -> IVec4

source§

fn xxyy(self) -> IVec4

source§

fn xyxx(self) -> IVec4

source§

fn xyxy(self) -> IVec4

source§

fn xyyx(self) -> IVec4

source§

fn xyyy(self) -> IVec4

source§

fn yxxx(self) -> IVec4

source§

fn yxxy(self) -> IVec4

source§

fn yxyx(self) -> IVec4

source§

fn yxyy(self) -> IVec4

source§

fn yyxx(self) -> IVec4

source§

fn yyxy(self) -> IVec4

source§

fn yyyx(self) -> IVec4

source§

fn yyyy(self) -> IVec4

source§

fn xxx(self) -> IVec3

source§

fn xxy(self) -> IVec3

source§

fn xyx(self) -> IVec3

source§

fn xyy(self) -> IVec3

source§

fn yxx(self) -> IVec3

source§

fn yxy(self) -> IVec3

source§

fn yyx(self) -> IVec3

source§

fn yyy(self) -> IVec3

source§

fn xx(self) -> IVec2

source§

fn yx(self) -> IVec2

source§

fn yy(self) -> IVec2

source§

fn xy(self) -> Self

source§

impl Vertex for IVec2

§

type Scalar = i32

The values used to describe the vertex position.
source§

impl Vertex2d for IVec2

source§

fn point2(self) -> [<IVec2 as Vertex>::Scalar; 2]

The x, y location of the vertex.
source§

impl Copy for IVec2

source§

impl Eq for IVec2

Auto Trait Implementations§

§

impl RefUnwindSafe for IVec2

§

impl Send for IVec2

§

impl Sync for IVec2

§

impl Unpin for IVec2

§

impl UnwindSafe for IVec2

Blanket Implementations§

source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Component + Float, Swp: WhitePoint, Dwp: WhitePoint, D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<Swp, Dwp, T>,

Convert the source color to the destination color using the specified method
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, U> ConvertInto<U> for T
where U: ConvertFrom<T>,

source§

fn convert_into(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

fn convert_unclamped_into(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
source§

fn try_convert_into(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSync for T
where T: Sync,