Struct EguiContextMessageReader 

pub struct EguiContextMessageReader<'w, 's, M: Message> { /* private fields */ }

A helper system param to iterate over pairs of messages and Egui contexts, see EguiContextsMessageIterator.

Implementations

impl<'w, 's, M: Message> EguiContextMessageReader<'w, 's, M>

pub fn read<'a, F>( &'a mut self, map_message_to_window_id_f: F, ) -> EguiContextsMessageIterator<'a, M, F>

where F: FnMut(&'a M) -> Entity, M: Message,

Returns EguiContextsMessageIterator that iterates only over window messages (i.e. skips contexts that render to images, etc.), expects a lambda that extracts a window id from an message.

pub fn read_with_non_window_hovered<'a, F>( &'a mut self, map_message_to_window_id_f: F, ) -> EguiContextsMessageIterator<'a, M, F>

where F: FnMut(&'a M) -> Entity, M: Message,

Returns EguiContextsMessageIterator that iterates over window messages but might substitute contexts with a currently hovered non-window context (see HoveredNonWindowEguiContext), expects a lambda that extracts a window id from an message.

pub fn read_with_non_window_focused<'a, F>( &'a mut self, map_message_to_window_id_f: F, ) -> EguiContextsMessageIterator<'a, M, F>

where F: FnMut(&'a M) -> Entity, M: Message,

Returns EguiContextsMessageIterator that iterates over window messages but might substitute contexts with a currently focused non-window context (see FocusedNonWindowEguiContext), expects a lambda that extracts a window id from an message.

Trait Implementations

impl<M: Message> SystemParam for EguiContextMessageReader<'_, '_, M>

type State = FetchState<M>

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

type Item<'w, 's> = EguiContextMessageReader<'w, 's, M>

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, M: Message> ReadOnlySystemParam for EguiContextMessageReader<'w, 's, M>

where MessageReader<'w, 's, M>: ReadOnlySystemParam, Res<'w, WindowToEguiContextMap>: ReadOnlySystemParam, Option<Res<'w, HoveredNonWindowEguiContext>>: ReadOnlySystemParam, Option<Res<'w, FocusedNonWindowEguiContext>>: ReadOnlySystemParam,