Struct flo_ui::BindingCanvas

pub struct BindingCanvas { /* fields omitted */ }

The binding canvas is a canvas that can have an attached rendering function. It will invalidate itself if any bindings used in that rendering function are changed.

Methods

impl BindingCanvas

pub fn new() -> BindingCanvas

Creates a new BindingCanvas

pub fn from(canvas: Arc<Canvas>) -> BindingCanvas

Creates a new binding canvas from a canvas

pub fn with_drawing<DrawingFn: 'static + Fn(&mut GraphicsPrimitives) + Send + Sync>(
    draw: DrawingFn
) -> BindingCanvas

Creates a new BindingCanvas with a drawing function

pub fn on_redraw<DrawingFn: 'static + Fn(&mut GraphicsPrimitives) + Send + Sync>(
    &self,
    draw: DrawingFn
)

Sets the drawing function for the canvas

Canvases don't have a drawing function by default, so it's safe to draw directly on them as they'll never become invalidated. Once a drawing function is set, any bindings it may have will cause it to become invalidated if they change. Additionally, setting a drawing function will invalidate the canvas.

pub fn redraw_if_invalid(&self)

Redraws the canvas if it is marked as invalid

pub fn invalidate(&self)

Marks this canvas as invalidated (will be redrawn on the next request)

Methods from Deref<Target = Canvas>

pub fn write(&self, to_draw: Vec<Draw>)

Sends some new drawing commands to this canvas

pub fn draw<FnAction>(&self, action: FnAction) where
    FnAction: Send + FnOnce(&mut GraphicsPrimitives), 

Provides a way to draw on this canvas via a GC

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn stream(&self) -> Box<Stream<Item = Draw, Error = ()> + 'static + Send>

Creates a stream for reading the instructions from this canvas

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn get_drawing(&self) -> Vec<Draw>

Retrieves the list of drawing actions in this canvas

Trait Implementations

impl Deref for BindingCanvas

type Target = Canvas

The resulting type after dereferencing.

fn deref(&self) -> &Canvas

Dereferences the value.