Enum cichlid::color_util::GradientDirection

#[repr(u8)]
pub enum GradientDirection {
    Forward,
    Backwards,
    Shortest,
    Longest,
}

Possible Directions around the color wheel a gradient can go.

Variants

Forward

Goes around the color wheel clockwise. ala, Hue increases as the gradient progresses, including integer wrapping.

Backwards

Goes around the color wheel counter-clockwise. Hue decreases as the gradient progresses, including integer wrapping.

Shortest

Goes around the color wheel by the shortest direction available.

Longest

Goes around the color wheel by longest direction available.

Methods

impl GradientDirection

pub fn into_hue_direction(self, hue_diff: u8) -> HueDirection

Transforms a GradientDirection into a HueDirection.

hue_diff is the difference between the ending hue and the starting hue. Specifically, hue_diff = end_hue.wrapping_sub(start_hue). This is needed in the cases where the discriminant is neither forwards or backwards.

Trait Implementations

impl Eq for GradientDirection

impl Copy for GradientDirection

impl PartialEq<GradientDirection> for GradientDirection

fn eq(&self, other: &GradientDirection) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

default fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for GradientDirection

fn clone(&self) -> GradientDirection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<HueDirection> for GradientDirection

fn from(dir: HueDirection) -> GradientDirection

Performs the conversion.

impl Debug for GradientDirection

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

Formats the value using the given formatter.