Struct hektor::Vec2

#[repr(C)]
pub struct Vec2 { /* fields omitted */ }

A 2-dimensional vector.

This is two f32 values, x and y.

Methods

impl Vec2

Accessors

pub fn x(self) -> f32

Gets the x component of this vector.

pub fn y(self) -> f32

Gets the y component of this vector.

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

&mut to the x component of this vector.

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

&mut to the y component of this vector.

impl Vec2

Constructors

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

Makes a new Vec2

pub fn splat(v: f32) -> Self

Splats the given value across all components.

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

Extends this 2d vec into a 3d vec with the z given.

impl Vec2

Operations

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

Dot product.

This is the sum of the component-wise multiplication of the two values. Order doesn't matter. Positive dot product means the vectors are pointing in the same general direction, zero dot product means they're perpendicular, and negative dot product means they have opposite general direction.

pub fn length(self) -> f32

The length / magnitude of the vector.

• sqrt(x^2 + y^2)

pub fn length2(self) -> f32

The squared length / magnitude of the vector.

• x^2 + y^2 + z^2

pub fn normalize(self) -> Self

Generates a new vector where the length is 1.0

Or, well, as close as it can get. Floating point, and all that.

impl Vec2

pub fn xx(self) -> Self

Swizzle: obtains the xx combination

pub fn xy(self) -> Self

Swizzle: obtains the xy combination

pub fn yx(self) -> Self

Swizzle: obtains the yx combination

pub fn yy(self) -> Self

Swizzle: obtains the yy combination

Trait Implementations

impl Display for Vec2

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

Display formats without labels like a 2-tuple.

Passes the formatter along to the fields, so you can use any normal f32 Display format arguments that you like.

impl Debug for Vec2

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

Passes the formatter along to the fields, so you can use any normal f32 Debug format arguments that you like.

impl UpperExp for Vec2

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

UpperExp formats like Display, but with the upper exponent.

Passes the formatter along to the fields, so you can use any normal f32 UpperExp format arguments that you like.

impl LowerExp for Vec2

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

LowerExp formats like Display, but with the lower exponent.

Passes the formatter along to the fields, so you can use any normal f32 LowerExp format arguments that you like.

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: &Vec2) -> bool

This method tests for !=.

impl Add<Vec2> for Vec2

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f32> for Vec2

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vec2> for f32

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<Vec2> for Vec2

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f32> for Vec2

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vec2> for f32

type Output = Vec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl Mul<f32> for Vec2

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for f32

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for Vec2

type Output = Self

The resulting type after applying the * operator.

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

Non-mathematical component-wise multiplication (GLSL-style)

impl Mul<Vec2> for Mat2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Vec2

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl AddAssign<Vec2> for Vec2

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AddAssign<f32> for Vec2

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl SubAssign<Vec2> for Vec2

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl SubAssign<f32> for Vec2

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl MulAssign<f32> for Vec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign<Vec2> for Vec2

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Index<usize> for Vec2

type Output = f32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec2

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

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

impl Copy for Vec2

impl AsRef<[f32; 2]> for Vec2

fn as_ref(&self) -> &[f32; 2]

Performs the conversion.

impl AsMut<[f32; 2]> for Vec2

fn as_mut(&mut self) -> &mut [f32; 2]

Performs the conversion.

impl From<[f32; 2]> for Vec2

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

Performs the conversion.

impl From<Vec2> for [f32; 2]

fn from(Vec2 { x: x, y: y }: Vec2) -> Self

Performs the conversion.

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

fn default() -> Vec2

Returns the "default value" for a type.

impl Pod for Vec2

impl Zeroable for Vec2

fn zeroed() -> Self

Calls zeroed.