Struct Scroll 

pub struct Scroll(/* private fields */);

A type representing a collection of PixelFrames that may be scrolled.

Implementations

impl Scroll

pub fn new(frames: &[PixelFrame]) -> Self

Creates a new scroll from a slice of PixelFrames.

Panics

The scroll needs at least 2 PixelFrames to be created.

Examples found in repository

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

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 26)

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 26)

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 26)

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));
    });
}

pub fn frames(&self) -> &[PixelFrame]

Returns &[PixelFrame] with the pixel frames that constitute this scroll.

pub fn clips(&self) -> Vec<Clip>

Returns Vec<Clip> with the pixel frames clips that may be rendered.

pub fn reverse(&mut self)

Reverse the order of the inner pixel frames.

pub fn len(&self) -> usize

Return the number of pixel frames in the scroll.

pub fn is_empty(&self) -> bool

Returns true if the scroll has no pixel frames.

pub fn right_to_left(&self) -> FrameSequence

Returns a FrameSequence iterator that moves the frames from the right to the left.

Examples found in repository

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

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));
    });
}

pub fn left_to_right(&self) -> FrameSequence

Returns a FrameSequence iterator that moves the frames from the left to the right.

Examples found in repository

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

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));
    });
}

pub fn top_to_bottom(&self) -> FrameSequence

Returns a FrameSequence iterator that moves the frames from the top to the bottom.

Examples found in repository

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

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));
    });
}

pub fn bottom_to_top(&self) -> FrameSequence

Returns a FrameSequence iterator that moves the frames from the bottom to the bottom.

Examples found in repository

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

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));
    });
}

Trait Implementations

impl Debug for Scroll

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

Formats the value using the given formatter.

impl Index<usize> for Scroll

type Output = PixelFrame

The returned type after indexing.

fn index(&self, index: usize) -> &PixelFrame

Performs the indexing (container[index]) operation.

impl PartialEq for Scroll

fn eq(&self, other: &Scroll) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Scroll