Struct egui::CtxRef

pub struct CtxRef(_);

A wrapper around CtxRef. This is how you will normally access a Context.

Implementations

impl CtxRef

pub fn begin_frame(&mut self, new_input: RawInput)

Call at the start of every frame. Put your widgets into a SidePanel, TopPanel, CentralPanel, Window or Area.

pub fn debug_painter(&self) -> Painter

Methods from Deref<Target = Context>

pub fn available_rect(&self) -> Rect

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.

pub fn memory(&self) -> MutexGuard<'_, Memory>

pub fn graphics(&self) -> MutexGuard<'_, GraphicLayers>

pub fn output(&self) -> MutexGuard<'_, Output>

pub fn request_repaint(&self)

Call this if there is need to repaint the UI, i.e. if you are showing an animation. If this is called at least once in a frame, then there will be another frame right after this. Call as many times as you wish, only one repaint will be issued.

pub fn input(&self) -> &InputState

pub fn fonts(&self) -> &Fonts

Not valid until first call to begin_frame() That's because since we don't know the proper pixels_per_point until then.

pub fn texture(&self) -> Arc<Texture>

The Egui texture, containing font characters etc.. Not valid until first call to begin_frame() That's because since we don't know the proper pixels_per_point until then.

pub fn set_fonts(&self, font_definitions: FontDefinitions)

Will become active at the start of the next frame. pixels_per_point will be ignored (overwritten at start of each frame with the contents of input)

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

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

pub fn pixels_per_point(&self) -> f32

pub fn round_to_pixel(&self, point: f32) -> f32

Useful for pixel-perfect rendering

pub fn round_pos_to_pixels(&self, pos: Pos2) -> Pos2

Useful for pixel-perfect rendering

pub fn round_vec_to_pixels(&self, vec: Vec2) -> Vec2

Useful for pixel-perfect rendering

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

Useful for pixel-perfect rendering

#[must_use]pub fn end_frame(&self) -> (Output, Vec<(Rect, PaintCmd)>)

Call at the end of each frame. Returns what has happened this frame (Output) as well as what you need to paint. You can transform the returned paint commands into triangles with a call to Context::tesselate.

pub fn tesselate(&self, paint_commands: Vec<(Rect, PaintCmd)>) -> PaintJobs

Tesselate the given paint commands into triangle meshes.

pub fn used_rect(&self) -> Rect

How much space is used by panels and windows.

pub fn used_size(&self) -> Vec2

How much space is used by panels and windows. You can shrink your Egui area to this size and still fit all Egui components.

pub fn is_mouse_over_area(&self) -> bool

Is the mouse over any Egui area?

pub fn wants_mouse_input(&self) -> bool

True if Egui is currently interested in the mouse. 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). Returns false if a drag starts outside of Egui and then moves over an Egui window.

pub fn is_using_mouse(&self) -> bool

Is Egui currently using the mouse position (e.g. dragging a slider). NOTE: this will return false if the mouse is just hovering over an Egui window.

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 layer_id_at(&self, pos: Pos2) -> Option<LayerId>

pub fn animate_bool(&self, id: Id, value: bool) -> f32

Returns a value in the range [0, 1], to indicate "how on" this thing is.

The first time called it will return if value { 1.0 } else { 0.0 } Calling this with value = true will always yield a number larger than zero, quickly going towards one. Calling this with value = false will always yield a number less than one, quickly going towards zero.

The function will call request_repaint() when appropriate.

pub fn settings_ui(&self, ui: &mut Ui)

pub fn inspection_ui(&self, ui: &mut Ui)

pub fn memory_ui(&self, ui: &mut Ui)

pub fn style_ui(&self, ui: &mut Ui)

Trait Implementations

impl AsRef<Context> for CtxRef

pub fn as_ref(&self) -> &Context

Performs the conversion.

impl Borrow<Context> for CtxRef

pub fn borrow(&self) -> &Context

Immutably borrows from an owned value.

impl Clone for CtxRef

pub fn clone(&self) -> CtxRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CtxRef

pub fn default() -> Self

Returns the "default value" for a type.

impl Deref for CtxRef

type Target = Context

The resulting type after dereferencing.

pub fn deref(&self) -> &Context

Dereferences the value.

impl PartialEq<CtxRef> for CtxRef

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.