Struct LedCanvas 

pub struct LedCanvas { /* private fields */ }

The Rust handle for the matrix canvas to draw on.

use pi_led_matrix::{LedMatrix, LedColor};
let matrix = LedMatrix::new(None, None).unwrap();
let mut canvas = matrix.canvas();
canvas.fill(&LedColor { red: 128, green: 128, blue: 128 });

Implementations

impl LedCanvas

pub fn canvas_size(&self) -> (i32, i32)

Retrieves the width & height of the canvas

pub fn set(&mut self, x: i32, y: i32, color: &LedColor)

Sets the pixel at the given coordinate to the given color.

pub fn clear(&mut self)

Clears the canvas.

pub fn fill(&mut self, color: &LedColor)

Fills the canvas with the given color.

pub fn draw_line( &mut self, x0: i32, y0: i32, x1: i32, y1: i32, color: &LedColor, )

Draws a straight, one pixel wide line using the C++ library.

Consider using embedded-graphics for more drawing features.

pub fn draw_circle(&mut self, x: i32, y: i32, radius: u32, color: &LedColor)

Draws a one pixel wide circle using the C++ library.

Consider using embedded-graphics for more drawing features.

pub fn draw_text( &mut self, font: &LedFont, text: &str, x: i32, y: i32, color: &LedColor, kerning_offset: i32, vertical: bool, ) -> i32

Renders text using the C++ library.

Panics

If the given text fails to convert to a CString. This can occur when there is a null character mid way in the string.

Trait Implementations

impl Dimensions for LedCanvas

Available on crate feature embeddedgraphics only.

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

impl DrawTarget for LedCanvas

Available on crate feature embeddedgraphics only.

type Color = Rgb888

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

impl Send for LedCanvas

Implements both the Send and Sync traits for LedCanvas.

The underlying handle referenced by this FFI is heap-allocated, allowing safe ownership transfer between threads. Additionally, references to this handle can be safely shared across thread boundaries.

impl Sync for LedCanvas