Enum OverlayInput 

pub enum OverlayInput {
    Interactive,
    Transparent,
}

The overlay portal’s own vocabulary, flat-re-exported from frust-core: which z-band a floated surface sits in, whether the pointer reaches it, and what a press landing outside it delivers.

overlay_portal floats a surface above the whole app, anchored to its child’s bounds and painted after the entire main tree — so it escapes both the child’s paint order and every ancestor’s clip, and follows the child across scroll and relayout with nothing subscribed. The surface is mounted while OverlayPortalView::overlay is Some; a widget that hosts a surface of its own instead reaches for authoring::OverlaySlot.

Lifted flat for EditCommand’s reason: an app or design system naming a band, an input class or a light-dismiss policy is configuring a portal, not authoring a widget.

use frust::{
    OverlayBand, OverlayInput, OverlayPlacement, OverlaySide, View, any, overlay_portal, text,
};

struct App {
    hovering: bool,
}

// A tooltip: above its trigger, in the topmost band, and transparent to the
// pointer so hovering the trigger is never interrupted by its own tip.
fn trigger(state: &mut App) -> impl View<App> + use<> {
    overlay_portal(text("Save"))
        .overlay(state.hovering.then(|| any(text("Save the document"))))
        .placement(OverlayPlacement::on(OverlaySide::Top))
        .band(OverlayBand::Tooltip)
        .input(OverlayInput::Transparent)
}

Whether a registered surface takes pointer input at all.

OverlayInput::Transparent is the rule egui’s Order::Tooltip encodes: a surface that is painted above the app but never hit-tested, so the pointer passes straight through it to whatever the main tree has underneath. A transparent entry is skipped by the root’s pre-pass entirely — it receives no InputEvent::Overlay, including no OverlayEventKind::OutsideDown.

Variants

Interactive

The surface hit-tests: a pointer inside its rect is routed to its owner and never reaches the main tree.

Transparent

The surface is painted but never hit-tested — pointer input passes through as though it were not there.

Trait Implementations

impl Clone for OverlayInput

fn clone(&self) -> OverlayInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OverlayInput

impl Debug for OverlayInput

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

Formats the value using the given formatter.

impl Eq for OverlayInput

impl Hash for OverlayInput

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for OverlayInput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OverlayInput