Struct egui::Ui

source ·

pub struct Ui {
    id: Id,
    unique_id: Id,
    next_auto_id_salt: u64,
    painter: Painter,
    style: Arc<Style>,
    placer: Placer,
    enabled: bool,
    sizing_pass: bool,
    menu_state: Option<Arc<RwLock<MenuState>>>,
    stack: Arc<UiStack>,
    sense: Sense,
    min_rect_already_remembered: bool,
}

Expand description

This is what you use to place widgets.

Represents a region of the screen with a type of layout (horizontal or vertical).

ui.add(egui::Label::new("Hello World!"));
ui.label("A shorter and more convenient way to add a label.");
ui.horizontal(|ui| {
    ui.label("Add widgets");
    if ui.button("on the same row!").clicked() {
        /* … */
    }
});

Fields§

§id: Id

Generated based on id of parent ui together with an optional id salt.

This should be stable from one frame to next so it can be used as a source for storing state (e.g. window position, or if a collapsing header is open).

However, it is not necessarily globally unique. For instance, sibling Uis share the same Self::id unless they where explicitly given different id salts using UiBuilder::id_salt.

§unique_id: Id

This is a globally unique ID of this Ui, based on where in the hierarchy of widgets this Ui is in.

This means it is not stable, as it can change if new widgets are added or removed prior to this one. It should therefore only be used for transient interactions (clicks etc), not for storing state over time.

§next_auto_id_salt: u64

This is used to create a unique interact ID for some widgets.

This value is based on where in the hierarchy of widgets this Ui is in, and the value is increment with each added child widget. This works as an Id source only as long as new widgets aren’t added or removed. They are therefore only good for Id:s that has no state.

§painter: Painter

Specifies paint layer, clip rectangle and a reference to Context.

§style: Arc<Style>

The Style (visuals, spacing, etc) of this ui. Commonly many Ui:s share the same Style. The Ui implements copy-on-write for this.

§placer: Placer

Handles the Ui size and the placement of new widgets.

§enabled: bool

If false we are unresponsive to input, and all widgets will assume a gray style.

§sizing_pass: bool

Set to true in special cases where we do one frame where we size up the contents of the Ui, without actually showing it.

§menu_state: Option<Arc<RwLock<MenuState>>>

Indicates whether this Ui belongs to a Menu.

§stack: Arc<UiStack>

The UiStack for this Ui.

§sense: Sense

The sense for the ui background.

§min_rect_already_remembered: bool

Whether Ui::remember_min_rect should be called when the Ui is dropped. This is an optimization, so we don’t call Ui::remember_min_rect multiple times at the end of a Ui::scope.

Struct egui::UiCopy item path

Fields§

Implementations§

impl Ui

pub fn new(ctx: Context, id: Id, ui_builder: UiBuilder) -> Self

pub fn child_ui( &mut self, max_rect: Rect, layout: Layout, ui_stack_info: Option<UiStackInfo>, ) -> Self

pub fn child_ui_with_id_source( &mut self, max_rect: Rect, layout: Layout, id_salt: impl Hash, ui_stack_info: Option<UiStackInfo>, ) -> Self

pub fn new_child(&mut self, ui_builder: UiBuilder) -> Self

pub fn set_sizing_pass(&mut self)

pub fn is_sizing_pass(&self) -> bool

pub fn id(&self) -> Id

pub fn unique_id(&self) -> Id

pub fn style(&self) -> &Arc<Style>

pub fn style_mut(&mut self) -> &mut Style

pub fn set_style(&mut self, style: impl Into<Arc<Style>>)

pub fn reset_style(&mut self)

pub fn spacing(&self) -> &Spacing

pub fn spacing_mut(&mut self) -> &mut Spacing

pub fn visuals(&self) -> &Visuals

pub fn visuals_mut(&mut self) -> &mut Visuals

pub fn stack(&self) -> &Arc<UiStack>

pub fn ctx(&self) -> &Context

pub fn painter(&self) -> &Painter

pub fn is_enabled(&self) -> bool

pub fn disable(&mut self)

§Example

pub fn set_enabled(&mut self, enabled: bool)

§Example

pub fn is_visible(&self) -> bool

pub fn set_invisible(&mut self)

§Example

pub fn set_visible(&mut self, visible: bool)

§Example

pub fn set_opacity(&mut self, opacity: f32)

§Example

pub fn multiply_opacity(&mut self, opacity: f32)

pub fn opacity(&self) -> f32

pub fn layout(&self) -> &Layout

pub fn wrap_mode(&self) -> TextWrapMode

pub fn wrap_text(&self) -> bool

pub fn text_valign(&self) -> Align

pub fn painter_at(&self, rect: Rect) -> Painter

pub fn layer_id(&self) -> LayerId

pub fn text_style_height(&self, style: &TextStyle) -> f32

pub fn clip_rect(&self) -> Rect

pub fn shrink_clip_rect(&mut self, new_clip_rect: Rect)

pub fn set_clip_rect(&mut self, clip_rect: Rect)

pub fn is_rect_visible(&self, rect: Rect) -> bool

impl Ui

§Helpers for accessing the underlying Context.

pub fn input<R>(&self, reader: impl FnOnce(&InputState) -> R) -> R

pub fn input_mut<R>(&self, writer: impl FnOnce(&mut InputState) -> R) -> R

pub fn memory<R>(&self, reader: impl FnOnce(&Memory) -> R) -> R

pub fn memory_mut<R>(&self, writer: impl FnOnce(&mut Memory) -> R) -> R

pub fn data<R>(&self, reader: impl FnOnce(&IdTypeMap) -> R) -> R

pub fn data_mut<R>(&self, writer: impl FnOnce(&mut IdTypeMap) -> R) -> R

pub fn output<R>(&self, reader: impl FnOnce(&PlatformOutput) -> R) -> R

pub fn output_mut<R>(&self, writer: impl FnOnce(&mut PlatformOutput) -> R) -> R

pub fn fonts<R>(&self, reader: impl FnOnce(&Fonts) -> R) -> R

impl Ui

§Sizes etc

pub fn min_rect(&self) -> Rect

pub fn min_size(&self) -> Vec2

pub fn max_rect(&self) -> Rect

pub(crate) fn force_set_min_rect(&mut self, min_rect: Rect)

pub fn set_max_size(&mut self, size: Vec2)

pub fn set_max_width(&mut self, width: f32)

pub fn set_max_height(&mut self, height: f32)

pub fn set_min_size(&mut self, size: Vec2)

pub fn set_min_width(&mut self, width: f32)

pub fn set_min_height(&mut self, height: f32)

pub fn shrink_width_to_current(&mut self)

pub fn shrink_height_to_current(&mut self)

pub fn expand_to_include_rect(&mut self, rect: Rect)

pub fn set_width_range(&mut self, width: impl Into<Rangef>)

pub fn set_height_range(&mut self, height: impl Into<Rangef>)

pub fn set_width(&mut self, width: f32)

pub fn set_height(&mut self, height: f32)

pub fn expand_to_include_x(&mut self, x: f32)

pub fn expand_to_include_y(&mut self, y: f32)

Struct egui::Ui

§Helpers for accessing the underlying `Context`.

§`Id` creation

pub fn make_persistent_id<IdSource>(&self, id_salt: IdSource) -> Id
where IdSource: Hash,

pub fn auto_id_with<IdSource>(&self, id_salt: IdSource) -> Id
where IdSource: Hash,