Struct rute::auto::color::Color

source ·

pub struct Color<'a> { /* private fields */ }

Expand description

Notice these docs are heavy WIP and not very relevent yet

A color is normally specified in terms of RGB (red, green, and blue) components, but it is also possible to specify it in terms of HSV (hue, saturation, and value) and CMYK (cyan, magenta, yellow and black) components. In addition a color can be specified using a color name. The color name can be any of the SVG 1.0 color names.

RGB
HSV
CMYK

The QColor constructor creates the color based on RGB values. To create a QColor based on either HSV or CMYK values, use the toHsv() and toCmyk() functions respectively. These functions return a copy of the color using the desired format. In addition the static fromRgb(), fromHsv() and fromCmyk() functions create colors from the specified values. Alternatively, a color can be converted to any of the three formats using the convertTo() function (returning a copy of the color in the desired format), or any of the setRgb(), setHsv() and setCmyk() functions altering this color’s format. The spec() function tells how the color was specified.

A color can be set by passing an RGB string (such as ), or an ARGB string (such as ) or a color name (such as ), to the setNamedColor() function. The color names are taken from the SVG 1.0 color names. The name() function returns the name of the color in the format . Colors can also be set using setRgb(), setHsv() and setCmyk(). To get a lighter or darker color use the lighter() and darker() functions respectively.

The isValid() function indicates whether a QColor is legal at all. For example, a RGB color with RGB values out of range is illegal. For performance reasons, QColor mostly disregards illegal colors, and for that reason, the result of using an invalid color is undefined.

The color components can be retrieved individually, e.g with red(), hue() and cyan(). The values of the color components can also be retrieved in one go using the getRgb(), getHsv() and getCmyk() functions. Using the RGB color model, the color components can in addition be accessed with rgb().

There are several related non-members: QRgb is a typdef for an unsigned int representing the RGB value triplet (r, g, b). Note that it also can hold a value for the alpha-channel (for more information, see the Alpha-Blended Drawing section). The qRed(), qBlue() and qGreen() functions return the respective component of the given QRgb value, while the qRgb() and qRgba() functions create and return the QRgb triplet based on the given component values. Finally, the qAlpha() function returns the alpha component of the provided QRgb, and the qGray() function calculates and return a gray value based on the given value.

QColor is platform and device independent. The QColormap class maps the color to the hardware.

For more information about painting in general, see the Paint System documentation.

Integer vs. Floating Point Precision

QColor supports floating point precision and provides floating point versions of all the color components functions, e.g. getRgbF(), hueF() and fromCmykF(). Note that since the components are stored using 16-bit integers, there might be minor deviations between the values set using, for example, setRgbF() and the values returned by the getRgbF() function due to rounding.

While the integer based functions take values in the range 0-255 (except hue() which must have values within the range 0-359), the floating point functions accept values in the range 0.0 - 1.0.

Alpha-Blended Drawing

QColor also support alpha-blended outlining and filling. The alpha channel of a color specifies the transparency effect, 0 represents a fully transparent color, while 255 represents a fully opaque color. For example:

The code above produces the following output:

The alpha channel of a color can be retrieved and set using the alpha() and setAlpha() functions if its value is an integer, and alphaF() and setAlphaF() if its value is qreal (double). By default, the alpha-channel is set to 255 (opaque). To retrieve and set all the RGB color components (including the alpha-channel) in one go, use the rgba() and setRgba() functions.

Predefined Colors

There are 20 predefined QColors described by the Qt::GlobalColor enum, including black, white, primary and secondary colors, darker versions of these colors and three shades of gray. QColor also recognizes a variety of color names; the static colorNames() function returns a QStringList color names that QColor knows about.

Qt Colors

Additionally, the Qt::color0, Qt::color1 and Qt::transparent colors are used for special purposes.

Qt::color0 (zero pixel value) and Qt::color1 (non-zero pixel value) are special colors for drawing in QBitmaps. Painting with Qt::color0 sets the bitmap bits to 0 (transparent; i.e., background), and painting with Qt::color1 sets the bits to 1 (opaque; i.e., foreground).

Qt::transparent is used to indicate a transparent pixel. When painting with this value, a pixel value will be used that is appropriate for the underlying pixel format in use.

The HSV Color Model

The RGB model is hardware-oriented. Its representation is close to what most monitors show. In contrast, HSV represents color in a way more suited to the human perception of color. For example, the relationships , , and are easily expressed in HSV but are much harder to express in RGB.

HSV, like RGB, has three components:

H, for hue, is in the range 0 to 359 if the color is chromatic (not gray), or meaningless if it is gray. It represents degrees on the color wheel familiar to most people. Red is 0 (degrees), green is 120, and blue is 240.
S, for saturation, is in the range 0 to 255, and the bigger it is, the stronger the color is. Grayish colors have saturation near 0; very strong colors have saturation near 255.
V, for value, is in the range 0 to 255 and represents lightness or brightness of the color. 0 is black; 255 is as far from black as possible.

Here are some examples: pure red is H=0, S=255, V=255; a dark red, moving slightly towards the magenta, could be H=350 (equivalent to -10), S=255, V=180; a grayish light red could have H about 0 (say 350-359 or 0-10), S about 50-100, and S=255.

Qt returns a hue value of -1 for achromatic colors. If you pass a hue value that is too large, Qt forces it into range. Hue 360 or 720 is treated as 0; hue 540 is treated as 180.

In addition to the standard HSV model, Qt provides an alpha-channel to feature alpha-blended drawing

The HSL Color Model

HSL is similar to HSV, however instead of the Value parameter, HSL specifies a Lightness parameter.

The CMYK Color Model

While the RGB and HSV color models are used for display on computer monitors, the CMYK model is used in the four-color printing process of printing presses and some hard-copy devices.

CMYK has four components, all in the range 0-255: cyan (C), magenta (M), yellow (Y) and black (K). Cyan, magenta and yellow are called subtractive colors; the CMYK color model creates color by starting with a white surface and then subtracting color by applying the appropriate components. While combining cyan, magenta and yellow gives the color black, subtracting one or more will yield any other color. When combined in various percentages, these three colors can create the entire spectrum of colors.

Mixing 100 percent of cyan, magenta and yellow does produce black, but the result is unsatisfactory since it wastes ink, increases drying time, and gives a muddy colour when printing. For that reason, black is added in professional printing to provide a solid black tone; hence the term ‘four color process’.

In addition to the standard CMYK model, Qt provides an alpha-channel to feature alpha-blended drawing

See also: Palette Brush

Licence

The documentation is an adoption of the original Qt Documentation and provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.

Struct rute::auto::color::Color

Implementations

impl<'a> Color<'a>

pub fn new() -> Color<'a>

pub fn is_valid(&self) -> bool

pub fn name(&self) -> String

pub fn name_2(&self, format: NameFormat) -> String

pub fn set_named_color(&self, name: &str) -> &Self

pub fn spec(&self) -> Spec

pub fn alpha(&self) -> i32

pub fn set_alpha(&self, alpha: i32) -> &Self

pub fn alpha_f(&self) -> f32

pub fn set_alpha_f(&self, alpha: f32) -> &Self

pub fn red(&self) -> i32

pub fn green(&self) -> i32

pub fn blue(&self) -> i32

pub fn set_red(&self, red: i32) -> &Self

pub fn set_green(&self, green: i32) -> &Self

pub fn set_blue(&self, blue: i32) -> &Self

pub fn red_f(&self) -> f32

pub fn green_f(&self) -> f32

pub fn blue_f(&self) -> f32

pub fn set_red_f(&self, red: f32) -> &Self

pub fn set_green_f(&self, green: f32) -> &Self

pub fn set_blue_f(&self, blue: f32) -> &Self

pub fn set_rgb(&self, r: i32, g: i32, b: i32, a: i32) -> &Self

pub fn set_rgb_f(&self, r: f32, g: f32, b: f32, a: f32) -> &Self

pub fn hue(&self) -> i32

pub fn saturation(&self) -> i32

pub fn hsv_hue(&self) -> i32

pub fn hsv_saturation(&self) -> i32

pub fn value(&self) -> i32

pub fn hue_f(&self) -> f32

pub fn saturation_f(&self) -> f32

pub fn hsv_hue_f(&self) -> f32

pub fn hsv_saturation_f(&self) -> f32

pub fn value_f(&self) -> f32

pub fn set_hsv(&self, h: i32, s: i32, v: i32, a: i32) -> &Self

pub fn set_hsv_f(&self, h: f32, s: f32, v: f32, a: f32) -> &Self

pub fn cyan(&self) -> i32

pub fn magenta(&self) -> i32

pub fn yellow(&self) -> i32

pub fn black(&self) -> i32

pub fn cyan_f(&self) -> f32

pub fn magenta_f(&self) -> f32

pub fn yellow_f(&self) -> f32

pub fn black_f(&self) -> f32

pub fn set_cmyk(&self, c: i32, m: i32, y: i32, k: i32, a: i32) -> &Self

pub fn set_cmyk_f(&self, c: f32, m: f32, y: f32, k: f32, a: f32) -> &Self

pub fn hsl_hue(&self) -> i32

pub fn hsl_saturation(&self) -> i32

pub fn lightness(&self) -> i32

pub fn hsl_hue_f(&self) -> f32

pub fn hsl_saturation_f(&self) -> f32

pub fn lightness_f(&self) -> f32

pub fn set_hsl(&self, h: i32, s: i32, l: i32, a: i32) -> &Self

pub fn set_hsl_f(&self, h: f32, s: f32, l: f32, a: f32) -> &Self

pub fn to_rgb(&self) -> Color<'_>

pub fn to_hsv(&self) -> Color<'_>

pub fn to_cmyk(&self) -> Color<'_>

pub fn to_hsl(&self) -> Color<'_>

pub fn convert_to(&self, color_spec: Spec) -> Color<'_>

pub fn from_rgb_2(r: i32, g: i32, b: i32, a: i32) -> Color<'a>

pub fn from_rgb_f(r: f32, g: f32, b: f32, a: f32) -> Color<'a>

pub fn from_rgba64(r: u16, g: u16, b: u16, a: u16) -> Color<'a>

pub fn from_hsv(h: i32, s: i32, v: i32, a: i32) -> Color<'a>

pub fn from_hsv_f(h: f32, s: f32, v: f32, a: f32) -> Color<'a>

pub fn from_cmyk(c: i32, m: i32, y: i32, k: i32, a: i32) -> Color<'a>

pub fn from_cmyk_f(c: f32, m: f32, y: f32, k: f32, a: f32) -> Color<'a>

pub fn from_hsl(h: i32, s: i32, l: i32, a: i32) -> Color<'a>

pub fn from_hsl_f(h: f32, s: f32, l: f32, a: f32) -> Color<'a>

pub fn light(&self, f: i32) -> Color<'_>

pub fn lighter(&self, f: i32) -> Color<'_>

pub fn dark(&self, f: i32) -> Color<'_>

pub fn darker(&self, f: i32) -> Color<'_>

pub fn is_valid_color(name: &str) -> bool

Trait Implementations

impl<'a> Clone for Color<'a>

fn clone(&self) -> Color<'a>

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,