Struct RGBA

pub struct RGBA {
    pub r: f32,
    pub g: f32,
    pub b: f32,
    pub a: 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 component (0..1)

b: f32

The blue component (0..1)

a: f32

The alpha component (0..1), 0 is transparent, 1 is solid

Implementations

impl RGBA

pub fn new() -> RGBA

Constructs a new, zeroed (black) RGB triplet.

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

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)
• a - the alpha component (0..1). 0 is transparent, 1 is solid.

Example

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

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

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 = RGBA::from_u8(255, 0, 0, 255);
let green = RGBA::from_u8(0, 255, 0, 255);
let invisible = RGBA::from_u8(0, 0, 0, 0);

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

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 = RGBA::named(RED);
let green = RGBA::named((0, 255, 0));

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

where S: AsRef<str>,

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

Arguments

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

Example

use bracket_color::prelude::*;
let red = RGBA::from_hex("#FF0000FF");
let green = RGBA::from_hex("#00FF00FF");

Errors

See HtmlColorConversionError

pub fn to_rgb(&self) -> RGB

Converts to an RGB, dropping the alpha component

pub fn to_greyscale(&self) -> RGBA

Applies a quick grayscale conversion to the color

pub fn desaturate(&self) -> RGBA

Applies a lengthier desaturate (via HSV) to the color

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

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

pub fn lerp_alpha(&self, color: RGBA, percent: f32) -> RGBA

Lerps only the alpha channel, by a specified percentage (from 0 to 1) between this color and another

Trait Implementations

impl Add<f32> for RGBA

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

type Output = RGBA

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for RGBA

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

type Output = RGBA

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for RGBA

fn clone(&self) -> RGBA

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RGBA

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

Formats the value using the given formatter.

impl Default for RGBA

fn default() -> RGBA

Returns the “default value” for a type.

impl From<[f32; 4]> for RGBA

fn from(item: [f32; 4]) -> RGBA

Converts to this type from the input type.

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

Support conversion from a color tuple

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

Converts to this type from the input type.

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

Support conversion from a color tuple

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

Converts to this type from the input type.

impl From<HSV> for RGBA

Support conversion from HSV

fn from(item: HSV) -> RGBA

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<RGBA> for HSV

Support conversion from RGBA

fn from(rgba: RGBA) -> HSV

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<RGBA> for XpColor

fn from(rgb: RGBA) -> XpColor

Converts to this type from the input type.

impl From<XpColor> for RGBA

fn from(xp: XpColor) -> RGBA

Converts to this type from the input type.

impl Mul<f32> for RGBA

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

type Output = RGBA

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for RGBA

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

type Output = RGBA

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for RGBA

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

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

type Output = RGBA

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for RGBA

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

type Output = RGBA

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for RGBA

impl StructuralPartialEq for RGBA