Crate winit_event_helper 

winit_event_helper is a crate for simplified winit event handling using callback functions without taking over the main loop.

Usage

winit_event_helper comes with the EventHelper struct, which handles all the callbacks and various miscellaneous things.

Pass your events to EventHelper::update and run your application logic when it returns true.

You can also add callbacks for specific winit events with the EventHelper helper functions or the Callbacks struct.

Example

use winit::event_loop::{ControlFlow, EventLoop};
use winit::window::WindowBuilder;
use winit_event_helper::*;
 
struct Data {
    counter: usize,
}
 
fn main() {
    let event_loop = EventLoop::new();
    let _window = WindowBuilder::new().build(&event_loop).unwrap();
 
    let mut eh = EventHelper::new(Data { counter: 0 });
    let mut callbacks = Callbacks::<Data>::empty();
 
    // is called whenever one of the given inputs was just pressed
    callbacks
        .window
        .inputs
        .just_pressed_all([GenericInput::from(MouseButton::Left), KeyCode::Space.into()], |eh| {
            eh.counter += 1
        });
     
    event_loop.run(move |event, _, control_flow| {
        // feed the events to the [EventHelper] struct
        // returns true when it receives [Event::MainEventsCleared]
        if !eh.update(&callbacks, &event) {
            return;
        }
 
        // exits the application when the key combination CTRL + ESC has been released
        if eh.data.window.inputs.just_released_combination([KeyCode::Escape], Modifiers::CTRL) {
            *control_flow = ControlFlow::Exit;
        }
 
        println!("{}", eh.counter);
 
        // do stuff
    })
}

Functions and Callbacks

winit_event_helper has functions for adding a callback for every winit event type except winit::event::UserEvent. Callbacks are called after a step as long as a winit event of the desired type is received.

For a complete overview of functions, see callbacks.

Keyboard and Mouse Inputs

Keyboard and mouse inputs are combined and moved into the InputData struct.

This can be accessed as field inputs on the WindowCallbackData and DeviceCallbackData structs (see example).

Callbacks are collected in InputCallbacks.

Features

• unique_windows — Allows the user to setup callbacks for individual windows.
• unique_devices — Allows the user to setup callbacks for individual devices.
• windows_with_device_ids — Allows the user to identify which device sent a window event (if applicable).

Re-exports

pub use crate::callbacks::all::Callbacks;

pub use crate::event_helper::EventHelper;

pub use crate::definitions::*;

Modules

callbacks

Contains collections of data used for callbacks and the collections callbacks themselves.

default_ahashmap

definitions

event_helper

input

Keyboard and mouse inputs are combined and moved into the InputData struct.