Struct embedded_graphics::geometry::Size

source ·
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) -> Size

Creates a size from a width and a height.

source

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

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() -> Size

Creates a size with width and height equal to zero.

source

pub const fn x_axis(self) -> Size

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) -> Size

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 fn saturating_add(self, other: Size) -> Size

Saturating addition.

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

source

pub fn saturating_sub(self, other: Size) -> Size

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: Size) -> Size

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: Size) -> Size

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 fn component_mul(self, other: Size) -> Size

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 fn component_div(self, other: Size) -> Size

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 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 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<(), Error>

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<(), Error>

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 From<&[u32; 2]> for Size

source§

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

Converts to this type from the input type.
source§

impl From<[u32; 2]> for Size

source§

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

Converts to this type from the input type.
source§

impl From<(u32, u32)> for Size

source§

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

Converts to this type from the input type.
source§

impl Hash for Size

source§

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

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) -> Self
where Self: Sized,

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

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

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

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

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

impl PartialEq for Size

source§

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

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

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd 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

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

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

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

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 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 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 StructuralPartialEq for Size

Auto Trait Implementations§

§

impl Freeze for Size

§

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 T
where 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) -> Dst
where T: Cast<Dst>,

Casts the value.
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where 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 Dst
where 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 Dst
where Src: CheckedCast<Dst>,

source§

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

Casts the value.
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where 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 Dst
where Src: OverflowingCast<Dst>,

source§

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

Casts the value.
source§

impl<T> SaturatingAs for T

source§

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

Casts the value.
source§

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

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where 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 T
where 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) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where 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) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
source§

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

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.