Skip to main content

DebugLayer

Enum DebugLayer 

Source
pub enum DebugLayer {
    All,
    TopMost,
    BaseOnly,
}
Expand description

Which layers the F12 debug overlay should outline (issue #201).

All (the default) outlines both the base layer and any active overlays/modals — matching the user’s expectation for “show everything the renderer is producing this frame.” TopMost only outlines the topmost overlay (or the base if no overlay is active), and BaseOnly keeps the legacy pre-fix behavior of skipping overlays entirely.

At runtime, Shift+F12 cycles All → TopMost → BaseOnly → All so a developer debugging a stacked modal can shrink the visible outlines to just the layer they care about without leaving the keyboard. Plain F12 independently toggles the overlay on/off.

§Example

use slt::{Context, DebugLayer};

slt::run(|ui: &mut Context| {
    // Match on the current layer to drive bespoke debug UI.
    let label = match ui.debug_layer() {
        DebugLayer::All => "showing base + overlays",
        DebugLayer::TopMost => "showing topmost overlay only",
        DebugLayer::BaseOnly => "showing base layer only",
    };
    ui.text(label);
})
.unwrap();

Variants§

§

All

Outline both the base tree and every active overlay/modal.

Default. Matches the reporter expectation that F12 reflects everything the renderer is producing this frame. Each layer family gets its own hue so a glance distinguishes base, overlay, and modal containers.

§

TopMost

Outline only the topmost overlay (or the base if no overlay is active).

Useful when modals or popovers stack and you only care about the active dialog — base-tree outlines become noise underneath an open modal.

§

BaseOnly

Outline only the base layer (legacy v0.19.x behavior).

Skips overlays and modals entirely. Use when an overlay is confirmed correct and you want to inspect the base layout underneath it.

Trait Implementations§

Source§

impl Clone for DebugLayer

Source§

fn clone(&self) -> DebugLayer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DebugLayer

Source§

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

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

impl Default for DebugLayer

Source§

fn default() -> DebugLayer

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

impl PartialEq for DebugLayer

Source§

fn eq(&self, other: &DebugLayer) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for DebugLayer

Source§

impl Eq for DebugLayer

Source§

impl StructuralPartialEq for DebugLayer

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<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> 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.