Struct rltk::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

g: f32

b: f32

Methods

impl RGB

#[must_use]pub fn new() -> RGB

Constructs a new, zeroed (black) RGB triplet.

#[must_use]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

#[must_use]pub fn from_u8(r: u8, g: u8, b: u8) -> RGB

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

#[must_use]pub fn named(col: (u8, u8, u8)) -> RGB

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

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

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

Errors

#[must_use]pub fn from_xp(col: XpColor) -> RGB

Converts an xp file color component to an RGB

#[must_use]pub fn to_xp(&self) -> XpColor

Converts an RGB to an xp file color component

#[must_use]pub fn to_hsv(&self) -> HSV

Converts an RGB triple to an HSV triple.

#[must_use]pub fn to_rgba(&self, alpha: f32) -> RGBA

Converts an RGB to an RGBA

#[must_use]pub fn to_greyscale(&self) -> RGB

Applies a quick grayscale conversion to the color

#[must_use]pub fn desaturate(&self) -> RGB

Applies a lengthier desaturate (via HSV) to the color

#[must_use]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<RGB> 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.

#[must_use]fn add(self, rhs: RGB) -> RGB

Performs the + operation.

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.

#[must_use]fn add(self, rhs: f32) -> 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 Copy for RGB

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

Performs the conversion.

impl From<HSV> for RGB

Support conversion from HSV

fn from(hsv: HSV) -> RGB

Performs the conversion.

impl From<RGB> for HSV

Support conversion from RGB

fn from(rgb: RGB) -> HSV

Performs the conversion.

impl From<RGB> for RGBA

Support conversion from RGB

fn from(item: RGB) -> RGBA

Performs the conversion.

impl From<RGB> for XpColor

fn from(rgb: RGB) -> XpColor

Performs the conversion.

impl From<RGBA> for RGB

Support conversion from RGBA

fn from(item: RGBA) -> RGB

Performs the conversion.

impl From<XpColor> for RGB

fn from(xp: XpColor) -> RGB

Performs the conversion.

impl Mul<RGB> 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.

#[must_use]fn mul(self, rhs: RGB) -> RGB

Performs the * operation.

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.

#[must_use]fn mul(self, rhs: f32) -> RGB

Performs the * operation.

impl PartialEq<RGB> for RGB

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

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

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

This method tests for !=.

impl StructuralPartialEq for RGB

impl Sub<RGB> 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.

#[must_use]fn sub(self, rhs: RGB) -> RGB

Performs the - operation.

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.

#[must_use]fn sub(self, rhs: f32) -> RGB

Performs the - operation.