Enum SystemEvent 

#[non_exhaustive]
pub enum SystemEvent {
    Suspend,
    Resume,
    FocusLost,
    FocusGained,
    QuitRequested,
    LowBattery,
    ToggleFullscreen,
    CrankDocked,
    CrankUndocked,
}

Something the system tells the game, between frames.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Suspend

The game is about to stop running for a while: the device sleeps or locks, the system’s home menu opens, the app goes to the background. App lets the game save and stops stepping it until Resume.

Resume

The game runs again. App forgets the time it was away, so the sleep doesn’t become a burst of catch-up steps.

FocusLost

The game’s window lost the player’s attention (another window, an overlay over it). The game keeps running; its hook may pause it.

FocusGained

The game’s window has the player’s attention again.

QuitRequested

The player asked the system to close the game (the window’s close button). App lets the game save, then quits.

LowBattery

The battery is nearly empty: the game may save in case the device turns off.

ToggleFullscreen

The window’s own fullscreen shortcut was pressed (F11, Alt+Enter): App flips the Fullscreen setting, so the next frame asks for the other window mode and an options screen shows it.

CrankDocked

The device’s crank was folded away, or was already when the game loaded: a screen whose required action is on the crank shows a hint to unfold it (Ctx::crank_docked).

CrankUndocked

The device’s crank was unfolded.

Trait Implementations

impl Clone for SystemEvent

fn clone(&self) -> SystemEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SystemEvent

impl Debug for SystemEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SystemEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SystemEvent

impl PartialEq for SystemEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SystemEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SystemEvent