Crate egui_winit

Source
Expand description

egui bindings for winit.

The library translates winit events to egui, handled copy/paste, updates the cursor, open links clicked in egui, etc.

§Feature flags

  • accesskit — Enable platform accessibility API implementations through AccessKit.
  • android-game-activity — Enable the game-activity backend via Winit on Android
  • android-native-activity — Enable the native-activity backend via Winit on Android
  • bytemuckbytemuck enables you to cast egui::epaint::Vertex, egui::Vec2 etc to &[u8].
  • clipboard (enabled by default) — Enable cut/copy/paste to OS clipboard. If disabled a clipboard will be simulated so you can still copy/paste within the egui app.
  • links (enabled by default) — Enable opening links in a browser when an egui hyperlink is clicked.
  • serde — Allow serialization of WindowSettings using serde.
  • wayland (enabled by default) — Enables Wayland support.
  • x11 (enabled by default) — Enables compiling for x11.

§Optional dependencies

  • document-features — Enable this when generating docs.

Re-exports§

pub use accesskit_winit;
pub use egui;
pub use winit;

Modules§

clipboard

Structs§

EventResponse
State
Handles the integration between egui and a winit Window.
WindowSettings
Can be used to store native window settings (position and size).

Enums§

ActionRequested

Functions§

apply_viewport_builder_to_window
Applies what create_winit_window_builder couldn’t
create_window
Build and intitlaize a window.
create_winit_window_attributes
inner_rect_in_points
outer_rect_in_points
pixels_per_point
Calculate the pixels_per_point for a given window, given the current egui zoom factor
process_viewport_commands
screen_size_in_pixels
short_device_event_description
Short and fast description of a device event. Useful for logging and profiling.
short_window_event_description
Short and fast description of a window event. Useful for logging and profiling.
update_viewport_info
Update the given viewport info with the current state of the window.