ultraviolet::int

Struct UVec4

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

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: u32§y: u32§z: u32§w: u32

Implementations§

impl UVec4

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

pub fn broadcast(val: u32) -> 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: UVec4) -> u32

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

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

pub fn mag(&self) -> u32

pub fn mag_sq(&self) -> u32

pub fn mul_add(&self, mul: UVec4, add: UVec4) -> 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: FnMut(u32) -> u32,

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

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

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

pub fn component_max(&self) -> u32

pub fn component_min(&self) -> u32

pub fn zero() -> Self

pub fn one() -> Self

pub fn xy(&self) -> UVec2

pub fn xyz(&self) -> UVec3

pub fn layout() -> Layout

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

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

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

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

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

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

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 u32

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 UVec4

pub fn abs(&self) -> Self

Trait Implementations§

impl Add for UVec4

type Output = UVec4

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl AddAssign for UVec4

fn add_assign(&mut self, rhs: UVec4)

Performs the += operation. Read more

impl Clone for UVec4

fn clone(&self) -> UVec4

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for UVec4

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

Formats the value using the given formatter. Read more

impl Default for UVec4

fn default() -> UVec4

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

impl<'de> Deserialize<'de> for UVec4

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

Deserialize this value from the given Serde deserializer. Read more

impl Div<u32> for UVec4

type Output = UVec4

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> UVec4

Performs the / operation. Read more

impl Div for UVec4

type Output = UVec4

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl DivAssign<u32> for UVec4

fn div_assign(&mut self, rhs: u32)

Performs the /= operation. Read more

impl DivAssign for UVec4

fn div_assign(&mut self, rhs: UVec4)

Performs the /= operation. Read more

impl From<&[u32; 4]> for UVec4

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

Converts to this type from the input type.

impl From<&(u32, u32, u32, u32)> for UVec4

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

Converts to this type from the input type.

impl From<&mut [u32; 4]> for UVec4

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

Converts to this type from the input type.

impl From<[u32; 4]> for UVec4

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

Converts to this type from the input type.

impl From<(u32, u32, u32, u32)> for UVec4

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

Converts to this type from the input type.

impl From<UVec3> for UVec4

fn from(vec: UVec3) -> Self

Converts to this type from the input type.

impl From<UVec4> for [u32; 4]

fn from(v: UVec4) -> Self

Converts to this type from the input type.

impl From<UVec4> for (u32, u32, u32, u32)

fn from(v: UVec4) -> Self

Converts to this type from the input type.

impl From<UVec4> for DVec4

fn from(v: UVec4) -> Self

Converts to this type from the input type.

impl From<UVec4> for UVec3

fn from(vec: UVec4) -> Self

Converts to this type from the input type.

impl From<UVec4> for Vec4

fn from(v: UVec4) -> Self

Converts to this type from the input type.

impl Hash for UVec4

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl Index<usize> for UVec4

type Output = u32

The returned type after indexing.

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

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

impl IndexMut<usize> for UVec4

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

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

impl Mul<UVec4> for u32

type Output = UVec4

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<u32> for UVec4

type Output = UVec4

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> UVec4

Performs the * operation. Read more

impl Mul for UVec4

type Output = UVec4

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl MulAssign<u32> for UVec4

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation. Read more

impl MulAssign for UVec4

fn mul_assign(&mut self, rhs: UVec4)

Performs the *= operation. Read more

impl PartialEq for UVec4

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for UVec4

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

Serialize this value into the given Serde serializer. Read more

impl Sub for UVec4

type Output = UVec4

The resulting type after applying the - operator.

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

Performs the - operation. Read more

impl SubAssign for UVec4

fn sub_assign(&mut self, rhs: UVec4)

Performs the -= operation. Read more

impl Sum for UVec4

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

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

impl TryFrom<DVec4> for UVec4

fn try_from(v: DVec4) -> Result<Self, Self::Error>

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

fn try_from(v: Vec4) -> Result<Self, Self::Error>

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 UVec4

fn zeroed() -> Self

Calls zeroed. Read more

impl Copy for UVec4

impl Eq for UVec4

impl Pod for UVec4

impl StructuralPartialEq for UVec4

Auto Trait Implementations§

impl Freeze for UVec4

impl RefUnwindSafe for UVec4

impl Send for UVec4

impl Sync for UVec4

impl Unpin for UVec4

impl UnwindSafe for UVec4

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

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

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> AnyBitPattern for T
where T: Pod,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> NoUninit for T
where T: Pod,