Skip to main content

OverlayManager

Struct OverlayManager 

Source
pub struct OverlayManager(/* private fields */);
Expand description

Counts open windows and paints a darkening overlay.

Cheap to clone (Arc). Stored on crate::theme::Theme::overlay_manager.

Implementations§

Source§

impl OverlayManager

Source

pub fn new() -> Self

Create a manager with no open windows.

Source

pub fn tint_0(&self) -> Color32

Lightest preset tint.

Source

pub fn tint_1(&self) -> Color32

Light preset tint.

Source

pub fn tint_2(&self) -> Color32

Medium preset tint.

Source

pub fn tint_3(&self) -> Color32

Darkest preset tint.

Source

pub fn counter(&self) -> u8

Number of currently tracked open windows.

Source

pub fn order(&self) -> Order

Last paint layer selected via paint_*.

Source

pub fn paint_background(&self)

Paint the next overlay on the background layer.

Source

pub fn paint_middle(&self)

Paint the next overlay on the middle layer.

Source

pub fn paint_foreground(&self)

Paint the next overlay on the foreground layer.

Source

pub fn paint_tooltip(&self)

Paint the next overlay on the tooltip layer.

Source

pub fn paint_debug(&self)

Paint the next overlay on the debug layer.

Source

pub fn window_opened(&self)

Call this when you open a window

Source

pub fn window_closed(&self)

Call this when you close a window

Source

pub fn recommended_order(&self) -> Order

Layer suggested by the current window count.

Source

pub fn calculate_alpha(&self) -> u8

Alpha derived from the window count (0 if none are open).

Source

pub fn overlay_tint(&self) -> Color32

Returns the tint color based on the counter

Source

pub fn paint_overlay(&self, ctx: &Context, recommend_order: bool)

Paints a full-screen darkening overlay up to Foreground layer if needed

If recommend_order is true, it will choose an order based on the counter

Source

pub fn paint_overlay_at( &self, ctx: &Context, rect: Rect, order: Order, id: Id, tint: Color32, )

Paints an overlay at a specific screen position

Trait Implementations§

Source§

impl Clone for OverlayManager

Source§

fn clone(&self) -> OverlayManager

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OverlayManager

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for OverlayManager

Source§

fn default() -> OverlayManager

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.