Struct bevy_egui::EguiContext

pub struct EguiContext { /* private fields */ }

A component for storing bevy_egui context.

Implementations

impl EguiContext

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.

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

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.

impl Component for EguiContext

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Default for EguiContext

fn default() -> EguiContext

Returns the “default value” for a type.

impl ExtractComponent for EguiContext

where Self: Clone,

type QueryData = &'static EguiContext

ECS ReadOnlyQueryData to fetch the components to extract.

type QueryFilter = ()

Filters the entities with additional constraints.

type Out = EguiContext

The output from extraction.

fn extract_component(item: QueryItem<'_, Self::QueryData>) -> Option<Self::Out>

Defines how the component is transferred into the “render world”.