Struct cichlid::rgb::ColorRGB

#[repr(packed)]
pub struct ColorRGB {
    pub r: u8,
    pub g: u8,
    pub b: u8,
}

Object representing a color through the standard single byte red, green, and blue values.

Fields

r: u8

Red Component.

g: u8

Green Component.

b: u8

Blue Component.

Methods

impl ColorRGB

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

Creates a new ColorRGB object.

pub const fn from_color_code(code: u32) -> Self

Creates a ColorRGB object from a 32bit color code.

Bits 0 to 7 are used for the blue component, Bits 8 to 16 are used for the green component, and bits 16 to 23 are used for the red component.

pub fn clear(&mut self)

Sets all components to zero.

pub fn red(self) -> u8

Returns the value of the red component.

pub fn green(self) -> u8

Returns the value of the green component.

pub fn blue(self) -> u8

Returns the value of the blue component.

pub fn modify_all<F>(&mut self, f: F) where
    F: FnMut(u8) -> u8, 

Function to modify each component by a given function.

pub fn scale(&mut self, scale: u8)

Scales all three components of a pixel by the given value.

pub fn scale_from_other(&mut self, other: ColorRGB)

Scales the current ColorRGB by another pixel.

pub fn fade_to_black_by(&mut self, fade: u8)

Fades to black by the given amount.

pub fn maximize_brightness(&mut self)

Maintains the ratio of red, green, and blue while maximizing brightness.

pub fn luma(self) -> u8

Returns the luminosity of a pixel.

pub fn avg_light(self) -> u8

Returns the average value over each component of a pixel.

pub fn blend(&mut self, other: ColorRGB, amount_of_other: u8)

Blends two ColorRGBs together.

The parameter amount_of_other is read as a fractional component. For example, a amount_of_other of 128 creates a ColorRGB equally blended between the two, while an amount_of_other of 0 returns self.

impl ColorRGB

pub const AliceBlue: ColorRGB

pub const Amethyst: ColorRGB

pub const AntiqueWhite: ColorRGB

pub const Aqua: ColorRGB

pub const Aquamarine: ColorRGB

pub const Azure: ColorRGB

pub const Beige: ColorRGB

pub const Bisque: ColorRGB

pub const Black: ColorRGB

pub const BlanchedAlmond: ColorRGB

pub const Blue: ColorRGB

pub const BlueViolet: ColorRGB

pub const Brown: ColorRGB

pub const BurlyWood: ColorRGB

pub const CadetBlue: ColorRGB

pub const Chartreuse: ColorRGB

pub const Chocolate: ColorRGB

pub const Coral: ColorRGB

pub const CornflowerBlue: ColorRGB

pub const Cornsilk: ColorRGB

pub const Crimson: ColorRGB

pub const Cyan: ColorRGB

pub const DarkBlue: ColorRGB

pub const DarkCyan: ColorRGB

pub const DarkGoldenrod: ColorRGB

pub const DarkGray: ColorRGB

pub const DarkGrey: ColorRGB

pub const DarkGreen: ColorRGB

pub const DarkKhaki: ColorRGB

pub const DarkMagenta: ColorRGB

pub const DarkOliveGreen: ColorRGB

pub const DarkOrange: ColorRGB

pub const DarkOrchid: ColorRGB

pub const DarkRed: ColorRGB

pub const DarkSalmon: ColorRGB

pub const DarkSeaGreen: ColorRGB

pub const DarkSlateBlue: ColorRGB

pub const DarkSlateGray: ColorRGB

pub const DarkSlateGrey: ColorRGB

pub const DarkTurquoise: ColorRGB

pub const DarkViolet: ColorRGB

pub const DeepPink: ColorRGB

pub const DeepSkyBlue: ColorRGB

pub const DimGray: ColorRGB

pub const DimGrey: ColorRGB

pub const DodgerBlue: ColorRGB

pub const FireBrick: ColorRGB

pub const FloralWhite: ColorRGB

pub const ForestGreen: ColorRGB

pub const Fuchsia: ColorRGB

pub const Gainsboro: ColorRGB

pub const GhostWhite: ColorRGB

pub const Gold: ColorRGB

pub const Goldenrod: ColorRGB

pub const Gray: ColorRGB

pub const Grey: ColorRGB

pub const Green: ColorRGB

pub const GreenYellow: ColorRGB

pub const Honeydew: ColorRGB

pub const HotPink: ColorRGB

pub const IndianRed: ColorRGB

pub const Indigo: ColorRGB

pub const Ivory: ColorRGB

pub const Khaki: ColorRGB

pub const Lavender: ColorRGB

pub const LavenderBlush: ColorRGB

pub const LawnGreen: ColorRGB

pub const LemonChiffon: ColorRGB

pub const LightBlue: ColorRGB

pub const LightCoral: ColorRGB

pub const LightCyan: ColorRGB

pub const LightGoldenrodYellow: ColorRGB

pub const LightGreen: ColorRGB

pub const LightGrey: ColorRGB

pub const LightPink: ColorRGB

pub const LightSalmon: ColorRGB

pub const LightSeaGreen: ColorRGB

pub const LightSkyBlue: ColorRGB

pub const LightSlateGray: ColorRGB

pub const LightSlateGrey: ColorRGB

pub const LightSteelBlue: ColorRGB

pub const LightYellow: ColorRGB

pub const Lime: ColorRGB

pub const LimeGreen: ColorRGB

pub const Linen: ColorRGB

pub const Magenta: ColorRGB

pub const Maroon: ColorRGB

pub const MediumAquamarine: ColorRGB

pub const MediumBlue: ColorRGB

pub const MediumOrchid: ColorRGB

pub const MediumPurple: ColorRGB

pub const MediumSeaGreen: ColorRGB

pub const MediumSlateBlue: ColorRGB

pub const MediumSpringGreen: ColorRGB

pub const MediumTurquoise: ColorRGB

pub const MediumVioletRed: ColorRGB

pub const MidnightBlue: ColorRGB

pub const MintCream: ColorRGB

pub const MistyRose: ColorRGB

pub const Moccasin: ColorRGB

pub const NavajoWhite: ColorRGB

pub const Navy: ColorRGB

pub const OldLace: ColorRGB

pub const Olive: ColorRGB

pub const OliveDrab: ColorRGB

pub const Orange: ColorRGB

pub const OrangeRed: ColorRGB

pub const Orchid: ColorRGB

pub const PaleGoldenrod: ColorRGB

pub const PaleGreen: ColorRGB

pub const PaleTurquoise: ColorRGB

pub const PaleVioletRed: ColorRGB

pub const PapayaWhip: ColorRGB

pub const PeachPuff: ColorRGB

pub const Peru: ColorRGB

pub const Pink: ColorRGB

pub const Plaid: ColorRGB

pub const Plum: ColorRGB

pub const PowderBlue: ColorRGB

pub const Purple: ColorRGB

pub const Red: ColorRGB

pub const RosyBrown: ColorRGB

pub const RoyalBlue: ColorRGB

pub const SaddleBrown: ColorRGB

pub const Salmon: ColorRGB

pub const SandyBrown: ColorRGB

pub const SeaGreen: ColorRGB

pub const Seashell: ColorRGB

pub const Sienna: ColorRGB

pub const Silver: ColorRGB

pub const SkyBlue: ColorRGB

pub const SlateBlue: ColorRGB

pub const SlateGray: ColorRGB

pub const SlateGrey: ColorRGB

pub const Snow: ColorRGB

pub const SpringGreen: ColorRGB

pub const SteelBlue: ColorRGB

pub const Tan: ColorRGB

pub const Teal: ColorRGB

pub const Thistle: ColorRGB

pub const Tomato: ColorRGB

pub const Turquoise: ColorRGB

pub const Violet: ColorRGB

pub const Wheat: ColorRGB

pub const White: ColorRGB

pub const WhiteSmoke: ColorRGB

pub const Yellow: ColorRGB

pub const YellowGreen: ColorRGB

Trait Implementations

impl Copy for ColorRGB

impl Clone for ColorRGB

fn clone(&self) -> ColorRGB

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<ColorRGB> for ColorRGB

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

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

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

This method tests for !=.

impl PartialOrd<ColorRGB> for ColorRGB

fn partial_cmp(&self, other: &ColorRGB) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ColorRGB

impl Default for ColorRGB

fn default() -> ColorRGB

Returns the "default value" for a type.

impl From<(u8, u8, u8)> for ColorRGB

fn from(other: (u8, u8, u8)) -> Self

Performs the conversion.

impl From<[u8; 3]> for ColorRGB

fn from(other: [u8; 3]) -> Self

Performs the conversion.

impl From<u32> for ColorRGB

fn from(other: u32) -> Self

Performs the conversion.

impl From<HSV> for ColorRGB

fn from(hsv: HSV) -> Self

Performs the conversion.

impl Ord for ColorRGB

fn cmp(&self, rhs: &ColorRGB) -> Ordering

This method returns an Ordering between self and other.

default fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

default fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

default fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Display for ColorRGB

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

Formats the value using the given formatter.

impl Hash for ColorRGB

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Add<ColorRGB> for ColorRGB

type Output = ColorRGB

The resulting type after applying the + operator.

fn add(self, other: ColorRGB) -> ColorRGB

Performs the + operation.

impl Sub<ColorRGB> for ColorRGB

type Output = ColorRGB

The resulting type after applying the - operator.

fn sub(self, other: ColorRGB) -> ColorRGB

Performs the - operation.

impl Mul<u8> for ColorRGB

type Output = ColorRGB

The resulting type after applying the * operator.

fn mul(self, rhs: u8) -> ColorRGB

Performs the * operation.

impl Div<u8> for ColorRGB

type Output = ColorRGB

The resulting type after applying the / operator.

fn div(self, rhs: u8) -> ColorRGB

Performs the / operation.

impl Rem<u8> for ColorRGB

type Output = ColorRGB

The resulting type after applying the % operator.

fn rem(self, rhs: u8) -> ColorRGB

Performs the % operation.

impl Neg for ColorRGB

type Output = ColorRGB

The resulting type after applying the - operator.

fn neg(self) -> ColorRGB

Performs the unary - operation.

impl AddAssign<ColorRGB> for ColorRGB

fn add_assign(&mut self, rhs: ColorRGB)

Performs the += operation.

impl AddAssign<u8> for ColorRGB

fn add_assign(&mut self, rhs: u8)

Performs the += operation.

impl SubAssign<ColorRGB> for ColorRGB

fn sub_assign(&mut self, rhs: ColorRGB)

Performs the -= operation.

impl SubAssign<u8> for ColorRGB

fn sub_assign(&mut self, rhs: u8)

Performs the -= operation.

impl MulAssign<u8> for ColorRGB

fn mul_assign(&mut self, rhs: u8)

Performs the *= operation.

impl DivAssign<u8> for ColorRGB

fn div_assign(&mut self, rhs: u8)

Performs the /= operation.

impl Not for ColorRGB

type Output = bool

The resulting type after applying the ! operator.

fn not(self) -> bool

Performs the unary ! operation.

impl BitAnd<ColorRGB> for ColorRGB

type Output = ColorRGB

The resulting type after applying the & operator.

fn bitand(self, other: ColorRGB) -> ColorRGB

Performs the & operation.

impl BitOr<ColorRGB> for ColorRGB

type Output = ColorRGB

The resulting type after applying the | operator.

fn bitor(self, other: ColorRGB) -> ColorRGB

Performs the | operation.

impl BitAndAssign<ColorRGB> for ColorRGB

fn bitand_assign(&mut self, rhs: ColorRGB)

Performs the &= operation.

impl BitAndAssign<u8> for ColorRGB

fn bitand_assign(&mut self, rhs: u8)

Performs the &= operation.

impl BitOrAssign<ColorRGB> for ColorRGB

fn bitor_assign(&mut self, rhs: ColorRGB)

Performs the |= operation.

impl BitOrAssign<u8> for ColorRGB

fn bitor_assign(&mut self, rhs: u8)

Performs the |= operation.

impl ShrAssign<u8> for ColorRGB

fn shr_assign(&mut self, rhs: u8)

Performs the >>= operation.

impl Index<usize> for ColorRGB

type Output = u8

The returned type after indexing.

fn index(&self, idx: usize) -> &u8

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for ColorRGB

fn index_mut(&mut self, idx: usize) -> &mut u8

Performs the mutable indexing (container[index]) operation.

impl Debug for ColorRGB

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

Formats the value using the given formatter.