Struct embedded_graphics_core::geometry::Size [−][src]
pub struct Size { pub width: u32, pub height: u32, }
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
impl Size
[src]
impl Size
[src]pub const fn new(width: u32, height: u32) -> Self
[src]
Creates a size from a width and a height.
pub const fn new_equal(value: u32) -> Self
[src]
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 } );
pub const fn zero() -> Self
[src]
Creates a size with width and height equal to zero.
pub const fn x_axis(self) -> Self
[src]
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));
pub const fn y_axis(self) -> Self
[src]
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));
pub fn saturating_add(self, other: Self) -> Self
[src]
Saturating addition.
Returns u32::max_value()
for width
and/or height
instead of overflowing.
pub fn saturating_sub(self, other: Self) -> Self
[src]
Saturating subtraction.
Returns 0
for width
and/or height
instead of overflowing, if the
value in other
is larger then in self
.
pub fn component_min(self, other: Self) -> Self
[src]
Returns the componentwise minimum of two Size
s.
use embedded_graphics::geometry::Size; let min = Size::new(20, 30).component_min(Size::new(15, 50)); assert_eq!(min, Size::new(15, 30));
pub fn component_max(self, other: Self) -> Self
[src]
Returns the componentwise maximum of two Size
s.
use embedded_graphics::geometry::Size; let min = Size::new(20, 30).component_max(Size::new(15, 50)); assert_eq!(min, Size::new(20, 50));
pub fn component_mul(self, other: Self) -> Self
[src]
Returns the componentwise multiplication of two Size
s.
use embedded_graphics::geometry::Size; let result = Size::new(20, 30).component_mul(Size::new(2, 3)); assert_eq!(result, Size::new(40, 90));
pub fn component_div(self, other: Self) -> Self
[src]
Returns the componentwise division of two Size
s.
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
impl AddAssign<Size> for Point
[src]
impl AddAssign<Size> for Point
[src]fn add_assign(&mut self, other: Size)
[src]
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.
impl Clone for Size
[src]
impl Clone for Size
[src]fn clone(&self) -> Size
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl DivAssign<u32> for Size
[src]
impl DivAssign<u32> for Size
[src]fn div_assign(&mut self, rhs: u32)
[src]
impl<N> From<&'_ Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Size where
N: Into<u32> + Scalar + Copy,
[src]
impl<N> From<&'_ Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Size where
N: Into<u32> + Scalar + Copy,
[src]impl<N> From<Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Size where
N: Into<u32> + Scalar + Copy,
[src]
impl<N> From<Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Size where
N: Into<u32> + Scalar + Copy,
[src]impl MulAssign<u32> for Size
[src]
impl MulAssign<u32> for Size
[src]fn mul_assign(&mut self, rhs: u32)
[src]
impl PartialOrd<Size> for Size
[src]
impl PartialOrd<Size> for Size
[src]impl StructuralEq for Size
[src]
impl StructuralEq for Size
[src]impl StructuralPartialEq for Size
[src]
impl StructuralPartialEq for Size
[src]Auto Trait Implementations
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Scalar for T where
T: Copy + PartialEq<T> + Debug + Any,
[src]
impl<T> Scalar for T where
T: Copy + PartialEq<T> + Debug + Any,
[src]pub fn inlined_clone(&self) -> T
[src]
pub fn is<T>() -> bool where
T: Scalar,
[src]
T: Scalar,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn is_in_subset(&self) -> bool
pub fn to_subset_unchecked(&self) -> SS
pub fn from_subset(element: &SS) -> SP
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,