Enum druid::widget::BackgroundBrush

#[non_exhaustive]
pub enum BackgroundBrush<T> {
    Color(Color),
    ColorKey(Key<Color>),
    Linear(LinearGradient),
    Radial(RadialGradient),
    Fixed(FixedGradient),
    Painter(Painter<T>),
}

Something that can be used as the background for a widget.

This represents anything that can be painted inside a widgets paint method; that is, it may have access to the Data and the Env.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Color(Color)

ColorKey(Key<Color>)

Linear(LinearGradient)

Radial(RadialGradient)

Fixed(FixedGradient)

Painter(Painter<T>)

Implementations

impl<T: Data> BackgroundBrush<T>

pub fn update( &mut self, ctx: &mut UpdateCtx<'_, '_>, old_data: &T, data: &T, env: &Env )

Request paint if the BackgroundBrush changed.

pub fn paint(&mut self, ctx: &mut PaintCtx<'_, '_, '_>, data: &T, env: &Env)

Draw this BackgroundBrush into a provided PaintCtx.

Examples found in repository

examples/multiwin.rs (line 121)

    fn paint(&mut self, ctx: &mut PaintCtx, data: &State, env: &Env) {
        if data.glow_hot && ctx.is_hot() {
            BackgroundBrush::Color(Color::rgb8(200, 55, 55)).paint(ctx, data, env);
        }
        self.inner.paint(ctx, data, env);
    }

examples/timer.rs (line 117)

    fn paint(&mut self, ctx: &mut PaintCtx, data: &u32, env: &Env) {
        let mut background = if ctx.is_hot() {
            BackgroundBrush::Color(Color::rgb8(200, 55, 55))
        } else {
            BackgroundBrush::Color(Color::rgb8(30, 210, 170))
        };
        background.paint(ctx, data, env);
    }

Trait Implementations

impl<T> From<Color> for BackgroundBrush<T>

fn from(src: Color) -> BackgroundBrush<T>

Converts to this type from the input type.

impl<T> From<FixedGradient> for BackgroundBrush<T>

fn from(src: FixedGradient) -> BackgroundBrush<T>

Converts to this type from the input type.

impl<T> From<Key<Color>> for BackgroundBrush<T>

fn from(src: Key<Color>) -> BackgroundBrush<T>

Converts to this type from the input type.

impl<T> From<LinearGradient> for BackgroundBrush<T>

fn from(src: LinearGradient) -> BackgroundBrush<T>

Converts to this type from the input type.

impl<T> From<PaintBrush> for BackgroundBrush<T>

fn from(src: PaintBrush) -> BackgroundBrush<T>

Converts to this type from the input type.

impl<T> From<Painter<T>> for BackgroundBrush<T>

fn from(src: Painter<T>) -> BackgroundBrush<T>

Converts to this type from the input type.

impl<T> From<RadialGradient> for BackgroundBrush<T>

fn from(src: RadialGradient) -> BackgroundBrush<T>

Converts to this type from the input type.