Struct Vector2

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

A vector in 2D space.

Fields

x: f32

y: f32

Implementations

impl Vector2

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

Construct new a vector from individual coordinates

pub const fn from_scalar(s: f32) -> Self

Construct new a vector where each coordinate is the same

pub const fn zero() -> Self

The additive identity

pub const fn one() -> Self

The multiplicative identity

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

Compute the dot product between this vector and another

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

Linear interpolation between this vector and another

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

Compute the element-wise minimum of this vector and another

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

Compute the element-wise maximum of this vector and another

pub fn magnitude_squared(&self) -> f32

The length of this vector squared. Note that this avoids an expensive square root.

pub fn magnitude(&self) -> f32

The length of this vector. Note that this involves an expensive square root.

pub fn normalized(&self) -> Self

Normalize this vector to unit length. Note that this involves an expensive square root.

pub fn as_slice(&self) -> &[f32]

impl Vector2

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

Compute a cross product between this vector and another. This treats both inputs as 3D vectors with a z-component of zero, performs the normal 3D cross product, and returns only the resulting z-component.

Trait Implementations

impl Add<f32> for Vector2

type Output = Vector2

The resulting type after applying the + operator.

fn add(self, t: f32) -> Self::Output

Performs the + operation.

impl Add for Vector2

type Output = Vector2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<f32> for Vector2

fn add_assign(&mut self, t: f32)

Performs the += operation.

impl AddAssign for Vector2

fn add_assign(&mut self, rhs: Vector2)

Performs the += operation.

impl Clone for Vector2

fn clone(&self) -> Vector2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vector2

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

Formats the value using the given formatter.

impl Div<Vector2> for f32

type Output = Vector2

The resulting type after applying the / operator.

fn div(self, t: Vector2) -> Self::Output

Performs the / operation.

impl Div<f32> for Vector2

type Output = Vector2

The resulting type after applying the / operator.

fn div(self, t: f32) -> Self::Output

Performs the / operation.

impl Div for Vector2

type Output = Vector2

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vector2

fn div_assign(&mut self, t: f32)

Performs the /= operation.

impl DivAssign for Vector2

fn div_assign(&mut self, rhs: Vector2)

Performs the /= operation.

impl Index<usize> for Vector2

type Output = f32

The returned type after indexing.

fn index(&self, i: usize) -> &f32

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vector2

fn index_mut(&mut self, i: usize) -> &mut f32

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

impl Mul<Vector2> for f32

type Output = Vector2

The resulting type after applying the * operator.

fn mul(self, t: Vector2) -> Self::Output

Performs the * operation.

impl Mul<f32> for Vector2

type Output = Vector2

The resulting type after applying the * operator.

fn mul(self, t: f32) -> Self::Output

Performs the * operation.

impl Mul for Vector2

type Output = Vector2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vector2

fn mul_assign(&mut self, t: f32)

Performs the *= operation.

impl MulAssign for Vector2

fn mul_assign(&mut self, rhs: Vector2)

Performs the *= operation.

impl NearlyEqual for &Vector2

fn nearly_equals(self, rhs: Self) -> bool

impl Neg for Vector2

type Output = Vector2

The resulting type after applying the - operator.

fn neg(self) -> Vector2

Performs the unary - operation.

impl PartialEq for Vector2

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<f32> for Vector2

type Output = Vector2

The resulting type after applying the - operator.

fn sub(self, t: f32) -> Self::Output

Performs the - operation.

impl Sub for Vector2

type Output = Vector2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<f32> for Vector2

fn sub_assign(&mut self, t: f32)

Performs the -= operation.

impl SubAssign for Vector2

fn sub_assign(&mut self, rhs: Vector2)

Performs the -= operation.

impl Copy for Vector2

impl StructuralPartialEq for Vector2