Struct ultraviolet::vec::Vec4x8

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

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: f32x8

y: f32x8

z: f32x8

w: f32x8

Implementations

impl Vec4x8

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

pub const fn broadcast(val: f32x8) -> Self

pub fn unit_x() -> Self

pub fn unit_y() -> Self

pub fn unit_z() -> Self

pub fn unit_w() -> Self

pub fn dot(&self, other: Vec4x8) -> f32x8

pub fn reflect(&mut self, normal: Vec4x8)

pub fn reflected(&self, normal: Vec4x8) -> Self

pub fn mag_sq(&self) -> f32x8

pub fn mag(&self) -> f32x8

pub fn normalize(&mut self)

pub fn normalized(&self) -> Self

pub fn normalize_homogeneous_point(&mut self)

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

pub fn normalized_homogeneous_point(&self) -> Self

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) -> Vec3x8

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

pub fn mul_add(&self, mul: Vec4x8, add: Vec4x8) -> Self

pub fn abs(&self) -> Self

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

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

pub fn map<F>(&self, f: F) -> Self where
    F: Fn(f32x8) -> f32x8, 

pub fn apply<F>(&mut self, f: F) where
    F: Fn(f32x8) -> f32x8, 

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

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

pub fn component_max(&self) -> f32x8

pub fn component_min(&self) -> f32x8

pub fn zero() -> Self

pub fn one() -> Self

pub const fn xy(&self) -> Vec2x8

pub const fn xyz(&self) -> Vec3x8

pub fn layout() -> Layout

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

pub fn as_slice(&self) -> &[f32x8]

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

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

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

pub const fn as_ptr(&self) -> *const f32x8

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 f32x8

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 Vec4x8

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

pub fn splat(vec: Vec4) -> Self

pub fn blend(mask: m32x8, tru: Self, fals: Self) -> Self

Blend two vectors together lanewise using mask as a mask.

This is essentially a bitwise blend operation, such that any point where there is a 1 bit in mask, the output will put the bit from tru, while where there is a 0 bit in mask, the output will put the bit from fals

Trait Implementations

impl Add<Vec4x8> for Vec4x8

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vec4x8> for Vec4x8

fn add_assign(&mut self, rhs: Vec4x8)

Performs the += operation.

impl Clone for Vec4x8

fn clone(&self) -> Vec4x8

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec4x8

impl Debug for Vec4x8

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

Formats the value using the given formatter.

impl Default for Vec4x8

fn default() -> Vec4x8

Returns the “default value” for a type.

impl Div<Vec4x8> for Vec4x8

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32x8> for Vec4x8

type Output = Vec4x8

The resulting type after applying the / operator.

fn div(self, rhs: f32x8) -> Vec4x8

Performs the / operation.

impl DivAssign<Vec4x8> for Vec4x8

fn div_assign(&mut self, rhs: Vec4x8)

Performs the /= operation.

impl DivAssign<f32x8> for Vec4x8

fn div_assign(&mut self, rhs: f32x8)

Performs the /= operation.

impl From<&'_ [f32x8; 4]> for Vec4x8

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

Performs the conversion.

impl From<&'_ (f32x8, f32x8, f32x8, f32x8)> for Vec4x8

fn from(comps: &(f32x8, f32x8, f32x8, f32x8)) -> Self

Performs the conversion.

impl From<&'_ mut [f32x8; 4]> for Vec4x8

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

Performs the conversion.

impl From<[Vec4; 8]> for Vec4x8

fn from(vecs: [Vec4; 8]) -> Self

Performs the conversion.

impl From<[f32x8; 4]> for Vec4x8

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

Performs the conversion.

impl From<(f32x8, f32x8, f32x8, f32x8)> for Vec4x8

fn from(comps: (f32x8, f32x8, f32x8, f32x8)) -> Self

Performs the conversion.

impl From<Vec3x8> for Vec4x8

fn from(vec: Vec3x8) -> Self

Performs the conversion.

impl From<Vec4> for Vec4x8

fn from(vec: Vec4) -> Self

Performs the conversion.

impl From<Vec4x8> for Vec3x8

fn from(vec: Vec4x8) -> Self

Performs the conversion.

impl Index<usize> for Vec4x8

type Output = f32x8

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec4x8

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

impl Into<[Vec4; 8]> for Vec4x8

fn into(self) -> [Vec4; 8]

Performs the conversion.

impl Into<[f32x8; 4]> for Vec4x8

fn into(self) -> [f32x8; 4]

Performs the conversion.

impl Lerp<f32x8> for Vec4x8

fn lerp(&self, end: Self, t: f32x8) -> Self

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<Vec4x8> for Mat4x8

type Output = Vec4x8

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec4x8> for Vec4x8

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec4x8> for f32x8

type Output = Vec4x8

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32x8> for Vec4x8

type Output = Vec4x8

The resulting type after applying the * operator.

fn mul(self, rhs: f32x8) -> Vec4x8

Performs the * operation.

impl MulAssign<Vec4x8> for Vec4x8

fn mul_assign(&mut self, rhs: Vec4x8)

Performs the *= operation.

impl MulAssign<f32x8> for Vec4x8

fn mul_assign(&mut self, rhs: f32x8)

Performs the *= operation.

impl Neg for Vec4x8

type Output = Vec4x8

The resulting type after applying the - operator.

fn neg(self) -> Vec4x8

Performs the unary - operation.

impl PartialEq<Vec4x8> for Vec4x8

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

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

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

This method tests for !=.

impl Slerp<f32x8> for Vec4x8

fn slerp(&self, end: Self, t: f32x8) -> Self

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 StructuralPartialEq for Vec4x8

impl Sub<Vec4x8> for Vec4x8

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Vec4x8> for Vec4x8

fn sub_assign(&mut self, rhs: Vec4x8)

Performs the -= operation.

impl Sum<Vec4x8> for Vec4x8

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

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