Struct RGB

pub struct RGB {
    pub r: f32,
    pub g: f32,
    pub b: f32,
}

Represents an R/G/B triplet, in the range 0..1 (32-bit float)

Fields

r: f32

The red component (0..1)

g: f32

The green components (0..1)

b: f32

The blue component (0..1)

Implementations

impl RGB

pub fn new() -> RGB

Constructs a new, zeroed (black) RGB triplet.

pub fn from_f32(r: f32, g: f32, b: f32) -> RGB

Constructs a new RGB color, from 3 32-bit floats in the range 0..1

Arguments

• r - the red component (0..1)
• g - the green component (0..1)
• b - the blue component (0..1)

Example

use bracket_color::prelude::*;
let red = RGB::from_f32(1.0, 0.0, 0.0);
let green = RGB::from_f32(0.0, 1.0, 0.0);

pub fn from_u8(r: u8, g: u8, b: u8) -> RGB

Constructs a new RGB color, from 3 bytes in the range 0..255

Arguments

• r - the red component, ranged from 0 to 255
• g - the green component, ranged from 0 to 255
• b - the blue component, ranged from 0 to 255

Example

use bracket_color::prelude::*;
let red = RGB::from_u8(255, 0, 0);
let green = RGB::from_u8(0, 255, 0);

pub fn named(col: (u8, u8, u8)) -> RGB

Construct an RGB color from a tuple of u8, or a named constant

Arguments

• col a tuple of three u8 values. See from_u8. These are usually provided from the named colors list.

Example

use bracket_color::prelude::*;
let red = RGB::named(RED);
let green = RGB::named((0, 255, 0));

pub fn from_hex<S>(code: S) -> Result<RGB, HtmlColorConversionError>

where S: AsRef<str>,

Constructs from an HTML color code (e.g. “#eeffee”)

Arguments

• code - an HTML color notation (e.g. “#ffeeff”)

Example

use bracket_color::prelude::*;
let red = RGB::from_hex("#FF0000");
let green = RGB::from_hex("#00FF00");

Errors

See HtmlColorConversionError

pub fn to_hsv(&self) -> HSV

Converts an RGB triple to an HSV triple.

pub fn to_rgba(&self, alpha: f32) -> RGBA

Converts an RGB to an RGBA

pub fn to_greyscale(&self) -> RGB

Applies a quick grayscale conversion to the color

pub fn desaturate(&self) -> RGB

Applies a lengthier desaturate (via HSV) to the color

pub fn lerp(&self, color: RGB, percent: f32) -> RGB

Lerps by a specified percentage (from 0 to 1) between this color and another

Trait Implementations

impl Add<f32> for RGB

Support adding a float to a color. The result is clamped via the constructor.

type Output = RGB

The resulting type after applying the + operator.

fn add(self, rhs: f32) -> RGB

Performs the + operation.

impl Add for RGB

Support adding an RGB to a color. The result is clamped via the constructor.

type Output = RGB

The resulting type after applying the + operator.

fn add(self, rhs: RGB) -> RGB

Performs the + operation.

impl Clone for RGB

fn clone(&self) -> RGB

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RGB

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

Formats the value using the given formatter.

impl Default for RGB

fn default() -> RGB

Returns the “default value” for a type.

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

Support conversion from a color tuple

fn from(vals: (u8, u8, u8)) -> RGB

Converts to this type from the input type.

impl From<HSV> for RGB

Support conversion from HSV

fn from(hsv: HSV) -> RGB

Converts to this type from the input type.

impl From<RGB> for HSV

Support conversion from RGB

fn from(rgb: RGB) -> HSV

Converts to this type from the input type.

impl From<RGB> for RGBA

Support conversion from RGB

fn from(item: RGB) -> RGBA

Converts to this type from the input type.

impl From<RGB> for XpColor

fn from(rgb: RGB) -> XpColor

Converts to this type from the input type.

impl From<RGBA> for RGB

Support conversion from RGBA

fn from(item: RGBA) -> RGB

Converts to this type from the input type.

impl From<XpColor> for RGB

fn from(xp: XpColor) -> RGB

Converts to this type from the input type.

impl Mul<f32> for RGB

Support multiplying a color by a float. The result is clamped via the constructor.

type Output = RGB

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> RGB

Performs the * operation.

impl Mul for RGB

Support multiplying a color by another color. The result is clamped via the constructor.

type Output = RGB

The resulting type after applying the * operator.

fn mul(self, rhs: RGB) -> RGB

Performs the * operation.

impl PartialEq for RGB

fn eq(&self, other: &RGB) -> 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 Sub<f32> for RGB

Support subtracting a float from a color. The result is clamped via the constructor.

type Output = RGB

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> RGB

Performs the - operation.

impl Sub for RGB

Support subtracting an RGB from a color. The result is clamped via the constructor.

type Output = RGB

The resulting type after applying the - operator.

fn sub(self, rhs: RGB) -> RGB

Performs the - operation.

impl Copy for RGB

impl StructuralPartialEq for RGB