Struct random_color::RandomColor

pub struct RandomColor {
    pub hue: Option<Gamut>,
    pub luminosity: Option<Luminosity>,
    pub seed: SmallRng,
    pub alpha: Option<f32>,
    pub color_dictionary: ColorDictionary,
}

A structure for generating random colors with a variety of options.

The available options are:

• hue: Specify a specific hue, or a range of hues. You can use the Gamut enum to select a hue.
• luminosity: Specify a specific luminosity, or a range of luminosities. You can use the Luminosity enum to select a luminosity.
• seed: Specify a seed for the random number generator. If you don’t specify a seed, one will be generated randomly.
• alpha: Specify an alpha value for the generated color. If you don’t specify an alpha value, 1.0 will be used.
• color_dictionary: Specify a custom color dictionary. If you don’t specify a color dictionary, the default one will be used.

Fields

hue: Option<Gamut>

The hue of the color to generate.

luminosity: Option<Luminosity>

The luminosity of the color to generate.

seed: SmallRng

The seed for the random number generator.

alpha: Option<f32>

The alpha value of the color to generate.

color_dictionary: ColorDictionary

The color dictionary to use.

Implementations

impl RandomColor

pub fn new() -> Self

Creates a new RandomColor instance.

pub fn hue(&mut self, hue: Gamut) -> &mut RandomColor

Sets the hue setting.

pub fn luminosity(&mut self, luminosity: Luminosity) -> &mut RandomColor

Removes the luminosity setting.

pub fn seed<T: Seed>(&mut self, seed: T) -> &mut RandomColor

Sets the seed.

pub fn alpha(&mut self, alpha: f32) -> &mut RandomColor

Sets the alpha setting.

pub fn random_alpha(&mut self) -> &mut RandomColor

Removes the alpha setting.

pub fn dictionary(&mut self, dictionary: ColorDictionary) -> &mut RandomColor

Sets the ColorDictionary.

pub fn to_hsv_array(&mut self) -> [u32; 3]

Generates a random color and returns it as an HSV array.

pub fn to_rgb_string(&mut self) -> String

Generates a random color and returns it as an RGB string.

pub fn to_rgba_string(&mut self) -> String

Generates a random color and returns it as an RGBA string.

pub fn to_rgb_array(&mut self) -> [u8; 3]

Generates a random color and returns it as an RGB array.

pub fn to_rgba_array(&mut self) -> [u8; 4]

Generates a random color and returns it as an RGB array.

pub fn to_f32_rgb_array(&mut self) -> [f32; 3]

Generates a random color and returns it as a f32 RGB array.

pub fn to_f32_rgba_array(&mut self) -> [f32; 4]

Generates a random color and returns it as an f32 RGBA array.

pub fn to_hsl_string(&mut self) -> String

Generates a random color and returns it as an HSL string.

pub fn to_hsla_string(&mut self) -> String

Generates a random color and returns it as an HSLA string.

pub fn to_hsl_array(&mut self) -> [u32; 3]

Generates a random color and returns it as an HSL array.

pub fn to_hex(&mut self) -> String

Generates a random color and returns it as a hex string.

pub fn into_rgb_array(self) -> [u8; 3]

Transforms the RandomColor into a u8 array with the color’s RGB values.

pub fn into_rgba_array(self) -> [u8; 4]

Transforms the RandomColor into a u8 array with the color’s RGBA values.

pub fn into_f32_rgb_array(self) -> [f32; 3]

Transforms the RandomColor into a f32 array with the color’s RGB values.

pub fn into_f32_rgba_array(self) -> [f32; 4]

Transforms the RandomColor into a f32 array with the color’s RGBA values.

pub fn to_rgb(&mut self) -> Rgb<u8>

Generates a random color and returns it as an Rgb struct from the rgb crate.

pub fn to_rgba(&mut self) -> Rgba<u8>

Generates a random color and returns it as an Rgba struct from the rgb crate.

pub fn to_srgb(&mut self) -> Srgb

Generates a random color and returns it as an Srgb struct from the palette crate.

pub fn to_srgba(&mut self) -> Srgba

Generates a random color and returns it as an Srgba struct from the palette crate.

pub fn to_color32(&mut self) -> Color32

Generates a random color and returns it as an Color32 struct from the ecolor crate.

Trait Implementations

impl Clone for RandomColor

fn clone(&self) -> RandomColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RandomColor

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

Formats the value using the given formatter.

impl Default for RandomColor

fn default() -> Self

Returns the “default value” for a type.

impl From<&mut RandomColor> for Srgba

fn from(value: &mut RandomColor) -> Self

Converts to this type from the input type.

impl From<&mut RandomColor> for Color32

fn from(value: &mut RandomColor) -> Self

Converts to this type from the input type.

impl From<&mut RandomColor> for Srgb

fn from(value: &mut RandomColor) -> Self

Converts to this type from the input type.

impl From<&mut RandomColor> for Rgb<u8>

fn from(value: &mut RandomColor) -> Self

Converts to this type from the input type.

impl From<&mut RandomColor> for Rgba

fn from(value: &mut RandomColor) -> Self

Converts to this type from the input type.

impl From<&mut RandomColor> for Rgba<u8>

fn from(value: &mut RandomColor) -> Self

Converts to this type from the input type.

impl From<RandomColor> for Srgba

fn from(value: RandomColor) -> Self

Converts to this type from the input type.

impl From<RandomColor> for Color32

fn from(value: RandomColor) -> Self

Converts to this type from the input type.

impl From<RandomColor> for Srgb

fn from(value: RandomColor) -> Self

Converts to this type from the input type.

impl From<RandomColor> for Rgb<u8>

fn from(value: RandomColor) -> Self

Converts to this type from the input type.

impl From<RandomColor> for Rgba

fn from(value: RandomColor) -> Self

Converts to this type from the input type.

impl From<RandomColor> for Rgba<u8>

fn from(value: RandomColor) -> Self

Converts to this type from the input type.

impl PartialEq for RandomColor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RandomColor