pub struct Size {
    pub width: u32,
    pub height: u32,
}
Expand description

2D size.

Size is used to define the width and height of an object.

Nalgebra support can be enabled with the nalgebra_support feature. This implements From<Vector2<N>> and From<&Vector2<N>> where N is Scalar + Into<u32>. This allows use of Nalgebra’s Vector2 with embedded-graphics where u32, u16 or u8 is used for value storage.

Examples

Create a Size from two integers

use embedded_graphics::geometry::Size;

// Create a size using the `new` constructor method
let s = Size::new(10, 20);

Create a Size from a Nalgebra Vector2

Be sure to enable the nalgebra_support feature to get Nalgebra integration.

Any Vector2<N> can be used where N: Into<u32> + nalgebra::Scalar. This includes the primitive types u32, u16 and u8.

use embedded_graphics::geometry::Size;
use nalgebra::Vector2;

assert_eq!(Size::from(Vector2::new(10u32, 20)), Size::new(10u32, 20));
assert_eq!(Size::from(Vector2::new(10u16, 20)), Size::new(10u32, 20));
assert_eq!(Size::from(Vector2::new(10u8, 20)), Size::new(10u32, 20));

.into() can also be used, but may require more type annotations:

use embedded_graphics::geometry::Size;
use nalgebra::Vector2;

let c: Size = Vector2::new(10u32, 20).into();

assert_eq!(c, Size::new(10u32, 20));

Fields§

§width: u32

The width.

§height: u32

The height.

Implementations§

source§

impl Size

source

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

Creates a size from a width and a height.

source

pub const fn new_equal(value: u32) -> Self

Creates a size with width and height set to an equal value.

use embedded_graphics::geometry::Size;

let size = Size::new_equal(11);

assert_eq!(
    size,
    Size {
        width: 11,
        height: 11
    }
);
source

pub const fn zero() -> Self

Creates a size with width and height equal to zero.

source

pub const fn x_axis(self) -> Self

Returns a size with equal width value and height set to 0.

Examples
Move a Point along the X axis.
use embedded_graphics::geometry::{Point, Size};

let size = Size::new(20, 30);

let point = Point::new(10, 15);

let moved_x = point + size.x_axis();

assert_eq!(moved_x, Point::new(30, 15));
source

pub const fn y_axis(self) -> Self

Returns a size with equal height value and width set to 0.

Examples
Move a Point along the Y axis.
use embedded_graphics::geometry::{Point, Size};

let size = Size::new(20, 30);

let point = Point::new(10, 15);

let moved_y = point + size.y_axis();

assert_eq!(moved_y, Point::new(10, 45));
source

pub const fn saturating_add(self, other: Self) -> Self

Saturating addition.

Returns u32::max_value() for width and/or height instead of overflowing.

source

pub const fn saturating_sub(self, other: Self) -> Self

Saturating subtraction.

Returns 0 for width and/or height instead of overflowing, if the value in other is larger then in self.

source

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

Returns the componentwise minimum of two Sizes.

use embedded_graphics::geometry::Size;

let min = Size::new(20, 30).component_min(Size::new(15, 50));

assert_eq!(min, Size::new(15, 30));
source

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

Returns the componentwise maximum of two Sizes.

use embedded_graphics::geometry::Size;

let min = Size::new(20, 30).component_max(Size::new(15, 50));

assert_eq!(min, Size::new(20, 50));
source

pub const fn component_mul(self, other: Self) -> Self

Returns the componentwise multiplication of two Sizes.

use embedded_graphics::geometry::Size;

let result = Size::new(20, 30).component_mul(Size::new(2, 3));

assert_eq!(result, Size::new(40, 90));
source

pub const fn component_div(self, other: Self) -> Self

Returns the componentwise division of two Sizes.

Panics

Panics if one of the components of other equals zero.

use embedded_graphics::geometry::Size;

let result = Size::new(20, 30).component_div(Size::new(5, 10));

assert_eq!(result, Size::new(4, 3));

Trait Implementations§

source§

impl Add<Size> for Point

source§

fn add(self, other: Size) -> Point

Offsets a point by adding a size.

Panics

This function will panic if width or height are too large to be represented as an i32 and debug assertions are enabled.

§

type Output = Point

The resulting type after applying the + operator.
source§

impl Add<Size> for Size

§

type Output = Size

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl AddAssign<Size> for Point

source§

fn add_assign(&mut self, other: Size)

Offsets a point by adding a size.

Panics

This function will panic if width or height are too large to be represented as an i32 and debug assertions are enabled.

source§

impl AddAssign<Size> for Size

source§

fn add_assign(&mut self, other: Size)

Performs the += operation. Read more
source§

impl Clone for Size

source§

fn clone(&self) -> Size

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
source§

impl Debug for Size

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Size

source§

fn default() -> Size

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

impl Display for Size

source§

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

Formats the value using the given formatter. Read more
source§

impl Div<u32> for Size

§

type Output = Size

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl DivAssign<u32> for Size

source§

fn div_assign(&mut self, rhs: u32)

Performs the /= operation. Read more
source§

impl Format for Size

source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.
source§

impl From<&[u32; 2]> for Size

source§

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

Converts to this type from the input type.
source§

impl<N> From<&Matrix<N, Const<nalgebra::::base::dimension::U2::{constant#0}>, Const<1>, ArrayStorage<N, 2, 1>>> for Sizewhere N: Into<u32> + Scalar + Copy,

source§

fn from(other: &Vector2<N>) -> Self

Converts to this type from the input type.
source§

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

source§

fn from(other: &Size) -> (u32, u32)

Converts to this type from the input type.
source§

impl From<[u32; 2]> for Size

source§

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

Converts to this type from the input type.
source§

impl From<(u32, u32)> for Size

source§

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

Converts to this type from the input type.
source§

impl<N> From<Matrix<N, Const<nalgebra::::base::dimension::U2::{constant#0}>, Const<1>, ArrayStorage<N, 2, 1>>> for Sizewhere N: Into<u32> + Scalar + Copy,

source§

fn from(other: Vector2<N>) -> Self

Converts to this type from the input type.
source§

impl From<Size> for [u32; 2]

source§

fn from(other: Size) -> [u32; 2]

Converts to this type from the input type.
source§

impl From<Size> for (u32, u32)

source§

fn from(other: Size) -> (u32, u32)

Converts to this type from the input type.
source§

impl Hash for Size

source§

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
source§

impl Index<usize> for Size

§

type Output = u32

The returned type after indexing.
source§

fn index(&self, idx: usize) -> &u32

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

impl Mul<u32> for Size

§

type Output = Size

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl MulAssign<u32> for Size

source§

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation. Read more
source§

impl Ord for Size

source§

fn cmp(&self, other: &Size) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<Size> for Size

source§

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

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

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.
source§

impl PartialOrd<Size> for Size

source§

fn partial_cmp(&self, other: &Size) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Sub<Size> for Point

source§

fn sub(self, other: Size) -> Point

Offsets a point by subtracting a size.

Panics

This function will panic if width or height are too large to be represented as an i32 and debug assertions are enabled.

§

type Output = Point

The resulting type after applying the - operator.
source§

impl Sub<Size> for Size

§

type Output = Size

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl SubAssign<Size> for Point

source§

fn sub_assign(&mut self, other: Size)

Offsets a point by subtracting a size.

Panics

This function will panic if width or height are too large to be represented as an i32 and debug assertions are enabled.

source§

impl SubAssign<Size> for Size

source§

fn sub_assign(&mut self, other: Size)

Performs the -= operation. Read more
source§

impl Copy for Size

source§

impl Eq for Size

source§

impl StructuralEq for Size

source§

impl StructuralPartialEq for Size

Auto Trait Implementations§

§

impl RefUnwindSafe for Size

§

impl Send for Size

§

impl Sync for Size

§

impl Unpin for Size

§

impl UnwindSafe for Size

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Az for T

source§

fn az<Dst>(self) -> Dstwhere T: Cast<Dst>,

Casts the value.
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<Src, Dst> CastFrom<Src> for Dstwhere Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dstwhere T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
§

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dstwhere T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dstwhere T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
§

impl<T, Right> ClosedAdd<Right> for Twhere T: Add<Right, Output = T> + AddAssign<Right>,

§

impl<T, Right> ClosedDiv<Right> for Twhere T: Div<Right, Output = T> + DivAssign<Right>,

§

impl<T, Right> ClosedMul<Right> for Twhere T: Mul<Right, Output = T> + MulAssign<Right>,

§

impl<T, Right> ClosedSub<Right> for Twhere T: Sub<Right, Output = T> + SubAssign<Right>,

source§

impl<T> Scalar for Twhere T: 'static + Clone + PartialEq<T> + Debug,