Struct ark_api::Vec2

#[repr(transparent)]
pub struct Vec2(_);

A 2-dimensional vector.

Implementations

impl Vec2

pub const ZERO: Vec2 = Self(XYF32::ZERO)

All zeroes.

pub const ONE: Vec2 = Self(XYF32::ONE)

All ones.

pub const X: Vec2 = Self(XYF32::X)

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

pub const Y: Vec2 = Self(XYF32::Y)

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

pub const AXES: [Vec2; 2] = [Self::X, Self::Y]

The unit axes.

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

Creates a new vector.

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

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

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

[x, y]

pub fn splat(v: f32) -> Vec2

Creates a vector with all elements set to v.

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

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 fn dot(self, other: Vec2) -> f32

Computes the dot product of self and other.

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

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

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

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

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

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

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

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 cmpeq(self, other: Vec2) -> BVec2

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

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

pub fn cmpne(self, other: Vec2) -> BVec2

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

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

pub fn cmpge(self, other: Vec2) -> BVec2

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

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

pub fn cmpgt(self, other: Vec2) -> BVec2

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

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

pub fn cmple(self, other: Vec2) -> BVec2

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

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

pub fn cmplt(self, other: Vec2) -> BVec2

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

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

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

Creates a vector from the first N values in slice.

Panics

Panics if slice is less than N elements long.

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

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

Panics

Panics if slice is less than N elements long.

pub fn abs(self) -> Vec2

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

pub fn signum(self) -> Vec2

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 perp(self) -> Vec2

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

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

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

pub const NAN: Vec2 = Self(<XYF32 as crate::core::traits::scalar::NanConstEx>::NAN)

All NAN.

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, other: Vec2) -> f32

Computes the Euclidean distance between two points in space.

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

Compute the squared euclidean distance between two points in space.

pub fn normalize(self) -> Vec2

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<Vec2>

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_zero(self) -> Vec2

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 1e-6.

pub fn project_onto(self, other: Vec2) -> Vec2

Returns the vector projection of self onto other.

other must be of non-zero length.

Panics

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

pub fn reject_from(self, other: Vec2) -> Vec2

Returns the vector rejection of self from other.

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

other must be of non-zero length.

Panics

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

pub fn project_onto_normalized(self, other: Vec2) -> Vec2

Returns the vector projection of self onto other.

other must be normalized.

Panics

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

pub fn reject_from_normalized(self, other: Vec2) -> Vec2

Returns the vector rejection of self from other.

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

other must be normalized.

Panics

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

pub fn round(self) -> Vec2

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) -> Vec2

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

pub fn ceil(self) -> Vec2

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

pub fn fract(self) -> Vec2

Returns a vector containing the fractional part of the vector, e.g. self - self.floor().

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

pub fn exp(self) -> Vec2

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

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

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

pub fn recip(self) -> Vec2

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

pub fn lerp(self, other: Vec2, s: f32) -> Vec2

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. When s is outside of range [0,1], the result is linearly extrapolated.

pub fn abs_diff_eq(self, other: Vec2, max_abs_diff: f32) -> bool

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 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) -> Vec2

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) -> Vec2

Returns a vector with a length no more than max

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

Returns a vector with a length no less than min

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

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 angle_between(self, other: Vec2) -> f32

Returns the angle (in radians) between self and other.

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

pub fn as_dvec2(&self) -> DVec2

Casts all elements of self to f64.

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.

Trait Implementations

impl Add<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f32> for Vec2

type Output = Vec2

The resulting type after applying the + operator.

fn add(self, other: f32) -> Vec2

Performs the + operation.

impl AddAssign<Vec2> for Vec2

fn add_assign(&mut self, other: Vec2)

Performs the += operation.

impl AddAssign<f32> for Vec2

fn add_assign(&mut self, other: f32)

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<(), Error>

Formats the value using the given formatter.

impl Default for Vec2

fn default() -> Vec2

Returns the “default value” for a type.

impl Deref for Vec2

type Target = XY<f32>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Vec2

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

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Vec2

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

Deserialize this value from the given Serde deserializer.

impl Display for Vec2

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

Formats the value using the given formatter.

impl Div<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, other: f32) -> Vec2

Performs the / operation.

impl DivAssign<Vec2> for Vec2

fn div_assign(&mut self, other: Vec2)

Performs the /= operation.

impl DivAssign<f32> for Vec2

fn div_assign(&mut self, other: f32)

Performs the /= operation.

impl From<[f32; 2]> for Vec2

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

Converts to this type from the input type.

impl From<(f32, f32)> for Vec2

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

Converts to this type from the input type.

impl From<Vec2> for XY<f32>

fn from(t: Vec2) -> XY<f32>

Converts to this type from the input type.

impl From<XY<f32>> for Vec2

fn from(t: XY<f32>) -> Vec2

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) -> &<Vec2 as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec2

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

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

impl Mul<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, other: f32) -> Vec2

Performs the * operation.

impl MulAssign<Vec2> for Vec2

fn mul_assign(&mut self, other: Vec2)

Performs the *= operation.

impl MulAssign<f32> for Vec2

fn mul_assign(&mut self, other: f32)

Performs the *= operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Vec2

Performs the unary - operation.

impl PartialEq<Vec2> 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) -> Vec2 where
    I: Iterator<Item = &'a Vec2>, 

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

impl<'a, C> Readable<'a, C> for Vec2 where
    C: Context, 

fn read_from<R>(reader: &mut R) -> Result<Vec2, <C as Context>::Error> where
    R: Reader<'a, C>, 

fn minimum_bytes_needed() -> usize

fn read_from_buffer_with_ctx(
    context: C,
    buffer: &'a [u8]
) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_with_ctx(
    context: C,
    buffer: &'a [u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_buffer_copying_data_with_ctx(
    context: C,
    buffer: &[u8]
) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_copying_data_with_ctx(
    context: C,
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_with_length_from_buffer_copying_data_with_ctx_mut(
    context: &mut C,
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_stream_unbuffered_with_ctx<S>(
    context: C,
    stream: S
) -> Result<Self, <C as Context>::Error> where
    S: Read, 

fn read_from_stream_buffered_with_ctx<S>(
    context: C,
    stream: S
) -> Result<Self, <C as Context>::Error> where
    S: Read, 

fn read_from_file_with_ctx(
    context: C,
    path: impl AsRef<Path>
) -> Result<Self, <C as Context>::Error>

impl Rem<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<f32> for Vec2

type Output = Vec2

The resulting type after applying the % operator.

fn rem(self, other: f32) -> Vec2

Performs the % operation.

impl RemAssign<Vec2> for Vec2

fn rem_assign(&mut self, other: Vec2)

Performs the %= operation.

impl RemAssign<f32> for Vec2

fn rem_assign(&mut self, other: f32)

Performs the %= operation.

impl Serialize for Vec2

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

Serialize this value into the given Serde serializer.

impl Sub<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f32> for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn sub(self, other: f32) -> Vec2

Performs the - operation.

impl SubAssign<Vec2> for Vec2

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation.

impl SubAssign<f32> for Vec2

fn sub_assign(&mut self, other: f32)

Performs the -= operation.

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

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

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

impl ValueConverterTrait<Vec2> for ValueConverter

fn into_value(v: Vec2) -> Value

Wraps the passed-in value in a Value enum.

fn from_value(v: &Value) -> Vec2

Extracts the value from a Value enum.

impl Vec2Ext for Vec2

fn trunc(self) -> Vec2

For element i of self, return v[i].trunc()

fn from_angle(angle: f32) -> Vec2

x: cos(angle), y: sin(angle) (in radians)

fn angle(&self) -> f32

Angle of the vector: y.atan2(x)

fn step(self, value: Vec2) -> Vec2

For element i of the return value, returns 0.0 if value[i] < self[i] and 1.0 otherwise.

fn step_select(self, value: Vec2, less: Vec2, greater_or_equal: Vec2) -> Vec2

Selects between true and false based on the result of value[i] < self[i]

fn fract(self) -> Vec2

Return only the fractional parts of each component.

fn saturate(self) -> Vec2

Clamp all components of self to the range [0.0, 1.0]

impl Vec2Swizzles for Vec2

type Vec3 = Vec3

type Vec4 = Vec4

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

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 xx(self) -> Vec2

fn yx(self) -> Vec2

fn yy(self) -> Vec2

fn xy(self) -> Self

impl<C> Writable<C> for Vec2 where
    C: Context, 

fn write_to<T>(&self, writer: &mut T) -> Result<(), <C as Context>::Error> where
    T: Writer<C> + ?Sized, 

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

fn write_to_buffer_with_ctx(
    &self,
    context: C,
    buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>

fn write_to_buffer_with_ctx_mut(
    &self,
    context: &mut C,
    buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>

fn write_to_vec_with_ctx(
    &self,
    context: C
) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_vec_with_ctx_mut(
    &self,
    context: &mut C
) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_stream_with_ctx<S>(
    &self,
    context: C,
    stream: S
) -> Result<(), <C as Context>::Error> where
    S: Write, 

fn write_to_file_with_ctx(
    &self,
    context: C,
    path: impl AsRef<Path>
) -> Result<(), <C as Context>::Error>

impl Copy for Vec2