Struct embedded_graphics::unsignedcoord::UnsignedCoord

pub struct UnsignedCoord(pub u32, pub u32);

2D unsigned coordinate in screen space

As opposed to Coord, this coordinate is unsigned. It is intended for use with Drawable iterators to output valid display pixel coordinates, i.e. coordinates that are always positive.

use embedded_graphics::{unsignedcoord::UnsignedCoord, ucoord};

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

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

assert_eq!(c1, c2);

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

Methods

impl UnsignedCoord

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

Create a new coordinate with X and Y values

Trait Implementations

impl Add<UnsignedCoord> for UnsignedCoord

type Output = UnsignedCoord

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<UnsignedCoord> for UnsignedCoord

fn add_assign(&mut self, other: UnsignedCoord)

Performs the += operation.

impl Clone for UnsignedCoord

fn clone(&self) -> UnsignedCoord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for UnsignedCoord

impl Debug for UnsignedCoord

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

Formats the value using the given formatter.

impl Eq for UnsignedCoord

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

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

Performs the conversion.

impl<'_> From<&'_ UnsignedCoord> for (u32, u32)

fn from(other: &UnsignedCoord) -> (u32, u32)

Performs the conversion.

impl From<[u32; 2]> for UnsignedCoord

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

Performs the conversion.

impl From<(u32, u32)> for UnsignedCoord

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

Performs the conversion.

impl From<UnsignedCoord> for (u32, u32)

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

Performs the conversion.

impl Index<usize> for UnsignedCoord

type Output = u32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Neg for UnsignedCoord

type Output = Coord

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<UnsignedCoord> for UnsignedCoord

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

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

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

This method tests for !=.

impl StructuralEq for UnsignedCoord

impl StructuralPartialEq for UnsignedCoord

impl Sub<UnsignedCoord> for UnsignedCoord

type Output = UnsignedCoord

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<UnsignedCoord> for UnsignedCoord

fn sub_assign(&mut self, other: UnsignedCoord)

Performs the -= operation.

impl ToSigned for UnsignedCoord

fn to_signed(self) -> Coord

Convert self into a signed Coord