pub struct Point {
    pub x: i32,
    pub y: i32,
}
Expand description

2D point.

A point can be used to define the position of a graphics object. For example, a Rectangle may be defined that has its top left corner at (-1, -2). To specify the size of an object Size should be used instead.

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

Examples

Create a Point from two integers

use embedded_graphics::geometry::Point;

// Create a coord using the `new` constructor method
let p = Point::new(10, 20);

Create a Point from a Nalgebra Vector2

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

use embedded_graphics::geometry::Point;
use nalgebra::Vector2;

let n_coord = Vector2::new(10i32, 20);

assert_eq!(Point::from(n_coord), Point::new(10, 20));

Convert a Vector2<u8> into a Point

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

Smaller unsigned types that can be converted to i32 are also supported in conversions.

use embedded_graphics::geometry::Point;
use nalgebra::Vector2;

let n_coord = Vector2::new(10u8, 20);

assert_eq!(Point::from(n_coord), Point::new(10, 20));

Fields§

§x: i32

The x coordinate.

§y: i32

The y coordinate.

Implementations§

source§

impl Point

source

pub const fn new(x: i32, y: i32) -> Point

Creates a point from X and Y coordinates.

source

pub const fn new_equal(value: i32) -> Point

Creates a point with X and Y values set to an equal value.

Examples
use embedded_graphics::geometry::Point;

let point = Point::new_equal(11);

assert_eq!(point, Point { x: 11, y: 11 });
source

pub const fn zero() -> Point

Creates a point with X and Y equal to zero.

source

pub const fn x_axis(self) -> Point

Returns a point with equal x value and y set to 0.

Examples
Move a Point along the X axis.
use embedded_graphics::geometry::Point;

let translate = Point::new(20, 30);

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

let moved_x = point + translate.x_axis();

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

pub const fn y_axis(self) -> Point

Returns a point with equal y value and x set to 0.

Examples
Move a Point along the Y axis.
use embedded_graphics::geometry::Point;

let translate = Point::new(20, 30);

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

let moved_y = point + translate.y_axis();

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

pub const fn abs(self) -> Point

Remove the sign from a coordinate

Examples
let point = Point::new(-5, -10);

assert_eq!(point.abs(), Point::new(5, 10));
source

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

Returns the componentwise minimum of two Points

Examples
use embedded_graphics::geometry::Point;

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

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

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

Returns the componentwise maximum of two Points

Examples
use embedded_graphics::geometry::Point;

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

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

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

Returns the componentwise multiplication of two Points.

use embedded_graphics::geometry::Point;

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

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

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

Returns the componentwise division of two Pointss.

Panics

Panics if one of the components of other equals zero.

use embedded_graphics::geometry::Point;

let result = Point::new(20, 30).component_div(Point::new(10, -3));

assert_eq!(result, Point::new(2, -10));

Trait Implementations§

source§

impl Add<Point> for Point

§

type Output = Point

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
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 AddAssign<Point> for Point

source§

fn add_assign(&mut self, other: Point)

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 Clone for Point

source§

fn clone(&self) -> Point

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 Point

source§

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

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

impl Default for Point

source§

fn default() -> Point

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

impl Display for Point

source§

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

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

impl Div<i32> for Point

§

type Output = Point

The resulting type after applying the / operator.
source§

fn div(self, rhs: i32) -> Point

Performs the / operation. Read more
source§

impl DivAssign<i32> for Point

source§

fn div_assign(&mut self, rhs: i32)

Performs the /= operation. Read more
source§

impl Format for Point

source§

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

Writes the defmt representation of self to fmt.
source§

impl From<&[i32; 2]> for Point

source§

fn from(other: &[i32; 2]) -> Point

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 Pointwhere N: Into<i32> + Scalar + Copy,

source§

fn from( other: &Matrix<N, Const<nalgebra::::base::dimension::U2::{constant#0}>, Const<1>, ArrayStorage<N, 2, 1>> ) -> Point

Converts to this type from the input type.
source§

impl From<[i32; 2]> for Point

source§

fn from(other: [i32; 2]) -> Point

Converts to this type from the input type.
source§

impl From<(i32, i32)> for Point

source§

fn from(other: (i32, i32)) -> Point

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 Pointwhere N: Into<i32> + Scalar + Copy,

source§

fn from( other: Matrix<N, Const<nalgebra::::base::dimension::U2::{constant#0}>, Const<1>, ArrayStorage<N, 2, 1>> ) -> Point

Converts to this type from the input type.
source§

impl Hash for Point

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 Point

§

type Output = i32

The returned type after indexing.
source§

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

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

impl Mul<i32> for Point

§

type Output = Point

The resulting type after applying the * operator.
source§

fn mul(self, rhs: i32) -> Point

Performs the * operation. Read more
source§

impl MulAssign<i32> for Point

source§

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation. Read more
source§

impl Neg for Point

§

type Output = Point

The resulting type after applying the - operator.
source§

fn neg(self) -> <Point as Neg>::Output

Performs the unary - operation. Read more
source§

impl Ord for Point

source§

fn cmp(&self, other: &Point) -> 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<Point> for Point

source§

fn eq(&self, other: &Point) -> 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<Point> for Point

source§

fn partial_cmp(&self, other: &Point) -> 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<Point> for Point

§

type Output = Point

The resulting type after applying the - operator.
source§

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

Performs the - operation. 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 SubAssign<Point> for Point

source§

fn sub_assign(&mut self, other: Point)

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 TryFrom<&[u32; 2]> for Point

§

type Error = TryFromIntError

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

fn try_from( point: &[u32; 2] ) -> Result<Point, <Point as TryFrom<&[u32; 2]>>::Error>

Performs the conversion.
source§

impl TryFrom<[u32; 2]> for Point

§

type Error = TryFromIntError

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

fn try_from( point: [u32; 2] ) -> Result<Point, <Point as TryFrom<[u32; 2]>>::Error>

Performs the conversion.
source§

impl TryFrom<(u32, u32)> for Point

§

type Error = TryFromIntError

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

fn try_from( point: (u32, u32) ) -> Result<Point, <Point as TryFrom<(u32, u32)>>::Error>

Performs the conversion.
source§

impl Copy for Point

source§

impl Eq for Point

source§

impl StructuralEq for Point

source§

impl StructuralPartialEq for Point

Auto Trait Implementations§

§

impl RefUnwindSafe for Point

§

impl Send for Point

§

impl Sync for Point

§

impl Unpin for Point

§

impl UnwindSafe for Point

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<Src, Dst> LosslessTryInto<Dst> for Srcwhere Dst: LosslessTryFrom<Src>,

source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
source§

impl<Src, Dst> LossyInto<Dst> for Srcwhere Dst: LossyFrom<Src>,

source§

fn lossy_into(self) -> Dst

Performs the conversion.
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> ClosedNeg for Twhere T: Neg<Output = T>,

§

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,