Struct Vec2 

pub struct Vec2 {
    pub x: f32,
    pub y: f32,
}

a vector made from a x and y coordinate.

Fields

x: f32

y: f32

Implementations

impl Vec2

pub const ZERO: Self

a zero vector

pub const ONE: Self

a vector full of ones

pub const X: Self

the x axis

pub const Y: Self

the y axis

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

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

pub const fn truncate(self) -> f32

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

create a vector where x and y equals value.

pub fn length_squared(self) -> f32

the length of the vector before being square rooted.

pub fn length(self) -> f32

length of the vector.

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

distance between two vectors before being square rooted.

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

distance between two vectors.

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

get the dot product of 2 vectors. equal to the cosign of the angle between vectors.

pub fn scale(self, scalar: f32) -> Vec2

multiplies each value by the scalar.

pub fn normalise(self) -> Self

makes the length of the vector equal to 1. on fail returns vec2 of zeros

pub fn transform(self, matrix: Mat2) -> Vec2

transforms vector by the matrix

pub fn eq(self, rhs: Self) -> BVec2

returns whether the 2 components are equal

pub fn less(self, rhs: Self) -> BVec2

returns whether the 1st components are less than the 2nd

pub fn more(self, rhs: Self) -> BVec2

returns whether the 1st components are more than the 2nd

pub fn less_or_eq(self, rhs: Self) -> BVec2

returns whether the 1st components are less than or equal to the 2nd

pub fn more_or_eq(self, rhs: Self) -> BVec2

returns whether the 1st components are more than or equal to the 2nd

Trait Implementations

impl Add for Vec2

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vec2

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AsUniformValue for Vec2

fn as_uniform_value(&self) -> UniformValue<'_>

Builds a UniformValue.

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 Div<Vec2> for f32

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Vec2

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vec2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl DivAssign for Vec2

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<[f32; 2]> for Vec2

fn from(value: [f32; 2]) -> Self

Converts to this type from the input type.

impl From<(f32, f32)> for Vec2

fn from(value: (f32, f32)) -> Self

Converts to this type from the input type.

impl From<Vec2> for [f32; 2]

fn from(value: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for (f32, f32)

fn from(value: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for DIVec2

fn from(value: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for DUVec2

fn from(value: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for DVec2

fn from(value: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for IVec2

fn from(value: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for TextureCoords

fn from(value: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for UVec2

fn from(value: Vec2) -> Self

Converts to this type from the input type.

impl Mul<Vec2> for Mat2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for f32

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Vec2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign for Vec2

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Rem<Vec2> for f32

type Output = Vec2

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<f32> for Vec2

type Output = Vec2

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem for Vec2

type Output = Vec2

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<f32> for Vec2

fn rem_assign(&mut self, rhs: f32)

Performs the %= operation.

impl RemAssign for Vec2

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub for Vec2

type Output = Vec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Vec2

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Vec2

impl StructuralPartialEq for Vec2