Enum nannou::app::LoopMode

pub enum LoopMode {
    RefreshSync,
    Rate {
        update_interval: Duration,
    },
    Wait,
    NTimes {
        number_of_updates: usize,
    },
}

The mode in which the App is currently running the event loop and emitting Update events.

Variants

RefreshSync

Synchronises Update events with requests for a new frame for the surface.

The result of using this loop mode is similar to using vsync in traditional applications. E.g. if you have one window running on a monitor with a 60hz refresh rate, your update will get called at a fairly consistent interval that is close to 60 times per second.

Rate

Specifies that the application is continuously looping at a consistent rate.

NOTE: This currently behaves the same as RefreshSync. Need to upate this to handled a fix step properly in the future. See #456.

Fields of Rate

update_interval: Duration

The minimum interval between emitted updates.

Wait

Waits for user input events to occur before calling event with an Update event.

This is particularly useful for low-energy GUIs that only need to update when some sort of input has occurred. The benefit of using this mode is that you don’t waste CPU cycles looping or updating when you know nothing is changing in your model or view.

NTimes

Loops for the given number of updates and then finishes.

This is similar to the Wait loop mode, except that windowing, application and input events will not cause the loop to update or view again after the initial number_of_updates have already been applied.

This is useful for sketches where you only want to draw one frame, or if you know exactly how many updates you require for an animation, etc.

Fields of NTimes

number_of_updates: usize

The number of updates that must be emited regardless of non-update events

Implementations

impl LoopMode

pub const DEFAULT_RATE_FPS: f64

pub const UPDATES_PER_WAIT_EVENT: u32

The minimum number of updates that will be emitted after an event is triggered in Wait mode.

pub fn refresh_sync() -> Self

A simplified constructor for the default RefreshSync loop mode.

Assumes a display refresh rate of ~60hz and in turn specifies a minimum_update_latency of ~8.33ms. The windows field is set to None.

pub fn rate_fps(fps: f64) -> Self

Specify the Rate mode with the given frames-per-second.

pub fn wait() -> Self

Specify the Wait mode.

pub fn loop_ntimes(number_of_updates: usize) -> Self

Specify the Ntimes mode with one update

Waits long enough to ensure loop iteration never occurs faster than the given max_fps.

pub fn loop_once() -> Self

Specify the Ntimes mode with one update

Trait Implementations

impl Clone for LoopMode

fn clone(&self) -> LoopMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoopMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LoopMode

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<LoopMode> for LoopMode

fn eq(&self, other: &LoopMode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LoopMode) -> bool

This method tests for !=.

impl StructuralPartialEq for LoopMode