Struct ultraviolet::vec::Vec4

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

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

y: f32

z: f32

w: f32

Methods

impl Vec4

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

pub fn broadcast<T: Into<f32> + Copy>(val: T) -> 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: Vec4) -> f32

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

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

pub fn mag_sq(&self) -> f32

pub fn mag(&self) -> f32

pub fn normalize(&mut self)

pub fn normalized(&self) -> Self

pub fn mul_add(&self, mul: Vec4, add: Vec4) -> 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(f32) -> f32, 

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

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

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

pub fn component_max(&self) -> f32

pub fn component_min(&self) -> f32

pub fn zero() -> Self

pub fn one() -> Self

pub fn xy(&self) -> Vec2

pub fn xyz(&self) -> Vec3

pub fn layout() -> Layout

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

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

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

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

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

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

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

pub fn refracted(&mut self, normal: Self, eta: f32) -> Self

Trait Implementations

impl Lerp<f32> for Vec4

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

impl From<Vec4> for Vec3

fn from(vec: Vec4) -> Self

Performs the conversion.

impl From<[f32; 4]> for Vec4

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl From<(f32, f32, f32, f32)> for Vec4

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

Performs the conversion.

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

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

Performs the conversion.

impl From<Vec4> for (f32, f32, f32, f32)

fn from(v: Vec4) -> Self

Performs the conversion.

impl From<Vec3> for Vec4

fn from(vec: Vec3) -> Self

Performs the conversion.

impl Clone for Vec4

fn clone(&self) -> Vec4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec4

impl Default for Vec4

fn default() -> Vec4

Returns the "default value" for a type.

impl Debug for Vec4

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

Formats the value using the given formatter.

impl Div<Vec4> for Vec4

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Vec4

type Output = Vec4

The resulting type after applying the / operator.

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

Performs the / operation.

impl Sub<Vec4> for Vec4

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Add<Vec4> for Vec4

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Mul<Vec4> for Mat4

type Output = Vec4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec4> for Vec4

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec4> for f32

type Output = Vec4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vec4

type Output = Vec4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Vec4

type Output = Vec4

The resulting type after applying the - operator.

fn neg(self) -> Vec4

Performs the unary - operation.

impl AddAssign<Vec4> for Vec4

fn add_assign(&mut self, rhs: Vec4)

Performs the += operation.

impl SubAssign<Vec4> for Vec4

fn sub_assign(&mut self, rhs: Vec4)

Performs the -= operation.

impl MulAssign<Vec4> for Vec4

fn mul_assign(&mut self, rhs: Vec4)

Performs the *= operation.

impl MulAssign<f32> for Vec4

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl DivAssign<Vec4> for Vec4

fn div_assign(&mut self, rhs: Vec4)

Performs the /= operation.

impl DivAssign<f32> for Vec4

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl Index<usize> for Vec4

type Output = f32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec4

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

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