Struct vek::vec::repr_c::vec2::Vec2

#[repr(C)]
pub struct Vec2<T> {
    pub x: T,
    pub y: T,
}

Vector type suited for 2D spatial coordinates.

Fields

x: T

y: T

Methods

impl<T> Vec2<T>

pub const fn new(x: T, y: T) -> Self

Creates a vector from elements.

impl<T> Vec2<T>

pub fn broadcast(val: T) -> Self where
    T: Copy, 

Broadcasts a single value to all elements of a new vector.

This function is also named splat() in some libraries, or set1() in Intel intrinsics.

"Broadcast" was chosen as the name because it is explicit enough and is the same wording as the description in relevant Intel intrinsics.

assert_eq!(Vec4::broadcast(5), Vec4::new(5,5,5,5));
assert_eq!(Vec4::broadcast(5), Vec4::from(5));

pub fn zero() -> Self where
    T: Zero, 

Creates a new vector with all elements set to zero.

assert_eq!(Vec4::zero(), Vec4::new(0,0,0,0));
assert_eq!(Vec4::zero(), Vec4::broadcast(0));
assert_eq!(Vec4::zero(), Vec4::from(0));

pub fn one() -> Self where
    T: One, 

Creates a new vector with all elements set to one.

assert_eq!(Vec4::one(), Vec4::new(1,1,1,1));
assert_eq!(Vec4::one(), Vec4::broadcast(1));
assert_eq!(Vec4::one(), Vec4::from(1));

pub fn iota() -> Self where
    T: Zero + One + AddAssign + Copy, 

Produces a vector of the first n integers, starting from zero, where n is the number of elements for this vector type.

The iota (ι) function, originating from APL.

See this StackOverflow answer.

This is mostly useful for debugging purposes and tests.

assert_eq!(Vec4::iota(), Vec4::new(0, 1, 2, 3));

pub const fn elem_count(&self) -> usize

Convenience method which returns the number of elements of this vector.

let v = Vec4::new(0,1,2,3);
assert_eq!(v.elem_count(), 4);

pub const ELEM_COUNT: usize

Convenience constant representing the number of elements for this vector type.

pub fn into_tuple(self) -> (T, T)

Converts this into a tuple with the same number of elements by consuming.

pub fn into_array(self) -> [T; 2]

Converts this vector into a fixed-size array.

pub fn as_slice(&self) -> &[T]

View this vector as an immutable slice.

pub fn as_mut_slice(&mut self) -> &mut [T]

View this vector as a mutable slice.

pub fn from_slice(slice: &[T]) -> Self where
    T: Default + Copy, 

Collects the content of a slice into a new vector. Elements are initialized to their default values.

pub fn map<D, F>(self, f: F) -> Vec2<D> where
    F: FnMut(T) -> D, 

Returns a memberwise-converted copy of this vector, using the given conversion closure.

let v = Vec4::new(0_f32, 1., 1.8, 3.14);
let i = v.map(|x| x.round() as i32);
assert_eq!(i, Vec4::new(0, 1, 2, 3));

Performing LERP on integer vectors by concisely converting them to floats:

let a = Vec4::new(0,1,2,3).map(|x| x as f32);
let b = Vec4::new(2,3,4,5).map(|x| x as f32);
let v = Vec4::lerp(a, b, 0.5_f32).map(|x| x.round() as i32);
assert_eq!(v, Vec4::new(1,2,3,4));

pub fn map2<D, F, S>(self, other: Vec2<S>, f: F) -> Vec2<D> where
    F: FnMut(T, S) -> D, 

Applies the function f to each element of two vectors, pairwise, and returns the result.

let a = Vec4::<u8>::new(255, 254, 253, 252);
let b = Vec4::<u8>::new(1, 2, 3, 4);
let v = a.map2(b, |a, b| a.wrapping_add(b));
assert_eq!(v, Vec4::zero());
let v = a.map2(b, u8::wrapping_add);
assert_eq!(v, Vec4::zero());

pub fn apply<F>(&mut self, f: F) where
    T: Copy,
    F: FnMut(T) -> T, 

Applies the function f to each element of this vector, in-place.

let mut v = Vec4::new(0_u32, 1, 2, 3);
v.apply(|x| x.count_ones());
assert_eq!(v, Vec4::new(0, 1, 1, 2));

pub fn apply2<F, S>(&mut self, other: Vec2<S>, f: F) where
    T: Copy,
    F: FnMut(T, S) -> T, 

Applies the function f to each element of two vectors, pairwise, in-place.

let mut a = Vec4::<u8>::new(255, 254, 253, 252);
let b = Vec4::<u8>::new(1, 2, 3, 4);
a.apply2(b, |a, b| a.wrapping_add(b));
assert_eq!(a, Vec4::zero());
a.apply2(b, u8::wrapping_add);
assert_eq!(a, b);

pub fn zip<S>(self, other: Vec2<S>) -> Vec2<(T, S)>

"Zips" two vectors together into a vector of tuples.

let a = Vec4::<u8>::new(255, 254, 253, 252);
let b = Vec4::<u8>::new(1, 2, 3, 4);
assert_eq!(a.zip(b), Vec4::new((255, 1), (254, 2), (253, 3), (252, 4)));

pub fn numcast<D>(self) -> Option<Vec2<D>> where
    T: NumCast,
    D: NumCast, 

Returns a memberwise-converted copy of this vector, using NumCast.

let v = Vec4::new(0_f32, 1., 2., 3.);
let i: Vec4<i32> = v.numcast().unwrap();
assert_eq!(i, Vec4::new(0, 1, 2, 3));

pub fn mul_add<V: Into<Self>>(self, mul: V, add: V) -> Self where
    T: MulAdd<T, T, Output = T>, 

Fused multiply-add. Returns self * mul + add, and may be implemented efficiently by the hardware.

The compiler is often able to detect this kind of operation, so generally you don't need to use it. However, it can make your intent clear.

The name for this method is the one used by the same operation on primitive floating-point types.

let a = Vec4::new(0,1,2,3);
let b = Vec4::new(4,5,6,7);
let c = Vec4::new(8,9,0,1);
assert_eq!(a*b+c, a.mul_add(b, c));

pub fn is_any_negative(&self) -> bool where
    T: Signed, 

Is any of the elements negative ?

This was intended for checking the validity of extent vectors, but can make sense for other types too.

pub fn are_all_positive(&self) -> bool where
    T: Signed, 

Are all of the elements positive ?

pub fn min<V>(a: V, b: V) -> Self where
    V: Into<Self>,
    T: Ord, 

Compares elements of a and b, and returns the minimum values into a new vector, using total ordering.

let a = Vec4::new(0,1,2,3);
let b = Vec4::new(3,2,1,0);
let m = Vec4::new(0,1,1,0);
assert_eq!(m, Vec4::min(a, b));

pub fn max<V>(a: V, b: V) -> Self where
    V: Into<Self>,
    T: Ord, 

Compares elements of a and b, and returns the maximum values into a new vector, using total ordering.

let a = Vec4::new(0,1,2,3);
let b = Vec4::new(3,2,1,0);
let m = Vec4::new(3,2,2,3);
assert_eq!(m, Vec4::max(a, b));

pub fn partial_min<V>(a: V, b: V) -> Self where
    V: Into<Self>,
    T: PartialOrd, 

Compares elements of a and b, and returns the minimum values into a new vector, using partial ordering.

let a = Vec4::new(0,1,2,3);
let b = Vec4::new(3,2,1,0);
let m = Vec4::new(0,1,1,0);
assert_eq!(m, Vec4::partial_min(a, b));

pub fn partial_max<V>(a: V, b: V) -> Self where
    V: Into<Self>,
    T: PartialOrd, 

Compares elements of a and b, and returns the minimum values into a new vector, using partial ordering.

let a = Vec4::new(0,1,2,3);
let b = Vec4::new(3,2,1,0);
let m = Vec4::new(3,2,2,3);
assert_eq!(m, Vec4::partial_max(a, b));

pub fn reduce_min(self) -> T where
    T: Ord, 

Returns the element which has the lowest value in this vector, using total ordering.

assert_eq!(-5, Vec4::new(0, 5, -5, 8).reduce_min());

pub fn reduce_max(self) -> T where
    T: Ord, 

Returns the element which has the highest value in this vector, using total ordering.

assert_eq!(8, Vec4::new(0, 5, -5, 8).reduce_max());

pub fn reduce_partial_min(self) -> T where
    T: PartialOrd, 

Returns the element which has the lowest value in this vector, using partial ordering.

assert_eq!(-5_f32, Vec4::new(0_f32, 5., -5., 8.).reduce_partial_min());

pub fn reduce_partial_max(self) -> T where
    T: PartialOrd, 

Returns the element which has the highest value in this vector, using partial ordering.

assert_eq!(8_f32, Vec4::new(0_f32, 5., -5., 8.).reduce_partial_max());

pub fn reduce_bitand(self) -> T where
    T: BitAnd<T, Output = T>, 

Returns the result of bitwise-AND (&) on all elements of this vector.

assert_eq!(true,  Vec4::new(true, true, true, true).reduce_bitand());
assert_eq!(false, Vec4::new(true, false, true, true).reduce_bitand());
assert_eq!(false, Vec4::new(true, true, true, false).reduce_bitand());

pub fn reduce_bitor(self) -> T where
    T: BitOr<T, Output = T>, 

Returns the result of bitwise-OR (|) on all elements of this vector.

assert_eq!(false, Vec4::new(false, false, false, false).reduce_bitor());
assert_eq!(true,  Vec4::new(false, false, true, false).reduce_bitor());

pub fn reduce_bitxor(self) -> T where
    T: BitXor<T, Output = T>, 

Returns the result of bitwise-XOR (^) on all elements of this vector.

assert_eq!(false, Vec4::new(true, true, true, true).reduce_bitxor());
assert_eq!(true,  Vec4::new(true, false, true, true).reduce_bitxor());

pub fn reduce<F>(self, f: F) -> T where
    F: FnMut(T, T) -> T, 

Reduces this vector with the given accumulator closure.

pub fn product(self) -> T where
    T: Product, 

Returns the product of each of this vector's elements.

assert_eq!(1*2*3*4, Vec4::new(1, 2, 3, 4).product());

pub fn sum(self) -> T where
    T: Sum, 

Returns the sum of each of this vector's elements.

assert_eq!(1+2+3+4, Vec4::new(1, 2, 3, 4).sum());

pub fn average(self) -> T where
    T: Sum + Div<T, Output = T> + From<u8>, 

Returns the average of this vector's elements.

assert_eq!(2.5_f32, Vec4::new(1_f32, 2., 3., 4.).average());

You should avoid using it on u8 vectors, not only because integer overflows cause panics in debug mode, but also because of integer division, the result may not be the one you expect.

// This causes a panic!
let red = Vec4::new(255u8, 1, 0, 0);
let grey_level = red.average();
assert_eq!(grey_level, 128);

You may want to convert the elements to bigger integers (or floating-point) instead:

let red = Vec4::new(255u8, 1, 128, 128);

let red = red.map(|c| c as u16);
let grey_level = red.average() as u8;
assert_eq!(grey_level, 128);

let red = red.map(|c| c as f32);
let grey_level = red.average().round() as u8;
assert_eq!(grey_level, 128);

pub fn sqrt(self) -> Self where
    T: Real, 

Returns a new vector which elements are the respective square roots of this vector's elements.

let v = Vec4::new(1f32, 2f32, 3f32, 4f32);
let s = Vec4::new(1f32, 4f32, 9f32, 16f32);
assert_eq!(v, s.sqrt());

pub fn rsqrt(self) -> Self where
    T: Real, 

Returns a new vector which elements are the respective reciprocal square roots of this vector's elements.

let v = Vec4::new(1f32, 0.5f32, 1f32/3f32, 0.25f32);
let s = Vec4::new(1f32, 4f32, 9f32, 16f32);
assert_eq!(v, s.rsqrt());

pub fn recip(self) -> Self where
    T: Real, 

Returns a new vector which elements are the respective reciprocal of this vector's elements.

let v = Vec4::new(1f32, 0.5f32, 0.25f32, 0.125f32);
let s = Vec4::new(1f32, 2f32, 4f32, 8f32);
assert_eq!(v, s.recip());
assert_eq!(s, v.recip());

pub fn ceil(self) -> Self where
    T: Real, 

Returns a new vector which elements are rounded to the nearest greater integer.

let v = Vec4::new(0_f32, 1., 1.8, 3.14);
assert_eq!(v.ceil(), Vec4::new(0f32, 1f32, 2f32, 4f32));

pub fn floor(self) -> Self where
    T: Real, 

Returns a new vector which elements are rounded down to the nearest lower integer.

let v = Vec4::new(0_f32, 1., 1.8, 3.14);
assert_eq!(v.floor(), Vec4::new(0f32, 1f32, 1f32, 3f32));

pub fn round(self) -> Self where
    T: Real, 

Returns a new vector which elements are rounded to the nearest integer.

let v = Vec4::new(0_f32, 1., 1.8, 3.14);
assert_eq!(v.round(), Vec4::new(0f32, 1f32, 2f32, 3f32));

pub fn hadd(self, rhs: Self) -> Self where
    T: Add<T, Output = T>, 

Horizontally adds adjacent pairs of elements in self and rhs into a new vector.

let a = Vec4::new(0, 1, 2, 3);
let b = Vec4::new(4, 5, 6, 7);
let h = Vec4::new(0+1, 2+3, 4+5, 6+7);
assert_eq!(h, a.hadd(b));

pub fn partial_cmpeq<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: PartialEq, 

Compares each element of two vectors with the partial equality test, returning a boolean vector.

let u = Vec4::new(0,2,2,6);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.partial_cmpeq(&v), Vec4::new(true, false, true, false));

pub fn partial_cmpne<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: PartialEq, 

Compares each element of two vectors with the partial not-equal test, returning a boolean vector.

let u = Vec4::new(0,2,2,6);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.partial_cmpne(&v), Vec4::new(false, true, false, true));

pub fn partial_cmpge<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: PartialOrd, 

Compares each element of two vectors with the partial greater-or-equal test, returning a boolean vector.

let u = Vec4::new(0,2,2,2);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.partial_cmpge(&v), Vec4::new(true, true, true, false));

pub fn partial_cmpgt<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: PartialOrd, 

Compares each element of two vectors with the partial greater-than test, returning a boolean vector.

let u = Vec4::new(0,2,2,6);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.partial_cmpgt(&v), Vec4::new(false, true, false, true));

pub fn partial_cmple<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: PartialOrd, 

Compares each element of two vectors with the partial less-or-equal test, returning a boolean vector.

let u = Vec4::new(0,2,2,2);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.partial_cmple(&v), Vec4::new(true, false, true, true));

pub fn partial_cmplt<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: PartialOrd, 

Compares each element of two vectors with the partial less-than test, returning a boolean vector.

let u = Vec4::new(0,2,2,2);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.partial_cmplt(&v), Vec4::new(false, false, false, true));

pub fn cmpeq<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: Eq, 

Compares each element of two vectors with the partial equality test, returning a boolean vector.

let u = Vec4::new(0,2,2,6);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.cmpeq(&v), Vec4::new(true, false, true, false));

pub fn cmpne<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: Eq, 

Compares each element of two vectors with the total not-equal test, returning a boolean vector.

let u = Vec4::new(0,2,2,6);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.cmpne(&v), Vec4::new(false, true, false, true));

pub fn cmpge<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: Ord, 

Compares each element of two vectors with the total greater-or-equal test, returning a boolean vector.

let u = Vec4::new(0,2,2,2);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.cmpge(&v), Vec4::new(true, true, true, false));

pub fn cmpgt<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: Ord, 

Compares each element of two vectors with the total greater-than test, returning a boolean vector.

let u = Vec4::new(0,2,2,6);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.cmpgt(&v), Vec4::new(false, true, false, true));

pub fn cmple<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: Ord, 

Compares each element of two vectors with the total less-or-equal test, returning a boolean vector.

let u = Vec4::new(0,2,2,2);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.cmple(&v), Vec4::new(true, false, true, true));

pub fn cmplt<Rhs: AsRef<Self>>(&self, rhs: &Rhs) -> Vec2<bool> where
    T: Ord, 

Compares each element of two vectors with the total less-than test, returning a boolean vector.

let u = Vec4::new(0,2,2,2);
let v = Vec4::new(0,1,2,3);
assert_eq!(u.cmplt(&v), Vec4::new(false, false, false, true));

pub fn lerp_unclamped_precise<S: Into<Self>>(
    from: Self,
    to: Self,
    factor: S
) -> Self where
    T: Copy + One + Mul<Output = T> + Sub<Output = T> + MulAdd<T, T, Output = T>, 

Returns the linear interpolation of from to to with factor unconstrained. See the Lerp trait.

pub fn lerp_unclamped<S: Into<Self>>(from: Self, to: Self, factor: S) -> Self where
    T: Copy + Sub<Output = T> + MulAdd<T, T, Output = T>, 

Same as lerp_unclamped_precise, implemented as a possibly faster but less precise operation. See the Lerp trait.

pub fn lerp<S: Into<Self> + Clamp + Zero + One>(
    from: Self,
    to: Self,
    factor: S
) -> Self where
    T: Copy + Sub<Output = T> + MulAdd<T, T, Output = T>, 

Returns the linear interpolation of from to to with factor constrained to be between 0 and 1. See the Lerp trait.

pub fn lerp_precise<S: Into<Self> + Clamp + Zero + One>(
    from: Self,
    to: Self,
    factor: S
) -> Self where
    T: Copy + One + Mul<Output = T> + Sub<Output = T> + MulAdd<T, T, Output = T>, 

Returns the linear interpolation of from to to with factor constrained to be between 0 and 1. See the Lerp trait.

impl Vec2<bool>

pub fn reduce_and(self) -> bool

Returns the result of logical AND (&&) on all elements of this vector.

assert_eq!(true,  Vec4::new(true, true, true, true).reduce_and());
assert_eq!(false, Vec4::new(true, false, true, true).reduce_and());
assert_eq!(false, Vec4::new(true, true, true, false).reduce_and());

pub fn reduce_or(self) -> bool

Returns the result of logical OR (||) on all elements of this vector.

assert_eq!(false, Vec4::new(false, false, false, false).reduce_or());
assert_eq!(true,  Vec4::new(false, false, true, false).reduce_or());

pub fn reduce_ne(self) -> bool

Reduces this vector using total inequality.

assert_eq!(false, Vec4::new(true, true, true, true).reduce_ne());
assert_eq!(true,  Vec4::new(true, false, true, true).reduce_ne());

impl<T> Vec2<T>

pub fn dot(self, v: Self) -> T where
    T: Sum + Mul<Output = T>, 

Dot product between this vector and another.

pub fn magnitude_squared(self) -> T where
    T: Copy + Sum + Mul<Output = T>, 

The squared magnitude of a vector is its spatial length, squared. It is slightly cheaper to compute than magnitude because it avoids a square root.

pub fn magnitude(self) -> T where
    T: Sum + Real, 

The magnitude of a vector is its spatial length.

pub fn distance_squared(self, v: Self) -> T where
    T: Copy + Sum + Sub<Output = T> + Mul<Output = T>, 

Squared distance between two point vectors. It is slightly cheaper to compute than distance because it avoids a square root.

pub fn distance(self, v: Self) -> T where
    T: Sum + Real, 

Distance between two point vectors.

pub fn normalized(self) -> Self where
    T: Sum + Real, 

Get a copy of this direction vector such that its length equals 1.

pub fn try_normalized(self) -> Option<Self> where
    T: ApproxEq + Sum + Real, 

Get a copy of this direction vector such that its length equals 1. If all components approximately zero, None is returned (uses ApproxEq).

pub fn normalize(&mut self) where
    T: Sum + Real, 

Divide this vector's components such that its length equals 1.

pub fn is_normalized(self) -> bool where
    T: ApproxEq + Sum + Real, 

Is this vector normalized ? (Uses ApproxEq)

pub fn is_approx_zero(self) -> bool where
    T: ApproxEq + Sum + Real, 

Is this vector approximately zero ? (Uses ApproxEq)

pub fn angle_between(self, v: Self) -> T where
    T: Sum + Real, 

Get the smallest angle, in radians, between two direction vectors.

pub fn angle_between_degrees(self, v: Self) -> T where
    T: Sum + Real, 

Deprecated:

Use to_degrees() on the value returned by angle_between() instead

Get the smallest angle, in degrees, between two direction vectors.

pub fn reflected(self, surface_normal: Self) -> Self where
    T: Copy + Sum + Mul<Output = T> + Sub<Output = T> + Add<Output = T>, 

The reflection direction for this vector on a surface which normal is given.

pub fn refracted(self, surface_normal: Self, eta: T) -> Self where
    T: Real + Sum + Mul<Output = T>, 

The refraction vector for this incident vector, a surface normal and a ratio of indices of refraction (eta).

pub fn face_forward(self, incident: Self, reference: Self) -> Self where
    T: Sum + Mul<Output = T> + Zero + PartialOrd + Neg<Output = T>, 

Orients a vector to point away from a surface as defined by its normal.

impl<T> Vec2<T>

pub fn determine_side(self, a: Self, b: Self) -> T where
    T: Copy + Sub<Output = T> + Mul<Output = T>, 

A signed value which tells in which half-space of the line segment ab this point lies.

Returns:

• < 0: This point lies in the half-space right of segment ab.
• == 0: This point lies in the infinite line along segment ab.
• > 0: This point lies in the half-space left of segment ab.

pub fn signed_triangle_area(a: Self, b: Self, c: Self) -> T where
    T: Copy + Sub<Output = T> + Mul<Output = T> + One + Div<Output = T> + Add<Output = T>, 

The signed area of the triangle defined by points (a, b, c).

pub fn triangle_area(a: Self, b: Self, c: Self) -> T where
    T: Copy + Sub<Output = T> + Mul<Output = T> + One + Div<Output = T> + Add<Output = T> + PartialOrd + Neg<Output = T>, 

The area of the triangle defined by points (a, b, c).

pub fn rotated_z(self, angle_radians: T) -> Self where
    T: Real, 

Returns this vector rotated in 2D, counter-clockwise.

use std::f32::consts::PI;

assert_relative_eq!(Vec2::unit_x().rotated_z(0_f32), Vec2::unit_x());
assert_relative_eq!(Vec2::unit_x().rotated_z(PI/2.), Vec2::unit_y());
assert_relative_eq!(Vec2::unit_x().rotated_z(PI), -Vec2::unit_x());
assert_relative_eq!(Vec2::unit_x().rotated_z(PI*1.5), -Vec2::unit_y());
assert_relative_eq!(Vec2::unit_x().rotated_z(PI*2.), Vec2::unit_x(), epsilon = 0.000001);

pub fn rotate_z(&mut self, angle_radians: T) where
    T: Real, 

Rotates this vector in 2D. See rotated_z().

pub fn unit_x() -> Self where
    T: Zero + One, 

Get the unit vector which has x set to 1.

pub fn unit_y() -> Self where
    T: Zero + One, 

Get the unit vector which has y set to 1.

pub fn left() -> Self where
    T: Zero + One + Neg<Output = T>, 

Get the unit vector which has x set to -1.

pub fn right() -> Self where
    T: Zero + One, 

Get the unit vector which has x set to 1.

pub fn up() -> Self where
    T: Zero + One, 

Get the unit vector which has y set to 1. This is not intended for screen-space coordinates (in which case the Y axis is reversed). When in doubt, just use unit_y() instead.

pub fn down() -> Self where
    T: Zero + One + Neg<Output = T>, 

Get the unit vector which has y set to -1. This is not intended for screen-space coordinates (in which case the Y axis is reversed). When in doubt, just use unit_y() instead.

impl<T> Vec2<T>

pub fn yx(self) -> Self

Returns a copy of this vector, with X and Y swapped.

impl<T> CVec<T>

pub fn into_repr_simd(self) -> Vec2<T>

Converts this vector into its #[repr(simd)] counterpart.

Trait Implementations

impl<T: IsBetween<Output = bool> + Copy> IsBetween<T> for Vec2<T>

type Output = Vec2<bool>

bool for scalars, or vector of bools for vectors.

fn is_between(self, lower: T, upper: T) -> Self::Output

Returns whether this value is between lower and upper (inclusive).

fn is_between01(self) -> Self::Output where
    Bound: Zero + One, 

Returns whether this value is between 0 and 1 (inclusive).

impl<T: IsBetween<Output = bool>> IsBetween<Vec2<T>> for Vec2<T>

type Output = Vec2<bool>

bool for scalars, or vector of bools for vectors.

fn is_between(self, lower: Self, upper: Self) -> Self::Output

Returns whether this value is between lower and upper (inclusive).

fn is_between01(self) -> Self::Output where
    Bound: Zero + One, 

Returns whether this value is between 0 and 1 (inclusive).

impl<T: Clamp + Copy> Clamp<T> for Vec2<T>

fn clamped(self, lower: T, upper: T) -> Self

Constrains this value to be between lower and upper (inclusive).

fn clamp(val: Self, lower: Bound, upper: Bound) -> Self

Alias to clamped, which doesn't take self.

fn clamped01(self) -> Self where
    Bound: Zero + One, 

Constrains this value to be between 0 and 1 (inclusive).

fn clamp01(val: Self) -> Self where
    Bound: Zero + One, 

Alias to clamped01, which doesn't take self.

impl<T: Clamp> Clamp<Vec2<T>> for Vec2<T>

fn clamped(self, lower: Self, upper: Self) -> Self

Constrains this value to be between lower and upper (inclusive).

fn clamp(val: Self, lower: Bound, upper: Bound) -> Self

Alias to clamped, which doesn't take self.

fn clamped01(self) -> Self where
    Bound: Zero + One, 

Constrains this value to be between 0 and 1 (inclusive).

fn clamp01(val: Self) -> Self where
    Bound: Zero + One, 

Alias to clamped01, which doesn't take self.

impl<T> MulAdd<Vec2<T>, Vec2<T>> for Vec2<T> where
    T: MulAdd<T, T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the fused multiply-add operation.

fn mul_add(self, a: Vec2<T>, b: Vec2<T>) -> Self::Output

Returns (self * mul) + add as a possibly faster and more precise single operation.

impl<'c, T> MulAdd<Vec2<T>, Vec2<T>> for &'c Vec2<T> where
    &'c T: MulAdd<T, T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the fused multiply-add operation.

fn mul_add(self, a: Vec2<T>, b: Vec2<T>) -> Self::Output

Returns (self * mul) + add as a possibly faster and more precise single operation.

impl<'b, T> MulAdd<Vec2<T>, &'b Vec2<T>> for Vec2<T> where
    T: MulAdd<T, &'b T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the fused multiply-add operation.

fn mul_add(self, a: Vec2<T>, b: &'b Vec2<T>) -> Self::Output

Returns (self * mul) + add as a possibly faster and more precise single operation.

impl<'b, 'c, T> MulAdd<Vec2<T>, &'b Vec2<T>> for &'c Vec2<T> where
    &'c T: MulAdd<T, &'b T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the fused multiply-add operation.

fn mul_add(self, a: Vec2<T>, b: &'b Vec2<T>) -> Self::Output

Returns (self * mul) + add as a possibly faster and more precise single operation.

impl<'a, T> MulAdd<&'a Vec2<T>, Vec2<T>> for Vec2<T> where
    T: MulAdd<&'a T, T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the fused multiply-add operation.

fn mul_add(self, a: &'a Vec2<T>, b: Vec2<T>) -> Self::Output

Returns (self * mul) + add as a possibly faster and more precise single operation.

impl<'a, 'c, T> MulAdd<&'a Vec2<T>, Vec2<T>> for &'c Vec2<T> where
    &'c T: MulAdd<&'a T, T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the fused multiply-add operation.

fn mul_add(self, a: &'a Vec2<T>, b: Vec2<T>) -> Self::Output

Returns (self * mul) + add as a possibly faster and more precise single operation.

impl<'a, 'b, T> MulAdd<&'a Vec2<T>, &'b Vec2<T>> for Vec2<T> where
    T: MulAdd<&'a T, &'b T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the fused multiply-add operation.

fn mul_add(self, a: &'a Vec2<T>, b: &'b Vec2<T>) -> Self::Output

Returns (self * mul) + add as a possibly faster and more precise single operation.

impl<'a, 'b, 'c, T> MulAdd<&'a Vec2<T>, &'b Vec2<T>> for &'c Vec2<T> where
    &'c T: MulAdd<&'a T, &'b T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the fused multiply-add operation.

fn mul_add(self, a: &'a Vec2<T>, b: &'b Vec2<T>) -> Self::Output

Returns (self * mul) + add as a possibly faster and more precise single operation.

impl<T, Factor> Lerp<Factor> for Vec2<T> where
    T: Lerp<Factor, Output = T>,
    Factor: Copy, 

type Output = Self

The resulting type after performing the LERP operation.

fn lerp_unclamped_precise(from: Self, to: Self, factor: Factor) -> Self

Returns the linear interpolation of from to to with factor unconstrained, using a possibly slower but more precise operation.

fn lerp_unclamped(from: Self, to: Self, factor: Factor) -> Self

Returns the linear interpolation of from to to with factor unconstrained, using the supposedly fastest but less precise implementation.

fn lerp(from: Self, to: Self, factor: Factor) -> Self::Output where
    Factor: Clamp + Zero + One, 

Alias to lerp_unclamped which constrains factor to be between 0 and 1 (inclusive).

fn lerp_precise(from: Self, to: Self, factor: Factor) -> Self::Output where
    Factor: Clamp + Zero + One, 

Alias to lerp_unclamped_precise which constrains factor to be between 0 and 1 (inclusive).

impl<'a, T, Factor> Lerp<Factor> for &'a Vec2<T> where
    &'a T: Lerp<Factor, Output = T>,
    Factor: Copy, 

type Output = Vec2<T>

The resulting type after performing the LERP operation.

fn lerp_unclamped_precise(from: Self, to: Self, factor: Factor) -> Vec2<T>

Returns the linear interpolation of from to to with factor unconstrained, using a possibly slower but more precise operation.

fn lerp_unclamped(from: Self, to: Self, factor: Factor) -> Vec2<T>

Returns the linear interpolation of from to to with factor unconstrained, using the supposedly fastest but less precise implementation.

fn lerp(from: Self, to: Self, factor: Factor) -> Self::Output where
    Factor: Clamp + Zero + One, 

Alias to lerp_unclamped which constrains factor to be between 0 and 1 (inclusive).

fn lerp_precise(from: Self, to: Self, factor: Factor) -> Self::Output where
    Factor: Clamp + Zero + One, 

Alias to lerp_unclamped_precise which constrains factor to be between 0 and 1 (inclusive).

impl<T: Wrap + Copy> Wrap<T> for Vec2<T>

fn wrapped(self, upper: T) -> Self

Returns this value, wrapped between zero and some upper bound (both inclusive).

fn wrapped_between(self, lower: T, upper: T) -> Self

Returns this value, wrapped between lower (inclusive) and upper (exclusive).

fn pingpong(self, upper: T) -> Self

Wraps a value such that it goes back and forth from zero to upper (inclusive) as it increases.

fn wrap(val: Self, upper: Bound) -> Self

Alias to wrapped() which doesn't take self.

fn wrapped_2pi(self) -> Self where
    Bound: FloatConst + Add<Output = Bound>, 

Returns this value, wrapped between zero and two times 𝛑 (inclusive).

fn wrap_2pi(val: Self) -> Self where
    Bound: FloatConst + Add<Output = Bound>, 

Alias to wrapped_2pi which doesn't take self.

fn wrap_between(val: Self, lower: Bound, upper: Bound) -> Self where
    Self: Sub<Output = Self> + Add<Output = Self> + From<Bound>,
    Bound: Copy + Sub<Output = Bound> + PartialOrd, 

Alias to wrapped_between which doesn't take self.

fn delta_angle(self, target: Self) -> Self where
    Self: From<Bound> + Sub<Output = Self> + PartialOrd,
    Bound: FloatConst + Add<Output = Bound>, 

Calculates the shortest difference between two given angles, in radians.

fn delta_angle_degrees(self, target: Self) -> Self where
    Self: From<Bound> + Sub<Output = Self> + PartialOrd,
    Bound: From<u16>, 

Calculates the shortest difference between two given angles, in degrees.

impl<T: Wrap> Wrap<Vec2<T>> for Vec2<T>

fn wrapped(self, upper: Vec2<T>) -> Self

Returns this value, wrapped between zero and some upper bound (both inclusive).

fn wrapped_between(self, lower: Self, upper: Self) -> Self

Returns this value, wrapped between lower (inclusive) and upper (exclusive).

fn pingpong(self, upper: Self) -> Self

Wraps a value such that it goes back and forth from zero to upper (inclusive) as it increases.

fn wrap(val: Self, upper: Bound) -> Self

Alias to wrapped() which doesn't take self.

fn wrapped_2pi(self) -> Self where
    Bound: FloatConst + Add<Output = Bound>, 

Returns this value, wrapped between zero and two times 𝛑 (inclusive).

fn wrap_2pi(val: Self) -> Self where
    Bound: FloatConst + Add<Output = Bound>, 

Alias to wrapped_2pi which doesn't take self.

fn wrap_between(val: Self, lower: Bound, upper: Bound) -> Self where
    Self: Sub<Output = Self> + Add<Output = Self> + From<Bound>,
    Bound: Copy + Sub<Output = Bound> + PartialOrd, 

Alias to wrapped_between which doesn't take self.

fn delta_angle(self, target: Self) -> Self where
    Self: From<Bound> + Sub<Output = Self> + PartialOrd,
    Bound: FloatConst + Add<Output = Bound>, 

Calculates the shortest difference between two given angles, in radians.

fn delta_angle_degrees(self, target: Self) -> Self where
    Self: From<Bound> + Sub<Output = Self> + PartialOrd,
    Bound: From<u16>, 

Calculates the shortest difference between two given angles, in degrees.

impl<T> From<(T, T)> for Vec2<T>

fn from(tuple: (T, T)) -> Self

Performs the conversion.

impl<T> From<[T; 2]> for Vec2<T>

fn from(array: [T; 2]) -> Self

Performs the conversion.

impl<T: Copy> From<T> for Vec2<T>

A vector can be obtained from a single scalar by broadcasting it.

This conversion is important because it allows scalars to be smoothly accepted as operands in most vector operations.

For instance :

assert_eq!(Vec4::min(4, 5), Vec4::broadcast(4));
assert_eq!(Vec4::max(4, 5), Vec4::broadcast(5));
assert_eq!(Vec4::from(4), Vec4::broadcast(4));
assert_eq!(Vec4::from(4).mul_add(4, 5), Vec4::broadcast(21));

// scaling_3d() logically accepts a Vec3...
let _ = Mat4::<f32>::scaling_3d(Vec3::broadcast(5.0));
// ... but there you go; quick uniform scale, thanks to Into !
let _ = Mat4::scaling_3d(5_f32);

On the other hand, it also allows writing nonsense. To minimize surprises, the names of operations try to be as explicit as possible.

// This creates a matrix that translates to (5,5,5), but it's probably not what you meant.
// Hopefully the `_3d` suffix would help you catch this.
let _ = Mat4::translation_3d(5_f32);
// translation_3d() takes V: Into<Vec3> because it allows it to accept
// Vec2, Vec3 and Vec4, and also with both repr(C) and repr(simd) layouts.

fn from(val: T) -> Self

Performs the conversion.

impl<T> From<Vec3<T>> for Vec2<T>

fn from(v: Vec3<T>) -> Self

Performs the conversion.

impl<T> From<Vec4<T>> for Vec2<T>

fn from(v: Vec4<T>) -> Self

Performs the conversion.

impl<T> From<Extent2<T>> for Vec2<T>

fn from(v: Extent2<T>) -> Self

Performs the conversion.

impl<T: Zero> From<Vec2<T>> for Vec3<T>

fn from(v: Vec2<T>) -> Self

Performs the conversion.

impl<T: Zero> From<Vec2<T>> for Vec4<T>

fn from(v: Vec2<T>) -> Self

Performs the conversion.

impl<T> From<Vec2<T>> for Extent2<T>

fn from(v: Vec2<T>) -> Self

Performs the conversion.

impl<T> From<Vec2<T>> for Vec2<T>

fn from(v: CVec<T>) -> Self

Performs the conversion.

impl<T> From<Vec2<T>> for CVec<T>

fn from(v: Vec2<T>) -> Self

Performs the conversion.

impl<T: Display> Display for Vec2<T>

Displays the vector, formatted as ({}, {}).

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

Formats the value using the given formatter.

impl<T: Debug> Debug for Vec2<T>

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

Formats the value using the given formatter.

impl<V, T> Div<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: Div<T, Output = T>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: V) -> Self::Output

Performs the / operation.

impl<'a, T> Div<&'a Vec2<T>> for Vec2<T> where
    T: Div<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the / operator.

fn div(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the / operation.

impl<'a, T> Div<Vec2<T>> for &'a Vec2<T> where
    &'a T: Div<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the / operator.

fn div(self, rhs: Vec2<T>) -> Self::Output

Performs the / operation.

impl<'a, 'b, T> Div<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: Div<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the / operator.

fn div(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the / operation.

impl<'a, T> Div<T> for &'a Vec2<T> where
    &'a T: Div<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<'a, 'b, T> Div<&'a T> for &'b Vec2<T> where
    &'b T: Div<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the / operator.

fn div(self, rhs: &'a T) -> Self::Output

Performs the / operation.

impl<V, T> Rem<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: Rem<T, Output = T>, 

type Output = Self

The resulting type after applying the % operator.

fn rem(self, rhs: V) -> Self::Output

Performs the % operation.

impl<'a, T> Rem<&'a Vec2<T>> for Vec2<T> where
    T: Rem<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the % operation.

impl<'a, T> Rem<Vec2<T>> for &'a Vec2<T> where
    &'a T: Rem<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the % operator.

fn rem(self, rhs: Vec2<T>) -> Self::Output

Performs the % operation.

impl<'a, 'b, T> Rem<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: Rem<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the % operation.

impl<'a, T> Rem<T> for &'a Vec2<T> where
    &'a T: Rem<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<'a, 'b, T> Rem<&'a T> for &'b Vec2<T> where
    &'b T: Rem<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a T) -> Self::Output

Performs the % operation.

impl<V, T> Sub<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: Sub<T, Output = T>, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: V) -> Self::Output

Performs the - operation.

impl<'a, T> Sub<&'a Vec2<T>> for Vec2<T> where
    T: Sub<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the - operation.

impl<'a, T> Sub<Vec2<T>> for &'a Vec2<T> where
    &'a T: Sub<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2<T>) -> Self::Output

Performs the - operation.

impl<'a, 'b, T> Sub<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: Sub<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the - operation.

impl<'a, T> Sub<T> for &'a Vec2<T> where
    &'a T: Sub<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<'a, 'b, T> Sub<&'a T> for &'b Vec2<T> where
    &'b T: Sub<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a T) -> Self::Output

Performs the - operation.

impl<T: PartialEq> PartialEq<Vec2<T>> for Vec2<T>

fn eq(&self, other: &Vec2<T>) -> bool

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

fn ne(&self, other: &Vec2<T>) -> bool

This method tests for !=.

impl<T: Eq> Eq for Vec2<T>

impl<V, T> Add<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: Add<T, Output = T>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: V) -> Self::Output

Performs the + operation.

impl<'a, T> Add<&'a Vec2<T>> for Vec2<T> where
    T: Add<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the + operator.

fn add(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the + operation.

impl<'a, T> Add<Vec2<T>> for &'a Vec2<T> where
    &'a T: Add<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<T>) -> Self::Output

Performs the + operation.

impl<'a, 'b, T> Add<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: Add<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the + operator.

fn add(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the + operation.

impl<'a, T> Add<T> for &'a Vec2<T> where
    &'a T: Add<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<'a, 'b, T> Add<&'a T> for &'b Vec2<T> where
    &'b T: Add<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the + operator.

fn add(self, rhs: &'a T) -> Self::Output

Performs the + operation.

impl Add<Vec2<i8>> for i8

type Output = Vec2<i8>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<i8>) -> Self::Output

Performs the + operation.

impl Add<Vec2<u8>> for u8

type Output = Vec2<u8>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<u8>) -> Self::Output

Performs the + operation.

impl Add<Vec2<i16>> for i16

type Output = Vec2<i16>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<i16>) -> Self::Output

Performs the + operation.

impl Add<Vec2<u16>> for u16

type Output = Vec2<u16>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<u16>) -> Self::Output

Performs the + operation.

impl Add<Vec2<i32>> for i32

type Output = Vec2<i32>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<i32>) -> Self::Output

Performs the + operation.

impl Add<Vec2<u32>> for u32

type Output = Vec2<u32>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<u32>) -> Self::Output

Performs the + operation.

impl Add<Vec2<i64>> for i64

type Output = Vec2<i64>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<i64>) -> Self::Output

Performs the + operation.

impl Add<Vec2<u64>> for u64

type Output = Vec2<u64>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<u64>) -> Self::Output

Performs the + operation.

impl Add<Vec2<f32>> for f32

type Output = Vec2<f32>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<f32>) -> Self::Output

Performs the + operation.

impl Add<Vec2<f64>> for f64

type Output = Vec2<f64>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<f64>) -> Self::Output

Performs the + operation.

impl<V, T> Mul<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: Mul<T, Output = T>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: V) -> Self::Output

Performs the * operation.

impl<'a, T> Mul<&'a Vec2<T>> for Vec2<T> where
    T: Mul<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the * operation.

impl<'a, T> Mul<Vec2<T>> for &'a Vec2<T> where
    &'a T: Mul<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<T>) -> Self::Output

Performs the * operation.

impl<'a, 'b, T> Mul<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: Mul<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the * operation.

impl<'a, T> Mul<T> for &'a Vec2<T> where
    &'a T: Mul<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<'a, 'b, T> Mul<&'a T> for &'b Vec2<T> where
    &'b T: Mul<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a T) -> Self::Output

Performs the * operation.

impl Mul<Vec2<i8>> for i8

type Output = Vec2<i8>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<i8>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<u8>> for u8

type Output = Vec2<u8>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<u8>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<i16>> for i16

type Output = Vec2<i16>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<i16>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<u16>> for u16

type Output = Vec2<u16>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<u16>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<i32>> for i32

type Output = Vec2<i32>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<i32>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<u32>> for u32

type Output = Vec2<u32>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<u32>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<i64>> for i64

type Output = Vec2<i64>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<i64>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<u64>> for u64

type Output = Vec2<u64>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<u64>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<f32>> for f32

type Output = Vec2<f32>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<f32>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<f64>> for f64

type Output = Vec2<f64>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<f64>) -> Self::Output

Performs the * operation.

impl<T: MulAdd<T, T, Output = T> + Mul<Output = T> + Copy> Mul<Mat2<T>> for Vec2<T>

Multiplies a row vector with a column-major matrix, giving a row vector.

use vek::mat::column_major::Mat4;
use vek::vec::Vec4;

let m = Mat4::new(
    0, 1, 2, 3,
    4, 5, 6, 7,
    8, 9, 0, 1,
    2, 3, 4, 5
);
let v = Vec4::new(0, 1, 2, 3);
let r = Vec4::new(26, 32, 18, 24);
assert_eq!(v * m, r);

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Mat2<T>) -> Self::Output

Performs the * operation.

impl<T: MulAdd<T, T, Output = T> + Mul<Output = T> + Copy> Mul<Vec2<T>> for Mat2<T>

Multiplies a column-major matrix with a column vector, giving a column vector.

With SIMD vectors, this is the most efficient way.

use vek::mat::column_major::Mat4;
use vek::vec::Vec4;

let m = Mat4::new(
    0, 1, 2, 3,
    4, 5, 6, 7,
    8, 9, 0, 1,
    2, 3, 4, 5
);
let v = Vec4::new(0, 1, 2, 3);
let r = Vec4::new(14, 38, 12, 26);
assert_eq!(m * v, r);

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, v: Vec2<T>) -> Self::Output

Performs the * operation.

impl<T: MulAdd<T, T, Output = T> + Mul<Output = T> + Copy> Mul<Mat2<T>> for Vec2<T>

Multiplies a row vector with a row-major matrix, giving a row vector.

With SIMD vectors, this is the most efficient way.

use vek::mat::row_major::Mat4;
use vek::vec::Vec4;

let m = Mat4::new(
    0, 1, 2, 3,
    4, 5, 6, 7,
    8, 9, 0, 1,
    2, 3, 4, 5
);
let v = Vec4::new(0, 1, 2, 3);
let r = Vec4::new(26, 32, 18, 24);
assert_eq!(v * m, r);

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Mat2<T>) -> Self::Output

Performs the * operation.

impl<T: MulAdd<T, T, Output = T> + Mul<Output = T> + Copy> Mul<Vec2<T>> for Mat2<T>

Multiplies a row-major matrix with a column vector, giving a column vector.

use vek::mat::row_major::Mat4;
use vek::vec::Vec4;

let m = Mat4::new(
    0, 1, 2, 3,
    4, 5, 6, 7,
    8, 9, 0, 1,
    2, 3, 4, 5
);
let v = Vec4::new(0, 1, 2, 3);
let r = Vec4::new(14, 38, 12, 26);
assert_eq!(m * v, r);

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, v: Vec2<T>) -> Self::Output

Performs the * operation.

impl<T> Neg for Vec2<T> where
    T: Neg<Output = T>, 

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<V, T> AddAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: AddAssign<T>, 

fn add_assign(&mut self, rhs: V)

Performs the += operation.

impl<V, T> SubAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: SubAssign<T>, 

fn sub_assign(&mut self, rhs: V)

Performs the -= operation.

impl<V, T> MulAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: MulAssign<T>, 

fn mul_assign(&mut self, rhs: V)

Performs the *= operation.

impl<V, T> DivAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: DivAssign<T>, 

fn div_assign(&mut self, rhs: V)

Performs the /= operation.

impl<V, T> RemAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: RemAssign<T>, 

fn rem_assign(&mut self, rhs: V)

Performs the %= operation.

impl<T> Not for Vec2<T> where
    T: Not<Output = T>, 

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<V, T> BitAnd<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: BitAnd<T, Output = T>, 

type Output = Self

The resulting type after applying the & operator.

fn bitand(self, rhs: V) -> Self::Output

Performs the & operation.

impl<'a, T> BitAnd<&'a Vec2<T>> for Vec2<T> where
    T: BitAnd<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the & operation.

impl<'a, T> BitAnd<Vec2<T>> for &'a Vec2<T> where
    &'a T: BitAnd<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the & operator.

fn bitand(self, rhs: Vec2<T>) -> Self::Output

Performs the & operation.

impl<'a, 'b, T> BitAnd<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: BitAnd<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the & operation.

impl<'a, T> BitAnd<T> for &'a Vec2<T> where
    &'a T: BitAnd<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the & operator.

fn bitand(self, rhs: T) -> Self::Output

Performs the & operation.

impl<'a, 'b, T> BitAnd<&'a T> for &'b Vec2<T> where
    &'b T: BitAnd<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a T) -> Self::Output

Performs the & operation.

impl<V, T> BitOr<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: BitOr<T, Output = T>, 

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, rhs: V) -> Self::Output

Performs the | operation.

impl<'a, T> BitOr<&'a Vec2<T>> for Vec2<T> where
    T: BitOr<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the | operation.

impl<'a, T> BitOr<Vec2<T>> for &'a Vec2<T> where
    &'a T: BitOr<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the | operator.

fn bitor(self, rhs: Vec2<T>) -> Self::Output

Performs the | operation.

impl<'a, 'b, T> BitOr<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: BitOr<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the | operation.

impl<'a, T> BitOr<T> for &'a Vec2<T> where
    &'a T: BitOr<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the | operator.

fn bitor(self, rhs: T) -> Self::Output

Performs the | operation.

impl<'a, 'b, T> BitOr<&'a T> for &'b Vec2<T> where
    &'b T: BitOr<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a T) -> Self::Output

Performs the | operation.

impl<V, T> BitXor<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: BitXor<T, Output = T>, 

type Output = Self

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: V) -> Self::Output

Performs the ^ operation.

impl<'a, T> BitXor<&'a Vec2<T>> for Vec2<T> where
    T: BitXor<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the ^ operation.

impl<'a, T> BitXor<Vec2<T>> for &'a Vec2<T> where
    &'a T: BitXor<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Vec2<T>) -> Self::Output

Performs the ^ operation.

impl<'a, 'b, T> BitXor<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: BitXor<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the ^ operation.

impl<'a, T> BitXor<T> for &'a Vec2<T> where
    &'a T: BitXor<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: T) -> Self::Output

Performs the ^ operation.

impl<'a, 'b, T> BitXor<&'a T> for &'b Vec2<T> where
    &'b T: BitXor<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a T) -> Self::Output

Performs the ^ operation.

impl<V, T> Shl<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: Shl<T, Output = T>, 

type Output = Self

The resulting type after applying the << operator.

fn shl(self, rhs: V) -> Self::Output

Performs the << operation.

impl<'a, T> Shl<&'a Vec2<T>> for Vec2<T> where
    T: Shl<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the << operator.

fn shl(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the << operation.

impl<'a, T> Shl<Vec2<T>> for &'a Vec2<T> where
    &'a T: Shl<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the << operator.

fn shl(self, rhs: Vec2<T>) -> Self::Output

Performs the << operation.

impl<'a, 'b, T> Shl<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: Shl<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the << operator.

fn shl(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the << operation.

impl<'a, T> Shl<T> for &'a Vec2<T> where
    &'a T: Shl<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the << operator.

fn shl(self, rhs: T) -> Self::Output

Performs the << operation.

impl<'a, 'b, T> Shl<&'a T> for &'b Vec2<T> where
    &'b T: Shl<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the << operator.

fn shl(self, rhs: &'a T) -> Self::Output

Performs the << operation.

impl<V, T> Shr<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: Shr<T, Output = T>, 

type Output = Self

The resulting type after applying the >> operator.

fn shr(self, rhs: V) -> Self::Output

Performs the >> operation.

impl<'a, T> Shr<&'a Vec2<T>> for Vec2<T> where
    T: Shr<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the >> operator.

fn shr(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the >> operation.

impl<'a, T> Shr<Vec2<T>> for &'a Vec2<T> where
    &'a T: Shr<T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the >> operator.

fn shr(self, rhs: Vec2<T>) -> Self::Output

Performs the >> operation.

impl<'a, 'b, T> Shr<&'a Vec2<T>> for &'b Vec2<T> where
    &'b T: Shr<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the >> operator.

fn shr(self, rhs: &'a Vec2<T>) -> Self::Output

Performs the >> operation.

impl<'a, T> Shr<T> for &'a Vec2<T> where
    &'a T: Shr<T, Output = T>,
    T: Copy, 

type Output = Vec2<T>

The resulting type after applying the >> operator.

fn shr(self, rhs: T) -> Self::Output

Performs the >> operation.

impl<'a, 'b, T> Shr<&'a T> for &'b Vec2<T> where
    &'b T: Shr<&'a T, Output = T>, 

type Output = Vec2<T>

The resulting type after applying the >> operator.

fn shr(self, rhs: &'a T) -> Self::Output

Performs the >> operation.

impl<V, T> BitAndAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: BitAndAssign<T>, 

fn bitand_assign(&mut self, rhs: V)

Performs the &= operation.

impl<V, T> BitOrAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: BitOrAssign<T>, 

fn bitor_assign(&mut self, rhs: V)

Performs the |= operation.

impl<V, T> BitXorAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: BitXorAssign<T>, 

fn bitxor_assign(&mut self, rhs: V)

Performs the ^= operation.

impl<V, T> ShlAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: ShlAssign<T>, 

fn shl_assign(&mut self, rhs: V)

Performs the <<= operation.

impl<V, T> ShrAssign<V> for Vec2<T> where
    V: Into<Vec2<T>>,
    T: ShrAssign<T>, 

fn shr_assign(&mut self, rhs: V)

Performs the >>= operation.

impl<T> Deref for Vec2<T>

type Target = [T]

The resulting type after dereferencing.

fn deref(&self) -> &[T]

Dereferences the value.

impl<T> DerefMut for Vec2<T>

fn deref_mut(&mut self) -> &mut [T]

Mutably dereferences the value.

impl<T: Hash> Hash for Vec2<T>

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<T: Copy> Copy for Vec2<T>

impl<T> StructuralPartialEq for Vec2<T>

impl<T> StructuralEq for Vec2<T>

impl<T: Default> FromIterator<T> for Vec2<T>

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = T>, 

Creates a value from an iterator.

impl<'a, T> IntoIterator for &'a Vec2<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Vec2<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Vec2<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> Sum<Vec2<T>> for Vec2<T> where
    T: Add<T, Output = T> + Zero, 

fn sum<I: Iterator<Item = Vec2<T>>>(iter: I) -> Vec2<T>

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

impl<T> Product<Vec2<T>> for Vec2<T> where
    T: Mul<T, Output = T> + One, 

fn product<I: Iterator<Item = Vec2<T>>>(iter: I) -> Vec2<T>

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

impl<T> AsRef<[T]> for Vec2<T>

fn as_ref(&self) -> &[T]

Performs the conversion.

impl<T> AsRef<Vec2<T>> for Vec2<T>

fn as_ref(&self) -> &Self

Performs the conversion.

impl<T> AsMut<[T]> for Vec2<T>

fn as_mut(&mut self) -> &mut [T]

Performs the conversion.

impl<T> AsMut<Vec2<T>> for Vec2<T>

fn as_mut(&mut self) -> &mut Self

Performs the conversion.

impl<T: Clone> Clone for Vec2<T>

fn clone(&self) -> Vec2<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default> Default for Vec2<T>

fn default() -> Vec2<T>

Returns the "default value" for a type.

impl<T> Borrow<[T]> for Vec2<T>

fn borrow(&self) -> &[T]

Immutably borrows from an owned value.

impl<T> BorrowMut<[T]> for Vec2<T>

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

Mutably borrows from an owned value.

impl<T: Zero + PartialEq> Zero for Vec2<T>

fn zero() -> Self

Returns the additive identity element of Self, 0. # Purity

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T: One> One for Vec2<T>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<T: ApproxEq> ApproxEq for Vec2<T> where
    T::Epsilon: Copy, 

type Epsilon = T::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> T::Epsilon

The default tolerance to use when testing values that are close together.

fn default_max_relative() -> T::Epsilon

The default relative tolerance for testing values that are far-apart.

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Self,
    epsilon: T::Epsilon,
    max_relative: T::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn ulps_eq(&self, other: &Self, epsilon: T::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn relative_ne(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

fn ulps_ne(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of ApproxEq::ulps_eq.