pub struct OverlayManager { /* private fields */ }Expand description
Internal state for all overlays within a single App tree.
The manager does not know about the concrete UI of each overlay type. It only allocates z-index values and tracks basic metadata so that visual layers can be rendered in a stable order.
Implementations§
Source§impl OverlayManager
impl OverlayManager
Sourcepub fn open(
&mut self,
kind: OverlayKind,
has_mask: bool,
) -> (OverlayKey, OverlayMeta)
pub fn open( &mut self, kind: OverlayKind, has_mask: bool, ) -> (OverlayKey, OverlayMeta)
Open a new overlay of the given kind.
Returns the allocated key together with the computed metadata so the caller can immediately use the z-index.
Sourcepub fn update(
&mut self,
key: OverlayKey,
has_mask: Option<bool>,
) -> Option<OverlayMeta>
pub fn update( &mut self, key: OverlayKey, has_mask: Option<bool>, ) -> Option<OverlayMeta>
Update a subset of the metadata for an existing overlay.
Sourcepub fn close(&mut self, key: OverlayKey)
pub fn close(&mut self, key: OverlayKey)
Close a single overlay.
Sourcepub fn entries(&self) -> impl Iterator<Item = (&OverlayKey, &OverlayMeta)>
pub fn entries(&self) -> impl Iterator<Item = (&OverlayKey, &OverlayMeta)>
Return an iterator over all active overlays. The order of iteration is
not guaranteed to be stable; callers that care about z-index ordering
should sort by z_index.
Sourcepub fn current_top_z_index(&self) -> i32
pub fn current_top_z_index(&self) -> i32
Return the highest z-index currently allocated, or the base value if there are no overlays.
Trait Implementations§
Source§impl Clone for OverlayManager
impl Clone for OverlayManager
Source§fn clone(&self) -> OverlayManager
fn clone(&self) -> OverlayManager
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for OverlayManager
impl Debug for OverlayManager
Auto Trait Implementations§
impl Freeze for OverlayManager
impl RefUnwindSafe for OverlayManager
impl Send for OverlayManager
impl Sync for OverlayManager
impl Unpin for OverlayManager
impl UnwindSafe for OverlayManager
Blanket Implementations§
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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> InitializeFromFunction<T> for T
impl<T> InitializeFromFunction<T> for T
Source§fn initialize_from_function(f: fn() -> T) -> T
fn initialize_from_function(f: fn() -> T) -> T
Create an instance of this type from an initialization function
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<Ret> SpawnIfAsync<(), Ret> for Ret
impl<Ret> SpawnIfAsync<(), Ret> for Ret
Source§impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
Source§fn super_from(input: T) -> O
fn super_from(input: T) -> O
Convert from a type to another type.
Source§impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
Source§fn super_into(self) -> O
fn super_into(self) -> O
Convert from a type to another type.