Struct BigColor 

pub struct BigColor { /* private fields */ }

BigColor struct represents a color with various formats Using OKLCH as the foundation

Implementations

impl BigColor

pub fn new<T: Into<String>>(color: T) -> Self

Create a new BigColor instance from various inputs

pub fn from_string<T: Into<String>>(input: T) -> Result<Self, String>

Alternative constructor for compatibility with old API

pub fn is_dark(&self) -> bool

Returns true if the color is dark

pub fn is_light(&self) -> bool

Returns true if the color is light

pub fn is_valid(&self) -> bool

Returns true if the color is valid

pub fn get_original_input(&self) -> &str

Returns the original input

pub fn get_format(&self) -> ColorFormat

Returns the format of the color

pub fn get_alpha(&self) -> f32

Returns the alpha value

pub fn get_brightness(&self) -> f32

Returns the brightness value

pub fn get_luminance(&self) -> f32

Returns the luminance value

pub fn set_alpha(&mut self, value: f32) -> &mut Self

Sets the alpha value

pub fn to_hsv(&self) -> HSV

Converts the color to HSV

pub fn to_hsv_string(&self) -> String

Converts the color to HSV string

pub fn to_hsl(&self) -> HSL

Converts the color to HSL

pub fn to_hsl_string(&self) -> String

Converts the color to HSL string

pub fn to_oklch(&self) -> OKLCH

Converts the color to OKLCH

pub fn to_oklch_string(&self) -> String

Converts the color to OKLCH string

pub fn to_oklab(&self) -> OKLab

Converts the color to OKLab

pub fn to_oklab_string(&self) -> String

Converts the color to OKLab string

pub fn to_lch(&self) -> LCH

Converts the color to LCH

pub fn to_lch_string(&self) -> String

Converts the color to LCH string

pub fn to_lab(&self) -> Lab

Converts the color to Lab

pub fn to_lab_string(&self) -> String

Converts the color to Lab string

pub fn to_hex(&self, allow_3_char: bool) -> String

Converts the color to HEX

pub fn to_hex_string(&self, allow_3_char: bool) -> String

Converts the color to HEX string

pub fn to_hex8(&self, allow_4_char: bool) -> String

Converts the color to HEX8

pub fn to_hex8_string(&self, allow_4_char: bool) -> String

Converts the color to HEX8 string

pub fn to_rgb(&self) -> RGB

Converts the color to RGB

pub fn to_rgb_string(&self) -> String

Converts the color to RGB string

pub fn to_percentage_rgb(&self) -> PercentageRGB

Converts the color to percentage RGB

pub fn to_percentage_rgb_string(&self) -> String

Converts the color to percentage RGB string

pub fn to_name(&self) -> Option<&'static str>

Converts the color to a name if possible

pub fn to_string(&self, format: Option<ColorFormat>) -> String

Converts the color to a string format

pub fn clone_color(&self) -> Self

Creates a clone of the color

pub fn lighten(&mut self, amount: Option<f32>) -> &mut Self

Lightens the color

pub fn brighten(&mut self, amount: Option<f32>) -> &mut Self

Brightens the color

pub fn darken(&mut self, amount: Option<f32>) -> &mut Self

Darkens the color

pub fn desaturate(&mut self, amount: Option<f32>) -> &mut Self

Desaturates the color

pub fn saturate(&mut self, amount: Option<f32>) -> &mut Self

Saturates the color

pub fn greyscale(&mut self) -> &mut Self

Converts the color to grayscale

pub fn spin(&mut self, amount: f32) -> &mut Self

Spins the hue of the color

pub fn analogous( &self, results: Option<usize>, slices: Option<usize>, ) -> Vec<BigColor>

Creates analogous colors

pub fn complement(&self) -> BigColor

Creates a complement color

pub fn monochromatic(&self, results: Option<usize>) -> Vec<BigColor>

Creates monochromatic colors

pub fn split_complement(&self) -> Vec<BigColor>

Creates split complement colors

pub fn triad(&self) -> Vec<BigColor>

Creates a triad of colors

pub fn tetrad(&self) -> Vec<BigColor>

Creates a tetrad of colors

pub fn polyad(&self, number: usize) -> Vec<BigColor>

Creates polyad colors

pub fn from_rgb(r: u8, g: u8, b: u8, a: f32) -> Self

Creates a BigColor from RGB values

pub fn from_hsl(h: f32, s: f32, l: f32, a: f32) -> Self

Creates a BigColor from HSL values

pub fn from_hsv(h: f32, s: f32, v: f32, a: f32) -> Self

Creates a BigColor from HSV values

pub fn from_lch(l: f32, c: f32, h: f32, a: f32) -> Self

Creates a BigColor from LCH values

pub fn from_oklch(l: f32, c: f32, h: f32, a: f32) -> Self

Creates a BigColor from OKLCH values directly

pub fn from_ratio(color: &str) -> Self

Creates a BigColor from a ratio

pub fn to_hsb(&self) -> HSV

Converts the color to HSB (same as HSV)

pub fn to_hsb_string(&self) -> String

Converts the color to HSB string

pub fn from_hsb(h: f32, s: f32, b: f32, a: f32) -> Self

Creates a BigColor from HSB values (same as HSV)

pub fn to_cmyk(&self) -> CMYK

Converts the color to CMYK

pub fn to_cmyk_string(&self) -> String

Converts the color to CMYK string

pub fn from_cmyk(c: f32, m: f32, y: f32, k: f32, a: f32) -> Self

Create a new BigColor from CMYK values

pub fn to(&self, format: ColorFormat) -> String

Returns the color as a CSS-compatible string in the specified format

pub fn get_contrast_color(&self, intensity: f32) -> BigColor

Gets a contrast color with a specified intensity (0.0 to 1.0)

The intensity parameter controls how strong the contrast will be:

• 0.0: Minimum contrast (slight difference)
• 0.5: Medium contrast
• 1.0: Maximum contrast (black or white)

pub fn get_contrast_ratio(&self, other: &BigColor) -> f32

Gets the contrast ratio between this color and another color according to WCAG standards. The ratio ranges from 1:1 (no contrast) to 21:1 (maximum contrast).

Trait Implementations

impl Clone for BigColor

fn clone(&self) -> BigColor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BigColor

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

Formats the value using the given formatter.

impl Default for BigColor

fn default() -> Self

Returns the “default value” for a type.

impl Display for BigColor

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

Formats the value using the given formatter.

impl PartialEq for BigColor

fn eq(&self, other: &Self) -> 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.