Enum piet_common::PaintBrush

pub enum PaintBrush {
    Color(Color),
    Linear(LinearGradient),
    Radial(RadialGradient),
    Fixed(FixedGradient),
}

A color or a gradient.

This type is provided as a convenience, so that library consumers can easily write methods and types that use or reference something that can be used as a brush, without needing to know what it is.

Examples

use piet::{Color, PaintBrush, RadialGradient};
use piet::kurbo::Rect;

struct Widget {
frame: Rect,
background: PaintBrush,
}

fn make_widget<T: Into<PaintBrush>>(frame: Rect, bg: T) -> Widget {
    Widget {
        frame,
        background: bg.into(),
    }
}

let color_widget = make_widget(Rect::ZERO, Color::BLACK);
let rad_grad = RadialGradient::new(0.8, (Color::WHITE, Color::BLACK));
let gradient_widget = make_widget(Rect::ZERO, rad_grad);

Variants

Color(Color)

A Color.

Tuple Fields of Color

0: Color

Linear(LinearGradient)

A LinearGradient.

Tuple Fields of Linear

0: LinearGradient

Radial(RadialGradient)

A RadialGradient.

Tuple Fields of Radial

0: RadialGradient

Fixed(FixedGradient)

A FixedGradient.

Tuple Fields of Fixed

0: FixedGradient

Trait Implementations

impl Clone for PaintBrush

pub fn clone(&self) -> PaintBrush

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaintBrush

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

Formats the value using the given formatter.

impl From<Color> for PaintBrush

pub fn from(src: Color) -> PaintBrush

Performs the conversion.

impl From<FixedGradient> for PaintBrush

pub fn from(src: FixedGradient) -> PaintBrush

Performs the conversion.

impl From<FixedLinearGradient> for PaintBrush

pub fn from(src: FixedLinearGradient) -> PaintBrush

Performs the conversion.

impl From<FixedRadialGradient> for PaintBrush

pub fn from(src: FixedRadialGradient) -> PaintBrush

Performs the conversion.

impl From<LinearGradient> for PaintBrush

pub fn from(src: LinearGradient) -> PaintBrush

Performs the conversion.

impl From<RadialGradient> for PaintBrush

pub fn from(src: RadialGradient) -> PaintBrush

Performs the conversion.

impl<P> IntoBrush<P> for PaintBrush where
    P: RenderContext, 

pub fn make_brush(
    &'a self,
    piet: &mut P,
    bbox: impl FnOnce() -> Rect
) -> Cow<'a, <P as RenderContext>::Brush>