Struct linfb::Compositor

pub struct Compositor {
    pub width: usize,
    pub height: usize,
    pub background: Color,
    // some fields omitted
}

Shape that can contain other shapes. Can deal with transparency and overlaps.

Fields

width: usize

Width of compositor in pixels

height: usize

Height of compositor in pixels

background: Color

Background color. Transparent backgrounds will be treated as if they're placed over black background

Methods

impl Compositor

pub fn new(width: usize, height: usize, background: Color) -> Self

Create empty compositor with given size and background

pub fn builder() -> CompositorBuilder

Create a default CompositorBuilder

pub fn add(&mut self, name: &str, shape: PositionedShape) -> &mut Self

Add a PositionedShape with given name. Later you can get a reference to shape by it's name.

Uniqueness of names is not enforced, but recommended

pub fn get_positioned(&mut self, name: &str) -> Option<&mut PositionedShape>

Get a previously added PositionedShape by it's name. Will return None if shape with such name was never added.

pub fn get<T: Shape>(&mut self, name: &str) -> Option<&mut T>

Get inner shape of previously added PositionedShape by it's name. Will return None if shape with such name was never added or has a different type. Use it like this:

let rect: &mut Rectangle = compositor.get("rectangle_name").unwrap();

Trait Implementations

impl Shape for Compositor

fn render(&self) -> Vec<Vec<Option<Color>>>

Create a two-dimensional array of pixels. Every row must have the same length.

fn at(self, x: usize, y: usize) -> PositionedShape where
    Self: Sized + 'static, 

Convert self into PositionedShape, saving position info. Needed for Compositor.