[−][src]Struct glam::Vec2
A 2-dimensional vector.
Implementations
impl Vec2
[src]
pub fn sign(self) -> Self
[src]
Returns a new Vec4
with elements representing the sign of self
.
1.0
if the number is positive,+0.0
orINFINITY
-1.0
if the number is negative,-0.0
orNEG_INFINITY
pub fn reciprocal(self) -> Self
[src]
Computes the reciprocal 1.0/n
of each element, returning the
results in a new Vec2
.
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 fn zero() -> Vec2
[src]
Creates a new Vec2
with all elements set to 0.0
.
pub fn one() -> Vec2
[src]
Creates a new Vec2
with all elements set to 1.0
.
pub fn unit_x() -> Vec2
[src]
Creates a new Vec2
with values [x: 1.0, y: 0.0]
.
pub fn unit_y() -> Vec2
[src]
Creates a new Vec2
with values [x: 0.0, y: 1.0]
.
pub fn splat(v: f32) -> Vec2
[src]
Creates a new Vec2
with all elements set to v
.
pub fn extend(self, z: f32) -> Vec3
[src]
Creates a new 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]
Computes 1.0 / Vec2::length()
.
For valid results, self
must not be of length zero.
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, z1 == z2, w1 == w2]
.
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, z1 != z2, w1 != w2]
.
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, z1 >= z2, w1 >= w2]
.
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, z1 > z2, w1 > w2]
.
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, z1 <= z2, w1 <= w2]
.
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, z1 < z2, w1 < w2]
.
pub fn from_slice_unaligned(slice: &[f32]) -> Self
[src]
Creates a new 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 new Vec2
containing the absolute value of each element of the original
Vec2
.
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]
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]
impl AsRef<[f32; 2]> for Vec2
[src]
impl Clone for Vec2
[src]
impl Copy for Vec2
[src]
impl Debug for Vec2
[src]
impl Default for Vec2
[src]
impl Display for Vec2
[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]
impl From<(f32, f32)> for Vec2
[src]
impl From<Vec2> for (f32, f32)
[src]
impl From<Vec2> for [f32; 2]
[src]
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]
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]
impl PartialEq<Vec2> for Vec2
[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]
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]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,