Struct egui::Memory

pub struct Memory {
    pub all_collpasing_are_open: bool,
    pub all_menus_are_open: bool,
    pub all_windows_are_open: bool,
    // some fields omitted
}

The data that Egui persists between frames.

This includes window positions and sizes, how far the user has scrolled in a ScrollArea etc.

If you want this to persist when closing your app you should serialize Memory and store it.

Fields

all_collpasing_are_open: bool

Useful for debugging, benchmarking etc.

all_menus_are_open: bool

Useful for debugging, benchmarking etc.

all_windows_are_open: bool

Useful for debugging, benchmarking etc.

Implementations

impl Memory

pub fn layer_id_at(
    &self,
    pos: Pos2,
    resize_interact_radius_side: f32
) -> Option<LayerId>

pub fn lost_kb_focus(&self, id: Id) -> bool

True if the given widget had keyboard focus last frame, but not this one.

pub fn has_kb_focus(&self, id: Id) -> bool

pub fn request_kb_focus(&mut self, id: Id)

pub fn surrender_kb_focus(&mut self, id: Id)

pub fn interested_in_kb_focus(&mut self, id: Id)

Register this widget as being interested in getting keyboard focus. This will allow the user to select it with tab and shift-tab.

pub fn stop_text_input(&mut self)

Stop editing of active TextEdit (if any).

pub fn is_anything_being_dragged(&self) -> bool

pub fn is_being_dragged(&self, id: Id) -> bool

pub fn reset_areas(&mut self)

Forget window positions, sizes etc. Can be used to auto-layout windows.

impl Memory

Popups

Popups are things like combo-boxes, color pickers, menus etc. Only one can be be open at a time.

pub fn is_popup_open(&mut self, popup_id: Id) -> bool

pub fn open_popup(&mut self, popup_id: Id)

pub fn close_popup(&mut self)

pub fn toggle_popup(&mut self, popup_id: Id)

Trait Implementations

impl Clone for Memory

pub fn clone(&self) -> Memory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Memory

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

Formats the value using the given formatter.

impl Default for Memory

pub fn default() -> Memory

Returns the "default value" for a type.