Enum tetra::Event[−][src]

#[non_exhaustive]
pub enum Event {
Show 20 variants    Resized {
        width: i32,
        height: i32,
    },
    Restored,
    Minimized,
    Maximized,
    FocusGained,
    FocusLost,
    KeyPressed {
        key: Key,
    },
    KeyReleased {
        key: Key,
    },
    MouseButtonPressed {
        button: MouseButton,
    },
    MouseButtonReleased {
        button: MouseButton,
    },
    MouseMoved {
        position: Vec2<f32>,
        delta: Vec2<f32>,
    },
    MouseWheelMoved {
        amount: Vec2<i32>,
    },
    GamepadAdded {
        id: usize,
    },
    GamepadRemoved {
        id: usize,
    },
    GamepadButtonPressed {
        id: usize,
        button: GamepadButton,
    },
    GamepadButtonReleased {
        id: usize,
        button: GamepadButton,
    },
    GamepadAxisMoved {
        id: usize,
        axis: GamepadAxis,
        position: f32,
    },
    GamepadStickMoved {
        id: usize,
        stick: GamepadStick,
        position: Vec2<f32>,
    },
    TextInput {
        text: String,
    },
    FileDropped {
        path: PathBuf,
    },
}

Expand description

Events that can occur while the game is running.

State::event will receive events as they occur.

Examples

The events example demonstrates how to handle events.

Variants (Non-exhaustive)

This enum is marked as 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.

Resized

The game window was resized.

Fields of Resized

width: i32

The new width of the game window.

height: i32

The new height of the game window.

Restored

The game window was restored to normal size and position by the user, either by un-minimizing or un-maximizing.

Minimized

The game window was minimized by the user.

Maximized

The game window was maximized by the user.

FocusGained

The game window was focused by the user.

FocusLost

The game window was un-focused by the user.

KeyPressed

A key on the keyboard was pressed.

Fields of KeyPressed

key: Key

The key that was pressed.

KeyReleased

A key on the keyboard was released.

Fields of KeyReleased

key: Key

The key that was released.

MouseButtonPressed

A button on the mouse was pressed.

Fields of MouseButtonPressed

button: MouseButton

The button that was pressed.

MouseButtonReleased

A button on the mouse was released.

Fields of MouseButtonReleased

button: MouseButton

The button that was released.

MouseMoved

The mouse was moved.

Fields of MouseMoved

position: Vec2<f32>

The new position of the mouse, in window co-ordinates.

If relative mouse mode is enabled, this field is not guarenteed to update.

delta: Vec2<f32>

The movement of the mouse, relative to the position of the previous MouseMoved event.

MouseWheelMoved

The mouse wheel was moved.

Fields of MouseWheelMoved

amount: Vec2<i32>

The amount that the wheel was moved.

Most ‘normal’ mice can only scroll vertically, but some devices can also scroll horizontally. Use the Y component of the returned vector if you don’t care about horizontal scroll.

Positive values correspond to scrolling up/right, negative values correspond to scrolling down/left.

GamepadAdded

A gamepad was connected to the system.