Enum raqote::Source

pub enum Source<'a> {
    Solid(SolidSource),
    Image(Image<'a>, ExtendMode, FilterMode, Transform),
    RadialGradient(Gradient, Spread, Transform),
    TwoCircleRadialGradient(Gradient, Spread, Point, f32, Point, f32, Transform),
    LinearGradient(Gradient, Spread, Transform),
    SweepGradient(Gradient, Spread, f32, f32, Transform),
}

LinearGradients have an implicit start point at 0,0 and an end point at 256,0. The transform parameter can be used to adjust them to the desired location. RadialGradients have an implicit center at 0,0 and a radius of 128. The helper functions: new_linear_gradient, new_radial_gradient and new_two_circle_radial_gradient allow the gradients to be constructed with easier to understand inputs. The transform parameter maps user space to source space. This means that setting the same transform on the draw target as the source will have the effect of canceling out.

These locations are an artifact of the blitter implementation and will probably change in the future to become more ergonomic.

Variants

Solid(SolidSource)

Image(Image<'a>, ExtendMode, FilterMode, Transform)

RadialGradient(Gradient, Spread, Transform)

TwoCircleRadialGradient(Gradient, Spread, Point, f32, Point, f32, Transform)

LinearGradient(Gradient, Spread, Transform)

SweepGradient(Gradient, Spread, f32, f32, Transform)

Implementations

impl<'a> Source<'a>

pub fn new_linear_gradient( gradient: Gradient, start: Point, end: Point, spread: Spread ) -> Source<'a>

Creates a new linear gradient source where the start point corresponds to the gradient stop at position = 0 and the end point corresponds to the gradient stop at position = 1.

Examples found in repository

examples/pad.rs (lines 13-33)

fn main() {
    let mut dt = DrawTarget::new(200, 200);
    
    let gradient = Source::new_linear_gradient(
        Gradient {
            stops: vec![
                GradientStop {
                    position: 0.0,
                    color: Color::new(0xff, 0xff, 0xff, 0xff),
                },
                GradientStop {
                    position: 0.9999,
                    color: Color::new(0xff, 0x0, 0x0, 0x0),
                },
                GradientStop {
                    position: 1.0,
                    color: Color::new(0xff, 0x0, 0x0, 0x0),
                },
            ],
        },
        Point::new(40., 0.),
        Point::new(100., 0.),
        Spread::Pad,
    );

    let mut pb = PathBuilder::new();
    pb.rect(0., 0., 80., 80.);
    let path = pb.finish();
    dt.fill(&path, &gradient, &DrawOptions::default());

    dt.write_png("out.png").unwrap();
}

pub fn new_radial_gradient( gradient: Gradient, center: Point, radius: f32, spread: Spread ) -> Source<'a>

Creates a new radial gradient that is centered at the given point and has the given radius.

pub fn new_two_circle_radial_gradient( gradient: Gradient, center1: Point, radius1: f32, center2: Point, radius2: f32, spread: Spread ) -> Source<'a>

Creates a new radial gradient that is centered at the given point and has the given radius.

pub fn new_sweep_gradient( gradient: Gradient, center: Point, start_angle: f32, end_angle: f32, spread: Spread ) -> Source<'a>

Creates a new sweep gradient that is centered at the given point with start_angle and end_angle.

Examples found in repository

examples/sweep-gradient.rs (lines 10-31)

fn main() {
    use raqote::*;

let mut dt = DrawTarget::new(400, 400);

let mut pb = PathBuilder::new();
pb.rect(0., 0., 400., 400.);
let path = pb.finish();

let gradient = Source::new_sweep_gradient(
    Gradient {
        stops: vec![
            GradientStop {
                position: 0.,
                color: Color::new(0xff, 0, 0, 0),
            },
            GradientStop {
                position: 0.5,
                color: Color::new(0xff, 0xff, 0xff, 0x0),
            },
            GradientStop {
                position: 1.,
                color: Color::new(0xff, 0, 0, 0x0),
            },
        ],
    },
    Point::new(150., 200.),
    45.,
    180.+45.,
    Spread::Repeat,
);
dt.fill(&path, &gradient, &DrawOptions::new());



dt.write_png("example.png");
}

Trait Implementations

impl<'a> Clone for Source<'a>

fn clone(&self) -> Source<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Color> for Source<'_>

fn from(color: Color) -> Self

Converts to this type from the input type.

impl From<SolidSource> for Source<'_>

fn from(other: SolidSource) -> Self

Converts to this type from the input type.