Struct 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 EguiContexts<'_, '_>

pub fn ctx_mut(&mut self) -> Result<&mut Context, QuerySingleError>

Returns an Egui context with the PrimaryEguiContext component.

pub fn ctx_for_entity_mut( &mut self, entity: Entity, ) -> Result<&mut Context, QueryEntityError>

Egui context of a specific entity.

pub fn ctx_for_entities_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 contexts without using the immutable_ctx feature.

pub fn add_image(&mut self, image: EguiTextureHandle) -> 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 don’t want to bother with cleaning up textures in Egui. (The cleanup happens in free_egui_textures_system.)

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: impl Into<AssetId<Image>>, ) -> Option<TextureId>

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

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

Returns an associated Egui texture id.

Trait Implementations

impl SystemParam for EguiContexts<'_, '_>

type State = FetchState

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) -> Self::State

Creates a new instance of this param’s State.

fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam

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 ApplyDeferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn validate_param<'w, 's>( state: &'s mut Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

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

where Query<'w, 's, (&'static mut EguiContext, Option<&'static PrimaryEguiContext>)>: ReadOnlySystemParam, ResMut<'w, EguiUserTextures>: ReadOnlySystemParam,