embedded-graphics 0.6.0-alpha.1

Embedded graphics library for small hardware displays

Embedded graphics

This crate aims to make drawing 2D graphics primitives super easy. It currently supports the following:

You can also add your own objects by implementing IntoIterator<Item = Pixel<C>> to create an iterator that Drawing#draw() can consume.

A core goal is to do the above without using any buffers; the crate should work without a dynamic memory allocator and without pre-allocating large chunks of memory. To achieve this, it takes an Iterator based approach, where pixel values and positions are calculated on the fly, with the minimum of saved state. This allows the consuming application to use far less RAM at little to no performance penalty.

Supported displays

These are just some of the displays the community has added embedded_graphics support to. This list is taken from the dependent crates list on crates.io so might be missing some unpublished entries. Please open an issue if there's a display driver that should be added to this list.

  • ili9341: A platform agnostic driver to interface with the ILI9341 (and ILI9340C) TFT LCD display
  • ls010b7dh01: A platform agnostic driver for the LS010B7DH01 memory LCD display
  • sh1106: I2C driver for the SH1106 OLED display
  • ssd1306: I2C and SPI (4 wire) driver for the SSD1306 OLED display
  • ssd1322: Pure Rust driver for the SSD1322 OLED display chip
  • ssd1331: SPI (4 wire) driver for the SSD1331 OLED display
  • ssd1351: SSD1351 driver
  • ssd1675: Rust driver for the Solomon Systech SSD1675 e-Paper display (EPD) controller
  • st7735-lcd: Rust library for displays using the ST7735 driver

Simulator

Embedded graphics comes with a simulator!

It can display all sorts of embedded-graphics test code.

Take a look at the simulator examples to see what embedded_graphics can do, and how it might look on a display. You can run the examples like this:

git clone https://github.com/jamwaffles/embedded-graphics.git
cd embedded-graphics

cargo run -p embedded-graphics-simulator --example hello

Crate features

Add these to your Cargo.toml to turn on extra bits of functionality.

  • nalgebra_support - use the Nalgebra crate with no_std support to use as the Coord type. This should allow you to use most Nalgebra methods on objects rendered by embedded_graphics.
  • bmp - use the TinyBMP crate for BMP image support.
  • tga - use the TinyTGA crate for TGA image support.

Examples

Draw a circle and some text

This example uses the Circle primitive and the Font6x8 font to draw a filled circle and some text over it on the screen.

use embedded_graphics::prelude::*;
use embedded_graphics::primitives::Circle;
use embedded_graphics::fonts::Font6x8;
use embedded_graphics::pixelcolor::Rgb565;
# use embedded_graphics::mock_display::MockDisplay;
# let mut display = MockDisplay::default();

let c = Circle::new(Coord::new(20, 20), 8).fill(Some(Rgb565::RED));
let t = Font6x8::render_str("Hello Rust!").fill(Some(Rgb565::GREEN)).translate(Coord::new(20, 16));

display.draw(c);
display.draw(t);

Draw a circle and some text

To make life even easier, some handy macros are provided for drawing styled primitives and text. Converting the example above, we get this:

use embedded_graphics::prelude::*;
use embedded_graphics::pixelcolor::Rgb565;
use embedded_graphics::{text_6x8, egcircle, icoord};
# use embedded_graphics::mock_display::MockDisplay;
# let mut display = MockDisplay::default();

let c = egcircle!((20, 20), 8, fill = Some(Rgb565::RED));
let t = text_6x8!("Hello Rust!", fill = Some(Rgb565::GREEN)).translate(icoord!(20, 16));

display.draw(c);
display.draw(t);

Chaining

Items can be chained to build more complex graphics objects.

use embedded_graphics::prelude::*;
use embedded_graphics::pixelcolor::Rgb565;
use embedded_graphics::{text_6x8, egcircle, icoord, egrectangle};
# use embedded_graphics::mock_display::MockDisplay;

fn build_thing(text: &'static str) -> impl Iterator<Item = Pixel<Rgb565>> {
egrectangle!((0, 0), (40, 40)).into_iter()
.chain(egcircle!((20, 20), 8, fill = Some(Rgb565::RED)))
.chain(text_6x8!(text, fill = Some(Rgb565::GREEN)).translate(icoord!(20, 16)))
}

fn main() {
# let mut display = MockDisplay::default();
display.draw(build_thing("Hello Rust!"));
}

Implementing embedded_graphics in a driver

To add support for embedded_graphics to a display driver, Drawing (and if possible SizedDrawing) should be implemented. This allows all embedded_graphics objects to be rendered by the display. See their respective docs for implementation details.