[−][src]Struct embedded_graphics::geometry::Point
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
[src]
pub const fn new(x: i32, y: i32) -> Point
[src]
Creates a point from X and Y coordinates.
pub const fn new_equal(value: i32) -> Point
[src]
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 });
pub const fn zero() -> Point
[src]
Creates a point with X and Y equal to zero.
pub const fn x_axis(self) -> Point
[src]
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));
pub const fn y_axis(self) -> Point
[src]
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));
pub const fn abs(self) -> Point
[src]
Remove the sign from a coordinate
Examples
let point = Point::new(-5, -10); assert_eq!(point.abs(), Point::new(5, 10));
pub fn component_min(self, other: Point) -> Point
[src]
Returns the componentwise minimum of two Point
s
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));
pub fn component_max(self, other: Point) -> Point
[src]
Returns the componentwise maximum of two Point
s
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));
pub fn component_mul(self, other: Point) -> Point
[src]
Returns the componentwise multiplication of two Point
s.
use embedded_graphics::geometry::Point; let result = Point::new(20, 30).component_mul(Point::new(-2, 3)); assert_eq!(result, Point::new(-40, 90));
pub fn component_div(self, other: Point) -> Point
[src]
Returns the componentwise division of two Points
s.
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
impl Add<Point> for Point
[src]
type Output = Point
The resulting type after applying the +
operator.
pub fn add(self, other: Point) -> Point
[src]
impl Add<Size> for Point
[src]
type Output = Point
The resulting type after applying the +
operator.
pub fn add(self, other: Size) -> Point
[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 AddAssign<Point> for Point
[src]
pub fn add_assign(&mut self, other: Point)
[src]
impl AddAssign<Size> for Point
[src]
pub 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 Point
[src]
impl Copy for Point
[src]
impl Debug for Point
[src]
impl Default for Point
[src]
impl Div<i32> for Point
[src]
type Output = Point
The resulting type after applying the /
operator.
pub fn div(self, rhs: i32) -> Point
[src]
impl DivAssign<i32> for Point
[src]
pub fn div_assign(&mut self, rhs: i32)
[src]
impl Eq for Point
[src]
impl<'_> From<&'_ [i32; 2]> for Point
[src]
impl<'_, N> From<&'_ Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Point where
N: Into<i32> + Scalar + Copy,
[src]
N: Into<i32> + Scalar + Copy,
pub fn from(
other: &Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>
) -> Point
[src]
other: &Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>
) -> Point
impl From<[i32; 2]> for Point
[src]
impl From<(i32, i32)> for Point
[src]
impl<N> From<Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Point where
N: Into<i32> + Scalar + Copy,
[src]
N: Into<i32> + Scalar + Copy,
pub fn from(
other: Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>
) -> Point
[src]
other: Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>
) -> Point
impl Hash for Point
[src]
pub fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
__H: Hasher,
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Index<usize> for Point
[src]
impl Mul<i32> for Point
[src]
type Output = Point
The resulting type after applying the *
operator.
pub fn mul(self, rhs: i32) -> Point
[src]
impl MulAssign<i32> for Point
[src]
pub fn mul_assign(&mut self, rhs: i32)
[src]
impl Neg for Point
[src]
type Output = Point
The resulting type after applying the -
operator.
pub fn neg(self) -> <Point as Neg>::Output
[src]
impl Ord for Point
[src]
pub fn cmp(&self, other: &Point) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Point> for Point
[src]
impl PartialOrd<Point> for Point
[src]
pub fn partial_cmp(&self, other: &Point) -> Option<Ordering>
[src]
pub fn lt(&self, other: &Point) -> bool
[src]
pub fn le(&self, other: &Point) -> bool
[src]
pub fn gt(&self, other: &Point) -> bool
[src]
pub fn ge(&self, other: &Point) -> bool
[src]
impl StructuralEq for Point
[src]
impl StructuralPartialEq for Point
[src]
impl Sub<Point> for Point
[src]
type Output = Point
The resulting type after applying the -
operator.
pub fn sub(self, other: Point) -> Point
[src]
impl Sub<Size> for Point
[src]
type Output = Point
The resulting type after applying the -
operator.
pub fn sub(self, other: Size) -> Point
[src]
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<Point> for Point
[src]
pub fn sub_assign(&mut self, other: Point)
[src]
impl SubAssign<Size> for Point
[src]
pub fn sub_assign(&mut self, other: Size)
[src]
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<'_> TryFrom<&'_ [u32; 2]> for Point
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
point: &[u32; 2]
) -> Result<Point, <Point as TryFrom<&'_ [u32; 2]>>::Error>
[src]
point: &[u32; 2]
) -> Result<Point, <Point as TryFrom<&'_ [u32; 2]>>::Error>
impl TryFrom<[u32; 2]> for Point
[src]
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
point: [u32; 2]
) -> Result<Point, <Point as TryFrom<[u32; 2]>>::Error>
[src]
point: [u32; 2]
) -> Result<Point, <Point as TryFrom<[u32; 2]>>::Error>
impl TryFrom<(u32, u32)> for Point
[src]
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, Right> ClosedAdd<Right> for T where
T: Add<Right, Output = T> + AddAssign<Right>,
T: Add<Right, Output = T> + AddAssign<Right>,
impl<T, Right> ClosedDiv<Right> for T where
T: Div<Right, Output = T> + DivAssign<Right>,
T: Div<Right, Output = T> + DivAssign<Right>,
impl<T, Right> ClosedMul<Right> for T where
T: Mul<Right, Output = T> + MulAssign<Right>,
T: Mul<Right, Output = T> + MulAssign<Right>,
impl<T> ClosedNeg for T where
T: Neg<Output = T>,
T: Neg<Output = T>,
impl<T, Right> ClosedSub<Right> for T where
T: Sub<Right, Output = T> + SubAssign<Right>,
T: Sub<Right, Output = T> + SubAssign<Right>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<Src, Dst> LosslessTryInto<Dst> for Src where
Dst: LosslessTryFrom<Src>,
[src]
Dst: LosslessTryFrom<Src>,
pub fn lossless_try_into(self) -> Option<Dst>
[src]
impl<Src, Dst> LossyInto<Dst> for Src where
Dst: LossyFrom<Src>,
[src]
Dst: LossyFrom<Src>,
pub fn lossy_into(self) -> Dst
[src]
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Scalar for T where
T: PartialEq<T> + Copy + Any + Debug,
[src]
T: PartialEq<T> + Copy + Any + Debug,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
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<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,