Skip to main content

Mask

Enum Mask 

Source
pub enum Mask {
    Ellipse,
    Gradient(Gradient),
    Image(&'static str),
}
Expand description

Where a widget and everything inside it show, as Qt’s OpacityMask: what they draw is kept only where the mask is opaque, its alpha multiplying theirs, and nothing shows outside the widget’s box. Set it with Style::mask.

use crabshell_ui::{Color, Gradient, Mask, Style};

const AVATAR: Style = Style::new().mask(Mask::ellipse());
// A list that fades out over its last fifth.
const FADING: Style = Style::new().mask(Mask::gradient(
    Gradient::linear(180.0, Color::rgb(0, 0, 0), Color::rgba(0, 0, 0, 0))
        .stop(0.8, Color::rgb(0, 0, 0)),
));
const STAR: Style = Style::new().mask(Mask::image("/usr/share/my-shell/star.png"));

Variants§

§

Ellipse

An ellipse filling the box.

§

Gradient(Gradient)

A gradient’s alpha, laid over the box as a background’s is.

§

Image(&'static str)

A file’s alpha, stretched over the box. It is read through the Image loaders and their caps; one that is missing or refused is logged once and the widget is drawn unmasked.

Implementations§

Source§

impl Mask

Source

pub const fn ellipse() -> Mask

An ellipse filling the box, for round avatars and album art.

Source

pub const fn gradient(gradient: Gradient) -> Mask

gradient‘s alpha laid over the box, for lists and strips that fade out at an edge. Only the colors’ alpha counts.

Source

pub const fn image(path: &'static str) -> Mask

The alpha of the image file at path, stretched over the box.

The path is &'static str, so a style holding it can be a const. For a path made at run time, leak it once, outside any closure: a String::leak inside a move || Style binding leaks again each time the binding runs.

use crabshell_ui::{Mask, Stack, Style};

let home = std::env::var("HOME").unwrap_or_default();
// Once, here, not in the closure below.
let face: &'static str = format!("{home}/.face").leak();
let avatar = Stack::new().style(move || Style::new().mask(Mask::image(face)));

Trait Implementations§

Source§

impl Clone for Mask

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 Mask

Source§

impl Debug for Mask

Source§

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

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

impl PartialEq for Mask

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 Mask

Auto Trait Implementations§

§

impl Forget for Mask

§

impl Freeze for Mask

§

impl Move for Mask

§

impl RefUnwindSafe for Mask

§

impl Send for Mask

§

impl Sync for Mask

§

impl Unpin for Mask

§

impl UnsafeUnpin for Mask

§

impl UnwindSafe for Mask

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = !

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more