Struct BoxStyle

pub struct BoxStyle {
    pub background: Background,
    pub border: Border,
    pub radius: Radius,
    pub shadows: Vec<BoxShadow>,
    pub opacity: Opacity,
}

Visual box decoration: background, border, radius, shadows, opacity.

Examples

use ailloli_ui_core::style::{Background, BoxStyle, Color};
let style = BoxStyle::new().background(Background::color(Color::WHITE));
assert!(style.background.is_visible());

Fields

background: Background

Optional solid background fill.

border: Border

Border whose effective widths also participate in layout.

radius: Radius

Per-corner outer radius in logical pixels.

shadows: Vec<BoxShadow>

Shadow layers in caller-provided paint order.

opacity: Opacity

Opacity multiplier applied to the decorated box.

Implementations

impl BoxStyle

pub fn new() -> Self

Creates a transparent, borderless, shadowless, fully opaque box style.

Examples

use ailloli_ui_core::style::BoxStyle;
assert!(BoxStyle::new().shadows.is_empty());

pub fn background(self, background: Background) -> Self

Replaces the background configuration.

Examples

use ailloli_ui_core::style::{Background, BoxStyle, Color};
assert!(BoxStyle::new().background(Background::color(Color::WHITE)).background.is_visible());

pub fn border(self, border: Border) -> Self

Replaces the complete border configuration.

Examples

use ailloli_ui_core::style::{Border, BoxStyle, Color};
assert!(BoxStyle::new().border(Border::new(1.0, Color::WHITE)).border.is_visible());

pub fn radius(self, radius: impl Into<Radius>) -> Self

Replaces all corner radii.

Examples

use ailloli_ui_core::style::{BoxStyle, Radius};
assert_eq!(BoxStyle::new().radius(Radius::uniform(4.0)).radius, Radius::uniform(4.0));

pub fn shadow(self, shadow: BoxShadow) -> Self

Appends one shadow after existing layers.

Examples

use ailloli_ui_core::style::{BoxShadow, BoxStyle};
assert_eq!(BoxStyle::new().shadow(BoxShadow::sm()).shadows.len(), 1);

pub fn shadows(self, shadows: Vec<BoxShadow>) -> Self

Replaces all shadow layers while preserving vector order.

Examples

use ailloli_ui_core::style::{BoxShadow, BoxStyle};
assert_eq!(BoxStyle::new().shadows(vec![BoxShadow::sm(), BoxShadow::md()]).shadows.len(), 2);

pub fn clear_shadows(self) -> Self

Removes every shadow layer.

Examples

use ailloli_ui_core::style::{BoxShadow, BoxStyle};
assert!(BoxStyle::new().shadow(BoxShadow::sm()).clear_shadows().shadows.is_empty());

pub fn visual_bounds(&self, rect: Rect) -> Rect

Returns the union of rect and every shadow’s paint bounds.

Inset shadows do not expand the result. Background, border, radius, and opacity do not change these conservative axis-aligned bounds.

Performance

Runs in linear time over the number of shadow layers without allocation.

Examples

use ailloli_ui_core::Rect;
use ailloli_ui_core::style::{BoxShadow, BoxStyle};
let bounds = BoxStyle::new().shadow(BoxShadow::sm()).visual_bounds(Rect::new(0.0, 0.0, 10.0, 10.0));
assert!(bounds.w >= 10.0);

pub fn opacity(self, opacity: Opacity) -> Self

Replaces the box opacity multiplier.

Examples

use ailloli_ui_core::style::{BoxStyle, Opacity};
assert_eq!(BoxStyle::new().opacity(Opacity::new(0.5)).opacity, Opacity(0.5));

Trait Implementations

impl Clone for BoxStyle

fn clone(&self) -> BoxStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoxStyle

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

Formats the value using the given formatter.

impl Default for BoxStyle

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for BoxStyle

fn eq(&self, other: &BoxStyle) -> 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 StructuralPartialEq for BoxStyle