Struct embedded_graphics::coord::Coord

pub struct Coord(pub i32, pub i32);

2D signed integer coordinate type

This coordinate should be used to define graphics object coordinates. For example, a Rect may be defined that has its top left at (-1,-2). To specify positive-only screen coordinates and the like, see UnsignedCoord.

use embedded_graphics::{coord::Coord, icoord};

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

// Create a coord using the handy `icoord` macro
let c2 = icoord!(10, 20);

assert_eq!(c1, c2);

Note that enabling the nalgebra feature will alias Nalgebra's Vector2<i32> type to Coord instead of this builtin implementation.

Methods

impl Coord

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

Create a new coordinate with X and Y values

pub fn clamp_positive(&self) -> Self

Clamp coordinate components to positive integer range

let coord = Coord::new(-5, 10);

assert_eq!(coord.clamp_positive(), Coord::new(0, 10));

pub fn abs(&self) -> Self

Remove the sign from a coordinate

let coord = Coord::new(-5, -10);

assert_eq!(coord.abs(), Coord::new(5, 10));

Trait Implementations

impl Add<Coord> for Coord

type Output = Coord

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Coord> for Coord

fn add_assign(&mut self, other: Coord)

Performs the += operation.

impl Clone for Coord

fn clone(&self) -> Coord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Coord

impl Debug for Coord

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

Formats the value using the given formatter.

impl Eq for Coord

impl<'_> From<&'_ [i32; 2]> for Coord

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

Performs the conversion.

impl<'_> From<&'_ [u32; 2]> for Coord

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

Performs the conversion.

impl<'_> From<&'_ Coord> for (i32, i32)

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

Performs the conversion.

impl From<[i32; 2]> for Coord

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

Performs the conversion.

impl From<[u32; 2]> for Coord

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

Performs the conversion.

impl From<(i32, i32)> for Coord

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

Performs the conversion.

impl From<(u32, u32)> for Coord

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

Performs the conversion.

impl From<Coord> for (i32, i32)

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

Performs the conversion.

impl Index<usize> for Coord

type Output = i32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Neg for Coord

type Output = Coord

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<Coord> for Coord

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Coord

impl StructuralPartialEq for Coord

impl Sub<Coord> for Coord

type Output = Coord

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Coord> for Coord

fn sub_assign(&mut self, other: Coord)

Performs the -= operation.

impl ToUnsigned for Coord

fn to_unsigned(self) -> UnsignedCoord

Convert to a positive-only coordinate, clamping negative values to zero

let coord = Coord::new(-5, 10);

assert_eq!(coord.to_unsigned(), UnsignedCoord::new(0, 10));