[−][src]Crate embedded_graphics

Embedded-graphics is a 2D graphics library that is focused on memory constrained embedded devices.

A core goal of embedded-graphics is to draw graphics without using any buffers; the crate is no_std compatible and works without a dynamic memory allocator, and without pre-allocating large chunks of memory. To achieve this, it takes an Iterator based approach, where pixel colors 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.

It contains built in items that make it easy to draw 2D graphics primitives:

Additional functions provided by external crates

Embedded-graphics is designed to be extended by the application or other crates. Examples of this are adding support for different image formats or implementing custom fonts.

Note that some of these crates may not support the latest version of embedded-graphics.

If you know of a crate that is not in this list, please open an issue to add it.

Display drivers

To support many different kinds of display, embedded-graphics doesn't include any drivers directly but provides the DrawTarget API in [embedded-graphics-core] that can be implemented by external crates. In addition to the drivers for real displays, the simulator can be used to test code during development.

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.

Note that some drivers may not support the latest version of embedded-graphics.

embedded-graphics-web-simulator: Simulated display in your browser via Webassembly
epd-waveshare Driver for various ePaper displays (EPD) from Waveshare
hub75: A rust driver for hub75 rgb matrix displays
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
ssd1309: I2C/SPI driver for the SSD1309 OLED display written in 100% Rust.
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
st7789: A Rust driver library for ST7789 displays
st7920: ST7920 LCD driver in Rust

Simulator

Embedded graphics comes with a simulator! The simulator can be used to test and debug embedded graphics code, or produce examples and interactive demos to show of embedded graphics features.

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/embedded-graphics/embedded-graphics.git
cd embedded-graphics

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

Crate features

Additional features can be enabled by adding the following features to your Cargo.toml.

nalgebra_support - use the Nalgebra crate with no_std support to enable conversions from nalgebra::Vector2 to Point and Size.
fixed_point - use fixed point arithmetic instead of floating point for all trigonometric calculation.

Migrating from 0.5 to 0.6

Please read the migration guide.

Implementing `embedded_graphics` support for a display driver

To add support for embedded-graphics to a display driver, DrawTarget from [embedded-graphics-core] must be implemented. This allows all embedded-graphics items to be rendered by the display. See the DrawTarget documentation for implementation details.

Examples

Drawing examples

Example usage of drawing primitives, text and images with embedded-graphics can be found here.

Shapes and text

The following example draws some shapes and text to a MockDisplay in place of target hardware. The simulator can also be used for debugging, development or if hardware is not available.

use embedded_graphics::{
    fonts::{Font6x8, Text},
    pixelcolor::BinaryColor,
    prelude::*,
    primitives::{Circle, Rectangle, Triangle},
    style::{PrimitiveStyle, MonoTextStyle},
    mock_display::MockDisplay,
};

fn main() -> Result<(), std::convert::Infallible> {
    // Create a new mock display
    let mut display: MockDisplay<BinaryColor> = MockDisplay::new();

    // Create styles used by the drawing operations.
    let thin_stroke = PrimitiveStyle::with_stroke(BinaryColor::On, 1);
    let thick_stroke = PrimitiveStyle::with_stroke(BinaryColor::On, 3);
    let fill = PrimitiveStyle::with_fill(BinaryColor::On);
    let text_style = MonoTextStyle::new(Font6x8, BinaryColor::On);

    let yoffset = 10;

    // Draw a 3px wide outline around the display.
    let display_size = display.size() - Size::new(1, 1);
    Rectangle::new(Point::zero(), display_size)
        .into_styled(thick_stroke)
        .draw(&mut display)?;

    // Draw a triangle.
    Triangle::new(
        Point::new(16, 16 + yoffset),
        Point::new(16 + 16, 16 + yoffset),
        Point::new(16 + 8, yoffset),
    )
    .into_styled(thin_stroke)
    .draw(&mut display)?;

    // Draw a filled square
    Rectangle::new(Point::new(52, yoffset), Size::new(16, 16))
        .into_styled(fill)
        .draw(&mut display)?;

    // Draw a circle with a 3px wide stroke.
    Circle::new(Point::new(88, yoffset), 17)
        .into_styled(thick_stroke)
        .draw(&mut display)?;

    // Draw centered text.
    let text = "embedded-graphics";
    let width = text.len() as i32 * 6;
    Text::new(text, Point::new(64 - width / 2, 40))
        .into_styled(text_style)
        .draw(&mut display)?;

    Ok(())
}

This example is also included in the simulator crate and can be run using cargo run --example hello-world. It produces this output:

Embedded Graphics Simulator example screenshot

Additional examples can be found in the simulator crate.

Chaining

Items can be chained to build more complex graphics objects.

use embedded_graphics::{
    fonts::{Font6x8, Text},
    mock_display::MockDisplay,
    pixelcolor::Rgb565,
    prelude::*,
    primitives::{Circle, Rectangle},
    style::{PrimitiveStyle, MonoTextStyle},
};

fn build_thing(text: &'static str) -> impl Iterator<Item = Pixel<Rgb565>> {
    Rectangle::new(Point::new(0, 0), Size::new(40, 40))
        .into_styled(PrimitiveStyle::with_stroke(Rgb565::CYAN, 1))
        .into_pixels()
        .chain(
            Circle::new(Point::new(12, 12), 17)
                .into_styled(PrimitiveStyle::with_fill(Rgb565::RED))
                .into_pixels(),
        )
        .chain(
            Text::new(text, Point::new(20, 16))
                .into_styled(MonoTextStyle::new(Font6x8, Rgb565::GREEN))
                .into_pixels(),
        )
}

build_thing("Hello Rust!").draw(&mut display)?;

Modules

draw_target	A target for embedded-graphics drawing operations.
fonts	Monospaced bitmap fonts.
geometry	Geometry module.
image	Image support for embedded-graphics
iterator	Iterators.
mock_display	Mock display for use in tests.
pixelcolor	Pixel color types.
prelude	Prelude
primitives	Graphics primitives
style	Styling struct to customize the look of objects.
transform	Transformations for graphics objects

Structs

Pixel

A single pixel.

Traits

Drawable

Marks an object as "drawable". Must be implemented for all graphics objects