Enum basalt::input::InputHook

pub enum InputHook {
    Press {
        global: bool,
        keys: Vec<Qwery>,
        mouse_buttons: Vec<MouseButton>,
    },
    Hold {
        global: bool,
        keys: Vec<Qwery>,
        mouse_buttons: Vec<MouseButton>,
        initial_delay: Duration,
        interval: Duration,
        accel: f32,
    },
    Release {
        global: bool,
        keys: Vec<Qwery>,
        mouse_buttons: Vec<MouseButton>,
    },
    Character,
    MouseEnter,
    MouseLeave,
    MouseMove,
    MouseMotion,
    MouseScroll,
    WindowFocused,
    WindowLostFocus,
    AnyMouseOrKeyPress {
        global: bool,
    },
    AnyMousePress {
        global: bool,
    },
    AnyKeyPress {
        global: bool,
    },
    AnyMouseOrKeyRelease {
        global: bool,
    },
    AnyMouseRelease {
        global: bool,
    },
    AnyKeyRelease {
        global: bool,
    },
}

Variants

Press

Fields

global: bool

keys: Vec<Qwery>

mouse_buttons: Vec<MouseButton>

Press is called once when all keys and mouse buttons are active.

Hold

Fields

global: bool

keys: Vec<Qwery>

mouse_buttons: Vec<MouseButton>

initial_delay: Duration

interval: Duration

accel: f32

Hold is called while the key and mouse buttons are called. Nothing will be called until the initial delay period has elapsed. After that it will be called every time interval has elapsed. accel is not implemnted at this time.

Release

Fields

global: bool

keys: Vec<Qwery>

mouse_buttons: Vec<MouseButton>

Release is called when the all keys/buttons have been set to active and then anyone of them has been release. Release is also called when the window loses focus.

Character

Like a normal key press. Qwery is converted into a Character with modifiers in consideration.

MouseEnter

Called when the mouse enters the window.

MouseLeave

Called when the mouse leaves the window.

MouseMove

Called when the mouse moves within the window.

MouseMotion

Called when the mouse motion is recieved. This is not a window event, but rather a device event. Do not use this in combination with MouseMove as the data units may differ. Example use would be for game camera.

MouseScroll

Called when the mouse is over the window.

WindowFocused

Called when the window gains focus.

WindowLostFocus

Called when the window loses focus.

AnyMouseOrKeyPress

Fields

global: bool

Called on any mouse button or key press.

AnyMousePress

Fields

global: bool

Called on any mouse button press.

AnyKeyPress

Fields

global: bool

Called on any key press.

AnyMouseOrKeyRelease

Fields

global: bool

Called on any mouse button or key release. Also called when the window loses focus with all the keys and buttons that were currently held before.

AnyMouseRelease

Fields

global: bool

Called on any mouse button release. Also called when the window loses focus with all the mouse buttons that were currently held before.

AnyKeyRelease

Fields

global: bool

Called on any key release. Also called when the window loses focus with all the keys that were currently held before.

Implementations

impl InputHook

pub fn into_data(&self) -> InputHookData

pub fn ty(&self) -> InputHookTy

Trait Implementations

impl Clone for InputHook

fn clone(&self) -> InputHook

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputHook

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

Formats the value using the given formatter.

impl PartialEq<InputHook> for InputHook

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

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

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

This method tests for !=.

impl StructuralPartialEq for InputHook