[][src]Struct palette::gradient::Gradient

pub struct Gradient<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.


impl<C: Mix + Clone> Gradient<C>[src]

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

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>[src]

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[src]

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>
pub fn take(&self, n: usize) -> Take<C>[src]

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

pub fn slice<R: Into<Range<C::Scalar>>>(&self, range: R) -> Slice<C>[src]

Slice this gradient to limit its domain.

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

Get the limits of this gradient's domain.

Trait Implementations

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

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

Auto Trait Implementations

impl<C> Send for Gradient<C> where
    C: Send,
    <C as Mix>::Scalar: Send

impl<C> Sync for Gradient<C> where
    C: Sync,
    <C as Mix>::Scalar: Sync

impl<C> Unpin for Gradient<C> where
    C: Unpin,
    <C as Mix>::Scalar: Unpin

impl<C> UnwindSafe for Gradient<C> where
    C: UnwindSafe,
    <C as Mix>::Scalar: UnwindSafe

impl<C> RefUnwindSafe for Gradient<C> where
    C: RefUnwindSafe,
    <C as Mix>::Scalar: RefUnwindSafe

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
    D: AdaptFrom<S, Swp, Dwp, T>,
    Dwp: WhitePoint,
    Swp: WhitePoint,
    T: Component + Float

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> From<T> for T[src]

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized