Struct Vec2

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

A 2-dimensional vector with f32 components.

Fields

x: f32

The x component of the vector.

y: f32

The y component of the vector.

Implementations

impl Vec2

pub const ZERO: Self

A vector with all components set to 0.0.

pub const ONE: Self

A vector with all components set to 1.0.

pub const X: Self

The unit vector pointing along the positive X-axis.

pub const Y: Self

The unit vector pointing along the positive Y-axis.

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

Creates a new Vec2 with the specified components.

pub const fn abs(self) -> Self

Returns a new vector with the absolute value of each component.

pub fn length_squared(&self) -> f32

Calculates the squared length (magnitude) of the vector. This is faster than length() as it avoids a square root.

pub fn length(&self) -> f32

Calculates the length (magnitude) of the vector.

pub fn normalize(&self) -> Self

Returns a normalized version of the vector with a length of 1. If the vector’s length is near zero, it returns Vec2::ZERO.

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

Calculates the dot product of this vector and another.

pub fn lerp(start: Self, end: Self, t: f32) -> Self

Performs a linear interpolation between two vectors. The interpolation factor t is clamped to the [0.0, 1.0] range.

Trait Implementations

impl Add for Vec2

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

Adds two vectors component-wise.

type Output = Vec2

The resulting type after applying the + operator.

impl Clone for Vec2

fn clone(&self) -> Vec2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Default for Vec2

fn default() -> Vec2

Returns the “default value” for a type.

impl Div<f32> for Vec2

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

Divides the vector by a scalar.

type Output = Vec2

The resulting type after applying the / operator.

impl Index<usize> for Vec2

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

Allows accessing a vector component by index (v[0], v[1]).

Panics

Panics if index is not 0 or 1.

type Output = f32

The returned type after indexing.

impl IndexMut<usize> for Vec2

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

Allows mutably accessing a vector component by index (v[0] = ...).

Panics

Panics if index is not 0 or 1.

impl Mul<Vec2> for f32

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

Multiplies a scalar by a vector.

type Output = Vec2

The resulting type after applying the * operator.

impl Mul<f32> for Vec2

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

Multiplies the vector by a scalar.

type Output = Vec2

The resulting type after applying the * operator.

impl Mul for Vec2

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

Multiplies two vectors component-wise.

type Output = Vec2

The resulting type after applying the * operator.

impl Neg for Vec2

fn neg(self) -> Self::Output

Negates the vector.

type Output = Vec2

The resulting type after applying the - operator.

impl PartialEq for Vec2

fn eq(&self, other: &Vec2) -> 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 for Vec2

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

Subtracts two vectors component-wise.

type Output = Vec2

The resulting type after applying the - operator.

impl Copy for Vec2

impl StructuralPartialEq for Vec2