Struct bevy_egui::EguiContexts

pub struct EguiContexts<'w, 's> { /* private fields */ }

A helper SystemParam that provides a way to get [EguiContext] with less boilerplate and combines a proxy interface to the EguiUserTextures resource.

Implementations

impl<'w, 's> EguiContexts<'w, 's>

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

Egui context of the primary window.

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

Egui context for a specific window.

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

Fallible variant of EguiContexts::ctx_for_window_mut.

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

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.

pub fn ctx(&self) -> &Context

Egui context of the primary window.

Even though the mutable borrow isn’t necessary, as the context is wrapped into RwLock, using the immutable getter is gated with the immutable_ctx feature. Using the immutable borrow is discouraged as it may cause unpredictable blocking in UI systems.

When the context is queried with &mut EguiContext, the Bevy scheduler is able to make sure that the context isn’t accessed concurrently and can perform other useful work instead of busy-waiting.

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

Egui context for a specific window.

Even though the mutable borrow isn’t necessary, as the context is wrapped into RwLock, using the immutable getter is gated with the immutable_ctx feature. Using the immutable borrow is discouraged as it may cause unpredictable blocking in UI systems.

When the context is queried with &mut EguiContext, the Bevy scheduler is able to make sure that the context isn’t accessed concurrently and can perform other useful work instead of busy-waiting.

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

Fallible variant of EguiContexts::ctx_for_window_mut.

Even though the mutable borrow isn’t necessary, as the context is wrapped into RwLock, using the immutable getter is gated with the immutable_ctx feature. Using the immutable borrow is discouraged as it may cause unpredictable blocking in UI systems.

When the context is queried with &mut EguiContext, the Bevy scheduler is able to make sure that the context isn’t accessed concurrently and can perform other useful work instead of busy-waiting.

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<'w, 's> SystemParam for EguiContexts<'w, 's>

type State = FetchState<'static, 'static>

Used to store data which persists across invocations of a system.

type Item<'_w, '_s> = EguiContexts<'_w, '_s>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any [World] access used by this [SystemParam] and creates a new instance of this param’s State.

fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta )

For the specified [Archetype], registers the components accessed by this [SystemParam] (if applicable).

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this [SystemParam]’s state. This is used to apply Commands during apply_system_buffers.

unsafe fn get_param<'w2, 's2>( state: &'s2 mut Self::State, system_meta: &SystemMeta, world: &'w2 World, change_tick: u32 ) -> Self::Item<'w2, 's2>

Safety

impl<'w, 's> ReadOnlySystemParam for EguiContexts<'w, 's>where Query<'w, 's, (Entity, &'static mut EguiContext, Option<&'static PrimaryWindow>), With<Window>>: ReadOnlySystemParam, ResMut<'w, EguiUserTextures>: ReadOnlySystemParam,