Struct graphene::Vec4

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

A structure capable of holding a vector with four dimensions: x, y, z, and w.

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

Implementations

impl Vec4

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

Adds each component of the two given vectors.

b

a Vec4

Returns

res

return location for the resulting vector

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

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 Vec4

Returns

res

return location for the resulting vector

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

Computes the dot product of the two given vectors.

b

a Vec4

Returns

the value of the dot product

pub fn w(&self) -> f32

Retrieves the value of the fourth component of the given Vec4.

Returns

the value of the fourth component

pub fn x(&self) -> f32

Retrieves the value of the first component of the given Vec4.

Returns

the value of the first component

pub fn xy(&self) -> Vec2

Creates a Vec2 that contains the first two components of the given Vec4.

Returns

res

return location for a Vec2

pub fn xyz(&self) -> Vec3

Creates a Vec3 that contains the first three components of the given Vec4.

Returns

res

return location for a graphene_vec3_t

pub fn y(&self) -> f32

Retrieves the value of the second component of the given Vec4.

Returns

the value of the second component

pub fn z(&self) -> f32

Retrieves the value of the third component of the given Vec4.

Returns

the value of the third component

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

Linearly interpolates self and v2 using the given factor.

v2

a Vec4

factor

the interpolation factor

Returns

res

the interpolated vector

pub fn length(&self) -> f32

Computes the length of the given Vec4.

Returns

the length of the vector

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

Compares each component of the two given vectors and creates a vector that contains the maximum values.

b

a Vec4

Returns

res

return location for the result vector

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

Compares each component of the two given vectors and creates a vector that contains the minimum values.

b

a Vec4

Returns

res

return location for the result vector

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

Multiplies each component of the two given vectors.

b

a Vec4

Returns

res

return location for the resulting vector

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

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

v2

a Vec4

epsilon

the threshold between the two vectors

Returns

true if the two vectors are near each other

pub fn negate(&self) -> Vec4

Negates the given Vec4.

Returns

res

return location for the result vector

pub fn normalize(&self) -> Vec4

Normalizes the given Vec4.

Returns

res

return location for the normalized vector

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

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: &Vec4) -> Vec4

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 Vec4

Returns

res

return location for the resulting vector

pub fn one() -> Vec4

Retrieves a pointer to a Vec4 with all its components set to 1.

Returns

a constant vector

pub fn w_axis() -> Vec4

Retrieves a pointer to a Vec4 with its components set to (0, 0, 0, 1).

Returns

a constant vector

pub fn x_axis() -> Vec4

Retrieves a pointer to a Vec4 with its components set to (1, 0, 0, 0).

Returns

a constant vector

pub fn y_axis() -> Vec4

Retrieves a pointer to a Vec4 with its components set to (0, 1, 0, 0).

Returns

a constant vector

pub fn z_axis() -> Vec4

Retrieves a pointer to a Vec4 with its components set to (0, 0, 1, 0).

Returns

a constant vector

pub fn zero() -> Vec4

Retrieves a pointer to a Vec4 with all its components set to 0.

Returns

a constant vector

impl Vec4

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

Initializes a Vec4 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

z

the Z field of the vector

w

the W field of the vector

Returns

a pointer to the initialized vector

pub fn from_vec2(src: &Vec2, z: f32, w: f32) -> Self

Initializes a Vec4 using the components of a Vec2 and the values of z and w.

src

a Vec2

z

the value for the third component of self

w

the value for the fourth component of self

Returns

the initialized vector

pub fn from_vec3(src: &Vec3, w: f32) -> Self

Initializes a Vec4 using the components of a Vec3 and the value of w.

src

a Vec3

w

the value for the fourth component of self

Returns

the initialized vector

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

Initializes a Vec4 with the values inside the given array.

src

an array of four floating point values

Returns

the initialized vector

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

Stores the components of the given Vec4 into an array of floating point values.

Returns

dest

return location for an array of floating point values

Trait Implementations

impl Clone for Vec4

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 Vec4

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

Formats the value using the given formatter.

impl PartialEq<Vec4> for Vec4

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 Vec4

fn static_type() -> Type

Returns the type identifier of Self.

impl Copy for Vec4

impl Eq for Vec4