Struct amethyst_rendy::palette::gradient::Gradient

pub struct Gradient<C>(_)
 where
    C: Mix + Clone;

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.

Methods

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

pub fn new<I>(colors: I) -> Gradient<C> where
    I: IntoIterator<Item = 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 as Mix>::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 as Mix>::Scalar) -> C

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

Important traits for Take<'a, C>

impl<'a, C> Iterator for Take<'a, C> where
    C: Mix + Clone,  type Item = C;

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

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

pub fn slice<R>(&self, range: R) -> Slice<C> where
    R: Into<Range<<C as Mix>::Scalar>>, 

Slice this gradient to limit its domain.

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

Get the limits of this gradient's domain.

Trait Implementations

impl<C> Clone for Gradient<C> where
    C: Mix + Clone,
    <C as Mix>::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 for Gradient<C> where
    C: Mix + Clone + Debug,
    <C as Mix>::Scalar: Debug, 

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

Formats the value using the given formatter.