Struct palette::gradient::Gradient

pub struct Gradient<C: Mix + Clone>(/* private fields */);

A linear interpolation between colors.

It’s used to smoothly transition between a series of colors, that can be either evenly spaced or have customized positions. The gradient is continuous between the control points, but it’s possible to iterate over a number of evenly spaced points using the take method. Any point outside the domain of the gradient will have the same color as the closest control point.

Implementations

impl<C: Mix + Clone> Gradient<C>

pub fn new<I: IntoIterator<Item = C>>(colors: I) -> Gradient<C>

Create a gradient of evenly spaced colors with the domain [0.0, 1.0]. There must be at least one color.

pub fn with_domain(colors: Vec<(C::Scalar, C)>) -> Gradient<C>

Create a gradient of colors with custom spacing and domain. There must be at least one color and they are expected to be ordered by their position value.

pub fn get(&self, i: C::Scalar) -> C

Get a color from the gradient. The color of the closest control point will be returned if i is outside the domain.

pub fn take(&self, n: usize) -> Take<'_, C>

Take n evenly spaced colors from the gradient, as an iterator.

pub fn slice<R: Into<Range<C::Scalar>>>(&self, range: R) -> Slice<'_, C>

Slice this gradient to limit its domain.

pub fn domain(&self) -> (C::Scalar, C::Scalar)

Get the limits of this gradient’s domain.

Trait Implementations

impl<C: Clone + Mix + Clone> Clone for Gradient<C>

where C::Scalar: Clone,

fn clone(&self) -> Gradient<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Mix + Clone> Debug for Gradient<C>

where C::Scalar: Debug,

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

Formats the value using the given formatter.