Struct piet::LinearGradient

[+] Show declaration

pub struct LinearGradient {
    start: UnitPoint,
    end: UnitPoint,
    stops: ArrayVec<[GradientStop; 3]>,
}

[−] Expand description

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.

Fields

start: UnitPoint

end: UnitPoint

stops: ArrayVec<[GradientStop; 3]>

Methods

impl LinearGradient[−]

pub fn new(
    start: UnitPoint,
    end: UnitPoint,
    stops: impl GradientStops
) -> LinearGradient[−]

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);

fn resolve(&self, rect: Rect) -> FixedLinearGradient[−]

Generate a FixedLinearGradient by mapping points in the unit square onto points in rect.

Trait Implementations

impl Clone for LinearGradient[+]

[+] Show hidden undocumented items

fn clone(&self) -> LinearGradient[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.