Struct termwiz::color::RgbColor

source ·

pub struct RgbColor { /* private fields */ }

Expand description

Describes a color in the SRGB colorspace using red, green and blue components in the range 0-255.

Implementations

source

impl RgbColor

source

pub const fn new_8bpc(red: u8, green: u8, blue: u8) -> Self

Construct a color from discrete red, green, blue values in the range 0-255.

source

pub fn new_f32(red: f32, green: f32, blue: f32) -> Self

Construct a color from discrete red, green, blue values in the range 0.0-1.0 in the sRGB colorspace.

source

pub fn to_tuple_rgb8(self) -> (u8, u8, u8)

Returns red, green, blue as 8bpc values. Will convert from 10bpc if that is the internal storage.

source

pub fn to_tuple_rgba(self) -> SrgbaTuple

Returns red, green, blue as floating point values in the range 0.0-1.0. An alpha channel with the value of 1.0 is included. The values are in the sRGB colorspace.

source

pub fn to_linear_tuple_rgba(self) -> LinearRgba

Returns red, green, blue as floating point values in the range 0.0-1.0. An alpha channel with the value of 1.0 is included. The values are converted from sRGB to linear colorspace.

source

pub fn from_named(name: &str) -> Option<RgbColor>

Construct a color from an X11/SVG/CSS3 color name. Returns None if the supplied name is not recognized. The list of names can be found here: https://en.wikipedia.org/wiki/X11_color_names

source

pub fn to_rgb_string(self) -> String

Returns a string of the form #RRGGBB

source

pub fn to_x11_16bit_rgb_string(self) -> String

Returns a string of the form rgb:RRRR/GGGG/BBBB

source

pub fn from_rgb_str(s: &str) -> Option<RgbColor>

Construct a color from a string of the form #RRGGBB where R, G and B are all hex digits. hsl:hue sat light is also accepted, and allows specifying a color in the HSL color space, where hue is measure in degrees and has a range of 0-360, and both sat and light are specified in percentage in the range 0-100.

source

pub fn from_named_or_rgb_string(s: &str) -> Option<Self>

Construct a color from an SVG/CSS3 color name. or from a string of the form #RRGGBB where R, G and B are all hex digits. hsl:hue sat light is also accepted, and allows specifying a color in the HSL color space, where hue is measure in degrees and has a range of 0-360, and both sat and light are specified in percentage in the range 0-100. Returns None if the supplied name is not recognized. The list of names can be found here: https://ogeon.github.io/docs/palette/master/palette/named/index.html

Trait Implementations

source

impl Clone for RgbColor

source

fn clone(&self) -> RgbColor

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for RgbColor

source

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

Formats the value using the given formatter. Read more

source

impl Default for RgbColor

source

fn default() -> RgbColor

Returns the “default value” for a type. Read more

source

impl<'de> Deserialize<'de> for RgbColor

source

fn deserialize<D>(deserializer: D) -> Result<RgbColor, D::Error>where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl From<RgbColor> for ColorSpec

source

fn from(col: RgbColor) -> Self

Converts to this type from the input type.

source

impl From<SrgbaTuple> for RgbColor

source

fn from(srgb: SrgbaTuple) -> RgbColor

Converts to this type from the input type.

source

impl FromDynamic for RgbColor

source

fn from_dynamic(
value: &Value,
options: FromDynamicOptions
) -> Result<Self, Error>

source

impl Hash for RgbColor

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl Into<SrgbaTuple> for RgbColor

source

fn into(self) -> SrgbaTuple

Converts this type into the (usually inferred) input type.

source

impl PartialEq<RgbColor> for RgbColor

source

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl Serialize for RgbColor

This is mildly unfortunate: in order to round trip RgbColor with serde we need to provide a Serialize impl equivalent to the Deserialize impl below. We use the impl below to allow more flexible specification of color strings in the config file. A side effect of doing it this way is that we have to serialize RgbColor as a 7-byte string when we could otherwise serialize it as a 3-byte array. There’s probably a way to make this work more efficiently, but for now this will do.

source