Struct oxid::framework::math::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 fn is_nan(self) -> Vec2Mask

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

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

Returns a Vec2 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.

pub fn is_normalized(self) -> bool

Returns whether self is length 1.0 or not.

Uses a precision threshold of 1e-6.

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

Creates a new Vec2.

pub const fn zero() -> Vec2

Creates a Vec2 with all elements set to 0.0.

pub const fn one() -> Vec2

Creates a Vec2 with all elements set to 1.0.

pub const fn unit_x() -> Vec2

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

pub const fn unit_y() -> Vec2

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

pub fn splat(v: f32) -> Vec2

Creates a Vec2 with all elements set to v.

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

Creates a Vec3 from self and the given z value.

pub fn x(self) -> f32

👎Deprecated since 0.10.0:

please use .x instead

pub fn y(self) -> f32

👎Deprecated since 0.10.0:

please use .y instead

pub fn x_mut(&mut self) -> &mut f32

👎Deprecated since 0.10.0:

please use .x instead

pub fn y_mut(&mut self) -> &mut f32

👎Deprecated since 0.10.0:

please use .y instead

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

👎Deprecated since 0.10.0:

please use .x instead

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

👎Deprecated since 0.10.0:

please use .y instead

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

Computes the dot product of self and other.

pub fn length(self) -> f32

Computes the length of self.

pub fn length_squared(self) -> f32

Computes the squared length of self.

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

pub fn length_recip(self) -> f32

Computes 1.0 / Vec2::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.

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

Compute the squared Euclidean distance between two points.

pub fn normalize(self) -> Vec2

Returns self normalized to length 1.0.

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

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

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

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

Returns the horizontal minimum of self’s elements.

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

pub fn max_element(self) -> f32

Returns the horizontal maximum of self’s elements.

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

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

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

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

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

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

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

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

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

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

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

pub fn round(self) -> Vec2

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

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

pub fn ceil(self) -> Vec2

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

pub fn perp(self) -> Vec2

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

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

The perpendicular dot product of the vector and other.

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

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

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vec2> for Vec2

fn add_assign(&mut self, other: Vec2)

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

fn from(v: Vec3) -> Vec2

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

impl From<Vec3A> for Vec2

fn from(v: Vec3A) -> Vec2

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

impl From<Vec4> for Vec2

fn from(v: Vec4) -> Vec2

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

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 Mat2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * 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 PartialOrd<Vec2> for Vec2

fn partial_cmp(&self, other: &Vec2) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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

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

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

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

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation.

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

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

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

impl Vec2Swizzles for Vec2

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

impl Copy for Vec2

impl StructuralPartialEq for Vec2