Struct Vec3 

#[repr(C)]
pub struct Vec3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

A three-component single-precision vector.

Fields

x: f32

X component.

y: f32

Y component.

z: f32

Z component.

Implementations

impl Vec3

pub const ZERO: Self

Zero vector.

pub const ONE: Self

One on every axis.

pub const X: Self

Positive X axis.

pub const Y: Self

Positive Y axis.

pub const Z: Self

Positive Z axis.

pub const NAN: Self

NaN on every axis.

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

Builds a vector.

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

Builds a vector with equal components.

pub const fn from_array(value: [f32; 3]) -> Self

Builds from an array.

pub fn from_slice(value: &[f32]) -> Self

Builds from the first three slice entries.

pub const fn to_array(&self) -> [f32; 3]

Returns components.

pub fn is_finite(self) -> bool

Returns whether every component is finite.

pub fn is_normalized(self) -> bool

Returns whether the length is approximately one.

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

Dot product.

pub fn cross(self, rhs: Self) -> Self

Cross product.

pub fn length_squared(self) -> f32

Squared length.

pub fn length(self) -> f32

Length.

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

Squared point distance.

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

Point distance.

pub fn normalize(self) -> Self

Normalized vector.

pub fn normalize_or_zero(self) -> Self

Normalized vector, or zero when degenerate.

pub fn try_normalize(self) -> Option<Self>

Attempts normalization.

pub fn abs(self) -> Self

Componentwise absolute value.

pub fn sqrt(self) -> Self

Componentwise square root.

pub fn recip(self) -> Self

Componentwise reciprocal.

pub fn min(self, rhs: Self) -> Self

Componentwise minimum.

pub fn max(self, rhs: Self) -> Self

Componentwise maximum.

pub fn clamp(self, min: Self, max: Self) -> Self

Componentwise clamp.

pub fn min_element(self) -> f32

Smallest component.

pub fn max_element(self) -> f32

Largest component.

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

Linear interpolation.

pub fn reject_from_normalized(self, normal: Self) -> Self

Rejects this vector from a normalized direction.

pub fn any_orthonormal_vector(self) -> Self

Returns a deterministic orthonormal vector.

pub const fn extend(self, w: f32) -> Vec4

Appends a W component.

Trait Implementations

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vec3

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec3

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Vec3

impl Debug for Vec3

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

Formats the value using the given formatter.

impl Default for Vec3

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vec3

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div for Vec3

type Output = Vec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vec3

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

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

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

Converts to this type from the input type.

impl From<Vec3> for [f32; 3]

fn from(value: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for Vec3

fn from(value: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for Vec3

fn from(value: Vec3) -> Self

Converts to this type from the input type.

impl From<[f32; 3]> for Vec3

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

Converts to this type from the input type.

impl Mul for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for Quat

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for f32

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vec3

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Vec3

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

Equality operator ==.

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

Inequality operator !=.

impl Pod for Vec3

impl Serialize for Vec3

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Vec3

impl Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Vec3

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for Vec3

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Zeroable for Vec3

fn zeroed() -> Self

Calls zeroed.