Enum UiEvent 

#[non_exhaustive]
pub enum UiEvent {
    Resize(u32, u32),
    CloseRequested,
    KeyPress(String),
    Mouse {
        x: f32,
        y: f32,
    },
    MouseDown {
        button: MouseButton,
        x: f32,
        y: f32,
        modifiers: Modifiers,
    },
    MouseUp {
        button: MouseButton,
        x: f32,
        y: f32,
        modifiers: Modifiers,
    },
    MouseMove {
        x: f32,
        y: f32,
    },
    Wheel(ScrollDelta),
    KeyDown {
        key: Key,
        modifiers: Modifiers,
        repeat: bool,
    },
    KeyUp {
        key: Key,
        modifiers: Modifiers,
    },
    ImePreedit {
        text: String,
        cursor: Option<(usize, usize)>,
    },
    ImeCommit(String),
}

Events that the UI backend can emit.

This enum is #[non_exhaustive] — match arms must include a catch-all (_ => {}) to remain forward-compatible as new variants are added.

When deserialising with serde (feature = "serde"), unknown variants will produce a serde error. This is intentional: the API contract only promises forward-compatibility at the Rust source level via the #[non_exhaustive] catch-all; JSON consumers must handle new variants themselves.

Variants (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.

Resize(u32, u32)

The window was resized to the given pixel dimensions.

CloseRequested

The user requested the window to close.

KeyPress(String)

A keyboard key was pressed (key name / character string).

Mouse

Mouse cursor position.

Fields

x: f32

Horizontal position in logical pixels.

y: f32

Vertical position in logical pixels.

MouseDown

A mouse button was pressed at the given position.

Fields

button: MouseButton

Which button was pressed.

x: f32

Horizontal position in logical pixels.

y: f32

Vertical position in logical pixels.

modifiers: Modifiers

Modifier keys held at the time of the press.

MouseUp

A mouse button was released at the given position.

Fields

button: MouseButton

Which button was released.

x: f32

Horizontal position in logical pixels.

y: f32

Vertical position in logical pixels.

modifiers: Modifiers

Modifier keys held at the time of the release.

MouseMove

The mouse moved to a new position (no button-state change implied).

Fields

x: f32

Horizontal position in logical pixels.

y: f32

Vertical position in logical pixels.

Wheel(ScrollDelta)

A scroll-wheel / trackpad scroll occurred.

KeyDown

A key was pressed (or auto-repeated).

Fields

key: Key

The logical key.

modifiers: Modifiers

Modifier keys held.

repeat: bool

Whether this is an auto-repeat (key held down).

KeyUp

A key was released.

Fields

key: Key

The logical key.

modifiers: Modifiers

Modifier keys held.

ImePreedit

IME preedit — composition in progress.

text is the current composition string. cursor is the byte-offset range (start, end) within text that should be highlighted as the cursor/selection; None means no explicit cursor hint.

Note: on the egui forwarding path the cursor range is forwarded as of egui 0.35+ — it is converted from this byte-offset range into the char-offset egui::ImeEvent::Preedit::active_range_chars range (egui 0.34 and earlier accepted only a bare String, so the cursor hint was dropped there).

Fields

text: String

Composition string being entered.

cursor: Option<(usize, usize)>

Optional byte-range cursor hint within text.

ImeCommit(String)

IME commit — final committed text after composition ends.

Callers should insert text into the active text-input field.

Trait Implementations

impl Clone for UiEvent

fn clone(&self) -> UiEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiEvent

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

Formats the value using the given formatter.