Struct winit_input_helper::WinitInputHelper

pub struct WinitInputHelper<T> { /* fields omitted */ }

The main struct of the API.

Create with WinitInputHelper::new. Then call update for every winit::event::Event you receive from winit. Then run your application logic when update returns true, callng any of the accessor methods you need.

Methods

impl<T> WinitInputHelper<T>

pub fn new() -> WinitInputHelper<T>

pub fn update(&mut self, event: Event<T>) -> bool

All passed events are queued until an Event::EventsCleared is received. At this point the WinitInputHelper processes all events and updates its state. You should run your application logic directly after this occurs. You can easily tell when this occurs because this method returns true iff the passed event is an Event::MainEventsCleared.

pub fn key_pressed(&self, check_key_code: VirtualKeyCode) -> bool

Returns true when the specified keyboard key goes from "not pressed" to "pressed" Otherwise returns false

pub fn mouse_pressed(&self, check_mouse_button: usize) -> bool

Returns true when the specified mouse button goes from "not pressed" to "pressed" Otherwise returns false

Left => 0 Right => 1 Middle => 2 Other => 3..255

pub fn key_released(&self, check_key_code: VirtualKeyCode) -> bool

Returns true when the specified keyboard key goes from "pressed" to "not pressed" Otherwise returns false

pub fn mouse_released(&self, check_mouse_button: usize) -> bool

Returns true when the specified mouse button goes from "pressed" to "not pressed" Otherwise returns false

Left => 0 Right => 1 Middle => 2 Other => 3..255

pub fn key_held(&self, key_code: VirtualKeyCode) -> bool

Returns true while the specified keyboard key remains "pressed" Otherwise returns false

pub fn mouse_held(&self, mouse_button: usize) -> bool

Returns true while the specified mouse button remains "pressed" Otherwise returns false

Left => 0 Right => 1 Middle => 2 Other => 3..255

pub fn held_shift(&self) -> bool

Returns true while any shift key is held on the keyboard Otherwise returns false

pub fn held_control(&self) -> bool

Returns true while any control key is held on the keyboard Otherwise returns false

pub fn held_alt(&self) -> bool

Returns true while any alt key is held on the keyboard Otherwise returns false

pub fn scroll_diff(&self) -> f32

Returns 0.0 if the mouse is outside of the window. Otherwise returns the amount scrolled by the mouse in between the last two update*() calls

pub fn mouse(&self) -> Option<(f32, f32)>

Returns None when the mouse is outside of the window. Otherwise returns the mouse coordinates in pixels

pub fn mouse_diff(&self) -> (f32, f32)

Returns the difference in mouse coordinates between the last two update*() calls Returns (0.0, 0.0) if the mouse is outside of the window.

pub fn resolution(&self) -> Option<(u32, u32)>

Returns None when the mouse is outside of the window. Otherwise returns the resolution of the window.

pub fn text(&self) -> Vec<TextChar>

Returns the characters pressed since the last update*(). The earlier the character was pressed, the lower the index in the Vec.

pub fn dropped_file(&self) -> Option<PathBuf>

Returns the path to a file that has been drag-and-dropped onto the window.

pub fn window_resized(&self) -> Option<LogicalSize>

Returns the current window size if it was resized between the last two update*() calls. Otherwise returns None

pub fn hidpi_changed(&self) -> Option<f64>

Returns the current window size if it was resized between the last two update*() calls. Otherwise returns None

pub fn quit(&self) -> bool

Returns true if the OS has requested the application to quit. Otherwise returns false.