Struct Canvas 

pub struct Canvas { /* private fields */ }

The interface of one frame plus what the player did with the previous one.

Implementations

impl Canvas

pub fn width(&self) -> f32

Width of the virtual screen (720 high, width follows the window).

pub fn set_style(&self, style: ButtonStyle)

Sets the look of the following buttons and sliders.

pub fn style(&self) -> ButtonStyle

The current button style.

pub fn panel(&self, rect: [f32; 4], color: [f32; 4], radius: f32)

A filled panel.

pub fn frame( &self, rect: [f32; 4], color: [f32; 4], outline: [f32; 4], radius: f32, )

A panel with an outline.

pub fn text( &self, text: &str, pos: [f32; 2], size: f32, color: [f32; 4], font: &str, align: Align, )

One line (or a wrapped paragraph when wrap > 0 is given via Self::paragraph) of text.

pub fn paragraph( &self, text: &str, pos: [f32; 2], width: f32, size: f32, color: [f32; 4], font: &str, )

Text wrapped to width units.

pub fn image(&self, path: &str, rect: [f32; 4], tint: [f32; 4])

An image (PNG/JPG from the assets).

pub fn button(&self, id: &str, rect: [f32; 4], text: &str) -> bool

A button; returns true on the frame after it was clicked.

pub fn hovered(&self, id: &str) -> bool

Whether the pointer was over the button last frame.

pub fn slider(&self, id: &str, rect: [f32; 4], value: f32) -> f32

A slider showing value (0..1); returns the value after the player’s change.

pub fn toggle(&self, id: &str, rect: [f32; 4], label: &str, on: bool) -> bool

A toggle drawn as a button with ON / OFF; returns the new state.

pub fn mouse(&self) -> [f32; 2]

Mouse position in interface units.

pub fn commands(&self) -> Vec<UiCmd>

Commands of the current frame.

pub fn wants_mouse(&self) -> bool

Whether any interactive element is on screen (the host then shows the cursor).

pub fn begin(&self)

Starts a new frame of commands (called by the runtime before scripts update).

pub fn feedback( &self, clicked: Vec<String>, hovered: Vec<String>, changed: Vec<(String, f32)>, width: f32, mouse: [f32; 2], )

What the player did with the painted frame (called by the shell after painting).

Trait Implementations

impl Clone for Canvas

fn clone(&self) -> Canvas

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Canvas

fn default() -> Canvas

Returns the “default value” for a type.