Struct EguiArk

pub struct EguiArk { /* private fields */ }

Bindings to the egui library.

Instantiate one EguiArk in your module.

let mut egui = EguiArk::default();
let ctx = egui.begin_frame(&applet());
ui(ctx);
let ctx = egui.end_frame(&render(), &applet());

fn ui(ctx: &mut egui::Context) {
    egui::Window::new("My window").show(ctx, |ui| {
        ui.label("Hello world!");
    });
}

Implementations

impl EguiArk

pub fn ctx(&self) -> &Context

Access to the egui context.

pub fn begin_frame(&mut self, applet: &Applet) -> Context

Call before using egui. This gathers input and prepares for a new frame.

pub fn end_frame(&mut self, render: &Render, applet: &Applet)

Call after using egui. This will render the interface.

pub fn wants_pointer_input(&self) -> bool

True if egui is currently interested in the pointer (mouse/touch). Could be the mouse is hovering over a egui window, or the user is dragging an egui widget. If false, the mouse is outside of any egui area and so you may be interested in what it is doing (e.g. controlling your game).

pub fn wants_keyboard_input(&self) -> bool

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

pub fn is_mouse_down(&self) -> bool

pub fn persist(&self) -> Value

Save egui state (window positions etc)

pub fn restore(&self, value: Value)

Restore egui (window positions etc)

pub fn viewport(&self) -> Rectangle

Almost the same as available_rect(), however, in physical pixels, not logical (i.e. available_rect() scaled by the DPI factor).

How much space is still available after panels has been added. This is the “background” area, what egui doesn’t cover with panels (but may cover with windows). This is also the area to which windows are constrained.

Trait Implementations

impl Default for EguiArk

fn default() -> EguiArk

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EguiArk

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EguiArk

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.