Struct bevy_egui::EguiContext

source · [−]

pub struct EguiContext { /* private fields */ }

Expand description

A resource for storing bevy_egui context.

Implementations

source

impl EguiContext

source

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.

source

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.

source

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.

source

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

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.

source

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

Removes a texture handle associated with the id.

Trait Implementations

source

impl Clone for EguiContext

source

fn clone(&self) -> EguiContext

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl !RefUnwindSafe for EguiContext

impl Send for EguiContext

impl Sync for EguiContext

impl Unpin for EguiContext

impl !UnwindSafe for EguiContext

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

impl<T> DowncastSync for T where
T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source