Skip to main content

Backdrop

Enum Backdrop 

Source
pub enum Backdrop {
    Opaque,
    Transparent,
    Blur,
    Tinted,
}
Expand description

What shows through a window where its frame paints nothing, or paints with alpha (backlog F126): named for the effect, not for where an app uses it. The app decides which regions show it — a sidebar, a toolbar — by painting them with alpha and the rest opaque; kui knows nothing of sidebars.

Asked for by the app (kui_native::Launcher::backdrop) and reported back, as what the driver actually got, in WindowEnv::backdrop — a platform that cannot give the effect reads what it gave instead, down to Opaque, and a view that paints translucent regions paints them opaque there.

use kui_core::Backdrop;

assert_eq!(Backdrop::default(), Backdrop::Opaque);
assert_eq!(Backdrop::from_name("blur"), Some(Backdrop::Blur));
assert!(Backdrop::Tinted.is_translucent() && !Backdrop::Opaque.is_translucent());

Variants§

§

Opaque

The window is opaque: what every window is unless an app asks.

§

Transparent

See-through where the frame is: the desktop and the windows under this one show as they are, unblurred. A compositor that blurs translucent windows itself (Hyprland, SwayFX, picom when configured) makes this look like Blur.

§

Blur

A live blur of whatever is behind the window, other windows included: macOS’s behind-window vibrancy (an NSVisualEffectView), Windows 11’s Acrylic, and on Linux the compositor’s blur where it offers one (KWin’s org_kde_kwin_blur or _KDE_NET_WM_BLUR_BEHIND_REGION, ext-background-effect-v1).

§

Tinted

The desktop’s colour, cheap and steady rather than live: Windows 11’s Mica, macOS’s window-background material (the wallpaper tinting AppKit gives a window), and elsewhere the wallpaper itself, read, scaled down and blurred once, drawn as the window’s ground.

Implementations§

Source§

impl Backdrop

Source

pub const ALL: [Backdrop; 4]

Every backdrop, in wire order: the index C’s KUI_BACKDROP_* spells. Append-only.

Source

pub fn name(self) -> &'static str

The wire name, for the bindings and the report.

Source

pub fn from_name(name: &str) -> Option<Backdrop>

The backdrop a wire name spells: the inverse of Self::name.

Source

pub fn from_code(code: u32) -> Option<Backdrop>

The backdrop at C’s index, None past the end.

Source

pub fn is_translucent(self) -> bool

Whether anything shows through: everything but Opaque.

Trait Implementations§

Source§

impl Clone for Backdrop

Source§

fn clone(&self) -> Self

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 Copy for Backdrop

Source§

impl Debug for Backdrop

Source§

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

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

impl Default for Backdrop

Source§

fn default() -> Self

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

impl Eq for Backdrop

Source§

impl Hash for Backdrop

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Backdrop

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Backdrop

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.