Struct pixel_canvas::canvas::Canvas

pub struct Canvas<State, Handler = EventHandler<State>> { /* fields omitted */ }

A Canvas manages a window and event loop, handing the current state to the renderer, and presenting its image on the screen.

Implementations

impl Canvas<()>

pub fn new(width: usize, height: usize) -> Canvas<()>

Create a new canvas with a given virtual window dimensions.

impl<State, Handler> Canvas<State, Handler> where
    Handler: FnMut(&CanvasInfo, &mut State, &Event<'_, ()>) -> bool + 'static,
    State: 'static, 

pub fn state<NewState>(
    self,
    state: NewState
) -> Canvas<NewState, EventHandler<NewState>>

Set the attached state.

Attaching a new state object will reset the input handler.

pub fn title(self, text: impl Into<String>) -> Self

Set the title on the canvas window.

pub fn hidpi(self, enabled: bool) -> Self

Toggle hidpi render.

Defaults to false. If you have a hidpi monitor, this will cause the image to be larger than the dimensions you specified when creating the canvas.

pub fn show_ms(self, enabled: bool) -> Self

Whether to show a frame duration in the title bar.

Defaults to false.

pub fn render_on_change(self, enabled: bool) -> Self

Whether to render a new frame only on state changes.

Defaults to false, which means it will render at a fixed framerate.

pub fn input<NewHandler>(
    self,
    callback: NewHandler
) -> Canvas<State, NewHandler> where
    NewHandler: FnMut(&CanvasInfo, &mut State, &Event<'_, ()>) -> bool + 'static, 

Attach an input handler.

Your input handler must be compatible with any state that you've set previously. Your event handler will be called for each event with the canvas information, the current state, and the inciting event.

pub fn render(self, callback: impl FnMut(&mut State, &mut Image) + 'static)

Provide a rendering callback.

The canvas will call your rendering callback on demant, with the current state and a reference to the image. Depending on settings, this will either be called at 60fps, or only called when state changes. See render_on_change.