Struct euclid::Size2D

#[repr(C)]
pub struct Size2D<T, U> {
    pub width: T,
    pub height: T,
    // some fields omitted
}

A 2d size tagged with a unit.

Fields

width: T

height: T

Methods

impl<T, U> Size2D<T, U>

pub const fn new(width: T, height: T) -> Self

Constructor taking scalar values.

impl<T: Clone, U> Size2D<T, U>

pub fn from_lengths(width: Length<T, U>, height: Length<T, U>) -> Self

Constructor taking scalar strongly typed lengths.

impl<T: Round, U> Size2D<T, U>

pub fn round(&self) -> Self

Rounds each component to the nearest integer value.

This behavior is preserved for negative values (unlike the basic cast).

impl<T: Ceil, U> Size2D<T, U>

pub fn ceil(&self) -> Self

Rounds each component to the smallest integer equal or greater than the original value.

This behavior is preserved for negative values (unlike the basic cast).

impl<T: Floor, U> Size2D<T, U>

pub fn floor(&self) -> Self

Rounds each component to the biggest integer equal or lower than the original value.

This behavior is preserved for negative values (unlike the basic cast).

impl<T: Copy + Clone + Mul<T>, U> Size2D<T, U>

pub fn area(&self) -> T::Output

impl<T, U> Size2D<T, U> where
    T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>, 

pub fn lerp(&self, other: Self, t: T) -> Self

Linearly interpolate between this size and another size.

t is expected to be between zero and one.

impl<T: Zero + PartialOrd, U> Size2D<T, U>

pub fn is_empty_or_negative(&self) -> bool

impl<T: Zero, U> Size2D<T, U>

pub fn zero() -> Self

impl<T: Copy, U> Size2D<T, U>

pub fn to_array(&self) -> [T; 2]

Returns self.width as a Length carrying the unit.

pub fn to_tuple(&self) -> (T, T)

pub fn to_vector(&self) -> Vector2D<T, U>

pub fn to_untyped(&self) -> Size2D<T, UnknownUnit>

Drop the units, preserving only the numeric value.

pub fn from_untyped(p: Size2D<T, UnknownUnit>) -> Self

Tag a unitless value with units.

impl<T: NumCast + Copy, Unit> Size2D<T, Unit>

pub fn cast<NewT: NumCast + Copy>(&self) -> Size2D<NewT, Unit>

Cast from one numeric representation to another, preserving the units.

When casting from floating point to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn try_cast<NewT: NumCast + Copy>(&self) -> Option<Size2D<NewT, Unit>>

Fallible cast from one numeric representation to another, preserving the units.

When casting from floating point to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn to_f32(&self) -> Size2D<f32, Unit>

Cast into an f32 size.

pub fn to_f64(&self) -> Size2D<f64, Unit>

Cast into an f64 size.

pub fn to_usize(&self) -> Size2D<usize, Unit>

Cast into an uint size, truncating decimals if any.

When casting from floating point sizes, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_u32(&self) -> Size2D<u32, Unit>

Cast into an u32 size, truncating decimals if any.

When casting from floating point sizes, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i32(&self) -> Size2D<i32, Unit>

Cast into an i32 size, truncating decimals if any.

When casting from floating point sizes, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i64(&self) -> Size2D<i64, Unit>

Cast into an i64 size, truncating decimals if any.

When casting from floating point sizes, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

impl<T, U> Size2D<T, U> where
    T: Signed, 

pub fn abs(&self) -> Self

pub fn is_positive(&self) -> bool

impl<T: PartialOrd, U> Size2D<T, U>

pub fn greater_than(&self, other: Self) -> BoolVector2D

pub fn lower_than(&self, other: Self) -> BoolVector2D

impl<T: PartialEq, U> Size2D<T, U>

pub fn equal(&self, other: Self) -> BoolVector2D

pub fn not_equal(&self, other: Self) -> BoolVector2D

impl<T: Float, U> Size2D<T, U>

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

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

pub fn clamp(&self, start: Self, end: Self) -> Self

Trait Implementations

impl<T: Zero, U> Zero for Size2D<T, U>

fn zero() -> Self

impl<T, U> From<Size2D<T, U>> for Box2D<T, U> where
    T: Copy + Zero + PartialOrd, 

fn from(b: Size2D<T, U>) -> Self

Performs the conversion.

impl<T, U> From<Size2D<T, U>> for Rect<T, U> where
    T: Copy + Zero, 

fn from(size: Size2D<T, U>) -> Self

Performs the conversion.

impl<T, U> From<Vector2D<T, U>> for Size2D<T, U>

fn from(v: Vector2D<T, U>) -> Self

Performs the conversion.

impl<T: Copy, U> From<[T; 2]> for Size2D<T, U>

fn from(array: [T; 2]) -> Self

Performs the conversion.

impl<T: Copy, U> From<(T, T)> for Size2D<T, U>

fn from(tuple: (T, T)) -> Self

Performs the conversion.

impl<T: Copy, U> From<Size2D<T, U>> for Vector2D<T, U>

fn from(size: Size2D<T, U>) -> Self

Performs the conversion.

impl<T: Display, U> Display for Size2D<T, U>

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

Formats the value using the given formatter.

impl<T: Debug, U> Debug for Size2D<T, U>

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

Formats the value using the given formatter.

impl<T: Copy + Div<T, Output = T>, U> Div<T> for Size2D<T, U>

type Output = Self

The resulting type after applying the / operator.

fn div(self, scale: T) -> Self

Performs the / operation.

impl<T: Copy + Div<T, Output = T>, U1, U2> Div<Scale<T, U1, U2>> for Size2D<T, U2>

type Output = Size2D<T, U1>

The resulting type after applying the / operator.

fn div(self, scale: Scale<T, U1, U2>) -> Size2D<T, U1>

Performs the / operation.

impl<T: Copy + Sub<T, Output = T>, U> Sub<Size2D<T, U>> for Size2D<T, U>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl<T, U> PartialEq<Size2D<T, U>> for Size2D<T, U> where
    T: PartialEq, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T, U> Eq for Size2D<T, U> where
    T: Eq, 

impl<T: Copy + Add<T, Output = T>, U> Add<Size2D<T, U>> for Point2D<T, U>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Size2D<T, U>) -> Self

Performs the + operation.

impl<T: Copy + Add<T, Output = T>, U> Add<Size2D<T, U>> for Size2D<T, U>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl<T: Copy + Mul<T, Output = T>, U> Mul<T> for Size2D<T, U>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, scale: T) -> Self

Performs the * operation.

impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<Scale<T, U1, U2>> for Size2D<T, U1>

type Output = Size2D<T, U2>

The resulting type after applying the * operator.

fn mul(self, scale: Scale<T, U1, U2>) -> Size2D<T, U2>

Performs the * operation.

impl<T, U> Hash for Size2D<T, U> where
    T: Hash, 

fn hash<H: Hasher>(&self, h: &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<T: Copy, U> Copy for Size2D<T, U>

impl<T: Copy, U> Into<[T; 2]> for Size2D<T, U>

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

Performs the conversion.

impl<T: Copy, U> Into<(T, T)> for Size2D<T, U>

fn into(self) -> (T, T)

Performs the conversion.

impl<T: Clone, U> Clone for Size2D<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default, U> Default for Size2D<T, U>

fn default() -> Self

Returns the "default value" for a type.