Struct nannou::app::App

pub struct App {
    pub audio: Audio,
    pub mouse: Mouse,
    pub window: Window,
    pub keys: Keys,
    // some fields omitted
}

An App represents the entire context of your application.

The App owns and manages:

• the event loop (used to drive the application forward)
• all OpenGL windows (for graphics and user input, can be referenced via IDs).

Fields

audio: Audio

The App's audio-related API.

mouse: Mouse

The current state of the Mouse.

window: Window

State of the window currently in focus.

keys: Keys

State of the keyboard keys.

mods provides state of each of the modifier keys: shift, ctrl, alt, logo.

down is the set of keys that are currently pressed.

NOTE: down this is tracked by the nannou App so issues might occur if e.g. a key is pressed while the app is in focus and then released when out of focus. Eventually we should change this to query the OS somehow, but I don't think winit provides a way to do this yet.

Methods

impl App

const ASSETS_DIRECTORY_NAME: &'static str

ASSETS_DIRECTORY_NAME: &'static str = "assets"

const DEFAULT_EXIT_ON_ESCAPE: bool

DEFAULT_EXIT_ON_ESCAPE: bool = true

fn assets_path(&self) -> Result<PathBuf, Error>

Find and return the absolute path to the project's assets directory.

This method looks for the assets directory in the following order:

1. Checks the same directory as the executable.
2. Recursively checks exe's parent directories (to a max depth of 5).
3. Recursively checks exe's children directories (to a max depth of 3).

fn new_window<'a>(&'a self) -> Builder<'a, 'static>

Begin building a new OpenGL window.

fn window_count(&self) -> usize

The number of windows currently in the application.

fn window(&self, id: Id) -> Option<Ref<Window>>

A reference to the window with the given Id.

fn exit_on_escape(&self) -> bool

Return whether or not the App is currently set to exit when the Escape key is pressed.

fn set_exit_on_escape(&self, b: bool)

Specify whether or not the app should close when the Escape key is pressed.

By default this is true.

fn loop_mode(&self) -> LoopMode

Returns the App's current LoopMode.

fn set_loop_mode(&self, mode: LoopMode)

Sets the loop mode of the App.

Note: Setting the loop mode will not affect anything until the end of the current loop iteration. The behaviour of a single loop iteration is described under each of the LoopMode variants.

fn create_proxy(&self) -> Proxy

A handle to the App that can be shared across threads.

This can be used to "wake up" the App's inner event loop.

fn new_ui(&self, window_id: Id) -> Builder

Create a new Ui for the window with the given Id.

Returns None if there is no window for the given window_id.