Struct graphene::Vec2

#[repr(transparent)]
pub struct Vec2 { /* private fields */ }

A structure capable of holding a vector with two dimensions, x and y.

The contents of the Vec2 structure are private and should never be accessed directly.

Implementations

impl Vec2

pub fn add(&self, b: &Vec2) -> Vec2

Adds each component of the two passed vectors and places each result into the components of res.

b

a Vec2

Returns

res

return location for the result

pub fn divide(&self, b: &Vec2) -> Vec2

Divides each component of the first operand self by the corresponding component of the second operand b, and places the results into the vector res.

b

a Vec2

Returns

res

return location for the result

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

Computes the dot product of the two given vectors.

b

a Vec2

Returns

the dot product of the vectors

pub fn x(&self) -> f32

Retrieves the X component of the Vec2.

Returns

the value of the X component

pub fn y(&self) -> f32

Retrieves the Y component of the Vec2.

Returns

the value of the Y component

pub fn interpolate(&self, v2: &Vec2, factor: f64) -> Vec2

Linearly interpolates self and v2 using the given factor.

v2

a Vec2

factor

the interpolation factor

Returns

res

the interpolated vector

pub fn length(&self) -> f32

Computes the length of the given vector.

Returns

the length of the vector

pub fn max(&self, b: &Vec2) -> Vec2

Compares the two given vectors and places the maximum values of each component into res.

b

a Vec2

Returns

res

the resulting vector

pub fn min(&self, b: &Vec2) -> Vec2

Compares the two given vectors and places the minimum values of each component into res.

b

a Vec2

Returns

res

the resulting vector

pub fn multiply(&self, b: &Vec2) -> Vec2

Multiplies each component of the two passed vectors and places each result into the components of res.

b

a Vec2

Returns

res

return location for the result

pub fn near(&self, v2: &Vec2, epsilon: f32) -> bool

Compares the two given Vec2 vectors and checks whether their values are within the given epsilon.

v2

a Vec2

epsilon

the threshold between the two vectors

Returns

true if the two vectors are near each other

pub fn negate(&self) -> Vec2

Negates the given Vec2.

Returns

res

return location for the result vector

pub fn normalize(&self) -> Vec2

Computes the normalized vector for the given vector self.

Returns

res

return location for the normalized vector

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

Multiplies all components of the given vector with the given scalar factor.

factor

the scalar factor

Returns

res

return location for the result vector

pub fn subtract(&self, b: &Vec2) -> Vec2

Subtracts from each component of the first operand self the corresponding component of the second operand b and places each result into the components of res.

b

a Vec2

Returns

res

return location for the result

pub fn one() -> Vec2

Retrieves a constant vector with (1, 1) components.

Returns

the one vector

pub fn x_axis() -> Vec2

Retrieves a constant vector with (1, 0) components.

Returns

the X axis vector

pub fn y_axis() -> Vec2

Retrieves a constant vector with (0, 1) components.

Returns

the Y axis vector

pub fn zero() -> Vec2

Retrieves a constant vector with (0, 0) components.

Returns

the zero vector

impl Vec2

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

Initializes a Vec2 using the given values.

This function can be called multiple times.

x

the X field of the vector

y

the Y field of the vector

Returns

the initialized vector

pub fn from_float(src: [f32; 2]) -> Self

Initializes self with the contents of the given array.

src

an array of floating point values with at least two elements

Returns

the initialized vector

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

Stores the components of self into an array.

Returns

dest

return location for an array of floating point values with at least 2 elements

Trait Implementations

impl Clone for Vec2

fn clone(&self) -> Self

Returns a copy 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 PartialEq<Vec2> for Vec2

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StaticType for Vec2

fn static_type() -> Type

Returns the type identifier of Self.

impl Copy for Vec2

impl Eq for Vec2