Struct piet_common::LinearGradient

pub struct LinearGradient { /* fields omitted */ }

A description of a linear gradient in the unit rect, which can be resolved to a fixed gradient.

The start and end points in the gradient are given in UnitPoint coordinates, which are then resolved to image-space coordinates for any given concrete Rect.

When the fixed coordinates are known, use FixedLinearGradient instead.

Methods

impl LinearGradient

pub fn new<impl GradientStops>(
    start: UnitPoint,
    end: UnitPoint,
    stops: impl GradientStops
) -> LinearGradient where
    impl GradientStops: GradientStops, 

Create a new linear gradient.

The start and end coordinates are UnitPoint coordinates, relative to the geometry of the shape being drawn.

Examples

use piet::{Color, RenderContext, LinearGradient, UnitPoint};
use piet::kurbo::{Circle, Point};

let circle = Circle::new(Point::new(100.0, 100.0), 50.0);
let gradient = LinearGradient::new(
    UnitPoint::TOP,
    UnitPoint::BOTTOM,
    (Color::WHITE, Color::BLACK)
);
render_ctx.fill(circle, &gradient);

Trait Implementations

impl From<LinearGradient> for PaintBrush

fn from(src: LinearGradient) -> PaintBrush

Performs the conversion.

impl Debug for LinearGradient

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

Formats the value using the given formatter.

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

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

impl Clone for LinearGradient

fn clone(&self) -> LinearGradient

Returns a copy of the value.

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

Performs copy-assignment from source.