Struct bevy_egui::EguiContext

pub struct EguiContext { /* private fields */ }

A resource for storing bevy_egui context.

Implementations

impl EguiContext

pub fn ctx(&self) -> &Context

Egui context of the primary window.

This function is only available when the immutable_ctx feature is enabled. The preferable way is to use ctx_mut to avoid unpredictable blocking inside UI systems.

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

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.

This function is only available when the immutable_ctx feature is enabled. The preferable way is to use ctx_for_window_mut to avoid unpredictable blocking inside UI systems.

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

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

This function is only available when the immutable_ctx feature is enabled. The preferable way is to use try_ctx_for_window_mut to avoid unpredictable blocking inside UI systems.

pub fn ctx_mut(&mut self) -> &Context

Egui context of the primary window.

pub fn ctx_for_window_mut(&mut self, window: WindowId) -> &Context

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.

pub fn try_ctx_for_window_mut(&mut self, window: WindowId) -> Option<&Context>

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

pub fn ctx_for_windows_mut<const N: usize>(
    &mut self,
    ids: [WindowId; N]
) -> [&Context; N]

Allows to get multiple contexts at the same time. This function is useful when you want to get multiple window contexts without using the immutable_ctx feature.

Panics

Panics if the passed window ids aren’t unique.

pub fn try_ctx_for_windows_mut<const N: usize>(
    &mut self,
    ids: [WindowId; N]
) -> [Option<&Context>; N]

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

Panics

Panics if the passed window ids aren’t unique.

pub fn add_image(&mut self, image: Handle<Image>) -> TextureId

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 are no handle copies stored anywhere else.

pub fn remove_image(&mut self, image: &Handle<Image>) -> Option<TextureId>

Removes the image handle and an Egui texture id associated with it.

pub fn image_id(&self, image: &Handle<Image>) -> Option<TextureId>

Returns an associated Egui texture id.

Trait Implementations

impl Clone for EguiContext

fn clone(&self) -> EguiContext

Returns a copy of the value.

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

Performs copy-assignment from source.