Struct ColorGradient 

pub struct ColorGradient { /* private fields */ }

A class to represent a gradient of colors.

Implementations

impl ColorGradient

pub fn new( spec: Option<Vec<(f32, &str)>>, preset: Option<Presets>, ) -> Result<ColorGradient, ImgGenSpecError>

Instantiate a ColorGradient object.

The spec parameter is an optional list of (f32, String) pairs. The float value is a percentage ranging [0.0, 1.0] that describes where the color (the str value) should take place. See SolidColor::from_string() for supported String values that describe the color.

If spec parameter is not specified, then the optional preset parameter (which defaults to Presets::MonoChrome) is used instead.

pub fn get_color_at(&self, position: f32, spread: &Spread) -> SolidColor

A helper function to get the interpolated color of the gradient at the specified position.

If position is beyond the range [0, 1.0], then the spread parameter is applied accordingly. See the Spread for more details.

Trait Implementations

impl Clone for ColorGradient

fn clone(&self) -> ColorGradient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColorGradient

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColorGradient

fn deserialize<D>( deserializer: D, ) -> Result<ColorGradient, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ColorGradient

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.