Struct glam::f32::Vec2

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

A 2-dimensional vector.

Fields

x: f32

y: f32

Implementations

impl Vec2

pub const ZERO: Self = _

All zeroes.

pub const ONE: Self = _

All ones.

pub const NEG_ONE: Self = _

All negative ones.

pub const MIN: Self = _

All f32::MIN.

pub const MAX: Self = _

All f32::MAX.

pub const NAN: Self = _

All f32::NAN.

pub const INFINITY: Self = _

All f32::INFINITY.

pub const NEG_INFINITY: Self = _

All f32::NEG_INFINITY.

pub const X: Self = _

A unit vector pointing along the positive X axis.

pub const Y: Self = _

A unit vector pointing along the positive Y axis.

pub const NEG_X: Self = _

A unit vector pointing along the negative X axis.

pub const NEG_Y: Self = _

A unit vector pointing along the negative Y axis.

pub const AXES: [Self; 2] = _

The unit axes.

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

Creates a new vector.

pub const fn splat(v: f32) -> Self

Creates a vector with all elements set to v.

pub fn select(mask: BVec2, if_true: Self, if_false: Self) -> Self

Creates a vector from the elements in if_true and if_false, selecting which to use for each element of self.

A true element in the mask uses the corresponding element from if_true, and false uses the element from if_false.

pub const fn from_array(a: [f32; 2]) -> Self

Creates a new vector from an array.

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

[x, y]

pub const fn from_slice(slice: &[f32]) -> Self

Creates a vector from the first 2 values in slice.

Panics

Panics if slice is less than 2 elements long.

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

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

Panics

Panics if slice is less than 2 elements long.

pub const fn extend(self, z: f32) -> Vec3

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

pub fn with_x(self, x: f32) -> Self

Creates a 2D vector from self with the given value of x.

pub fn with_y(self, y: f32) -> Self

Creates a 2D vector from self with the given value of y.

pub fn dot(self, rhs: Self) -> f32

Computes the dot product of self and rhs.

pub fn dot_into_vec(self, rhs: Self) -> Self

Returns a vector where every component is the dot product of self and rhs.

pub fn min(self, rhs: Self) -> Self

Returns a vector containing the minimum values for each element of self and rhs.

In other words this computes [self.x.min(rhs.x), self.y.min(rhs.y), ..].

pub fn max(self, rhs: Self) -> Self

Returns a vector containing the maximum values for each element of self and rhs.

In other words this computes [self.x.max(rhs.x), self.y.max(rhs.y), ..].

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

Component-wise clamping of values, similar to f32::clamp.

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

Panics

Will panic if min is greater than max when glam_assert is enabled.

pub fn min_element(self) -> f32

Returns the horizontal minimum of self.

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

pub fn max_element(self) -> f32

Returns the horizontal maximum of self.

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

pub fn element_sum(self) -> f32

Returns the sum of all elements of self.

In other words, this computes self.x + self.y + ...

pub fn element_product(self) -> f32

Returns the product of all elements of self.

In other words, this computes self.x * self.y * ...

pub fn cmpeq(self, rhs: Self) -> BVec2

Returns a vector mask containing the result of a == comparison for each element of self and rhs.

In other words, this computes [self.x == rhs.x, self.y == rhs.y, ..] for all elements.

pub fn cmpne(self, rhs: Self) -> BVec2

Returns a vector mask containing the result of a != comparison for each element of self and rhs.

In other words this computes [self.x != rhs.x, self.y != rhs.y, ..] for all elements.

pub fn cmpge(self, rhs: Self) -> BVec2

Returns a vector mask containing the result of a >= comparison for each element of self and rhs.

In other words this computes [self.x >= rhs.x, self.y >= rhs.y, ..] for all elements.

pub fn cmpgt(self, rhs: Self) -> BVec2

Returns a vector mask containing the result of a > comparison for each element of self and rhs.

In other words this computes [self.x > rhs.x, self.y > rhs.y, ..] for all elements.

pub fn cmple(self, rhs: Self) -> BVec2

Returns a vector mask containing the result of a <= comparison for each element of self and rhs.

In other words this computes [self.x <= rhs.x, self.y <= rhs.y, ..] for all elements.

pub fn cmplt(self, rhs: Self) -> BVec2

Returns a vector mask containing the result of a < comparison for each element of self and rhs.

In other words this computes [self.x < rhs.x, self.y < rhs.y, ..] for all elements.

pub fn abs(self) -> Self

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

pub fn signum(self) -> Self

Returns a vector with elements representing the sign of self.

• 1.0 if the number is positive, +0.0 or INFINITY
• -1.0 if the number is negative, -0.0 or NEG_INFINITY
• NAN if the number is NAN

pub fn copysign(self, rhs: Self) -> Self

Returns a vector with signs of rhs and the magnitudes of self.

pub fn is_negative_bitmask(self) -> u32

Returns a bitmask with the lowest 2 bits set to the sign bits from the elements of self.

A negative element results in a 1 bit and a positive element in a 0 bit. Element x goes into the first lowest bit, element y into the second, etc.

pub fn is_finite(self) -> bool

Returns true if, and only if, all elements are finite. If any element is either NaN, positive or negative infinity, this will return false.

pub fn is_nan(self) -> bool

Returns true if any elements are NaN.

pub fn is_nan_mask(self) -> BVec2

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

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

pub fn length(self) -> f32

Computes the length of self.

pub fn length_squared(self) -> f32

Computes the squared length of self.

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

pub fn length_recip(self) -> f32

Computes 1.0 / length().

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

pub fn distance(self, rhs: Self) -> f32

Computes the Euclidean distance between two points in space.

pub fn distance_squared(self, rhs: Self) -> f32

Compute the squared euclidean distance between two points in space.

pub fn div_euclid(self, rhs: Self) -> Self

Returns the element-wise quotient of [Euclidean division] of self by rhs.

pub fn rem_euclid(self, rhs: Self) -> Self

Returns the element-wise remainder of Euclidean division of self by rhs.

pub fn normalize(self) -> Self

Returns self normalized to length 1.0.

For valid results, self must not be of length zero, nor very close to zero.

See also Self::try_normalize() and Self::normalize_or_zero().

Panics

Will panic if self is zero length when glam_assert is enabled.

pub fn try_normalize(self) -> Option<Self>

Returns self normalized to length 1.0 if possible, else returns None.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be None.

See also Self::normalize_or_zero().

pub fn normalize_or(self, fallback: Self) -> Self

Returns self normalized to length 1.0 if possible, else returns a fallback value.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be the fallback value.

See also Self::try_normalize().

pub fn normalize_or_zero(self) -> Self

Returns self normalized to length 1.0 if possible, else returns zero.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be zero.

See also Self::try_normalize().

pub fn is_normalized(self) -> bool

Returns whether self is length 1.0 or not.

Uses a precision threshold of approximately 1e-4.

pub fn project_onto(self, rhs: Self) -> Self

Returns the vector projection of self onto rhs.

rhs must be of non-zero length.

Panics

Will panic if rhs is zero length when glam_assert is enabled.

pub fn reject_from(self, rhs: Self) -> Self

Returns the vector rejection of self from rhs.

The vector rejection is the vector perpendicular to the projection of self onto rhs, in rhs words the result of self - self.project_onto(rhs).

rhs must be of non-zero length.

Panics

Will panic if rhs has a length of zero when glam_assert is enabled.

pub fn project_onto_normalized(self, rhs: Self) -> Self

Returns the vector projection of self onto rhs.

rhs must be normalized.

Panics

Will panic if rhs is not normalized when glam_assert is enabled.

pub fn reject_from_normalized(self, rhs: Self) -> Self

Returns the vector rejection of self from rhs.

The vector rejection is the vector perpendicular to the projection of self onto rhs, in rhs words the result of self - self.project_onto(rhs).

rhs must be normalized.

Panics

Will panic if rhs is not normalized when glam_assert is enabled.

pub fn round(self) -> Self

Returns a vector 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

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

pub fn ceil(self) -> Self

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

pub fn trunc(self) -> Self

Returns a vector containing the integer part each element of self. This means numbers are always truncated towards zero.

pub fn fract(self) -> Self

Returns a vector containing the fractional part of the vector as self - self.trunc().

Note that this differs from the GLSL implementation of fract which returns self - self.floor().

Note that this is fast but not precise for large numbers.

pub fn fract_gl(self) -> Self

Returns a vector containing the fractional part of the vector as self - self.floor().

Note that this differs from the Rust implementation of fract which returns self - self.trunc().

Note that this is fast but not precise for large numbers.

pub fn exp(self) -> Self

Returns a vector containing e^self (the exponential function) for each element of self.

pub fn powf(self, n: f32) -> Self

Returns a vector containing each element of self raised to the power of n.

pub fn recip(self) -> Self

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

pub fn lerp(self, rhs: Self, s: f32) -> Self

Performs a linear interpolation between self and rhs 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 rhs. When s is outside of range [0, 1], the result is linearly extrapolated.

pub fn move_towards(&self, rhs: Self, d: f32) -> Self

Moves towards rhs based on the value d.

When d is 0.0, the result will be equal to self. When d is equal to self.distance(rhs), the result will be equal to rhs. Will not go past rhs.

pub fn midpoint(self, rhs: Self) -> Self

Calculates the midpoint between self and rhs.

The midpoint is the average of, or halfway point between, two vectors. a.midpoint(b) should yield the same result as a.lerp(b, 0.5) while being slightly cheaper to compute.

pub fn abs_diff_eq(self, rhs: Self, max_abs_diff: f32) -> bool

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

This can be used to compare if two vectors 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 see comparing floating point numbers.

pub fn clamp_length(self, min: f32, max: f32) -> Self

Returns a vector with a length no less than min and no more than max

Panics

Will panic if min is greater than max when glam_assert is enabled.

pub fn clamp_length_max(self, max: f32) -> Self

Returns a vector with a length no more than max

pub fn clamp_length_min(self, min: f32) -> Self

Returns a vector with a length no less than min

pub fn mul_add(self, a: Self, b: Self) -> Self

Fused multiply-add. Computes (self * a) + b element-wise with only one rounding error, yielding a more accurate result than an unfused multiply-add.

Using mul_add may be more performant than an unfused multiply-add if the target architecture has a dedicated fma CPU instruction. However, this is not always true, and will be heavily dependant on designing algorithms with specific target hardware in mind.

pub fn from_angle(angle: f32) -> Self

Creates a 2D vector containing [angle.cos(), angle.sin()]. This can be used in conjunction with the rotate() method, e.g. Vec2::from_angle(PI).rotate(Vec2::Y) will create the vector [-1, 0] and rotate Vec2::Y around it returning -Vec2::Y.

pub fn to_angle(self) -> f32

Returns the angle (in radians) of this vector in the range [-π, +π].

The input does not need to be a unit vector however it must be non-zero.

pub fn angle_between(self, rhs: Self) -> f32

Returns the angle (in radians) between self and rhs in the range [-π, +π].

The inputs do not need to be unit vectors however they must be non-zero.

pub fn perp(self) -> Self

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

pub fn perp_dot(self, rhs: Self) -> f32

The perpendicular dot product of self and rhs. Also known as the wedge product, 2D cross product, and determinant.

pub fn rotate(self, rhs: Self) -> Self

Returns rhs rotated by the angle of self. If self is normalized, then this just rotation. This is what you usually want. Otherwise, it will be like a rotation with a multiplication by self’s length.

pub fn as_dvec2(&self) -> DVec2

Casts all elements of self to f64.

pub fn as_i16vec2(&self) -> I16Vec2

Casts all elements of self to i16.

pub fn as_u16vec2(&self) -> U16Vec2

Casts all elements of self to u16.

pub fn as_ivec2(&self) -> IVec2

Casts all elements of self to i32.

pub fn as_uvec2(&self) -> UVec2

Casts all elements of self to u32.

pub fn as_i64vec2(&self) -> I64Vec2

Casts all elements of self to i64.

pub fn as_u64vec2(&self) -> U64Vec2

Casts all elements of self to u64.

Trait Implementations

impl Add<Vec2> for f32

type Output = Vec2

The resulting type after applying the + operator.

fn add(self, rhs: Vec2) -> Vec2

Performs the + operation.

impl Add<f32> for Vec2

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Vec2

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<f32> for Vec2

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl AddAssign for Vec2

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AsMut<[f32; 2]> for Vec2

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

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

impl AsRef<[f32; 2]> for Vec2

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

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

impl Clone for Vec2

fn clone(&self) -> Vec2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Default for Vec2

fn default() -> Self

Returns the “default value” for a type.

impl Display for Vec2

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

Formats the value using the given formatter.

impl Div<Vec2> for f32

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: Vec2) -> Vec2

Performs the / operation.

impl Div<f32> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self

Performs the / operation.

impl Div for Vec2

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vec2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl DivAssign for Vec2

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<[f32; 2]> for Vec2

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

Converts to this type from the input type.

impl From<(f32, f32)> for Vec2

fn from(t: (f32, f32)) -> Self

Converts to this type from the input type.

impl From<BVec2> for Vec2

fn from(v: BVec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for [f32; 2]

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for (f32, f32)

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for DVec2

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl Index<usize> for Vec2

type Output = f32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec2

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

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

impl Mul<Vec2> for Mat2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for f32

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Vec2

Performs the * operation.

impl Mul<f32> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Vec2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign for Vec2

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Vec2

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

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

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.

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

fn product<I>(iter: I) -> Self

where I: Iterator<Item = &'a Self>,

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

impl Product for Vec2

fn product<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

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

impl Rem<Vec2> for f32

type Output = Vec2

The resulting type after applying the % operator.

fn rem(self, rhs: Vec2) -> Vec2

Performs the % operation.

impl Rem<f32> for Vec2

type Output = Vec2

The resulting type after applying the % operator.

fn rem(self, rhs: f32) -> Self

Performs the % operation.

impl Rem for Vec2

type Output = Vec2

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<f32> for Vec2

fn rem_assign(&mut self, rhs: f32)

Performs the %= operation.

impl RemAssign for Vec2

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub<Vec2> for f32

type Output = Vec2

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2) -> Vec2

Performs the - operation.

impl Sub<f32> for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> Self

Performs the - operation.

impl Sub for Vec2

type Output = Vec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<f32> for Vec2

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl SubAssign for Vec2

fn sub_assign(&mut self, rhs: Vec2)

Performs the -= operation.

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

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = &'a Self>,

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

impl Sum for Vec2

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

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

impl Vec2Swizzles for Vec2

type Vec3 = Vec3

type Vec4 = Vec4

fn xx(self) -> Vec2

fn xy(self) -> Vec2

fn yx(self) -> Vec2

fn yy(self) -> Vec2

fn xxx(self) -> Vec3

fn xxy(self) -> Vec3

fn xyx(self) -> Vec3

fn xyy(self) -> Vec3

fn yxx(self) -> Vec3

fn yxy(self) -> Vec3

fn yyx(self) -> Vec3

fn yyy(self) -> Vec3

fn xxxx(self) -> Vec4

fn xxxy(self) -> Vec4

fn xxyx(self) -> Vec4

fn xxyy(self) -> Vec4

fn xyxx(self) -> Vec4

fn xyxy(self) -> Vec4

fn xyyx(self) -> Vec4

fn xyyy(self) -> Vec4

fn yxxx(self) -> Vec4

fn yxxy(self) -> Vec4

fn yxyx(self) -> Vec4

fn yxyy(self) -> Vec4

fn yyxx(self) -> Vec4

fn yyxy(self) -> Vec4

fn yyyx(self) -> Vec4

fn yyyy(self) -> Vec4

impl Copy for Vec2

impl StructuralPartialEq for Vec2