Skip to main content

Color

Struct Color 

Source
pub struct Color { /* private fields */ }
Expand description

Represents a color with various conversion capabilities

Implementations§

Source§

impl Color

Source

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

Create a new Color from RGB values

Source

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

Create a new Color from RGBA values

Source

pub fn from_hex(hex: &str) -> Result<Self, ColorError>

Create a Color from a hex string (e.g., “#FF5733” or “FF5733”)

Source

pub fn from_hsl(h: f32, s: f32, l: f32) -> Result<Self, ColorError>

Create a Color from HSL values

Source

pub fn from_minecraft_code(code: &str) -> Result<Self, ColorError>

Create a Color from Minecraft color code (e.g., “§c”, “&4”, “&#FF5733”)

Source

pub fn from_hsv(h: f32, s: f32, v: f32) -> Result<Self, ColorError>

Create a Color from HSV values

Source

pub fn from_cmyk(c: f32, m: f32, y: f32, k: f32) -> Result<Self, ColorError>

Create a Color from CMYK values

Source

pub fn to_rgb(&self) -> Rgb

Convert to RGB

Source

pub fn to_hex(&self) -> String

Convert to hex string

Source

pub fn to_hex_alpha(&self) -> String

Convert to hex string with alpha

Source

pub fn to_hsl(&self) -> Hsl

Convert to HSL

Source

pub fn to_hsv(&self) -> Hsv

Convert to HSV

Source

pub fn to_cmyk(&self) -> Cmyk

Convert to CMYK

Source

pub fn luminance(&self) -> f32

Get luminance (brightness) of the color

Source

pub fn is_dark(&self) -> bool

Check if the color is considered “dark” (luminance < 0.5)

Source

pub fn is_light(&self) -> bool

Check if the color is considered “light” (luminance >= 0.5)

Source

pub fn contrasting_text_color(&self) -> Color

Get a contrasting color (black or white) for text overlay

Source

pub fn blend(&self, other: &Color, ratio: f32) -> Color

Blend this color with another color

Source

pub fn to_minecraft_code(&self) -> String

Convert to Minecraft legacy color code (closest match)

Source

pub fn to_minecraft_hex(&self) -> String

Convert to Minecraft modern hex color code format

Source

pub fn to_minecraft_hex_alt(&self) -> String

Convert to Minecraft alternate hex format (&x&R&R&G&G&B&B)

Source

pub fn darken(&self, percentage: f32) -> Color

Darken the color by a percentage

Source

pub fn lighten(&self, percentage: f32) -> Color

Lighten the color by a percentage

Source§

impl Color

Trait Implementations§

Source§

impl Clone for Color

Source§

fn clone(&self) -> Color

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Color

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Color

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Color

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Color

Auto Trait Implementations§

§

impl Freeze for Color

§

impl RefUnwindSafe for Color

§

impl Send for Color

§

impl Sync for Color

§

impl Unpin for Color

§

impl UnsafeUnpin for Color

§

impl UnwindSafe for Color

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.