mirui 0.42.0

A lightweight, no_std ECS-driven UI framework for embedded, desktop, and WebAssembly
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! Bridge `InputEvent::AppSuspend` / `AppResume` from backends through
//! `SuspendRequest` so `App::tick` flips `App::suspend()` / `App::resume()`
//! the next time it drains the resource.
//!
//! Plug it in to make the app react to OS lifecycle signals (SDL focus
//! loss, browser tab hide, mobile background) without writing any
//! glue in user code. Omit it to let `App::suspend` / `App::resume`
//! stay strictly host-driven.

use crate::app::lifecycle::SuspendRequest;
use crate::app::plugin::Plugin;
use crate::app::{App, RendererFactory};
use crate::ecs::World;
use crate::input::event::input::InputEvent;
use crate::surface::Surface;

/// **Inserts**
/// - resource: `SuspendRequest` (only on lifecycle events; otherwise none)
/// - hooks:    `on_event` (swallows `AppSuspend` / `AppResume`)
#[derive(Default)]
pub struct AutoSuspendPlugin;

impl<B, F> Plugin<B, F> for AutoSuspendPlugin
where
    B: Surface,
    F: RendererFactory<B>,
{
    fn build(&mut self, _app: &mut App<B, F>) {}

    fn on_event(&mut self, world: &mut World, event: &InputEvent) -> bool {
        match event {
            InputEvent::AppSuspend => {
                world.insert_resource(SuspendRequest::Suspend);
                true
            }
            InputEvent::AppResume => {
                world.insert_resource(SuspendRequest::Resume);
                true
            }
            _ => false,
        }
    }
}