Struct ultraviolet::int::Vec2u

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

A set of two coordinates which may be interpreted as a vector or point in 2d space.

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

Methods

impl Vec2u

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

pub fn broadcast(val: u32) -> Self

pub fn unit_x() -> Self

pub fn unit_y() -> Self

pub fn into_homogeneous_point(self) -> Vec3u

Create a homogeneous 2d 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) -> Vec3u

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

pub fn from_homogeneous_point(v: Vec3u) -> Self

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

pub fn from_homogeneous_vector(v: Vec3u) -> Self

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

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

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

pub fn mag(&self) -> u32

pub fn mag_sq(&self) -> u32

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

pub fn apply<F>(&mut self, f: F) where
    F: Fn(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 xyz(&self) -> Vec3u

pub fn xyzw(&self) -> Vec4u

pub fn layout() -> Layout

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

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

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.

Trait Implementations

impl Add<Vec2u> for Vec2u

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vec2u> for Vec2u

fn add_assign(&mut self, rhs: Vec2u)

Performs the += operation.

impl Clone for Vec2u

fn clone(&self) -> Vec2u

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec2u

impl Debug for Vec2u

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

Formats the value using the given formatter.

impl Default for Vec2u

fn default() -> Vec2u

Returns the "default value" for a type.

impl Div<Vec2u> for Vec2u

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<u32> for Vec2u

type Output = Vec2u

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<Vec2u> for Vec2u

fn div_assign(&mut self, rhs: Vec2u)

Performs the /= operation.

impl DivAssign<u32> for Vec2u

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl Eq for Vec2u

impl<'_> From<&'_ [u32; 2]> for Vec2u

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

Performs the conversion.

impl<'_> From<&'_ (u32, u32)> for Vec2u

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

Performs the conversion.

impl<'_> From<&'_ mut [u32; 2]> for Vec2u

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

Performs the conversion.

impl From<[u32; 2]> for Vec2u

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

Performs the conversion.

impl From<(u32, u32)> for Vec2u

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

Performs the conversion.

impl From<Vec2u> for (u32, u32)

fn from(v: Vec2u) -> Self

Performs the conversion.

impl From<Vec3u> for Vec2u

fn from(vec: Vec3u) -> Self

Performs the conversion.

impl Hash for Vec2u

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, 

Feeds a slice of this type into the given [Hasher].

impl Index<usize> for Vec2u

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 Vec2u

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

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

impl Into<[u32; 2]> for Vec2u

fn into(self) -> [u32; 2]

Performs the conversion.

impl Mul<Vec2u> for Vec2u

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2u> for u32

type Output = Vec2u

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u32> for Vec2u

type Output = Vec2u

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Vec2u> for Vec2u

fn mul_assign(&mut self, rhs: Vec2u)

Performs the *= operation.

impl MulAssign<u32> for Vec2u

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation.

impl PartialEq<Vec2u> for Vec2u

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

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

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

This method tests for !=.

impl StructuralEq for Vec2u

impl StructuralPartialEq for Vec2u

impl Sub<Vec2u> for Vec2u

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Vec2u> for Vec2u

fn sub_assign(&mut self, rhs: Vec2u)

Performs the -= operation.