Struct EguiWantsInput

pub struct EguiWantsInput { /* private fields */ }

Stores whether there’s an Egui context using pointer or keyboard.

Implementations

impl EguiWantsInput

pub fn is_pointer_over_area(&self) -> bool

Is the pointer (mouse/touch) over any egui area?

pub fn wants_pointer_input(&self) -> bool

True if egui is currently interested in the pointer (mouse or touch).

Could be the pointer is hovering over a egui::Window or the user is dragging a widget. If false, the pointer is outside of any egui area and so you may be interested in what it is doing (e.g. controlling your game). Returns false if a drag started outside of egui and then moved over an egui area.

pub fn is_using_pointer(&self) -> bool

Is egui currently using the pointer position (e.g. dragging a slider)?

NOTE: this will return false if the pointer is just hovering over an egui area.

pub fn wants_keyboard_input(&self) -> bool

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

pub fn is_context_menu_open(&self) -> bool

Is an egui context menu open?

pub fn wants_any_pointer_input(&self) -> bool

Returns true if any of the following is true: EguiWantsInput::is_pointer_over_area, EguiWantsInput::wants_pointer_input, EguiWantsInput::is_using_pointer, EguiWantsInput::is_context_menu_open.

pub fn wants_any_keyboard_input(&self) -> bool

Returns true if any of the following is true: EguiWantsInput::wants_keyboard_input, EguiWantsInput::is_context_menu_open.

pub fn wants_any_input(&self) -> bool

Returns true if any of the following is true: EguiWantsInput::wants_any_pointer_input, EguiWantsInput::wants_any_keyboard_input.

Trait Implementations

impl Clone for EguiWantsInput

fn clone(&self) -> EguiWantsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EguiWantsInput

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

Formats the value using the given formatter.

impl Default for EguiWantsInput

fn default() -> EguiWantsInput

Returns the “default value” for a type.

impl Resource for EguiWantsInput

where Self: Send + Sync + 'static,