Upgrade to embedded-graphics 0.6.0 (#6)

* Upgrade to e-g 0.6.0

* Changelog entry

* Install fewer deps

* Fmt

* Add associated error type

* Fix examples

* Fix doc examples

Author: jamwaffles

.circleci/config.yml

@@ -5,8 +5,7 @@ target_steps: &target_steps
     - checkout
     - restore_cache:
         key: v1-ssd1331-{{ .Environment.CIRCLE_JOB }}-{{ checksum "Cargo.toml" }}
-    - run: sudo apt install -qq libsdl2-dev python-pip
-    - run: sudo pip install linkchecker
+    - run: sudo apt install -qq linkchecker
     - run: rustup default ${RUST_VERSION:-stable}
     - run: rustup component add rustfmt
     - run: |
@@ -28,48 +27,48 @@ version: 2
 jobs:
   target-arm-unknown-linux-eabi:
     environment:
-      - TARGET: "arm-unknown-linux-gnueabi"
+      - TARGET: 'arm-unknown-linux-gnueabi'
       - DISABLE_EXAMPLES: 1
     <<: *target_steps
 
   target-armv7-unknown-linux-gnueabihf:
     environment:
-      - TARGET: "armv7-unknown-linux-gnueabihf"
+      - TARGET: 'armv7-unknown-linux-gnueabihf'
       - DISABLE_EXAMPLES: 1
     <<: *target_steps
 
   target-x86_64-unknown-linux-gnu:
     environment:
-      - TARGET: "x86_64-unknown-linux-gnu"
+      - TARGET: 'x86_64-unknown-linux-gnu'
       - DISABLE_EXAMPLES: 1
     <<: *target_steps
 
   target-x86_64-unknown-linux-musl:
     environment:
-      - TARGET: "x86_64-unknown-linux-musl"
+      - TARGET: 'x86_64-unknown-linux-musl'
       - DISABLE_EXAMPLES: 1
     <<: *target_steps
 
   target-thumbv6m-none-eabi:
     environment:
-      - TARGET: "thumbv6m-none-eabi"
+      - TARGET: 'thumbv6m-none-eabi'
       # Disable example builds as they target thumbv7 and up
       - DISABLE_EXAMPLES: 1
     <<: *target_steps
 
   target-thumbv7em-none-eabi:
     environment:
-      - TARGET: "thumbv7em-none-eabi"
+      - TARGET: 'thumbv7em-none-eabi'
     <<: *target_steps
 
   target-thumbv7em-none-eabihf:
     environment:
-      - TARGET: "thumbv7em-none-eabihf"
+      - TARGET: 'thumbv7em-none-eabihf'
     <<: *target_steps
 
   target-thumbv7m-none-eabi:
     environment:
-      - TARGET: "thumbv7m-none-eabi"
+      - TARGET: 'thumbv7m-none-eabi'
     <<: *target_steps
 
 build_jobs: &build_jobs
@@ -100,7 +99,7 @@ workflows:
     <<: *build_jobs
     triggers:
       - schedule:
-          cron: "0 0 * * *"
+          cron: '0 0 * * *'
           filters:
             branches:
               only:

CHANGELOG.md

@@ -8,6 +8,10 @@ projects using an SPI interface.
 
 ## [Unreleased] - ReleaseDate
 
+### Changed
+
+- **(breaking)** [#6](https://github.com/jamwaffles/ssd1331/pull/6) Upgrade to embedded-graphics 0.6.0
+
 ### Fixed
 
 - [#4](https://github.com/jamwaffles/ssd1331/pull/4) Guard against negative pixel coordinates panicking `draw_pixel()` calls.

Cargo.toml

@@ -22,17 +22,16 @@ embedded-hal = "0.2.3"
 
 [dependencies.embedded-graphics]
 optional = true
-version = "=0.6.0-alpha.3"
+version = "0.6.0"
 
 [dev-dependencies]
 cortex-m = "0.6.1"
 cortex-m-rt = "0.6.11"
 panic-semihosting = "0.5.3"
 
-# Turns `bmp` feature on in examples to enable `ImageBmp`
-[dev-dependencies.embedded-graphics]
-version = "=0.6.0-alpha.3"
-features = ["bmp"]
+[dev-dependencies.tinybmp]
+version = "0.2.2"
+features = [ "graphics" ]
 
 [dev-dependencies.stm32f1xx-hal]
 version = "0.5.2"

examples/bmp.rs

@@ -23,7 +23,7 @@
 #![no_main]
 
 use cortex_m_rt::{entry, exception, ExceptionFrame};
-use embedded_graphics::{geometry::Point, image::ImageBmp, prelude::*};
+use embedded_graphics::{geometry::Point, image::Image, pixelcolor::Rgb565, prelude::*};
 use panic_semihosting as _;
 use ssd1331::{DisplayRotation, Ssd1331};
 use stm32f1xx_hal::{
@@ -32,6 +32,7 @@ use stm32f1xx_hal::{
     spi::{Mode, Phase, Polarity, Spi},
     stm32,
 };
+use tinybmp::Bmp;
 
 #[entry]
 fn main() -> ! {
@@ -79,15 +80,17 @@ fn main() -> ! {
 
     let (w, h) = disp.dimensions();
 
-    let im = ImageBmp::new(include_bytes!("./rust-pride.bmp")).unwrap();
+    let bmp = Bmp::from_slice(include_bytes!("./rust-pride.bmp")).unwrap();
+
+    let im: Image<Bmp, Rgb565> = Image::new(&bmp, Point::zero());
 
     // Position image in the center of the display
     let moved = im.translate(Point::new(
-        (w as u32 - im.width()) as i32 / 2,
-        (h as u32 - im.height()) as i32 / 2,
+        (w as u32 - bmp.width()) as i32 / 2,
+        (h as u32 - bmp.height()) as i32 / 2,
     ));
 
-    moved.draw(&mut disp);
+    moved.draw(&mut disp).unwrap();
 
     disp.flush().unwrap();
 

examples/graphics.rs

@@ -92,7 +92,8 @@ fn main() -> ! {
             .stroke_width(1)
             .build(),
     )
-    .draw(&mut disp);
+    .draw(&mut disp)
+    .unwrap();
 
     Rectangle::new(Point::new(36, 16), Point::new(36 + 16, 16 + 16))
         .into_styled(
@@ -101,7 +102,8 @@ fn main() -> ! {
                 .stroke_width(1)
                 .build(),
         )
-        .draw(&mut disp);
+        .draw(&mut disp)
+        .unwrap();
 
     Circle::new(Point::new(72, 16 + 8), 8)
         .into_styled(
@@ -110,7 +112,8 @@ fn main() -> ! {
                 .stroke_width(1)
                 .build(),
         )
-        .draw(&mut disp);
+        .draw(&mut disp)
+        .unwrap();
 
     disp.flush().unwrap();
 

examples/image.rs

@@ -26,7 +26,10 @@
 #![no_main]
 
 use cortex_m_rt::{entry, exception, ExceptionFrame};
-use embedded_graphics::{image::ImageLE, prelude::*};
+use embedded_graphics::{
+    image::{Image, ImageRawLE},
+    prelude::*,
+};
 use panic_semihosting as _;
 use ssd1331::{DisplayRotation::Rotate0, Ssd1331};
 use stm32f1xx_hal::{
@@ -82,10 +85,11 @@ fn main() -> ! {
 
     // Loads an 86x64px image encoded in LE (Little Endian) format. This image is a 16BPP image of
     // the Rust mascot, Ferris.
-    let im = ImageLE::new(include_bytes!("./ferris.raw"), 86, 64)
-        .translate(Point::new((96 - 86) / 2, 0));
+    let im = ImageRawLE::new(include_bytes!("./ferris.raw"), 86, 64);
 
-    im.draw(&mut disp);
+    Image::new(&im, Point::new((96 - 86) / 2, 0))
+        .draw(&mut disp)
+        .unwrap();
 
     disp.flush().unwrap();
 

examples/rotation.rs

@@ -26,7 +26,7 @@
 #![no_main]
 
 use cortex_m_rt::{entry, exception, ExceptionFrame};
-use embedded_graphics::{image::ImageLE, pixelcolor::BinaryColor, prelude::*};
+use embedded_graphics::{image::ImageRawLE, pixelcolor::BinaryColor, prelude::*};
 use panic_semihosting as _;
 use ssd1331::{DisplayRotation, Ssd1331};
 use stm32f1xx_hal::{
@@ -86,12 +86,13 @@ fn main() -> ! {
 
     // Load a 1BPP 64x64px image with LE (Little Endian) encoding of the Rust logo, white foreground
     // black background
-    let im = ImageLE::<BinaryColor>::new(include_bytes!("./rust.raw"), 64, 64);
+    let im = ImageRawLE::<BinaryColor>::new(include_bytes!("./rust.raw"), 64, 64);
 
     // Map on/off image colours to Rgb565::BLACK/Rgb565::WHITE
     im.into_iter()
         .map(|p| Pixel(p.0, p.1.into()))
-        .draw(&mut disp);
+        .draw(&mut disp)
+        .unwrap();
 
     disp.flush().unwrap();
 

examples/text.rs

@@ -92,11 +92,13 @@ fn main() -> ! {
                 .text_color(Rgb565::WHITE)
                 .build(),
         )
-        .draw(&mut disp);
+        .draw(&mut disp)
+        .unwrap();
 
     Text::new("Hello Rust!", Point::new(0, 16))
         .into_styled(TextStyleBuilder::new(Font6x8).text_color(rust).build())
-        .draw(&mut disp);
+        .draw(&mut disp)
+        .unwrap();
 
     // Macros can also be used
     egtext!(
@@ -109,7 +111,8 @@ fn main() -> ! {
         )
     )
     .translate(Point::new(0, 24))
-    .draw(&mut disp);
+    .draw(&mut disp)
+    .unwrap();
 
     disp.flush().unwrap();
 

src/display.rs

@@ -22,7 +22,7 @@ const BUF_SIZE: usize = 96 * 64 * 2;
 /// use embedded_graphics::{
 ///     fonts::{Font6x8, Text},
 ///     geometry::Point,
-///     image::ImageLE,
+///     image::{Image, ImageRawLE},
 ///     pixelcolor::Rgb565,
 ///     prelude::*,
 ///     primitives::{Circle, Line, Rectangle},
@@ -36,7 +36,9 @@ const BUF_SIZE: usize = 96 * 64 * 2;
 /// let dc = Pin;
 ///
 /// let mut display = Ssd1331::new(spi, dc, Rotate0);
-/// let image = ImageLE::new(include_bytes!("../examples/ferris.raw"), 86, 64);
+/// let raw = ImageRawLE::new(include_bytes!("../examples/ferris.raw"), 86, 64);
+///
+/// let image: Image<ImageRawLE<Rgb565>, Rgb565> = Image::new(&raw, Point::zero());
 ///
 /// // Initialise and clear the display
 /// display.init().unwrap();
@@ -369,20 +371,24 @@ where
     SPI: hal::blocking::spi::Write<u8>,
     DC: OutputPin,
 {
-    fn draw_pixel(&mut self, pixel: drawable::Pixel<Rgb565>) {
+    type Error = core::convert::Infallible;
+
+    fn draw_pixel(&mut self, pixel: drawable::Pixel<Rgb565>) -> Result<(), Self::Error> {
         let drawable::Pixel(pos, color) = pixel;
 
         // Guard against negative values. All positive i32 values from `pos` can be represented in
         // the `u32`s that `set_pixel()` accepts.
         if pos.x < 0 || pos.y < 0 {
-            return;
+            return Ok(());
         }
 
         self.set_pixel(
             (pos.x).try_into().unwrap(),
             (pos.y).try_into().unwrap(),
             RawU16::from(color).into_inner(),
         );
+
+        Ok(())
     }
 
     fn size(&self) -> Size {

src/lib.rs

@@ -46,8 +46,9 @@
 //!
 //! ```rust
 //! # use ssd1331::test_helpers::{Spi, Pin};
-//! use embedded_graphics::{image::ImageBmp, prelude::*};
+//! use embedded_graphics::{image::Image, pixelcolor::Rgb565, prelude::*};
 //! use ssd1331::{DisplayRotation::Rotate0, Ssd1331};
+//! use tinybmp::Bmp;
 //!
 //! // Set up SPI interface and digital pin. These are stub implementations used in examples.
 //! let spi = Spi;
@@ -56,10 +57,12 @@
 //! let mut display = Ssd1331::new(spi, dc, Rotate0);
 //! display.init();
 //!
-//! let im = ImageBmp::new(include_bytes!("../examples/rust-pride.bmp")).unwrap();
+//! let bmp = Bmp::from_slice(include_bytes!("../examples/rust-pride.bmp")).unwrap();
+//!
+//! let im: Image<Bmp, Rgb565> = Image::new(&bmp, Point::zero());
 //!
 //! // Center the image on the display
-//! let moved = im.translate(Point::new((96 - im.width() as i32) / 2, 0));
+//! let moved = im.translate(Point::new((96 - bmp.width() as i32) / 2, 0));
 //!
 //! moved.draw(&mut display);
 //!