Struct ultraviolet::int::UVec3

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

A set of three coordinates which may be interpreted as a point or vector in 3d space, or as a homogeneous 2d 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

Implementations

impl UVec3

pub const fn new(x: u32, y: u32, z: 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 cross(&self, other: UVec3) -> Self

pub fn into_homogeneous_point(self) -> UVec4

Create a homogeneous 3d point from this vector interpreted as a point, meaning the homogeneous component will start with a value of 1.

pub fn into_homogeneous_vector(self) -> UVec4

Create a homogeneous 3d vector from this vector, meaning the homogeneous component will always have a value of 0.

pub fn from_homogeneous_point(v: UVec4) -> Self

Create a 3d point from a homogeneous 3d point, performing division by the homogeneous component. This should not be used for homogeneous 3d vectors, which will have 0 as their homogeneous component.

pub fn from_homogeneous_vector(v: UVec4) -> Self

Create a 3d vector from homogeneous 2d vector, which simply discards the homogeneous component.

pub fn dot(&self, other: UVec3) -> u32

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

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

pub fn mag(&self) -> u32

pub fn mag_sq(&self) -> u32

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

pub fn layout() -> Layout

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

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

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 UVec3

pub fn abs(&self) -> Self

Trait Implementations

impl Add<UVec3> for UVec3

type Output = UVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<UVec3> for UVec3

fn add_assign(&mut self, rhs: UVec3)

Performs the += operation.

impl Clone for UVec3

fn clone(&self) -> UVec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UVec3

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

Formats the value using the given formatter.

impl Default for UVec3

fn default() -> UVec3

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UVec3

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

Deserialize this value from the given Serde deserializer.

impl Div<UVec3> for UVec3

type Output = UVec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<u32> for UVec3

type Output = UVec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<UVec3> for UVec3

fn div_assign(&mut self, rhs: UVec3)

Performs the /= operation.

impl DivAssign<u32> for UVec3

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl From<&[u32; 3]> for UVec3

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&mut [u32; 3]> for UVec3

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

Converts to this type from the input type.

impl From<[u32; 3]> for UVec3

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<UVec3> for [u32; 3]

fn from(v: UVec3) -> Self

Converts to this type from the input type.

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

fn from(v: UVec3) -> Self

Converts to this type from the input type.

impl From<UVec3> for DVec3

fn from(v: UVec3) -> Self

Converts to this type from the input type.

impl From<UVec3> for UVec2

fn from(vec: UVec3) -> 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<UVec3> for Vec3

fn from(v: UVec3) -> 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 Hash for UVec3

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Index<usize> for UVec3

type Output = u32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for UVec3

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

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

impl Mul<UVec3> for UVec3

type Output = UVec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<UVec3> for u32

type Output = UVec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u32> for UVec3

type Output = UVec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<UVec3> for UVec3

fn mul_assign(&mut self, rhs: UVec3)

Performs the *= operation.

impl MulAssign<u32> for UVec3

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation.

impl PartialEq<UVec3> for UVec3

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

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

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

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

impl Serialize for UVec3

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

Serialize this value into the given Serde serializer.

impl Sub<UVec3> for UVec3

type Output = UVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<UVec3> for UVec3

fn sub_assign(&mut self, rhs: UVec3)

Performs the -= operation.

impl TryFrom<DVec3> for UVec3

fn try_from(v: DVec3) -> 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<IVec3> for UVec3

type Error = <u32 as TryFrom<i32>>::Error

The type returned in the event of a conversion error.

fn try_from(rhv: IVec3) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<UVec3> for IVec3

type Error = <i32 as TryFrom<u32>>::Error

The type returned in the event of a conversion error.

fn try_from(rhv: UVec3) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec3> for UVec3

fn try_from(v: Vec3) -> 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 UVec3

fn zeroed() -> Self

Calls zeroed.

impl Copy for UVec3

impl Eq for UVec3

impl Pod for UVec3

impl StructuralEq for UVec3

impl StructuralPartialEq for UVec3