1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

//! Graphics for rendering on the 5×5 LED display.
//!
//! # Features
//!
//! This module provides:
//! - simple 5×5 greyscale and black-and-white image types;
//! - a copy of the 'pendolino' font from the [micro:bit runtime][dal];
//! - support for scrolling text.
//!
//! # The `Render` trait
//!
//! The graphics types in this module implement the [`display::Render`] trait,
//! which defines the interface that the display code needs.
//!
//! It supports ten levels of brightness; see [Greyscale model][greyscale].
//!
//! # Simple images
//!
//! The [`image`] module provides two static image types implementing
//! `Render`:
//!
//! - [`GreyscaleImage`], allowing all 10 levels (using one byte for each LED)
//! - [`BitImage`], allowing only 'on' and 'off' (using five bytes)
//!
//! # Fonts
//!
//! The [`font`] module provides 5×5 representations of the ascii printable
//! characters as [`BitImage`]s.
//!
//! These are taken from the "pendolino" font supplied with the
//! [micro:bit runtime][dal].
//!
//! # Scrolling images and text
//!
//! The [`scrolling`] module supports horizontal scrolling for a sequence of
//! images via a [`ScrollingImages`] type which implements `Render` and an
//! [`Animate`] interface.
//!
//! The [`scrolling_text`] module supports scrolling messages, providing
//! [`ScrollingStaticText`] and [`ScrollingBufferedText`] types.
//!
//! [dal]: https://lancaster-university.github.io/microbit-docs/
//! [greyscale]: crate::display
//! [`Animate`]: scrolling::Animate
//! [`BitImage`]: image::BitImage
//! [`GreyscaleImage`]: image::GreyscaleImage
//! [`display::Render`]: crate::display::Render
//! [`Scrollable`]: scrolling::Scrollable
//! [`ScrollingImages`]: scrolling::ScrollingImages
//! [`ScrollingBufferedText`]: scrolling_text::ScrollingBufferedText
//! [`ScrollingStaticText`]: scrolling_text::ScrollingStaticText

pub mod font;
pub mod image;
pub mod scrolling;
pub mod scrolling_text;