Struct courgette::Color

pub struct Color {
    pub r: f32,
    pub g: f32,
    pub b: f32,
    pub a: f32,
}

Main color structure, holds RGBA but can be constructed using other color spaces.

Fields

r: f32

Red value of the color in the range [0.0, 1.0].

g: f32

Green value of the color in the range [0.0, 1.0].

b: f32

Blue value of the color in the range [0.0, 1.0].

a: f32

Alpha value of the color in the range [0.0, 1.0].

Methods

impl Color

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

Shorthand to create a new RGBA color value. Clamps values to their respective ranges.

pub fn hex(hex: u32) -> Self

Construct a color from an 8-digit hexidecimal color code.

Examples

Basic usage:

use courgette::RGB;

// FF at the end represents 1.0 alpha.
let red = RGB::hex(0xFF0000FF);
let yellow = RGB::hex(0xFFFF00FF);
let green = RGB::hex(0x00FF00FF);
let cyan = RGB::hex(0x00FFFFFF);
let blue = RGB::hex(0x0000FFFF);
let magenta = RGB::hex(0xFF00FFFF);

pub fn hex_rgb(hex: u32) -> Self

Construct a color from a 6-digit hexidecimal color code.

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

Construct a color from HSLA values. Applies modulo 360 to hue.

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

Construct a color from HSL values. Calls Color::hsla with alpha of 1.0.

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

Construct a color from HSVA values. Applies modulo 360 to hue.

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

Construct a color from HSV values. Calls Color::hsva with alpha of 1.0.

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

Construct a color from HSBA values. HSB is equivelant to HSV, therefore this simply calls Color::hsva.

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

Construct a color from HSB values. Calls Color::hsba with alpha of 1.0.

pub fn brightness(self, percent: f32) -> Self

Change the brightness of the current color, with a percent of 1.0 being normal brightness.

Examples

Basic usage:

use courgette::Color;

let color = Color::hex(0xff4488ff);

let brighter = color.brightness(1.1); // Lighten color by 10%.
let darker = color.brightness(0.9); // Dark color by 10%.

pub fn invert(self) -> Self

Invert the current color.

pub fn grey(self) -> Self

Get greyscale version of the color.

pub fn hue(self, hue: f32) -> Self

Get hue shifted color of the current color. Hue value has a modulo of 360.0 applied.

pub fn hue_shift(self, dhue: f32) -> Self

Hue shift the current color. Changes hue by dhue (delta hue) value.

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Color

impl Into<[f32; 4]> for Color

fn into(self) -> [f32; 4]

Performs the conversion.

impl Into<[f32; 3]> for Color

fn into(self) -> [f32; 3]

Performs the conversion.

impl Debug for Color

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

Formats the value using the given formatter.