Struct ultraviolet::vec::Vec4[−][src]

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

Expand description

A set of four coordinates which may be interpreted as a point or vector in 4d space, or as a homogeneous 3d vector or point.

Generally this distinction between a point and vector is more of a pain than it is worth to distinguish on a type level, however when converting to and from homogeneous coordinates it is quite important.

Fields

x: f32y: f32z: f32w: f32

Implementations

`impl Vec4`[src]

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

`pub const fn broadcast(val: f32) -> Self`[src]

`pub fn unit_x() -> Self`[src]

`pub fn unit_y() -> Self`[src]

`pub fn unit_z() -> Self`[src]

`pub fn unit_w() -> Self`[src]

`pub fn dot(&self, other: Vec4) -> f32`[src]

`pub fn reflect(&mut self, normal: Vec4)`[src]

`pub fn reflected(&self, normal: Vec4) -> Self`[src]

`pub fn mag_sq(&self) -> f32`[src]

`pub fn mag(&self) -> f32`[src]

`pub fn normalize(&mut self)`[src]

#[must_use = "Did you mean to use `.normalize()` to normalize `self` in place?"] pub fn normalized(&self) -> Self [src]

`pub fn normalize_homogeneous_point(&mut self)`[src]

Normalize self in-place by interpreting it as a homogeneous point, i.e. scaling the vector to ensure the homogeneous component has length 1.

#[must_use = "Did you mean to use `.normalize_homogeneous_point()` to normalize `self` in place?"] pub fn normalized_homogeneous_point(&self) -> Self [src]

Normalize self by interpreting it as a homogeneous point, i.e. scaling the vector to ensure the homogeneous component has length 1.

`pub fn truncated(&self) -> Vec3`[src]

Convert self into a Vec3 by simply removing its w component.

`pub fn mul_add(&self, mul: Vec4, add: Vec4) -> Self`[src]

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

`pub fn clamp(&mut self, min: Self, max: Self)`[src]

`pub fn clamped(self, min: Self, max: Self) -> Self`[src]

`pub fn map<F>(&self, f: F) -> Self where F: Fn(f32) -> f32,` [src]

`pub fn apply<F>(&mut self, f: F) where F: Fn(f32) -> f32,` [src]

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

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

`pub fn component_max(&self) -> f32`[src]

`pub fn component_min(&self) -> f32`[src]

`pub fn zero() -> Self`[src]

`pub fn one() -> Self`[src]

`pub const fn xy(&self) -> Vec2`[src]

`pub const fn xyz(&self) -> Vec3`[src]

`pub fn layout() -> Layout`[src]

`pub fn as_array(&self) -> &[f32; 4]`[src]

`pub fn as_slice(&self) -> &[f32]`[src]

`pub fn as_byte_slice(&self) -> &[u8]`[src]

`pub fn as_mut_slice(&mut self) -> &mut [f32]`[src]

`pub fn as_mut_byte_slice(&mut self) -> &mut [u8]`[src]

`pub const fn as_ptr(&self) -> *const f32`[src]

Returns a constant unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

`pub fn as_mut_ptr(&mut self) -> *mut f32`[src]

Returns a mutable unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

`impl Vec4`[src]

`pub fn refract(&mut self, normal: Self, eta: f32)`[src]

`pub fn refracted(&self, normal: Self, eta: f32) -> Self`[src]

Trait Implementations

`impl Add<Vec4> for Vec4`[src]

`type Output = Self`

The resulting type after applying the + operator.

`fn add(self, rhs: Vec4) -> Self`[src]

Performs the + operation. Read more

`impl AddAssign<Vec4> for Vec4`[src]

`fn add_assign(&mut self, rhs: Vec4)`[src]

Performs the += operation. Read more

`impl Clone for Vec4`[src]

`fn clone(&self) -> Vec4`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl Debug for Vec4`[src]

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

Formats the value using the given formatter. Read more

`impl Default for Vec4`[src]

`fn default() -> Vec4`[src]

Returns the “default value” for a type. Read more

`impl<'de> Deserialize<'de> for Vec4`[src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>,` [src]

Deserialize this value from the given Serde deserializer. Read more

`impl Div<Vec4> for Vec4`[src]

`type Output = Self`

The resulting type after applying the / operator.

`fn div(self, rhs: Vec4) -> Self`[src]

Performs the / operation. Read more

`impl Div<f32> for Vec4`[src]

`type Output = Vec4`

The resulting type after applying the / operator.

`fn div(self, rhs: f32) -> Vec4`[src]

Performs the / operation. Read more

`impl DivAssign<Vec4> for Vec4`[src]

`fn div_assign(&mut self, rhs: Vec4)`[src]

Performs the /= operation. Read more

`impl DivAssign<f32> for Vec4`[src]

`fn div_assign(&mut self, rhs: f32)`[src]

Performs the /= operation. Read more

`impl From<&'_ [f32; 4]> for Vec4`[src]

`fn from(comps: &[f32; 4]) -> Self`[src]

Performs the conversion.

`impl From<&'_ (f32, f32, f32, f32)> for Vec4`[src]

`fn from(comps: &(f32, f32, f32, f32)) -> Self`[src]

Performs the conversion.

`impl From<&'_ mut [f32; 4]> for Vec4`[src]

`fn from(comps: &mut [f32; 4]) -> Self`[src]

Performs the conversion.

`impl From<[f32; 4]> for Vec4`[src]

`fn from(comps: [f32; 4]) -> Self`[src]

Performs the conversion.

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

`fn from(comps: (f32, f32, f32, f32)) -> Self`[src]

Performs the conversion.

`impl From<IVec4> for Vec4`[src]

`fn from(v: IVec4) -> Self`[src]

Performs the conversion.

`impl From<UVec4> for Vec4`[src]

`fn from(v: UVec4) -> Self`[src]

Performs the conversion.

`impl From<Vec3> for Vec4`[src]

`fn from(vec: Vec3) -> Self`[src]

Performs the conversion.

`impl From<Vec4> for Vec3`[src]

`fn from(vec: Vec4) -> Self`[src]

Performs the conversion.

`impl From<Vec4> for Vec4x4`[src]

`fn from(vec: Vec4) -> Self`[src]

Performs the conversion.

`impl From<Vec4> for Vec4x8`[src]

`fn from(vec: Vec4) -> Self`[src]

Performs the conversion.

`impl From<Vector4<f32>> for Vec4`[src]

`fn from(v: Vector4<f32>) -> Self`[src]

Performs the conversion.

`impl Index<usize> for Vec4`[src]

`type Output = f32`

The returned type after indexing.

`fn index(&self, index: usize) -> &Self::Output`[src]

Performs the indexing (container[index]) operation. Read more

`impl IndexMut<usize> for Vec4`[src]

`fn index_mut(&mut self, index: usize) -> &mut Self::Output`[src]

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

`impl Lerp<f32> for Vec4`[src]

`fn lerp(&self, end: Self, t: f32) -> Self`[src]

Linearly interpolate between self and end by t between 0.0 and 1.0. i.e. (1.0 - t) * self + (t) * end.

For interpolating Rotors with linear interpolation, you almost certainly want to normalize the returned Rotor. For example,

let interpolated_rotor = rotor1.lerp(rotor2, 0.5).normalized();

For most cases (especially where performance is the primary concern, like in animation interpolation for games, this ‘normalized lerp’ or ‘nlerp’ is probably what you want to use. However, there are situations in which you really want the interpolation between two Rotors to be of constant angular velocity. In this case, check out Slerp.

`impl Mul<Vec4> for Mat4`[src]

`type Output = Vec4`

The resulting type after applying the * operator.

`fn mul(self, rhs: Vec4) -> Vec4`[src]

Performs the * operation. Read more

`impl Mul<Vec4> for Vec4`[src]

`type Output = Self`

The resulting type after applying the * operator.

`fn mul(self, rhs: Vec4) -> Self`[src]

Performs the * operation. Read more

`impl Mul<f32> for Vec4`[src]

`type Output = Vec4`

The resulting type after applying the * operator.

`fn mul(self, rhs: f32) -> Vec4`[src]

Performs the * operation. Read more

`impl MulAssign<Vec4> for Vec4`[src]

`fn mul_assign(&mut self, rhs: Vec4)`[src]

Performs the *= operation. Read more

`impl MulAssign<f32> for Vec4`[src]

`fn mul_assign(&mut self, rhs: f32)`[src]

Performs the *= operation. Read more

`impl Neg for Vec4`[src]

`type Output = Vec4`

The resulting type after applying the - operator.

`fn neg(self) -> Vec4`[src]

Performs the unary - operation. Read more

`impl PartialEq<Vec4> for Vec4`[src]

`fn eq(&self, other: &Vec4) -> bool`[src]

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

`fn ne(&self, other: &Vec4) -> bool`[src]

This method tests for !=.

`impl Serialize for Vec4`[src]

`fn serialize<T>(&self, serializer: T) -> Result<T::Ok, T::Error> where T: Serializer,` [src]

Serialize this value into the given Serde serializer. Read more

`impl Slerp<f32> for Vec4`[src]

`fn slerp(&self, end: Self, t: f32) -> Self`[src]

Spherical-linear interpolation between self and end based on t from 0.0 to 1.0.

self and end should both be normalized or something bad will happen!

The implementation for SIMD types also requires that the two things being interpolated between are not exactly aligned, or else the result is undefined.

Basically, interpolation that maintains a constant angular velocity from one orientation on a unit hypersphere to another. This is sorta the “high quality” interpolation for Rotors, and it can also be used to interpolate other things, one example being interpolation of 3d normal vectors.

Note that you should often normalize the result returned by this operation, when working with Rotors, etc!

`impl Sub<Vec4> for Vec4`[src]

`type Output = Self`

The resulting type after applying the - operator.

`fn sub(self, rhs: Vec4) -> Self`[src]

Performs the - operation. Read more

`impl SubAssign<Vec4> for Vec4`[src]

`fn sub_assign(&mut self, rhs: Vec4)`[src]

Performs the -= operation. Read more

`impl Sum<Vec4> for Vec4`[src]

`fn sum(iter: I) -> Self where I: Iterator<Item = Self>,` [src]

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

`impl TryFrom<Vec4> for IVec4`[src]

`fn try_from(v: Vec4) -> Result<Self, Self::Error>`[src]

Tries to convert the source to Self in a lossy way, flooring any float value.

Errors

NaN - If a float value is NaN.
NotFinite - If a float value is infinity or negative infinity.
PosOverflow - If a float value would be greater than the the self.component max value.
NegOverflow - If a float value would be less than the self.component min value.

`type Error = FloatConversionError`

The type returned in the event of a conversion error.

`impl TryFrom<Vec4> for UVec4`[src]

`fn try_from(v: Vec4) -> Result<Self, Self::Error>`[src]

Tries to convert the source to Self in a lossy way, flooring any float value.

Errors

NaN - If a float value is NaN.
NotFinite - If a float value is infinity or negative infinity.
PosOverflow - If a float value would be greater than the the self.component max value.
NegOverflow - If a float value would be less than the self.component min value.

`type Error = FloatConversionError`

The type returned in the event of a conversion error.

`impl Zeroable for Vec4`[src]

`fn zeroed() -> Self`[src]

Calls zeroed. Read more

`impl Copy for Vec4`[src]

`impl Pod for Vec4`[src]

`impl StructuralPartialEq for Vec4`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Vec4`

`impl Send for Vec4`

`impl Sync for Vec4`

`impl Unpin for Vec4`

`impl UnwindSafe for Vec4`

Blanket Implementations

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

`pub fn type_id(&self) -> TypeId`[src]

Gets the TypeId of self. Read more

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

`pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

`pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

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

`pub fn from(t: T) -> T`[src]

Performs the conversion.

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

`pub fn into(self) -> U`[src]

Performs the conversion.

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

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

`pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

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

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

Performs the conversion.

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

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

Performs the conversion.

Struct ultraviolet::vec::Vec4[−][src]

Fields

Implementations

impl Vec4[src]

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

pub const fn broadcast(val: f32) -> Self[src]

pub fn unit_x() -> Self[src]

pub fn unit_y() -> Self[src]

pub fn unit_z() -> Self[src]

pub fn unit_w() -> Self[src]

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

pub fn reflect(&mut self, normal: Vec4)[src]

pub fn reflected(&self, normal: Vec4) -> Self[src]

pub fn mag_sq(&self) -> f32[src]

pub fn mag(&self) -> f32[src]

pub fn normalize(&mut self)[src]

#[must_use = "Did you mean to use `.normalize()` to normalize `self` in place?"]pub fn normalized(&self) -> Self[src]

pub fn normalize_homogeneous_point(&mut self)[src]

#[must_use = "Did you mean to use `.normalize_homogeneous_point()` to normalize `self` in place?"]pub fn normalized_homogeneous_point(&self) -> Self[src]

pub fn truncated(&self) -> Vec3[src]

pub fn mul_add(&self, mul: Vec4, add: Vec4) -> Self[src]

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

pub fn clamp(&mut self, min: Self, max: Self)[src]

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

pub fn map<F>(&self, f: F) -> Self where F: Fn(f32) -> f32, [src]

pub fn apply<F>(&mut self, f: F) where F: Fn(f32) -> f32, [src]

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

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

pub fn component_max(&self) -> f32[src]

pub fn component_min(&self) -> f32[src]

pub fn zero() -> Self[src]

pub fn one() -> Self[src]

pub const fn xy(&self) -> Vec2[src]

pub const fn xyz(&self) -> Vec3[src]

pub fn layout() -> Layout[src]

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

pub fn as_slice(&self) -> &[f32][src]

pub fn as_byte_slice(&self) -> &[u8][src]

pub fn as_mut_slice(&mut self) -> &mut [f32][src]

pub fn as_mut_byte_slice(&mut self) -> &mut [u8][src]

pub const fn as_ptr(&self) -> *const f32[src]

Safety

pub fn as_mut_ptr(&mut self) -> *mut f32[src]

Safety

impl Vec4[src]

pub fn refract(&mut self, normal: Self, eta: f32)[src]

pub fn refracted(&self, normal: Self, eta: f32) -> Self[src]

Trait Implementations

impl Add<Vec4> for Vec4[src]

type Output = Self

fn add(self, rhs: Vec4) -> Self[src]

impl AddAssign<Vec4> for Vec4[src]

fn add_assign(&mut self, rhs: Vec4)[src]

impl Clone for Vec4[src]

fn clone(&self) -> Vec4[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Vec4[src]

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

impl Default for Vec4[src]

fn default() -> Vec4[src]

impl<'de> Deserialize<'de> for Vec4[src]

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>, [src]

impl Div<Vec4> for Vec4[src]

type Output = Self

fn div(self, rhs: Vec4) -> Self[src]

impl Div<f32> for Vec4[src]

type Output = Vec4

fn div(self, rhs: f32) -> Vec4[src]

impl DivAssign<Vec4> for Vec4[src]

fn div_assign(&mut self, rhs: Vec4)[src]

impl DivAssign<f32> for Vec4[src]

fn div_assign(&mut self, rhs: f32)[src]

impl From<&'_ [f32; 4]> for Vec4[src]

fn from(comps: &[f32; 4]) -> Self[src]

impl From<&'_ (f32, f32, f32, f32)> for Vec4[src]

fn from(comps: &(f32, f32, f32, f32)) -> Self[src]

impl From<&'_ mut [f32; 4]> for Vec4[src]

fn from(comps: &mut [f32; 4]) -> Self[src]

impl From<[f32; 4]> for Vec4[src]

fn from(comps: [f32; 4]) -> Self[src]

`impl Vec4`[src]

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

`pub const fn broadcast(val: f32) -> Self`[src]

`pub fn unit_x() -> Self`[src]

`pub fn unit_y() -> Self`[src]

`pub fn unit_z() -> Self`[src]

`pub fn unit_w() -> Self`[src]

`pub fn dot(&self, other: Vec4) -> f32`[src]

`pub fn reflect(&mut self, normal: Vec4)`[src]

`pub fn reflected(&self, normal: Vec4) -> Self`[src]

`pub fn mag_sq(&self) -> f32`[src]

`pub fn mag(&self) -> f32`[src]

`pub fn normalize(&mut self)`[src]

#[must_use = "Did you mean to use `.normalize()` to normalize `self` in place?"] pub fn normalized(&self) -> Self [src]

`pub fn normalize_homogeneous_point(&mut self)`[src]

#[must_use = "Did you mean to use `.normalize_homogeneous_point()` to normalize `self` in place?"] pub fn normalized_homogeneous_point(&self) -> Self [src]

`pub fn truncated(&self) -> Vec3`[src]

`pub fn mul_add(&self, mul: Vec4, add: Vec4) -> Self`[src]

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

`pub fn clamp(&mut self, min: Self, max: Self)`[src]

`pub fn clamped(self, min: Self, max: Self) -> Self`[src]

`pub fn map<F>(&self, f: F) -> Self where F: Fn(f32) -> f32,` [src]

`pub fn apply<F>(&mut self, f: F) where F: Fn(f32) -> f32,` [src]

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

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

`pub fn component_max(&self) -> f32`[src]

`pub fn component_min(&self) -> f32`[src]

`pub fn zero() -> Self`[src]

`pub fn one() -> Self`[src]

`pub const fn xy(&self) -> Vec2`[src]

`pub const fn xyz(&self) -> Vec3`[src]

`pub fn layout() -> Layout`[src]

`pub fn as_array(&self) -> &[f32; 4]`[src]

`pub fn as_slice(&self) -> &[f32]`[src]

`pub fn as_byte_slice(&self) -> &[u8]`[src]

`pub fn as_mut_slice(&mut self) -> &mut [f32]`[src]

`pub fn as_mut_byte_slice(&mut self) -> &mut [u8]`[src]

`pub const fn as_ptr(&self) -> *const f32`[src]

`pub fn as_mut_ptr(&mut self) -> *mut f32`[src]

`impl Vec4`[src]

`pub fn refract(&mut self, normal: Self, eta: f32)`[src]

`pub fn refracted(&self, normal: Self, eta: f32) -> Self`[src]

`impl Add<Vec4> for Vec4`[src]

`type Output = Self`

`fn add(self, rhs: Vec4) -> Self`[src]

`impl AddAssign<Vec4> for Vec4`[src]

`fn add_assign(&mut self, rhs: Vec4)`[src]

`impl Clone for Vec4`[src]

`fn clone(&self) -> Vec4`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

`impl Debug for Vec4`[src]

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

`impl Default for Vec4`[src]

`fn default() -> Vec4`[src]

`impl<'de> Deserialize<'de> for Vec4`[src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>,` [src]

`impl Div<Vec4> for Vec4`[src]

`type Output = Self`

`fn div(self, rhs: Vec4) -> Self`[src]

`impl Div<f32> for Vec4`[src]

`type Output = Vec4`

`fn div(self, rhs: f32) -> Vec4`[src]

`impl DivAssign<Vec4> for Vec4`[src]

`fn div_assign(&mut self, rhs: Vec4)`[src]

`impl DivAssign<f32> for Vec4`[src]

`fn div_assign(&mut self, rhs: f32)`[src]

`impl From<&'_ [f32; 4]> for Vec4`[src]

`fn from(comps: &[f32; 4]) -> Self`[src]

`impl From<&'_ (f32, f32, f32, f32)> for Vec4`[src]

`fn from(comps: &(f32, f32, f32, f32)) -> Self`[src]

`impl From<&'_ mut [f32; 4]> for Vec4`[src]

`fn from(comps: &mut [f32; 4]) -> Self`[src]

`impl From<[f32; 4]> for Vec4`[src]

`fn from(comps: [f32; 4]) -> Self`[src]

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

`fn from(comps: (f32, f32, f32, f32)) -> Self`[src]

`impl From<IVec4> for Vec4`[src]

`fn from(v: IVec4) -> Self`[src]

`impl From<UVec4> for Vec4`[src]

`fn from(v: UVec4) -> Self`[src]