[][src]Struct glam::f32::Vec3

#[repr(C)]
pub struct Vec3(_);

A 3-dimensional vector.

This type is 16 byte aligned and thus contains 4 bytes padding.

Methods

impl Vec3[src]

pub fn sign(self) -> Self[src]

Returns a new Vec4 with elements representing the sign of self.

  • 1.0 if the number is positive, +0.0 or INFINITY
  • -1.0 if the number is negative, -0.0 or NEG_INFINITY

pub fn reciprocal(self) -> Self[src]

Computes the reciprocal 1.0/n of each element, returning the results in a new Vec3.

pub fn lerp(self, other: Self, s: f32) -> Self[src]

Performs a linear interpolation between self and other based on the value s.

When s is 0.0, the result will be equal to self. When s is 1.0, the result will be equal to other.

pub fn is_normalized(self) -> bool[src]

Returns whether self of length 1.0 or not.

Uses a precision threshold of std::f32::EPSILON.

pub fn abs_diff_eq(self, other: Self, max_abs_diff: f32) -> bool[src]

Returns true if the absolute difference of all elements between self and other is less than or equal to max_abs_diff.

This can be used to compare if two Vec3's contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more on floating point comparisons see https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/

impl Vec3[src]

pub fn new(x: f32, y: f32, z: f32) -> Self[src]

Creates a new Vec3.

pub fn zero() -> Self[src]

Creates a new Vec3 with all elements set to 0.0.

pub fn one() -> Self[src]

Creates a new Vec3 with all elements set to 1.0.

pub fn unit_x() -> Self[src]

Creates a new Vec3 with values [x: 1.0, y: 0.0, z: 0.0].

pub fn unit_y() -> Self[src]

Creates a new Vec3 with values [x: 0.0, y: 1.0, z: 0.0].

pub fn unit_z() -> Self[src]

Creates a new Vec3 with values [x: 0.0, y: 0.0, z: 1.0].

pub fn splat(v: f32) -> Self[src]

Creates a new Vec3 with all elements set to v.

pub fn extend(self, w: f32) -> Vec4[src]

Creates a new Vec4 from self and the given w value.

pub fn truncate(self) -> Vec2[src]

Creates a Vec2 from the first three elements of self, removing z.

pub fn x(self) -> f32[src]

Returns element x.

pub fn y(self) -> f32[src]

Returns element y.

pub fn z(self) -> f32[src]

Returns element z.

pub fn set_x(&mut self, x: f32)[src]

Sets element x.

pub fn set_y(&mut self, y: f32)[src]

Sets element y.

pub fn set_z(&mut self, z: f32)[src]

Sets element z.

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

Computes the dot product of self and other.

pub fn cross(self, other: Self) -> Self[src]

Computes the cross product of self and other.

pub fn length(self) -> f32[src]

Computes the length of self.

pub fn length_squared(self) -> f32[src]

Computes the squared length of self.

This is generally faster than Vec3::length() as it avoids a square root operation.

pub fn length_reciprocal(self) -> f32[src]

Computes 1.0 / Vec3::length().

For valid results, self must not be of length zero.

pub fn normalize(self) -> Self[src]

Returns self normalized to length 1.0.

For valid results, self must not be of length zero.

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

Returns the vertical minimum of self and other.

In other words, this computes [x: min(x1, x2), y: min(y1, y2), z: min(z1, z2)], taking the minimum of each element individually.

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

Returns the vertical maximum of self and other.

In other words, this computes [x: max(x1, x2), y: max(y1, y2), z: max(z1, z2)], taking the maximum of each element individually.

pub fn min_element(self) -> f32[src]

Returns the horizontal minimum of self's elements.

In other words, this computes min(x, y, z).

pub fn max_element(self) -> f32[src]

Returns the horizontal maximum of self's elements.

In other words, this computes max(x, y, z).

pub fn cmpeq(self, other: Self) -> Vec3Mask[src]

Performs a vertical == comparison between self and other, returning a Vec3Mask of the results.

In other words, this computes [x1 == x2, y1 == y2, z1 == z2, w1 == w2].

pub fn cmpne(self, other: Self) -> Vec3Mask[src]

Performs a vertical != comparison between self and other, returning a Vec3Mask of the results.

In other words, this computes [x1 != x2, y1 != y2, z1 != z2, w1 != w2].

pub fn cmpge(self, other: Self) -> Vec3Mask[src]

Performs a vertical >= comparison between self and other, returning a Vec3Mask of the results.

In other words, this computes [x1 >= x2, y1 >= y2, z1 >= z2, w1 >= w2].

pub fn cmpgt(self, other: Self) -> Vec3Mask[src]

Performs a vertical > comparison between self and other, returning a Vec3Mask of the results.

In other words, this computes [x1 > x2, y1 > y2, z1 > z2, w1 > w2].

pub fn cmple(self, other: Self) -> Vec3Mask[src]

Performs a vertical <= comparison between self and other, returning a Vec3Mask of the results.

In other words, this computes [x1 <= x2, y1 <= y2, z1 <= z2, w1 <= w2].

pub fn cmplt(self, other: Self) -> Vec3Mask[src]

Performs a vertical < comparison between self and other, returning a Vec3Mask of the results.

In other words, this computes [x1 < x2, y1 < y2, z1 < z2, w1 < w2].

pub fn abs(self) -> Self[src]

Returns a new Vec3 containing the absolute value of each element of the original Vec3.

Trait Implementations

impl AsRef<[f32; 3]> for Vec3[src]

impl AsMut<[f32; 3]> for Vec3[src]

impl From<Vec3> for __m128[src]

impl From<__m128> for Vec3[src]

impl From<(f32, f32, f32)> for Vec3[src]

impl From<Vec3> for (f32, f32, f32)[src]

impl From<[f32; 3]> for Vec3[src]

impl From<Vec3> for [f32; 3][src]

impl Clone for Vec3[src]

impl Copy for Vec3[src]

impl Default for Vec3[src]

impl PartialEq<Vec3> for Vec3[src]

impl PartialOrd<Vec3> for Vec3[src]

impl Display for Vec3[src]

impl Debug for Vec3[src]

impl Div<Vec3> for Vec3[src]

type Output = Self

The resulting type after applying the / operator.

impl Div<f32> for Vec3[src]

type Output = Self

The resulting type after applying the / operator.

impl Sub<Vec3> for Vec3[src]

type Output = Self

The resulting type after applying the - operator.

impl Add<Vec3> for Vec3[src]

type Output = Self

The resulting type after applying the + operator.

impl Mul<Vec3> for Mat3[src]

type Output = Vec3

The resulting type after applying the * operator.

impl Mul<Vec3> for Quat[src]

type Output = Vec3

The resulting type after applying the * operator.

impl Mul<Vec3> for Vec3[src]

type Output = Self

The resulting type after applying the * operator.

impl Mul<f32> for Vec3[src]

type Output = Self

The resulting type after applying the * operator.

impl Mul<Vec3> for f32[src]

type Output = Vec3

The resulting type after applying the * operator.

impl Neg for Vec3[src]

type Output = Self

The resulting type after applying the - operator.

impl AddAssign<Vec3> for Vec3[src]

impl SubAssign<Vec3> for Vec3[src]

impl MulAssign<Vec3> for Vec3[src]

impl MulAssign<f32> for Vec3[src]

impl DivAssign<Vec3> for Vec3[src]

impl DivAssign<f32> for Vec3[src]

Auto Trait Implementations

impl Send for Vec3

impl Sync for Vec3

impl Unpin for Vec3

impl UnwindSafe for Vec3

impl RefUnwindSafe for Vec3

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]