Struct ultraviolet::int::UVec3[−][src]

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

Expand description

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: u32y: u32z: u32

Implementations

`impl UVec3`[src]

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

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

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

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

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

`pub fn cross(&self, other: UVec3) -> Self`[src]

`pub fn into_homogeneous_point(self) -> UVec4`[src]

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`[src]

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`[src]

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`[src]

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

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

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

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

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

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

`pub fn mul_add(&self, mul: UVec3, add: UVec3) -> 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(u32) -> u32,` [src]

`pub fn apply<F>(&mut self, f: F) where F: Fn(u32) -> u32,` [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) -> u32`[src]

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

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

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

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

`pub fn xyzw(&self) -> UVec4`[src]

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

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

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

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

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

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

`pub fn as_ptr(&self) -> *const u32`[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 u32`[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 UVec3`[src]

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

Trait Implementations

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

`type Output = Self`

The resulting type after applying the + operator.

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

Performs the + operation. Read more

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

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

Performs the += operation. Read more

`impl Clone for UVec3`[src]

`fn clone(&self) -> UVec3`[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 UVec3`[src]

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

Formats the value using the given formatter. Read more

`impl Default for UVec3`[src]

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

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

`impl<'de> Deserialize<'de> for UVec3`[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<UVec3> for UVec3`[src]

`type Output = Self`

The resulting type after applying the / operator.

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

Performs the / operation. Read more

`impl Div<u32> for UVec3`[src]

`type Output = UVec3`

The resulting type after applying the / operator.

`fn div(self, rhs: u32) -> UVec3`[src]

Performs the / operation. Read more

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

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

Performs the /= operation. Read more

`impl DivAssign<u32> for UVec3`[src]

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

Performs the /= operation. Read more

`impl From<&'_ [u32; 3]> for UVec3`[src]

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

Performs the conversion.

`impl From<&'_ (u32, u32, u32)> for UVec3`[src]

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

Performs the conversion.

`impl From<&'_ mut [u32; 3]> for UVec3`[src]

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

Performs the conversion.

`impl From<[u32; 3]> for UVec3`[src]

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

Performs the conversion.

`impl From<(u32, u32, u32)> for UVec3`[src]

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

Performs the conversion.

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

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

Performs the conversion.

`impl From<UVec3> for DVec3`[src]

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

Performs the conversion.

`impl From<UVec3> for UVec2`[src]

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

`impl Hash for UVec3`[src]

`fn hash<H: Hasher>(&self, state: &mut H)`[src]

Feeds this value into the given Hasher. Read more

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

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

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

`type Output = u32`

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 UVec3`[src]

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

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

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

`type Output = Self`

The resulting type after applying the * operator.

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

Performs the * operation. Read more

`impl Mul<u32> for UVec3`[src]

`type Output = UVec3`

The resulting type after applying the * operator.

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

Performs the * operation. Read more

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

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

Performs the *= operation. Read more

`impl MulAssign<u32> for UVec3`[src]

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

Performs the *= operation. Read more

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

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

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

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

This method tests for !=.

`impl Serialize for UVec3`[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 Sub<UVec3> for UVec3`[src]

`type Output = Self`

The resulting type after applying the - operator.

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

Performs the - operation. Read more

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

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

Performs the -= operation. Read more

`impl TryFrom<DVec3> for UVec3`[src]

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

`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>`[src]

Performs the conversion.

`impl TryFrom<UVec3> for IVec3`[src]

`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>`[src]

Performs the conversion.

`impl TryFrom<Vec3> for UVec3`[src]

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

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

Calls zeroed. Read more

`impl Copy for UVec3`[src]

`impl Eq for UVec3`[src]

`impl Pod for UVec3`[src]

`impl StructuralEq for UVec3`[src]

`impl StructuralPartialEq for UVec3`[src]

Auto Trait Implementations

`impl RefUnwindSafe for UVec3`

`impl Send for UVec3`

`impl Sync for UVec3`

`impl Unpin for UVec3`

`impl UnwindSafe for UVec3`

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::int::UVec3[−][src]

Fields

Implementations

impl UVec3[src]

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

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

pub fn unit_x() -> Self[src]

pub fn unit_y() -> Self[src]

pub fn unit_z() -> Self[src]

pub fn cross(&self, other: UVec3) -> Self[src]

pub fn into_homogeneous_point(self) -> UVec4[src]

pub fn into_homogeneous_vector(self) -> UVec4[src]

pub fn from_homogeneous_point(v: UVec4) -> Self[src]

pub fn from_homogeneous_vector(v: UVec4) -> Self[src]

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

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

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

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

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

pub fn mul_add(&self, mul: UVec3, add: UVec3) -> 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(u32) -> u32, [src]

pub fn apply<F>(&mut self, f: F) where F: Fn(u32) -> u32, [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) -> u32[src]

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

pub fn zero() -> Self[src]

pub fn one() -> Self[src]

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

pub fn xyzw(&self) -> UVec4[src]

pub fn layout() -> Layout[src]

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

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

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

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

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

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

Safety

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

Safety

impl UVec3[src]

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

Trait Implementations

impl Add<UVec3> for UVec3[src]

type Output = Self

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

impl AddAssign<UVec3> for UVec3[src]

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

impl Clone for UVec3[src]

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

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

impl Debug for UVec3[src]

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

impl Default for UVec3[src]

fn default() -> UVec3[src]

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

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

impl Div<UVec3> for UVec3[src]

type Output = Self

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

impl Div<u32> for UVec3[src]

type Output = UVec3

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

impl DivAssign<UVec3> for UVec3[src]

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

impl DivAssign<u32> for UVec3[src]

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

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

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

impl From<&'_ (u32, u32, u32)> for UVec3[src]

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

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

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

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

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

impl From<(u32, u32, u32)> for UVec3[src]

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

impl From<UVec3> for Vec3[src]

`impl UVec3`[src]

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

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

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

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

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

`pub fn cross(&self, other: UVec3) -> Self`[src]

`pub fn into_homogeneous_point(self) -> UVec4`[src]

`pub fn into_homogeneous_vector(self) -> UVec4`[src]

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

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

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

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

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

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

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

`pub fn mul_add(&self, mul: UVec3, add: UVec3) -> 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(u32) -> u32,` [src]

`pub fn apply<F>(&mut self, f: F) where F: Fn(u32) -> u32,` [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) -> u32`[src]

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

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

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

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

`pub fn xyzw(&self) -> UVec4`[src]

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

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

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

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

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

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

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

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

`impl UVec3`[src]

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

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

`type Output = Self`

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

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

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

`impl Clone for UVec3`[src]

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

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

`impl Debug for UVec3`[src]

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

`impl Default for UVec3`[src]

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

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

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

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

`type Output = Self`

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

`impl Div<u32> for UVec3`[src]

`type Output = UVec3`

`fn div(self, rhs: u32) -> UVec3`[src]

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

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

`impl DivAssign<u32> for UVec3`[src]

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

`impl From<&'_ [u32; 3]> for UVec3`[src]

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

`impl From<&'_ (u32, u32, u32)> for UVec3`[src]

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

`impl From<&'_ mut [u32; 3]> for UVec3`[src]

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

`impl From<[u32; 3]> for UVec3`[src]

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

`impl From<(u32, u32, u32)> for UVec3`[src]

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

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

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

`impl From<UVec3> for DVec3`[src]

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

`impl From<UVec3> for UVec2`[src]

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

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