Struct bevy_egui::EguiContext

pub struct EguiContext { /* fields omitted */ }

A resource for storing bevy_egui context.

Implementations

impl EguiContext

pub fn ctx(&self) -> &CtxRef

Egui context of the primary window.

Note: accessing the context from different threads simultaneously requires enabling egui/multi_threaded feature.

pub fn ctx_for_window(&self, window: WindowId) -> &CtxRef

Egui context for a specific window. If you want to display UI on a non-primary window, make sure to set up the render graph by calling setup_pipeline.

Note: accessing the context from different threads simultaneously requires enabling egui/multi_threaded feature.

pub fn try_ctx_for_window(&self, window: WindowId) -> Option<&CtxRef>

Fallible variant of EguiContext::ctx_for_window. Make sure to set up the render graph by calling setup_pipeline.

pub fn set_egui_texture(&mut self, id: u64, texture: Handle<Texture>)

Can accept either a strong or a weak handle.

You may want to pass a weak handle if you control removing texture assets in your application manually and you don’t want to bother with cleaning up textures in egui.

You’ll want to pass a strong handle if a texture is used only in egui and there’s no handle copies stored anywhere else.

pub fn remove_egui_texture(&mut self, id: u64)

Removes a texture handle associated with the id.