Struct Point

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

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

impl Point

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

Creates a point from X and Y coordinates.

pub const fn zero() -> Self

Creates a point with X and Y equal to zero.

pub fn abs(self) -> Self

Remove the sign from a coordinate

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

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

Trait Implementations

impl Add<Size> for Point

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.

impl Add for Point

type Output = Point

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Size> for Point

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.

impl AddAssign for Point

fn add_assign(&mut self, other: Point)

Performs the += operation.

impl Clone for Point

fn clone(&self) -> Point

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Point

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

Formats the value using the given formatter.

impl Default for Point

fn default() -> Point

Returns the “default value” for a type.

impl Div<i32> for Point

type Output = Point

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<i32> for Point

fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

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

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

Converts to this type from the input type.

impl From<&Point> for (i32, i32)

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

Converts to this type from the input type.

impl From<[i32; 2]> for Point

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

Converts to this type from the input type.

impl From<(i32, i32)> for Point

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

Converts to this type from the input type.

impl From<Point> for [i32; 2]

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

Converts to this type from the input type.

impl From<Point> for (i32, i32)

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

Converts to this type from the input type.

impl Hash for Point

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for Point

type Output = i32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Mul<i32> for Point

type Output = Point

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<i32> for Point

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl Neg for Point

type Output = Point

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Point

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Point

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Point

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<Size> for Point

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.

impl Sub for Point

type Output = Point

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Size> for Point

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.

impl SubAssign for Point

fn sub_assign(&mut self, other: Point)

Performs the -= operation.

impl TryFrom<&[u32; 2]> for Point

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<[u32; 2]> for Point

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<(u32, u32)> for Point

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(point: (u32, u32)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Point> for [u32; 2]

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(point: Point) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Point> for (u32, u32)

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(point: Point) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Point

impl Eq for Point

impl StructuralPartialEq for Point

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes