Struct embedded_graphics::primitives::line::Line

pub struct Line<C: PixelColor> {
    pub start: Coord,
    pub end: Coord,
    pub style: Style<C>,
}

Line primitive

Examples

The macro examples make for more concise code.

Create some lines with different styles

use embedded_graphics::prelude::*;
use embedded_graphics::primitives::Line;

// Default line from (10, 20) to (30, 40)
let l1 = Line::new(Coord::new(10, 20), Coord::new(30, 40));

// Line with styled stroke from (50, 20) to (60, 35)
let l2 = Line::new(Coord::new(50, 20), Coord::new(60, 35))
    .stroke(Some(5u8));

// Line with translation applied
let l3 = Line::new(Coord::new(50, 20), Coord::new(60, 35))
    .translate(Coord::new(65, 35));

display.draw(l1);
display.draw(l2);
display.draw(l3);

Fields

start: Coord

Start point

end: Coord

End point

style: Style<C>

Line style

Methods

impl<C> Line<C> where
    C: PixelColor, 

pub fn new(start: Coord, end: Coord) -> Self

Create a new line

Trait Implementations

impl<C: Clone + PixelColor> Clone for Line<C>

fn clone(&self) -> Line<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Copy + PixelColor> Copy for Line<C>

impl<C: Debug + PixelColor> Debug for Line<C>

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

Formats the value using the given formatter.

impl<C> Dimensions for Line<C> where
    C: PixelColor, 

fn top_left(&self) -> Coord

Get the top left corner of the bounding box for an object

fn bottom_right(&self) -> Coord

Get the bottom right corner of the bounding box for an object

fn size(&self) -> UnsignedCoord

Get the width and height for an object

impl<C> Drawable for Line<C> where
    C: PixelColor, 

impl<C> IntoIterator for Line<C> where
    C: PixelColor, 

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = LineIterator<C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, C: PixelColor> IntoIterator for &'a Line<C>

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = LineIterator<C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<C> Primitive for Line<C> where
    C: PixelColor, 

impl<C> Transform for Line<C> where
    C: PixelColor, 

fn translate(&self, by: Coord) -> Self

Translate the line from its current position to a new position by (x, y) pixels, returning a new Line. For a mutating transform, see translate_mut.

let line = Line::new(Coord::new(5, 10), Coord::new(15, 20))
let moved = line.translate(Coord::new(10, 10));

assert_eq!(moved.start, Coord::new(15, 20));
assert_eq!(moved.end, Coord::new(25, 30));

fn translate_mut(&mut self, by: Coord) -> &mut Self

Translate the line from its current position to a new position by (x, y) pixels.

let mut line = Line::new(Coord::new(5, 10), Coord::new(15, 20))
line.translate_mut(Coord::new(10, 10));

assert_eq!(line.start, Coord::new(15, 20));
assert_eq!(line.end, Coord::new(25, 30));

impl<C> WithStyle<C> for Line<C> where
    C: PixelColor, 

fn style(self, style: Style<C>) -> Self

Add a complete style to the object

fn stroke(self, color: Option<C>) -> Self

Set the stroke colour for the object

fn stroke_width(self, width: u8) -> Self

Set the stroke width for the object

fn fill(self, color: Option<C>) -> Self

Set the fill property of the object's style