embedded-layout

embedded-layout extends [embedded-graphics] with basic layout functions.

embedded-layout consists of two main parts: - alignments that can be used to position two objects relative to one another * horizontal * NoAlignment, Left, Right, Center * LeftToRight, RightToLeft * vertical * NoAlignment, Top, Bottom, Center * TopToBottom, BottomToTop - layouts that can be used to arrange multiple views * ViewGroup * LinearLayout

Example

The examples are based on [the embedded-graphics simulator]. The simulator is built on top of SDL2. See the [simulator README] for more information.

```rust use embeddedgraphicssimulator::{ BinaryColorTheme, OutputSettingsBuilder, SimulatorDisplay, Window, };

use embeddedgraphics::{ fonts::{Font6x8, Text}, pixelcolor::BinaryColor, primitives::{Circle, Triangle}, style::{PrimitiveStyle, TextStyleBuilder}, }; use embeddedlayout::{ layout::{linear::LinearLayout, ViewGroup}, prelude::*, };

fn main() -> Result<(), core::convert::Infallible> { let mut display: SimulatorDisplay = SimulatorDisplay::new(Size::new(128, 64));

let output_settings = OutputSettingsBuilder::new()
    .theme(BinaryColorTheme::OledBlue)
    .build();

// Create a Rectangle from the display's dimensions
let display_area = display.display_area();

// Style objects
let text_style = TextStyleBuilder::new(Font6x8)
    .text_color(BinaryColor::On)
    .build();

let thin_stroke = PrimitiveStyle::with_stroke(BinaryColor::On, 1);
let thick_stroke = PrimitiveStyle::with_stroke(BinaryColor::On, 3);
let fill_on = PrimitiveStyle::with_fill(BinaryColor::On);
let fill_off = PrimitiveStyle::with_fill(BinaryColor::Off);

// Primitives to be displayed
let triangle = Triangle::new(Point::new(0, 0), Point::new(12, 0), Point::new(6, 12))
    .into_styled(thin_stroke);

let circle = Circle::new(Point::zero(), 6).into_styled(thick_stroke);
let circle2 = Circle::new(Point::zero(), 7).into_styled(fill_on);
let triangle2 =
    Triangle::new(Point::new(0, 0), Point::new(10, 0), Point::new(5, 8)).into_styled(fill_off);
let text = Text::new("embedded-layout", Point::zero()).into_styled(text_style);

// The layout
LinearLayout::vertical()
    .with_alignment(horizontal::Center)
    .add_view(text)
    .add_view(
        LinearLayout::horizontal()
            .add_view(triangle)
            .add_view(circle)
            .arrange(),
    )
    .add_view(
        ViewGroup::new()
            .add_view(triangle2.align_to(&circle2, horizontal::Center, vertical::Top))
            .add_view(circle2),
    )
    .arrange()
    .align_to(&display_area, horizontal::Center, vertical::Center)
    .draw(&mut display)
    .unwrap();

Window::new("Layout example", &output_settings).show_static(&display);
Ok(())

} ```

Development setup

Minimum supported Rust version

The minimum supported Rust version for embedded-layout is 1.40.0 or greater. However, the documentation uses the intra-crate links feature which requires nightly Rust. Ensure you have the latest stable version of Rust installed, preferably through https://rustup.rs.

Installation

For setup in general, follow the installation instructions for [embedded-graphics].

To install SDL2 on Windows, see https://github.com/Rust-SDL2/rust-sdl2#windows-msvc