Struct Shell 

pub struct Shell {
    pub mode: Mode,
    pub mouse: Mouse,
    pub want_exit: bool,
    /* private fields */
}

Fields

mode: Mode

mouse: Mouse

want_exit: bool

Implementations

impl Shell

pub fn new(audio: AudioHandle, sdk_path: PathBuf) -> Self

pub fn set_hide_cursor(&mut self, hide: bool)

Hide the console’s software mouse cursor (used by frontends that show the host’s own pointer, like the terminal, to avoid a double cursor).

pub fn say(&mut self, text: &str, color: u8)

Print a (wrapped) line to the console.

pub fn assets(&self) -> Option<&Assets>

pub fn assets_mut(&mut self) -> Option<&mut Assets>

pub fn window_title(&self) -> String

The OS window title: the loaded cart’s name plus the console name, or just the console name when nothing is loaded.

pub fn set_button(&mut self, b: usize, down: bool)

Feed a game button (host already mapped keys to buttons 0..6).

pub fn key(&mut self, key: Key, mods: Mods)

pub fn switch_editor(&mut self, mode: Mode)

pub fn startup_load(&mut self, path: &str)

Load a cart/project given on the command line at boot.

pub fn startup_run(&mut self)

Run the cart/project loaded at boot, as if the user typed run. Used by the pixel8 run <path> launch mode. A cart enters Run mode immediately; a project spawns its build and enters Run mode once it succeeds.

pub fn cmd_run(&mut self)

pub fn tick_fps(&self) -> u32

The rate the host should tick at: a running cart’s frame rate (30 or 60), else 30. Running the whole Run-mode tick at the cart’s rate is what gets the display to refresh at 60 too.

pub fn tick(&mut self)

pub fn draw(&mut self) -> &Framebuffer