Struct egui::Context

pub struct Context { /* fields omitted */ }

Contains the input, style and output of all GUI commands. Ui:s keep an Arc pointer to this. This allows us to create several child Ui:s at once, all working against the same shared Context.

Implementations

impl Context

pub fn new() -> Arc<Self>

pub fn rect(&self) -> Rect

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

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

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

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) -> &Texture

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 (overwitten at start of each frame with the contents of input)

pub fn style(&self) -> Style

pub fn set_style(&self, style: 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

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

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

pub fn begin_frame(self: &mut Arc<Self>, new_input: RawInput) -> Ui

Call at the start of every frame. Returns a master fullscreen UI, covering the entire screen.

#[must_use]pub fn end_frame(&self) -> (Output, PaintBatches)

Call at the end of each frame. Returns what has happened this frame (Output) as well as what you need to paint.

pub fn make_unique_id<IdSource>(&self, source: IdSource, pos: Pos2) -> Id where
    IdSource: Hash + Debug + Copy, 

Generate a id from the given source. If it is not unique, an error will be printed at the given position.

pub fn register_unique_id(
    &self,
    id: Id,
    source_name: impl Debug,
    pos: Pos2
) -> Id

If the given Id is not unique, an error will be printed at the given position.

pub fn contains_mouse(&self, layer: Layer, clip_rect: Rect, rect: Rect) -> bool

pub fn interact(
    &self,
    layer: Layer,
    clip_rect: Rect,
    rect: Rect,
    interaction_id: Option<Id>,
    sense: Sense
) -> InteractInfo

pub fn show_error(&self, pos: Pos2, text: impl Into<String>)

pub fn debug_text(&self, pos: Pos2, text: impl Into<String>)

pub fn debug_rect(&self, rect: Rect, name: impl Into<String>)

pub fn floating_text(
    &self,
    layer: Layer,
    pos: Pos2,
    text: String,
    text_style: TextStyle,
    align: (Align, Align),
    text_color: Option<Color>
) -> Rect

Show some text anywhere on screen. To center the text at the given position, use align: (Center, Center).

pub fn add_galley(
    &self,
    layer: Layer,
    pos: Pos2,
    galley: Galley,
    text_style: TextStyle,
    color: Option<Color>
)

Already layed out text.

pub fn add_paint_cmd(&self, layer: Layer, paint_cmd: PaintCmd)

impl Context

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

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

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

impl Context

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

Trait Implementations

impl Clone for Context

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Context

fn default() -> Context

Returns the "default value" for a type.