Struct bevy_egui::EguiContext
source · pub struct EguiContext(/* private fields */);
Expand description
A component for storing bevy_egui
context.
Implementations§
source§impl EguiContext
impl EguiContext
sourcepub fn get(&self) -> &Context
pub fn get(&self) -> &Context
Borrows the underlying Egui context immutably.
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.
sourcepub fn get_mut(&mut self) -> &mut Context
pub fn get_mut(&mut self) -> &mut Context
Borrows the underlying Egui context mutably.
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.
Trait Implementations§
source§impl Clone for EguiContext
impl Clone for EguiContext
source§fn clone(&self) -> EguiContext
fn clone(&self) -> EguiContext
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Component for EguiContext
impl Component for EguiContext
source§impl Default for EguiContext
impl Default for EguiContext
source§fn default() -> EguiContext
fn default() -> EguiContext
source§impl ExtractComponent for EguiContextwhere
Self: Clone,
impl ExtractComponent for EguiContextwhere
Self: Clone,
§type QueryData = &'static EguiContext
type QueryData = &'static EguiContext
ReadOnlyQueryData
] to fetch the components to extract.§type QueryFilter = ()
type QueryFilter = ()
§type Out = EguiContext
type Out = EguiContext
source§fn extract_component(item: QueryItem<'_, Self::QueryData>) -> Option<Self::Out>
fn extract_component(item: QueryItem<'_, Self::QueryData>) -> Option<Self::Out>
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§
§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
[ShaderType
] for self
. When used in [AsBindGroup
]
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<C> Bundle for Cwhere
C: Component,
impl<C> Bundle for Cwhere
C: Component,
fn component_ids( components: &mut Components, storages: &mut Storages, ids: &mut impl FnMut(ComponentId) )
unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<C> DynamicBundle for Cwhere
C: Component,
impl<C> DynamicBundle for Cwhere
C: Component,
fn get_components(self, func: &mut impl FnMut(StorageType, OwningPtr<'_>))
§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given [World
].