Struct EguiState 

pub struct EguiState { /* private fields */ }

smithay-egui state object

Implementations

impl EguiState

pub fn new(area: Rectangle<i32, Logical>) -> EguiState

Creates a new EguiState

pub fn context(&self) -> &Context

Retrieve the underlying egui::Context

pub fn wants_keyboard(&self) -> bool

If true, egui is currently listening on text input (e.g. typing text in a TextEdit).

pub fn wants_pointer(&self) -> bool

True if egui is currently interested in the pointer (mouse or touch). Could be the pointer is hovering over a Window or the user is dragging a widget. If false, the pointer is outside of any egui area and so you may want to forward it to other clients as usual. Returns false if a drag started outside of egui and then moved over an egui area.

pub fn handle_device_added(&self, device: &impl Device)

Pass new input devices to EguiState for internal tracking

pub fn handle_device_removed(&self, device: &impl Device)

Remove input devices to EguiState for internal tracking

pub fn handle_keyboard( &self, handle: &KeysymHandle<'_>, pressed: bool, modifiers: ModifiersState, )

Pass keyboard events into EguiState.

You do not want to pass in events, egui should not react to, but you need to make sure they add up. So for every pressed event, you want to send a released one.

You likely want to use the filter-closure of [smithay::wayland::seat::KeyboardHandle::input] to optain these values. Use [smithay::wayland::seat::KeysymHandle] and the provided [smithay::wayland::seat::ModifiersState].

pub fn handle_pointer_motion(&self, position: Point<i32, Logical>)

Pass new pointer coordinates to EguiState

pub fn handle_pointer_button(&self, button: MouseButton, pressed: bool)

Pass pointer button presses to EguiState

Note: If you are unsure about which PointerButtonEvents to send to smithay-egui instead of normal clients, check EguiState::wants_pointer to figure out, if there is an egui-element below your pointer.

pub fn handle_pointer_axis(&self, x_amount: f64, y_amount: f64)

Pass a pointer axis scrolling to EguiState

Note: If you are unsure about which PointerAxisEvents to send to smithay-egui instead of normal clients, check EguiState::wants_pointer to figure out, if there is an egui-element below your pointer.

pub fn set_focused(&self, focused: bool)

Set if this EguiState should consider itself focused

pub fn render( &self, ui: impl FnMut(&Context), renderer: &mut GlowRenderer, area: Rectangle<i32, Logical>, scale: f64, alpha: f32, ) -> Result<TextureRenderElement<GlesTexture>, GlesError>

Produce a new frame of egui. Returns a [RenderElement]

• ui is your drawing function
• renderer is a GlowRenderer
• area limits the space egui will be using and offsets the result
• scale is the scale egui should render in
• alpha applies (additional) transparency to the whole ui
• start_time need to be a fixed point in time before the first run call to measure animation-times and the like.
• modifiers should be the current state of modifiers pressed on the keyboards.

pub fn set_zindex(&self, idx: u8)

Sets the z_index as reported by SpaceElement::z_index.

The default is RenderZindex::Overlay.

pub fn last_output(&self) -> Option<PlatformOutput>

Returns the egui PlatformOutput generated by the last Self::render call

Trait Implementations

impl Clone for EguiState

fn clone(&self) -> EguiState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EguiState

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

Formats the value using the given formatter.

impl IsAlive for EguiState

fn alive(&self) -> bool

Check if object is alive

impl<D: SeatHandler> KeyboardTarget<D> for EguiState

fn enter( &self, _seat: &Seat<D>, _data: &mut D, keys: Vec<KeysymHandle<'_>>, _serial: Serial, )

Keyboard focus of a given seat was assigned to this handler

fn leave(&self, _seat: &Seat<D>, _data: &mut D, _serial: Serial)

The keyboard focus of a given seat left this handler

fn key( &self, _seat: &Seat<D>, _data: &mut D, key: KeysymHandle<'_>, state: KeyState, _serial: Serial, _time: u32, )

A key was pressed on a keyboard from a given seat

fn modifiers( &self, _seat: &Seat<D>, _data: &mut D, modifiers: ModifiersState, _serial: Serial, )

Hold modifiers were changed on a keyboard from a given seat

fn replace( &self, replaced: <D as SeatHandler>::KeyboardFocus, seat: &Seat<D>, data: &mut D, keys: Vec<KeysymHandle<'_>>, modifiers: ModifiersState, serial: Serial, )

Keyboard focus of a given seat moved from another handler to this handler

impl PartialEq for EguiState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<D: SeatHandler> PointerTarget<D> for EguiState

fn enter(&self, _seat: &Seat<D>, _data: &mut D, event: &MotionEvent)

A pointer of a given seat entered this handler

fn motion(&self, _seat: &Seat<D>, _data: &mut D, event: &MotionEvent)

A pointer of a given seat moved over this handler

fn relative_motion( &self, _seat: &Seat<D>, _data: &mut D, _event: &RelativeMotionEvent, )

A pointer of a given seat that provides relative motion moved over this handler

fn button(&self, _seat: &Seat<D>, _data: &mut D, event: &ButtonEvent)

A pointer of a given seat clicked a button

fn axis(&self, _seat: &Seat<D>, _data: &mut D, _frame: AxisFrame)

A pointer of a given seat scrolled on an axis

fn leave(&self, _seat: &Seat<D>, _data: &mut D, _serial: Serial, _time: u32)

A pointer of a given seat left this handler

fn frame(&self, _seat: &Seat<D>, _data: &mut D)

End of a pointer frame

fn gesture_swipe_begin( &self, _seat: &Seat<D>, _data: &mut D, _event: &GestureSwipeBeginEvent, )

A pointer of a given seat started a swipe gesture

fn gesture_swipe_update( &self, _seat: &Seat<D>, _data: &mut D, _event: &GestureSwipeUpdateEvent, )

A pointer of a given seat updated a swipe gesture

fn gesture_swipe_end( &self, _seat: &Seat<D>, _data: &mut D, _event: &GestureSwipeEndEvent, )

A pointer of a given seat ended a swipe gesture

fn gesture_pinch_begin( &self, _seat: &Seat<D>, _data: &mut D, _event: &GesturePinchBeginEvent, )

A pointer of a given seat started a pinch gesture

fn gesture_pinch_update( &self, _seat: &Seat<D>, _data: &mut D, _event: &GesturePinchUpdateEvent, )

A pointer of a given seat updated a pinch gesture

fn gesture_pinch_end( &self, _seat: &Seat<D>, _data: &mut D, _event: &GesturePinchEndEvent, )

A pointer of a given seat ended a pinch gesture

fn gesture_hold_begin( &self, _seat: &Seat<D>, _data: &mut D, _event: &GestureHoldBeginEvent, )

A pointer of a given seat started a hold gesture

fn gesture_hold_end( &self, _seat: &Seat<D>, _data: &mut D, _event: &GestureHoldEndEvent, )

A pointer of a given seat ended a hold gesture

fn replace( &self, replaced: <D as SeatHandler>::PointerFocus, seat: &Seat<D>, data: &mut D, event: &MotionEvent, )

A pointer of a given seat moved from another handler to this handler

impl SpaceElement for EguiState

Available on crate feature desktop_integration only.

fn bbox(&self) -> Rectangle<i32, Logical>

Returns the bounding box of this element

fn is_in_input_region(&self, point: &Point<f64, Logical>) -> bool

Returns whenever a given point inside this element will be able to receive input

fn set_activate(&self, _activated: bool)

Set the rendered state to activated, if applicable to this element

fn output_enter(&self, _output: &Output, _overlap: Rectangle<i32, Logical>)

The element is displayed on a given output.

fn output_leave(&self, _output: &Output)

The element left a given output

fn z_index(&self) -> u8

Gets the z-index of this element

fn geometry(&self) -> Rectangle<i32, Logical>

Returns the geometry of this element.

fn refresh(&self)

Periodically called to update internal state, if necessary