Struct PaintStyle 

pub struct PaintStyle {
    pub bg: Option<Color32>,
    pub border: Option<Stroke>,
    pub radius: Option<f32>,
    pub shadow: bool,
    pub custom_shadow: Option<Shadow>,
    pub opacity: Option<f32>,
}

How a box looks: background, border, corner radius, shadow and opacity.

Every field is optional and Default paints nothing, so an element that nobody styled costs no shapes at all.

The three shapes all sit on the node’s border box — its whole box, not the content rect — and share one radius. A border of width n is also reserved by the layout (ItemStyle::to_taffy sets taffy’s border), so the stroke is drawn StrokeKind::Inside and lands exactly in the band the children were kept out of.

Fields

bg: Option<Color32>

Background colour, filled behind the children or the widget.

border: Option<Stroke>

Border stroke, drawn on top of them and reserved by the layout.

radius: Option<f32>

Corner radius, shared by the shadow, the background and the border.

shadow: bool

Cast the theme’s Visuals::window_shadow.

custom_shadow: Option<Shadow>

Cast this shadow instead, whatever shadow says.

opacity: Option<f32>

Multiply the opacity of the node and everything under it.

Implementations

impl PaintStyle

pub fn bg(self, v: impl Into<Color32>) -> Self

Set the background colour.

pub fn border(self, v: impl Into<Stroke>) -> Self

Set the border stroke. The layout reserves its width.

pub fn radius(self, v: f32) -> Self

Set the corner radius of all three shapes.

pub fn shadow(self, v: bool) -> Self

Cast the theme’s window shadow, or stop casting it.

pub fn custom_shadow(self, v: Shadow) -> Self

Cast this shadow instead of the theme’s.

pub fn opacity(self, v: f32) -> Self

Multiply the opacity of this node and everything under it.

pub fn is_none(&self) -> bool

Whether this style does nothing, so the engine can skip the node.

radius alone does not count: it only rounds shapes that another field asks for. opacity does, even though it draws nothing itself, because the engine still has to set it around the children.

pub fn shadow_shape(&self, rect: Rect, visuals: &Visuals) -> Option<Shape>

The shadow shape under rect, if this style casts one.

custom_shadow wins over shadow; shadow alone is the theme’s window shadow, which is why this needs the Visuals. Shadow::as_shape offsets and expands the rect itself, so rect is the plain border box.

pub fn bg_shape(&self, rect: Rect) -> Option<Shape>

The background shape filling rect, if there is a bg.

pub fn border_shape(&self, rect: Rect) -> Option<Shape>

The border shape around rect, if there is a border.

StrokeKind::Inside: the layout already reserved the stroke’s width inside the border box, so drawing it there costs no extra room and two neighbours with borders do not overlap.

Trait Implementations

impl Clone for PaintStyle

fn clone(&self) -> PaintStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaintStyle

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

Formats the value using the given formatter.

impl Default for PaintStyle

fn default() -> PaintStyle

Returns the “default value” for a type.

impl PartialEq for PaintStyle

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for PaintStyle

impl StructuralPartialEq for PaintStyle