Struct Vector

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

A 2D vector.

Fields

x: f32

The x coordinate.

y: f32

The y coordinate.

Implementations

impl Vector

pub const ZERO: Self = _

The zero vector.

pub const ONE: Self = _

The one vector.

pub const X: Self = _

The unit x vector.

pub const Y: Self = _

The unit y vector.

pub const NEG_X: Self = _

The negative unit x vector.

pub const NEG_Y: Self = _

The negative unit y vector.

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

Create a new vector.

pub const fn all(value: f32) -> Self

Create a new vector with the same x and y.

pub fn from_angle(angle: f32) -> Self

Create a new vector from an angle.

let x = std::f32::consts::FRAC_PI_3;
let v = Vector::from_angle(x);

assert_eq!(v.x, x.cos());
assert_eq!(v.y, x.sin());

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

Get the min of self and other by element.

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

Get the max of self and other by element.

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

Clamp self to the range [min, max] by element.

pub fn floor(self) -> Self

Floor the vector by element.

pub fn ceil(self) -> Self

Ceil the vector by element.

pub fn round(self) -> Self

Round the vector by element.

pub fn signum(self) -> Self

Get the absolute value of the vector.

pub fn length_squared(self) -> f32

Get the length of the vector squared.

pub fn length(self) -> f32

Get the length of the vector.

pub fn normalize(self) -> Self

Normalize the vector.

If the length of the vector is zero, the zero vector is returned.

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

Get the dot product of self and other.

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

Get the length of the cross product of self and other.

pub fn hat(self) -> Self

Hat the vector.

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

Get the angle between self and other.

pub fn angle(self) -> f32

Get the angle of the vector.

pub const fn to_point(self) -> Point

Convert the vector to a vector.

pub const fn to_size(self) -> Size

Convert the vector to a size.

Trait Implementations

impl Add<Vector> for Point

type Output = Point

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vector> for Rect

type Output = Rect

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vector> for Size

type Output = Size

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f32> for Vector

type Output = Vector

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Vector

type Output = Vector

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vector> for Point

fn add_assign(&mut self, rhs: Vector)

Performs the += operation.

impl AddAssign<Vector> for Rect

fn add_assign(&mut self, rhs: Vector)

Performs the += operation.

impl AddAssign<Vector> for Size

fn add_assign(&mut self, rhs: Vector)

Performs the += operation.

impl AddAssign<f32> for Vector

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl AddAssign for Vector

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vector

fn clone(&self) -> Vector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector

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

Formats the value using the given formatter.

impl Default for Vector

fn default() -> Vector

Returns the “default value” for a type.

impl Display for Vector

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

Formats the value using the given formatter.

impl Div<Vector> for Point

type Output = Point

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Vector> for Size

type Output = Size

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Vector

type Output = Vector

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Vector

type Output = Vector

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<Vector> for Point

fn div_assign(&mut self, rhs: Vector)

Performs the /= operation.

impl DivAssign<Vector> for Size

fn div_assign(&mut self, rhs: Vector)

Performs the /= operation.

impl DivAssign<f32> for Vector

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl DivAssign for Vector

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<[f32; 2]> for Vector

fn from([x, y]: [f32; 2]) -> Self

Converts to this type from the input type.

impl From<(f32, f32)> for Vector

fn from((x, y): (f32, f32)) -> Self

Converts to this type from the input type.

impl From<Point> for Vector

fn from(point: Point) -> Self

Converts to this type from the input type.

impl From<Size> for Vector

fn from(size: Size) -> Self

Converts to this type from the input type.

impl From<Vector> for [f32; 2]

fn from(vector: Vector) -> Self

Converts to this type from the input type.

impl From<Vector> for (f32, f32)

fn from(vector: Vector) -> Self

Converts to this type from the input type.

impl From<Vector> for Point

fn from(vec: Vector) -> Self

Converts to this type from the input type.

impl From<Vector> for Size

fn from(vec: Vector) -> Self

Converts to this type from the input type.

impl From<f32> for Vector

fn from(value: f32) -> Self

Converts to this type from the input type.

impl Hash for Vector

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<Vector> for Affine

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector> for Matrix

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, point: Vector) -> Self::Output

Performs the * operation.

impl Mul<Vector> for Point

type Output = Point

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector> for Size

type Output = Size

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vector

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Vector

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Vector> for Point

fn mul_assign(&mut self, rhs: Vector)

Performs the *= operation.

impl MulAssign<Vector> for Size

fn mul_assign(&mut self, rhs: Vector)

Performs the *= operation.

impl MulAssign<f32> for Vector

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign for Vector

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Vector

type Output = Vector

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Vector

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

type Output = Point

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<Vector> for Size

type Output = Size

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<f32> for Vector

type Output = Vector

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem for Vector

type Output = Vector

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<Vector> for Point

fn rem_assign(&mut self, rhs: Vector)

Performs the %= operation.

impl RemAssign<Vector> for Size

fn rem_assign(&mut self, rhs: Vector)

Performs the %= operation.

impl RemAssign<f32> for Vector

fn rem_assign(&mut self, rhs: f32)

Performs the %= operation.

impl RemAssign for Vector

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub<Vector> for Point

type Output = Point

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vector> for Rect

type Output = Rect

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vector> for Size

type Output = Size

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f32> for Vector

type Output = Vector

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Vector

type Output = Vector

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Vector> for Point

fn sub_assign(&mut self, rhs: Vector)

Performs the -= operation.

impl SubAssign<Vector> for Rect

fn sub_assign(&mut self, rhs: Vector)

Performs the -= operation.

impl SubAssign<Vector> for Size

fn sub_assign(&mut self, rhs: Vector)

Performs the -= operation.

impl SubAssign<f32> for Vector

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl SubAssign for Vector

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Vector

impl StructuralPartialEq for Vector