Struct Screen 

pub struct Screen { /* private fields */ }

This is the main type for interacting with the LED Matrix Screen.

Implementations

impl Screen

pub fn open(path: &str) -> Result<Self, ScreenError>

Open the framebuffer to the screen at the given file-system path.

Examples found in repository

examples/letter.rs (line 17)

fn main() {
    let mut screen = Screen::open("/dev/fb1").unwrap();

    let white_50_pct = PixelColor::WHITE.dim(0.5);

    let letter = "Dear Toño, I am well. Thank you. Bye. - ゆにち";

    let screen_text = FONT_COLLECTION.sanitize_str(letter).unwrap();

    for unicode in screen_text.chars() {
        if let Some(symbol) = FONT_COLLECTION.get(unicode) {
            let frame = font_to_frame(symbol.byte_array(), white_50_pct);
            screen.write_frame(&frame);
        }
        thread::sleep(Duration::from_millis(800));
    }
}

examples/scroll-bottom-top.rs (line 15)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" ^^^123^^^ ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of CYAN and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::CYAN, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `bottom_to_top` method.
    scroll.bottom_to_top().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/scroll-left-right.rs (line 15)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" >>>123>>> ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of YELLOW and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::YELLOW, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `left_to_right` method.
    scroll.left_to_right().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/scroll-top-bottom.rs (line 15)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" vvv123vvv ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of YELLOW and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::YELLOW, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `top_to_bottom` method.
    scroll.top_to_bottom().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/scroll-right-left.rs (line 15)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" «««123««« ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of GREEN and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::GREEN, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `right_to_left` method.
    scroll.right_to_left().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/clip.rs (line 16)

fn main() {
    let mut screen = Screen::open("/dev/fb1").unwrap();

    let letters = "a e i o u ";
    let letter_color = PixelColor::YELLOW.dim(0.5);

    let frames = letters
        .chars()
        .map(|sym| {
            let font = FONT_COLLECTION.get(sym).unwrap();
            font_to_pixel_frame(font.byte_array(), letter_color)
        })
        .collect::<Vec<PixelFrame>>();

    // create a sequence of clips that will scroll each character-whitespace pair
    // from appearing to move from right to left.
    let frame_reel: Vec<PixelFrame> = frames.chunks(2).fold(Vec::new(), |mut v, chunk| match chunk
        .len()
    {
        2 => {
            let clip = chunk[0].build_clip(&chunk[1]);
            for i in 0..=8 {
                v.push(clip.offset(Offset::left(i)));
            }
            v
        }
        _ => panic!("this frame reel will only display &str of even length (divisible by 2)"),
    });

    for frame in &frame_reel {
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(750));
    }
}

Additional examples can be found in:

• examples/rotate.rs
• examples/offset.rs
• examples/blink.rs

pub fn write_frame(&mut self, frame: &FrameLine)

Write the contents of a FrameLine into the framebuffer. This will render the frameline on the screen.

Examples found in repository

examples/letter.rs (line 28)

fn main() {
    let mut screen = Screen::open("/dev/fb1").unwrap();

    let white_50_pct = PixelColor::WHITE.dim(0.5);

    let letter = "Dear Toño, I am well. Thank you. Bye. - ゆにち";

    let screen_text = FONT_COLLECTION.sanitize_str(letter).unwrap();

    for unicode in screen_text.chars() {
        if let Some(symbol) = FONT_COLLECTION.get(unicode) {
            let frame = font_to_frame(symbol.byte_array(), white_50_pct);
            screen.write_frame(&frame);
        }
        thread::sleep(Duration::from_millis(800));
    }
}

examples/scroll-bottom-top.rs (line 32)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" ^^^123^^^ ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of CYAN and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::CYAN, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `bottom_to_top` method.
    scroll.bottom_to_top().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/scroll-left-right.rs (line 32)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" >>>123>>> ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of YELLOW and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::YELLOW, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `left_to_right` method.
    scroll.left_to_right().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/scroll-top-bottom.rs (line 32)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" vvv123vvv ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of YELLOW and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::YELLOW, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `top_to_bottom` method.
    scroll.top_to_bottom().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/scroll-right-left.rs (line 32)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" «««123««« ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of GREEN and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::GREEN, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `right_to_left` method.
    scroll.right_to_left().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/clip.rs (line 45)

fn main() {
    let mut screen = Screen::open("/dev/fb1").unwrap();

    let letters = "a e i o u ";
    let letter_color = PixelColor::YELLOW.dim(0.5);

    let frames = letters
        .chars()
        .map(|sym| {
            let font = FONT_COLLECTION.get(sym).unwrap();
            font_to_pixel_frame(font.byte_array(), letter_color)
        })
        .collect::<Vec<PixelFrame>>();

    // create a sequence of clips that will scroll each character-whitespace pair
    // from appearing to move from right to left.
    let frame_reel: Vec<PixelFrame> = frames.chunks(2).fold(Vec::new(), |mut v, chunk| match chunk
        .len()
    {
        2 => {
            let clip = chunk[0].build_clip(&chunk[1]);
            for i in 0..=8 {
                v.push(clip.offset(Offset::left(i)));
            }
            v
        }
        _ => panic!("this frame reel will only display &str of even length (divisible by 2)"),
    });

    for frame in &frame_reel {
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(750));
    }
}

Additional examples can be found in:

• examples/rotate.rs
• examples/offset.rs
• examples/blink.rs

Trait Implementations

impl Debug for Screen

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.