[−][src]Struct glam::Vec2

#[repr(C)]pub struct Vec2(_, _);

A 2-dimensional vector.

Implementations

`impl Vec2`[src]

`pub fn is_nan(self) -> Vec2Mask`[src]

Performs is_nan on each element of self, returning a Vec2Mask of the results.

In other words, this computes [x.is_nan(), y.is_nan()].

`pub fn sign(self) -> Self`[src]

👎 Deprecated since 0.9.5:

please use Vec2::signum instead

`pub fn signum(self) -> Self`[src]

Returns a Vec2 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 reciprocal(self) -> Self`[src]

👎 Deprecated since 0.9.5:

please use Vec2::recip instead

`pub fn recip(self) -> Self`[src]

Returns a Vec2 containing the reciprocal 1.0/n of each element of self.

`pub fn lerp(self, other: Self, s: f32) -> Self`[src]

Performs a linear interpolation between self and other based on the value s.

When s is 0.0, the result will be equal to self. When s is 1.0, the result will be equal to other.

`pub fn is_normalized(self) -> bool`[src]

Returns whether self is length 1.0 or not.

Uses a precision threshold of 1e-6.

`pub fn abs_diff_eq(self, other: Self, max_abs_diff: f32) -> bool`[src]

Returns true if the absolute difference of all elements between self and other is less than or equal to max_abs_diff.

This can be used to compare if two Vec2's contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more on floating point comparisons see https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/

`pub fn new(x: f32, y: f32) -> Vec2`[src]

Creates a new Vec2.

`pub const fn zero() -> Vec2`[src]

Creates a Vec2 with all elements set to 0.0.

`pub const fn one() -> Vec2`[src]

Creates a Vec2 with all elements set to 1.0.

`pub const fn unit_x() -> Vec2`[src]

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

`pub const fn unit_y() -> Vec2`[src]

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

`pub fn splat(v: f32) -> Vec2`[src]

Creates a Vec2 with all elements set to v.

`pub fn extend(self, z: f32) -> Vec3`[src]

Creates a Vec3 from self and the given z value.

`pub fn x(self) -> f32`[src]

Returns element x.

`pub fn y(self) -> f32`[src]

Returns element y.

`pub fn x_mut(&mut self) -> &mut f32`[src]

Returns a mutable reference to element x.

`pub fn y_mut(&mut self) -> &mut f32`[src]

Returns a mutable reference to element y.

`pub fn set_x(&mut self, x: f32)`[src]

Sets element x.

`pub fn set_y(&mut self, y: f32)`[src]

Sets element y.

`pub fn dot(self, other: Vec2) -> f32`[src]

Computes the dot product of self and other.

`pub fn length(self) -> f32`[src]

Computes the length of self.

`pub fn length_squared(self) -> f32`[src]

Computes the squared length of self.

This is generally faster than Vec2::length() as it avoids a square root operation.

`pub fn length_reciprocal(self) -> f32`[src]

👎 Deprecated since 0.9.5:

please use Vec2::length_recip instead

`pub fn length_recip(self) -> f32`[src]

Computes 1.0 / Vec2::length().

For valid results, self must not be of length zero.

`pub fn distance(self, other: Vec2) -> f32`[src]

Computes the Euclidean distance between two points.

`pub fn distance_squared(self, other: Vec2) -> f32`[src]

Compute the squared Euclidean distance between two points.

`pub fn normalize(self) -> Vec2`[src]

Returns self normalized to length 1.0.

For valid results, self must not be of length zero.

`pub fn min(self, other: Vec2) -> Vec2`[src]

Returns the vertical minimum of self and other.

In other words, this computes [x: min(x1, x2), y: min(y1, y2)], taking the minimum of each element individually.

`pub fn max(self, other: Vec2) -> Vec2`[src]

Returns the vertical maximum of self and other.

In other words, this computes [x: max(x1, x2), y: max(y1, y2)], taking the maximum of each element individually.

`pub fn min_element(self) -> f32`[src]

Returns the horizontal minimum of self's elements.

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

`pub fn max_element(self) -> f32`[src]

Returns the horizontal maximum of self's elements.

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

`pub fn cmpeq(self, other: Vec2) -> Vec2Mask`[src]

Performs a vertical == comparison between self and other, returning a Vec2Mask of the results.

In other words, this computes [x1 == x2, y1 == y2].

`pub fn cmpne(self, other: Vec2) -> Vec2Mask`[src]

Performs a vertical != comparison between self and other, returning a Vec2Mask of the results.

In other words, this computes [x1 != x2, y1 != y2].

`pub fn cmpge(self, other: Vec2) -> Vec2Mask`[src]

Performs a vertical >= comparison between self and other, returning a Vec2Mask of the results.

In other words, this computes [x1 >= x2, y1 >= y2].

`pub fn cmpgt(self, other: Vec2) -> Vec2Mask`[src]

Performs a vertical > comparison between self and other, returning a Vec2Mask of the results.

In other words, this computes [x1 > x2, y1 > y2].

`pub fn cmple(self, other: Vec2) -> Vec2Mask`[src]

Performs a vertical <= comparison between self and other, returning a Vec2Mask of the results.

In other words, this computes [x1 <= x2, y1 <= y2].

`pub fn cmplt(self, other: Vec2) -> Vec2Mask`[src]

Performs a vertical < comparison between self and other, returning a Vec2Mask of the results.

In other words, this computes [x1 < x2, y1 < y2].

`pub fn from_slice_unaligned(slice: &[f32]) -> Self`[src]

Creates a Vec2 from the first two values in slice.

Panics

Panics if slice is less than two elements long.

`pub fn write_to_slice_unaligned(self, slice: &mut [f32])`[src]

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

Panics

Panics if slice is less than two elements long.

`pub fn abs(self) -> Self`[src]

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

`pub fn round(self) -> Self`[src]

Returns a Vec2 containing the nearest integer to a number for each element of self. Round half-way cases away from 0.0.

`pub fn floor(self) -> Self`[src]

Returns a Vec2 containing the largest integer less than or equal to a number for each element of self.

`pub fn ceil(self) -> Self`[src]

Returns a Vec2 containing the smallest integer greater than or equal to a number for each element of self.

`pub fn perp_dot(self, other: Vec2) -> f32`[src]

The perpendicular dot product of the vector and other.

`pub fn angle_between(self, other: Self) -> f32`[src]

Returns the angle between two vectors, in radians.

The vectors do not need to be unit length, but this function does perform a sqrt.

Trait Implementations

`impl Add<Vec2> for Vec2`[src]

`type Output = Self`

The resulting type after applying the + operator.

`fn add(self, other: Self) -> Self`[src]

`impl AddAssign<Vec2> for Vec2`[src]

`fn add_assign(&mut self, other: Self)`[src]

`impl AsMut<[f32; 2]> for Vec2`[src]

`fn as_mut(&mut self) -> &mut [f32; 2]`[src]

`impl AsRef<[f32; 2]> for Vec2`[src]

`fn as_ref(&self) -> &[f32; 2]`[src]

`impl Clone for Vec2`[src]

`fn clone(&self) -> Vec2`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Vec2`[src]

`impl Debug for Vec2`[src]

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

`impl Default for Vec2`[src]

`fn default() -> Vec2`[src]

`impl Display for Vec2`[src]

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

`impl Div<Vec2> for Vec2`[src]

`type Output = Self`

The resulting type after applying the / operator.

`fn div(self, other: Vec2) -> Self`[src]

`impl Div<Vec2> for f32`[src]

`type Output = Vec2`

The resulting type after applying the / operator.

`fn div(self, other: Vec2) -> Vec2`[src]

`impl Div<f32> for Vec2`[src]

`type Output = Self`

The resulting type after applying the / operator.

`fn div(self, other: f32) -> Self`[src]

`impl DivAssign<Vec2> for Vec2`[src]

`fn div_assign(&mut self, other: Vec2)`[src]

`impl DivAssign<f32> for Vec2`[src]

`fn div_assign(&mut self, other: f32)`[src]

`impl From<[f32; 2]> for Vec2`[src]

`fn from(a: [f32; 2]) -> Self`[src]

`impl From<(f32, f32)> for Vec2`[src]

`fn from(t: (f32, f32)) -> Self`[src]

`impl From<Vec2> for (f32, f32)`[src]

`fn from(v: Vec2) -> Self`[src]

`impl From<Vec2> for [f32; 2]`[src]

`fn from(v: Vec2) -> Self`[src]

`impl From<Vec3> for Vec2`[src]

`fn from(v: Vec3) -> Self`[src]

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

`impl From<Vec3A> for Vec2`[src]

`fn from(v: Vec3A) -> Self`[src]

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

`impl From<Vec4> for Vec2`[src]

`fn from(v: Vec4) -> Self`[src]

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

`impl Index<usize> for Vec2`[src]

`type Output = f32`

The returned type after indexing.

`fn index(&self, index: usize) -> &Self::Output`[src]

`impl IndexMut<usize> for Vec2`[src]

`fn index_mut(&mut self, index: usize) -> &mut Self::Output`[src]

`impl Mul<Vec2> for Mat2`[src]

`type Output = Vec2`

The resulting type after applying the * operator.

`fn mul(self, other: Vec2) -> Vec2`[src]

`impl Mul<Vec2> for Vec2`[src]

`type Output = Self`

The resulting type after applying the * operator.

`fn mul(self, other: Vec2) -> Self`[src]

`impl Mul<Vec2> for f32`[src]

`type Output = Vec2`

The resulting type after applying the * operator.

`fn mul(self, other: Vec2) -> Vec2`[src]

`impl Mul<f32> for Vec2`[src]

`type Output = Self`

The resulting type after applying the * operator.

`fn mul(self, other: f32) -> Self`[src]

`impl MulAssign<Vec2> for Vec2`[src]

`fn mul_assign(&mut self, other: Vec2)`[src]

`impl MulAssign<f32> for Vec2`[src]

`fn mul_assign(&mut self, other: f32)`[src]

`impl Neg for Vec2`[src]

`type Output = Self`

The resulting type after applying the - operator.

`fn neg(self) -> Self`[src]

`impl PartialEq<Vec2> for Vec2`[src]

`fn eq(&self, other: &Vec2) -> bool`[src]

`fn ne(&self, other: &Vec2) -> bool`[src]

`impl PartialOrd<Vec2> for Vec2`[src]

`fn partial_cmp(&self, other: &Vec2) -> Option<Ordering>`[src]

`fn lt(&self, other: &Vec2) -> bool`[src]

`fn le(&self, other: &Vec2) -> bool`[src]

`fn gt(&self, other: &Vec2) -> bool`[src]

`fn ge(&self, other: &Vec2) -> bool`[src]

`impl StructuralPartialEq for Vec2`[src]

`impl Sub<Vec2> for Vec2`[src]

`type Output = Self`

The resulting type after applying the - operator.

`fn sub(self, other: Vec2) -> Self`[src]

`impl SubAssign<Vec2> for Vec2`[src]

`fn sub_assign(&mut self, other: Vec2)`[src]

`impl Vec2Swizzles for Vec2`[src]

`fn xxxx(self) -> Vec4`[src]

`fn xxxy(self) -> Vec4`[src]

`fn xxyx(self) -> Vec4`[src]

`fn xxyy(self) -> Vec4`[src]

`fn xyxx(self) -> Vec4`[src]

`fn xyxy(self) -> Vec4`[src]

`fn xyyx(self) -> Vec4`[src]

`fn xyyy(self) -> Vec4`[src]

`fn yxxx(self) -> Vec4`[src]

`fn yxxy(self) -> Vec4`[src]

`fn yxyx(self) -> Vec4`[src]

`fn yxyy(self) -> Vec4`[src]

`fn yyxx(self) -> Vec4`[src]

`fn yyxy(self) -> Vec4`[src]

`fn yyyx(self) -> Vec4`[src]

`fn yyyy(self) -> Vec4`[src]

`fn xxx(self) -> Vec3`[src]

`fn xxy(self) -> Vec3`[src]

`fn xyx(self) -> Vec3`[src]

`fn xyy(self) -> Vec3`[src]

`fn yxx(self) -> Vec3`[src]

`fn yxy(self) -> Vec3`[src]

`fn yyx(self) -> Vec3`[src]

`fn yyy(self) -> Vec3`[src]

`fn xx(self) -> Vec2`[src]

`fn yx(self) -> Vec2`[src]

`fn yy(self) -> Vec2`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Vec2`

`impl Send for Vec2`

`impl Sync for Vec2`

`impl Unpin for Vec2`

`impl UnwindSafe for Vec2`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

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

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

`pub fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`pub default fn to_string(&self) -> String`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Struct glam::Vec2

Implementations

impl Vec2[src]

pub fn is_nan(self) -> Vec2Mask[src]

pub fn sign(self) -> Self[src]

pub fn signum(self) -> Self[src]

pub fn reciprocal(self) -> Self[src]

pub fn recip(self) -> Self[src]

pub fn lerp(self, other: Self, s: f32) -> Self[src]

pub fn is_normalized(self) -> bool[src]

pub fn abs_diff_eq(self, other: Self, max_abs_diff: f32) -> bool[src]

pub fn new(x: f32, y: f32) -> Vec2[src]

pub const fn zero() -> Vec2[src]

pub const fn one() -> Vec2[src]

pub const fn unit_x() -> Vec2[src]

pub const fn unit_y() -> Vec2[src]

pub fn splat(v: f32) -> Vec2[src]

pub fn extend(self, z: f32) -> Vec3[src]

pub fn x(self) -> f32[src]

pub fn y(self) -> f32[src]

pub fn x_mut(&mut self) -> &mut f32[src]

pub fn y_mut(&mut self) -> &mut f32[src]

pub fn set_x(&mut self, x: f32)[src]

pub fn set_y(&mut self, y: f32)[src]

pub fn dot(self, other: Vec2) -> f32[src]

pub fn length(self) -> f32[src]

pub fn length_squared(self) -> f32[src]

pub fn length_reciprocal(self) -> f32[src]

pub fn length_recip(self) -> f32[src]

pub fn distance(self, other: Vec2) -> f32[src]

pub fn distance_squared(self, other: Vec2) -> f32[src]

pub fn normalize(self) -> Vec2[src]

pub fn min(self, other: Vec2) -> Vec2[src]

pub fn max(self, other: Vec2) -> Vec2[src]

pub fn min_element(self) -> f32[src]

pub fn max_element(self) -> f32[src]

pub fn cmpeq(self, other: Vec2) -> Vec2Mask[src]

pub fn cmpne(self, other: Vec2) -> Vec2Mask[src]

pub fn cmpge(self, other: Vec2) -> Vec2Mask[src]

pub fn cmpgt(self, other: Vec2) -> Vec2Mask[src]

pub fn cmple(self, other: Vec2) -> Vec2Mask[src]

pub fn cmplt(self, other: Vec2) -> Vec2Mask[src]

pub fn from_slice_unaligned(slice: &[f32]) -> Self[src]

Panics

pub fn write_to_slice_unaligned(self, slice: &mut [f32])[src]

Panics

pub fn abs(self) -> Self[src]

pub fn round(self) -> Self[src]

pub fn floor(self) -> Self[src]

pub fn ceil(self) -> Self[src]

pub fn perp_dot(self, other: Vec2) -> f32[src]

pub fn angle_between(self, other: Self) -> f32[src]

Trait Implementations

impl Add<Vec2> for Vec2[src]

type Output = Self

fn add(self, other: Self) -> Self[src]

impl AddAssign<Vec2> for Vec2[src]

fn add_assign(&mut self, other: Self)[src]

impl AsMut<[f32; 2]> for Vec2[src]

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

impl AsRef<[f32; 2]> for Vec2[src]

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

impl Clone for Vec2[src]

fn clone(&self) -> Vec2[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Copy for Vec2[src]

impl Debug for Vec2[src]

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

impl Default for Vec2[src]

fn default() -> Vec2[src]

impl Display for Vec2[src]

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

impl Div<Vec2> for Vec2[src]

type Output = Self

fn div(self, other: Vec2) -> Self[src]

impl Div<Vec2> for f32[src]

type Output = Vec2

fn div(self, other: Vec2) -> Vec2[src]

impl Div<f32> for Vec2[src]

type Output = Self

`impl Vec2`[src]

`pub fn is_nan(self) -> Vec2Mask`[src]

`pub fn sign(self) -> Self`[src]

`pub fn signum(self) -> Self`[src]

`pub fn reciprocal(self) -> Self`[src]

`pub fn recip(self) -> Self`[src]

`pub fn lerp(self, other: Self, s: f32) -> Self`[src]

`pub fn is_normalized(self) -> bool`[src]

`pub fn abs_diff_eq(self, other: Self, max_abs_diff: f32) -> bool`[src]

`pub fn new(x: f32, y: f32) -> Vec2`[src]

`pub const fn zero() -> Vec2`[src]

`pub const fn one() -> Vec2`[src]

`pub const fn unit_x() -> Vec2`[src]

`pub const fn unit_y() -> Vec2`[src]

`pub fn splat(v: f32) -> Vec2`[src]

`pub fn extend(self, z: f32) -> Vec3`[src]

`pub fn x(self) -> f32`[src]

`pub fn y(self) -> f32`[src]

`pub fn x_mut(&mut self) -> &mut f32`[src]

`pub fn y_mut(&mut self) -> &mut f32`[src]

`pub fn set_x(&mut self, x: f32)`[src]

`pub fn set_y(&mut self, y: f32)`[src]

`pub fn dot(self, other: Vec2) -> f32`[src]

`pub fn length(self) -> f32`[src]

`pub fn length_squared(self) -> f32`[src]

`pub fn length_reciprocal(self) -> f32`[src]

`pub fn length_recip(self) -> f32`[src]

`pub fn distance(self, other: Vec2) -> f32`[src]

`pub fn distance_squared(self, other: Vec2) -> f32`[src]

`pub fn normalize(self) -> Vec2`[src]

`pub fn min(self, other: Vec2) -> Vec2`[src]

`pub fn max(self, other: Vec2) -> Vec2`[src]

`pub fn min_element(self) -> f32`[src]

`pub fn max_element(self) -> f32`[src]

`pub fn cmpeq(self, other: Vec2) -> Vec2Mask`[src]

`pub fn cmpne(self, other: Vec2) -> Vec2Mask`[src]

`pub fn cmpge(self, other: Vec2) -> Vec2Mask`[src]

`pub fn cmpgt(self, other: Vec2) -> Vec2Mask`[src]

`pub fn cmple(self, other: Vec2) -> Vec2Mask`[src]

`pub fn cmplt(self, other: Vec2) -> Vec2Mask`[src]

`pub fn from_slice_unaligned(slice: &[f32]) -> Self`[src]

`pub fn write_to_slice_unaligned(self, slice: &mut [f32])`[src]

`pub fn abs(self) -> Self`[src]

`pub fn round(self) -> Self`[src]

`pub fn floor(self) -> Self`[src]

`pub fn ceil(self) -> Self`[src]

`pub fn perp_dot(self, other: Vec2) -> f32`[src]

`pub fn angle_between(self, other: Self) -> f32`[src]

`impl Add<Vec2> for Vec2`[src]

`type Output = Self`

`fn add(self, other: Self) -> Self`[src]

`impl AddAssign<Vec2> for Vec2`[src]

`fn add_assign(&mut self, other: Self)`[src]

`impl AsMut<[f32; 2]> for Vec2`[src]

`fn as_mut(&mut self) -> &mut [f32; 2]`[src]

`impl AsRef<[f32; 2]> for Vec2`[src]

`fn as_ref(&self) -> &[f32; 2]`[src]

`impl Clone for Vec2`[src]

`fn clone(&self) -> Vec2`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Vec2`[src]

`impl Debug for Vec2`[src]

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

`impl Default for Vec2`[src]

`fn default() -> Vec2`[src]

`impl Display for Vec2`[src]

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

`impl Div<Vec2> for Vec2`[src]

`type Output = Self`

`fn div(self, other: Vec2) -> Self`[src]

`impl Div<Vec2> for f32`[src]

`type Output = Vec2`

`fn div(self, other: Vec2) -> Vec2`[src]

`impl Div<f32> for Vec2`[src]

`type Output = Self`

`fn div(self, other: f32) -> Self`[src]

`impl DivAssign<Vec2> for Vec2`[src]

`fn div_assign(&mut self, other: Vec2)`[src]

`impl DivAssign<f32> for Vec2`[src]

`fn div_assign(&mut self, other: f32)`[src]