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
impl Mask
Sourcepub const fn gradient(gradient: Gradient) -> Mask
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.
Sourcepub const fn image(path: &'static str) -> Mask
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)));