Struct embedded_graphics::primitives::line::Line

pub struct Line {
    pub start: Point,
    pub end: Point,
}

Line primitive

Examples

The macro examples make for more concise code.

Create some lines with different styles

use embedded_graphics::{
    pixelcolor::Rgb565, prelude::*, primitives::Line, style::PrimitiveStyle,
};

// Red 1 pixel wide line from (50, 20) to (60, 35)
Line::new(Point::new(50, 20), Point::new(60, 35))
    .into_styled(PrimitiveStyle::with_stroke(Rgb565::RED, 1))
    .draw(&mut display)?;

// Green 10 pixel wide line with translation applied
Line::new(Point::new(50, 20), Point::new(60, 35))
    .translate(Point::new(65, 35))
    .into_styled(PrimitiveStyle::with_stroke(Rgb565::GREEN, 10))
    .draw(&mut display)?;

Fields

start: Point

Start point

end: Point

End point

Methods

impl Line

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

Create a new line

Trait Implementations

impl Clone for Line

fn clone(&self) -> Line

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Line

impl Debug for Line

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

Formats the value using the given formatter.

impl Default for Line

fn default() -> Line

Returns the "default value" for a type.

impl Dimensions for Line

fn top_left(&self) -> Point

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

fn bottom_right(&self) -> Point

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

fn size(&self) -> Size

Get the width and height for an object

impl Eq for Line

impl Hash for Line

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Line

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Line> for Line

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

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

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

This method tests for !=.

impl PartialOrd<Line> for Line

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Primitive for Line

fn into_styled<C>(
    self,
    style: PrimitiveStyle<C>
) -> Styled<Self, PrimitiveStyle<C>> where
    C: PixelColor,
    Self: Sized, 

Converts this primitive into a Styled.

impl StructuralEq for Line

impl StructuralPartialEq for Line

impl Transform for Line

fn translate(&self, by: Point) -> 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(Point::new(5, 10), Point::new(15, 20));
let moved = line.translate(Point::new(10, 10));

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

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

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

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

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