Enum winit::event::WindowEvent

source ·
pub enum WindowEvent<'a> {
Show 21 variants Resized(PhysicalSize<u32>), Moved(PhysicalPosition<i32>), CloseRequested, Destroyed, DroppedFile(PathBuf), HoveredFile(PathBuf), HoveredFileCancelled, ReceivedCharacter(char), Focused(bool), KeyboardInput { device_id: DeviceId, input: KeyboardInput, is_synthetic: bool, }, ModifiersChanged(ModifiersState), CursorMoved { device_id: DeviceId, position: PhysicalPosition<f64>, modifiers: ModifiersState, }, CursorEntered { device_id: DeviceId, }, CursorLeft { device_id: DeviceId, }, MouseWheel { device_id: DeviceId, delta: MouseScrollDelta, phase: TouchPhase, modifiers: ModifiersState, }, MouseInput { device_id: DeviceId, state: ElementState, button: MouseButton, modifiers: ModifiersState, }, TouchpadPressure { device_id: DeviceId, pressure: f32, stage: i64, }, AxisMotion { device_id: DeviceId, axis: AxisId, value: f64, }, Touch(Touch), ScaleFactorChanged { scale_factor: f64, new_inner_size: &'a mut PhysicalSize<u32>, }, ThemeChanged(Theme),
}
Expand description

Describes an event from a Window.

Variants§

§

Resized(PhysicalSize<u32>)

The size of the window has changed. Contains the client area’s new dimensions.

§

Moved(PhysicalPosition<i32>)

The position of the window has changed. Contains the window’s new position.

§

CloseRequested

The window has been requested to close.

§

Destroyed

The window has been destroyed.

§

DroppedFile(PathBuf)

A file has been dropped into the window.

When the user drops multiple files at once, this event will be emitted for each file separately.

§

HoveredFile(PathBuf)

A file is being hovered over the window.

When the user hovers multiple files at once, this event will be emitted for each file separately.

§

HoveredFileCancelled

A file was hovered, but has exited the window.

There will be a single HoveredFileCancelled event triggered even if multiple files were hovered.

§

ReceivedCharacter(char)

The window received a unicode character.

§

Focused(bool)

The window gained or lost focus.

The parameter is true if the window has gained focus, and false if it has lost focus.

§

KeyboardInput

Fields

§device_id: DeviceId
§is_synthetic: bool

If true, the event was generated synthetically by winit in one of the following circumstances:

  • Synthetic key press events are generated for all keys pressed when a window gains focus. Likewise, synthetic key release events are generated for all keys pressed when a window goes out of focus. Currently, this is only functional on X11 and Windows

Otherwise, this value is always false.

An event from the keyboard has been received.

§

ModifiersChanged(ModifiersState)

The keyboard modifiers have changed.

Platform-specific behavior:

  • Web: This API is currently unimplemented on the web. This isn’t by design - it’s an issue, and it should get fixed - but it’s the current state of the API.
§

CursorMoved

Fields

§device_id: DeviceId
§position: PhysicalPosition<f64>

(x,y) coords in pixels relative to the top-left corner of the window. Because the range of this data is limited by the display area and it may have been transformed by the OS to implement effects such as cursor acceleration, it should not be used to implement non-cursor-like interactions such as 3D camera control.

§modifiers: ModifiersState
👎Deprecated: Deprecated in favor of WindowEvent::ModifiersChanged

The cursor has moved on the window.

§

CursorEntered

Fields

§device_id: DeviceId

The cursor has entered the window.

§

CursorLeft

Fields

§device_id: DeviceId

The cursor has left the window.

§

MouseWheel

Fields

§device_id: DeviceId
§phase: TouchPhase
§modifiers: ModifiersState
👎Deprecated: Deprecated in favor of WindowEvent::ModifiersChanged

A mouse wheel movement or touchpad scroll occurred.

§

MouseInput

Fields

§device_id: DeviceId
§button: MouseButton
§modifiers: ModifiersState
👎Deprecated: Deprecated in favor of WindowEvent::ModifiersChanged

An mouse button press has been received.

§

TouchpadPressure

Fields

§device_id: DeviceId
§pressure: f32
§stage: i64

Touchpad pressure event.

At the moment, only supported on Apple forcetouch-capable macbooks. The parameters are: pressure level (value between 0 and 1 representing how hard the touchpad is being pressed) and stage (integer representing the click level).

§

AxisMotion

Fields

§device_id: DeviceId
§axis: AxisId
§value: f64

Motion on some analog axis. May report data redundant to other, more specific events.

§

Touch(Touch)

Touch event has been received

§

ScaleFactorChanged

Fields

§scale_factor: f64
§new_inner_size: &'a mut PhysicalSize<u32>

The window’s scale factor has changed.

The following user actions can cause DPI changes:

  • Changing the display’s resolution.
  • Changing the display’s scale factor (e.g. in Control Panel on Windows).
  • Moving the window to a display with a different scale factor.

After this event callback has been processed, the window will be resized to whatever value is pointed to by the new_inner_size reference. By default, this will contain the size suggested by the OS, but it can be changed to any value.

For more information about DPI in general, see the dpi module.

§

ThemeChanged(Theme)

The system window theme has changed.

Applications might wish to react to this to change the theme of the content of the window when the system changes the window theme.

At the moment this is only supported on Windows.

Implementations§

source§

impl<'a> WindowEvent<'a>

source

pub fn to_static(self) -> Option<WindowEvent<'static>>

Trait Implementations§

source§

impl Clone for WindowEvent<'static>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for WindowEvent<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> PartialEq<WindowEvent<'a>> for WindowEvent<'a>

source§

fn eq(&self, other: &WindowEvent<'a>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a> StructuralPartialEq for WindowEvent<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for WindowEvent<'a>

§

impl<'a> Send for WindowEvent<'a>

§

impl<'a> Sync for WindowEvent<'a>

§

impl<'a> Unpin for WindowEvent<'a>

§

impl<'a> !UnwindSafe for WindowEvent<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere
    T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere
    T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.