Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
The QColor class provides colors based on RGB, HSV or CMYK values. More...
#include <qcolor.h>
Public Types | |
enum | Spec { Invalid , Rgb , Hsv , Cmyk , Hsl , ExtendedRgb } |
The type of color specified, either RGB, extended RGB, HSV, CMYK or HSL. More... | |
enum | NameFormat { HexRgb , HexArgb } |
How to format the output of the name() function. More... | |
Public Member Functions | |
constexpr | QColor () noexcept |
Constructs an invalid color with the RGB value (0, 0, 0). | |
QColor (Qt::GlobalColor color) noexcept | |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Constructs a new color with a color value of color. | |
constexpr | QColor (int r, int g, int b, int a=255) noexcept |
Constructs a color with the RGB value r, g, b, and the alpha-channel (transparency) value of a. | |
QColor (QRgb rgb) noexcept | |
Constructs a color with the value color. | |
QColor (QRgba64 rgba64) noexcept | |
QColor (const QString &name) | |
Constructs a named color in the same way as setNamedColor() using the given name. | |
QColor (QStringView name) | |
QColor (const char *aname) | |
Constructs a named color in the same way as setNamedColor() using the given name. | |
QColor (QLatin1StringView name) | |
Constructs a named color in the same way as setNamedColor() using the given name. | |
QColor (Spec spec) noexcept | |
QColor & | operator= (Qt::GlobalColor color) noexcept |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Assigns a copy of color and returns a reference to this color. | |
bool | isValid () const noexcept |
Returns true if the color is valid; otherwise returns false . | |
QString | name (NameFormat format=HexRgb) const |
Spec | spec () const noexcept |
Returns how the color was specified. | |
int | alpha () const noexcept |
Returns the alpha color component of this color. | |
void | setAlpha (int alpha) |
Sets the alpha of this color to alpha. | |
float | alphaF () const noexcept |
Returns the alpha color component of this color. | |
void | setAlphaF (float alpha) |
Sets the alpha of this color to alpha. | |
int | red () const noexcept |
Returns the red color component of this color. | |
int | green () const noexcept |
Returns the green color component of this color. | |
int | blue () const noexcept |
Returns the blue color component of this color. | |
void | setRed (int red) |
Sets the red color component of this color to red. | |
void | setGreen (int green) |
Sets the green color component of this color to green. | |
void | setBlue (int blue) |
Sets the blue color component of this color to blue. | |
float | redF () const noexcept |
Returns the red color component of this color. | |
float | greenF () const noexcept |
Returns the green color component of this color. | |
float | blueF () const noexcept |
Returns the blue color component of this color. | |
void | setRedF (float red) |
Sets the red color component of this color to red. | |
void | setGreenF (float green) |
Sets the green color component of this color to green. | |
void | setBlueF (float blue) |
Sets the blue color component of this color to blue. | |
void | getRgb (int *r, int *g, int *b, int *a=nullptr) const |
Sets the contents pointed to by r, g, b, and a, to the red, green, blue, and alpha-channel (transparency) components of the color's RGB value. | |
void | setRgb (int r, int g, int b, int a=255) |
Sets the RGB value to r, g, b and the alpha value to a. | |
void | getRgbF (float *r, float *g, float *b, float *a=nullptr) const |
Sets the contents pointed to by r, g, b, and a, to the red, green, blue, and alpha-channel (transparency) components of the color's RGB value. | |
void | setRgbF (float r, float g, float b, float a=1.0) |
Sets the color channels of this color to r (red), g (green), b (blue) and a (alpha, transparency). | |
QRgba64 | rgba64 () const noexcept |
void | setRgba64 (QRgba64 rgba) noexcept |
QRgb | rgba () const noexcept |
Returns the RGB value of the color, including its alpha. | |
void | setRgba (QRgb rgba) noexcept |
Sets the RGB value to rgba, including its alpha. | |
QRgb | rgb () const noexcept |
Returns the RGB value of the color. | |
void | setRgb (QRgb rgb) noexcept |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the RGB value to rgb. | |
int | hue () const noexcept |
Returns the HSV hue color component of this color. | |
int | saturation () const noexcept |
Returns the HSV saturation color component of this color. | |
int | hsvHue () const noexcept |
Returns the HSV hue color component of this color. | |
int | hsvSaturation () const noexcept |
Returns the HSV saturation color component of this color. | |
int | value () const noexcept |
Returns the value color component of this color. | |
float | hueF () const noexcept |
Returns the HSV hue color component of this color. | |
float | saturationF () const noexcept |
Returns the HSV saturation color component of this color. | |
float | hsvHueF () const noexcept |
Returns the hue color component of this color. | |
float | hsvSaturationF () const noexcept |
Returns the HSV saturation color component of this color. | |
float | valueF () const noexcept |
Returns the value color component of this color. | |
void | getHsv (int *h, int *s, int *v, int *a=nullptr) const |
Sets the contents pointed to by h, s, v, and a, to the hue, saturation, value, and alpha-channel (transparency) components of the color's HSV value. | |
void | setHsv (int h, int s, int v, int a=255) |
Sets a HSV color value; h is the hue, s is the saturation, v is the value and a is the alpha component of the HSV color. | |
void | getHsvF (float *h, float *s, float *v, float *a=nullptr) const |
Sets the contents pointed to by h, s, v, and a, to the hue, saturation, value, and alpha-channel (transparency) components of the color's HSV value. | |
void | setHsvF (float h, float s, float v, float a=1.0) |
Sets a HSV color value; h is the hue, s is the saturation, v is the value and a is the alpha component of the HSV color. | |
int | cyan () const noexcept |
Returns the cyan color component of this color. | |
int | magenta () const noexcept |
Returns the magenta color component of this color. | |
int | yellow () const noexcept |
Returns the yellow color component of this color. | |
int | black () const noexcept |
Returns the black color component of this color. | |
float | cyanF () const noexcept |
Returns the cyan color component of this color. | |
float | magentaF () const noexcept |
Returns the magenta color component of this color. | |
float | yellowF () const noexcept |
Returns the yellow color component of this color. | |
float | blackF () const noexcept |
Returns the black color component of this color. | |
void | getCmyk (int *c, int *m, int *y, int *k, int *a=nullptr) const |
Sets the contents pointed to by c, m, y, k, and a, to the cyan, magenta, yellow, black, and alpha-channel (transparency) components of the color's CMYK value. | |
void | setCmyk (int c, int m, int y, int k, int a=255) |
Sets the color to CMYK values, c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e. | |
void | getCmykF (float *c, float *m, float *y, float *k, float *a=nullptr) const |
Sets the contents pointed to by c, m, y, k, and a, to the cyan, magenta, yellow, black, and alpha-channel (transparency) components of the color's CMYK value. | |
void | setCmykF (float c, float m, float y, float k, float a=1.0) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the color to CMYK values, c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e. | |
int | hslHue () const noexcept |
int | hslSaturation () const noexcept |
int | lightness () const noexcept |
float | hslHueF () const noexcept |
float | hslSaturationF () const noexcept |
float | lightnessF () const noexcept |
void | getHsl (int *h, int *s, int *l, int *a=nullptr) const |
void | setHsl (int h, int s, int l, int a=255) |
void | getHslF (float *h, float *s, float *l, float *a=nullptr) const |
void | setHslF (float h, float s, float l, float a=1.0) |
QColor | toRgb () const noexcept |
Create and returns an RGB QColor based on this color. | |
QColor | toHsv () const noexcept |
Creates and returns an HSV QColor based on this color. | |
QColor | toCmyk () const noexcept |
Creates and returns a CMYK QColor based on this color. | |
QColor | toHsl () const noexcept |
Creates and returns an HSL QColor based on this color. | |
QColor | toExtendedRgb () const noexcept |
Create and returns an extended RGB QColor based on this color. | |
QColor | convertTo (Spec colorSpec) const noexcept |
Creates a copy of this color in the format specified by colorSpec. | |
QColor | lighter (int f=150) const noexcept |
QColor | darker (int f=200) const noexcept |
bool | operator== (const QColor &c) const noexcept |
Returns true if this color has the same color specification and component values as color; otherwise returns false . | |
bool | operator!= (const QColor &c) const noexcept |
Returns true if this color has different color specification or component values from color; otherwise returns false . | |
operator QVariant () const | |
Returns the color as a QVariant. | |
Static Public Member Functions | |
static QColor | fromString (QAnyStringView name) noexcept |
static QStringList | colorNames () |
Returns a QStringList containing the color names Qt knows about. | |
static QColor | fromRgb (QRgb rgb) noexcept |
Static convenience function that returns a QColor constructed from the given QRgb value rgb. | |
static QColor | fromRgba (QRgb rgba) noexcept |
Static convenience function that returns a QColor constructed from the given QRgb value rgba. | |
static QColor | fromRgb (int r, int g, int b, int a=255) |
Static convenience function that returns a QColor constructed from the RGB color values, r (red), g (green), b (blue), and a (alpha-channel, i.e. | |
static QColor | fromRgbF (float r, float g, float b, float a=1.0) |
Static convenience function that returns a QColor constructed from the RGB color values, r (red), g (green), b (blue), and a (alpha-channel, i.e. | |
static QColor | fromRgba64 (ushort r, ushort g, ushort b, ushort a=USHRT_MAX) noexcept |
static QColor | fromRgba64 (QRgba64 rgba) noexcept |
static QColor | fromHsv (int h, int s, int v, int a=255) |
Static convenience function that returns a QColor constructed from the HSV color values, h (hue), s (saturation), v (value), and a (alpha-channel, i.e. | |
static QColor | fromHsvF (float h, float s, float v, float a=1.0) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Static convenience function that returns a QColor constructed from the HSV color values, h (hue), s (saturation), v (value), and a (alpha-channel, i.e. | |
static QColor | fromCmyk (int c, int m, int y, int k, int a=255) |
Static convenience function that returns a QColor constructed from the given CMYK color values: c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e. | |
static QColor | fromCmykF (float c, float m, float y, float k, float a=1.0) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Static convenience function that returns a QColor constructed from the given CMYK color values: c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e. | |
static QColor | fromHsl (int h, int s, int l, int a=255) |
static QColor | fromHslF (float h, float s, float l, float a=1.0) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
static bool | isValidColorName (QAnyStringView) noexcept |
Friends | |
class | QColormap |
Q_GUI_EXPORT QDataStream & | operator<< (QDataStream &stream, const QColor &color) |
Writes the color to the stream. | |
Q_GUI_EXPORT QDataStream & | operator>> (QDataStream &stream, QColor &color) |
Reads the color from the stream. | |
Related Symbols | |
(Note that these are not member symbols.) | |
int | qRed (QRgb rgb) |
Returns the red component of the ARGB quadruplet rgb. | |
int | qGreen (QRgb rgb) |
Returns the green component of the ARGB quadruplet rgb. | |
int | qBlue (QRgb rgb) |
Returns the blue component of the ARGB quadruplet rgb. | |
int | qAlpha (QRgb rgba) |
Returns the alpha component of the ARGB quadruplet rgba. | |
QRgb | qRgb (int r, int g, int b) |
Returns the ARGB quadruplet (255, {r}, {g}, {b}). | |
QRgb | qRgba (int r, int g, int b, int a) |
Returns the ARGB quadruplet ({a}, {r}, {g}, {b}). | |
int | qGray (int r, int g, int b) |
Returns a gray value (0 to 255) from the (r, g, b) triplet. | |
int | qGray (QRgb rgb) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QRgb | qPremultiply (QRgb rgb) |
QRgb | qUnpremultiply (QRgb rgb) |
QRgb | |
An ARGB quadruplet on the format #AARRGGBB, equivalent to an unsigned int. | |
The QColor class provides colors based on RGB, HSV or CMYK values.
\inmodule QtGui
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.
\table \header
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 "#112233"), or an ARGB string (such as "#ff112233") or a color name (such as "blue"), to the fromString() 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 "#RRGGBB". 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 \l {QColor#Alpha-Blended Drawing}{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 \l{Paint System} documentation.
enum QColor::NameFormat |
How to format the output of the name() function.
\value HexRgb #RRGGBB A "#" character followed by three two-digit hexadecimal numbers (i.e. {#RRGGBB}). \value HexArgb #AARRGGBB A "#" character followed by four two-digit hexadecimal numbers (i.e.
{#AARRGGBB}).
Enumerator | |
---|---|
HexRgb | |
HexArgb |
enum QColor::Spec |
The type of color specified, either RGB, extended RGB, HSV, CMYK or HSL.
\value Rgb \value Hsv \value Cmyk \value Hsl \value ExtendedRgb \value Invalid
Enumerator | |
---|---|
Invalid | |
Rgb | |
Hsv | |
Cmyk | |
Hsl | |
ExtendedRgb |
|
inlineconstexprnoexcept |
|
noexcept |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Constructs a new color with a color value of color.
Definition at line 653 of file qcolor.cpp.
|
inlineconstexprnoexcept |
|
noexcept |
Constructs a color with the value color.
The alpha component is ignored and set to solid.
Definition at line 728 of file qcolor.cpp.
|
noexcept |
Constructs a color with the value rgba64.
Definition at line 746 of file qcolor.cpp.
|
inline |
|
inlineexplicit |
|
inline |
Constructs a named color in the same way as setNamedColor() using the given name.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inline |
Constructs a named color in the same way as setNamedColor() using the given name.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
noexcept |
Constructs a color with the given spec.
This function is primarily present to avoid that QColor::Invalid becomes a valid color by accident.
Definition at line 760 of file qcolor.cpp.
|
noexcept |
Returns the alpha color component of this color.
Definition at line 1464 of file qcolor.cpp.
|
noexcept |
Returns the alpha color component of this color.
Definition at line 1495 of file qcolor.cpp.
|
noexcept |
Returns the black color component of this color.
Definition at line 1949 of file qcolor.cpp.
|
noexcept |
Returns the black color component of this color.
Definition at line 1997 of file qcolor.cpp.
|
noexcept |
Returns the blue color component of this color.
Definition at line 1581 of file qcolor.cpp.
|
noexcept |
Returns the blue color component of this color.
Definition at line 1673 of file qcolor.cpp.
|
static |
Returns a QStringList containing the color names Qt knows about.
Definition at line 1000 of file qcolor.cpp.
|
nodiscardnoexcept |
|
noexcept |
Returns the cyan color component of this color.
Definition at line 1912 of file qcolor.cpp.
|
noexcept |
Returns the cyan color component of this color.
Definition at line 1961 of file qcolor.cpp.
|
nodiscardnoexcept |
Returns a darker (or lighter) color, but does not change this object.
If the factor is greater than 100, this functions returns a darker color. Setting factor to 300 returns a color that has one-third the brightness. If the factor is less than 100, the return color is lighter, but we recommend using the lighter() function for this purpose. If the factor is 0 or negative, the return value is unspecified.
The function converts the current color to HSV, divides the value (V) component by factor and converts the color back to it's original color spec.
Definition at line 2855 of file qcolor.cpp.
|
static |
Static convenience function that returns a QColor constructed from the given CMYK color values: c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e.
transparency).
All the values must be in the range 0-255.
Definition at line 2739 of file qcolor.cpp.
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Static convenience function that returns a QColor constructed from the given CMYK color values: c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e.
transparency).
All the values must be in the range 0.0-1.0.
Definition at line 2771 of file qcolor.cpp.
|
static |
Static convenience function that returns a QColor constructed from the HSV color values, h (hue), s (saturation), l (lightness), and a (alpha-channel, i.e. transparency).
The value of s, l, and a must all be in the range 0-255; the value of h must be in the range 0-359.
Definition at line 2560 of file qcolor.cpp.
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Static convenience function that returns a QColor constructed from the HSV color values, h (hue), s (saturation), l (lightness), and a (alpha-channel, i.e. transparency).
All the values must be in the range 0.0-1.0.
Definition at line 2592 of file qcolor.cpp.
|
static |
Static convenience function that returns a QColor constructed from the HSV color values, h (hue), s (saturation), v (value), and a (alpha-channel, i.e.
transparency).
The value of s, v, and a must all be in the range 0-255; the value of h must be in the range 0-359.
Definition at line 2497 of file qcolor.cpp.
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Static convenience function that returns a QColor constructed from the HSV color values, h (hue), s (saturation), v (value), and a (alpha-channel, i.e.
transparency).
All the values must be in the range 0.0-1.0.
Definition at line 2528 of file qcolor.cpp.
|
static |
Static convenience function that returns a QColor constructed from the RGB color values, r (red), g (green), b (blue), and a (alpha-channel, i.e.
transparency).
All the values must be in the range 0-255.
Definition at line 2397 of file qcolor.cpp.
Static convenience function that returns a QColor constructed from the given QRgb value rgb.
The alpha component of rgb is ignored (i.e. it is automatically set to 255), use the fromRgba() function to include the alpha-channel specified by the given QRgb value.
Definition at line 2367 of file qcolor.cpp.
Static convenience function that returns a QColor constructed from the given QRgb value rgba.
Unlike the fromRgb() function, the alpha-channel specified by the given QRgb value is included.
Definition at line 2383 of file qcolor.cpp.
Static convenience function that returns a QColor constructed from the given QRgba64 value rgba64.
Definition at line 2480 of file qcolor.cpp.
Static convenience function that returns a QColor constructed from the RGBA64 color values, r (red), g (green), b (blue), and a (alpha-channel, i.e. transparency).
Definition at line 2465 of file qcolor.cpp.
|
static |
Static convenience function that returns a QColor constructed from the RGB color values, r (red), g (green), b (blue), and a (alpha-channel, i.e.
transparency).
The alpha value must be in the range 0.0-1.0. If any of the other values are outside the range of 0.0-1.0 the color model will be set as ExtendedRgb
.
Definition at line 2425 of file qcolor.cpp.
|
staticnoexcept |
Returns an RGB QColor parsed from name, which may be in one of these formats:
\list
transparent
- representing the absence of a color. \endlistReturns an invalid color if name cannot be parsed.
Definition at line 978 of file qcolor.cpp.
Sets the contents pointed to by c, m, y, k, and a, to the cyan, magenta, yellow, black, and alpha-channel (transparency) components of the color's CMYK value.
These components can be retrieved individually using the cyan(), magenta(), yellow(), black() and alpha() functions.
Definition at line 2624 of file qcolor.cpp.
Sets the contents pointed to by c, m, y, k, and a, to the cyan, magenta, yellow, black, and alpha-channel (transparency) components of the color's CMYK value.
These components can be retrieved individually using the cyanF(), magentaF(), yellowF(), blackF() and alphaF() functions.
Definition at line 2653 of file qcolor.cpp.
Sets the contents pointed to by h, s, l, and a, to the hue, saturation, lightness, and alpha-channel (transparency) components of the color's HSL value.
These components can be retrieved individually using the hslHue(), hslSaturation(), lightness() and alpha() functions.
Definition at line 1155 of file qcolor.cpp.
Sets the contents pointed to by h, s, l, and a, to the hue, saturation, lightness, and alpha-channel (transparency) components of the color's HSL value.
These components can be retrieved individually using the hslHueF(), hslSaturationF(), lightnessF() and alphaF() functions.
Definition at line 1125 of file qcolor.cpp.
Sets the contents pointed to by h, s, v, and a, to the hue, saturation, value, and alpha-channel (transparency) components of the color's HSV value.
These components can be retrieved individually using the hue(), saturation(), value() and alpha() functions.
Definition at line 1043 of file qcolor.cpp.
Sets the contents pointed to by h, s, v, and a, to the hue, saturation, value, and alpha-channel (transparency) components of the color's HSV value.
These components can be retrieved individually using the hueF(), saturationF(), valueF() and alphaF() functions.
Definition at line 1015 of file qcolor.cpp.
|
noexcept |
Returns the green color component of this color.
Definition at line 1553 of file qcolor.cpp.
|
noexcept |
Returns the green color component of this color.
Definition at line 1641 of file qcolor.cpp.
|
noexcept |
Returns the HSL hue color component of this color.
Definition at line 1830 of file qcolor.cpp.
|
noexcept |
Returns the HSL hue color component of this color.
Definition at line 1872 of file qcolor.cpp.
|
noexcept |
Returns the HSL saturation color component of this color.
Definition at line 1844 of file qcolor.cpp.
|
noexcept |
Returns the HSL saturation color component of this color.
Definition at line 1886 of file qcolor.cpp.
|
noexcept |
Returns the HSV hue color component of this color.
Definition at line 1716 of file qcolor.cpp.
|
noexcept |
Returns the hue color component of this color.
Definition at line 1779 of file qcolor.cpp.
|
noexcept |
Returns the HSV saturation color component of this color.
Definition at line 1742 of file qcolor.cpp.
|
noexcept |
Returns the HSV saturation color component of this color.
Definition at line 1804 of file qcolor.cpp.
|
noexcept |
|
noexcept |
|
inlinenoexcept |
|
staticnoexcept |
Returns true
if the name is a valid color name and can be used to construct a valid QColor object, otherwise returns false.
It uses the same algorithm used in fromString().
Definition at line 948 of file qcolor.cpp.
|
nodiscardnoexcept |
Returns a lighter (or darker) color, but does not change this object.
If the factor is greater than 100, this functions returns a lighter color. Setting factor to 150 returns a color that is 50% brighter. If the factor is less than 100, the return color is darker, but we recommend using the darker() function for this purpose. If the factor is 0 or negative, the return value is unspecified.
The function converts the current color to HSV, multiplies the value (V) component by factor and converts the color back to it's original color spec.
Definition at line 2810 of file qcolor.cpp.
|
noexcept |
Returns the lightness color component of this color.
Definition at line 1858 of file qcolor.cpp.
|
noexcept |
Returns the lightness color component of this color.
Definition at line 1900 of file qcolor.cpp.
|
noexcept |
Returns the magenta color component of this color.
Definition at line 1924 of file qcolor.cpp.
|
noexcept |
Returns the magenta color component of this color.
Definition at line 1973 of file qcolor.cpp.
QString QColor::name | ( | NameFormat | format = HexRgb | ) | const |
Returns the name of the color in the specified format.
Definition at line 832 of file qcolor.cpp.
Referenced by testing.tools.encode_pdf_filter._PdfStream::RegisterByName().
QColor::operator QVariant | ( | ) | const |
Returns the color as a QVariant.
Definition at line 2920 of file qcolor.cpp.
|
noexcept |
Returns true
if this color has different color specification or component values from color; otherwise returns false
.
ExtendedRgb and Rgb specifications are considered matching in this context.
Definition at line 2913 of file qcolor.cpp.
|
noexcept |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Assigns a copy of color and returns a reference to this color.
Definition at line 2872 of file qcolor.cpp.
|
noexcept |
Returns true
if this color has the same color specification and component values as color; otherwise returns false
.
ExtendedRgb and Rgb specifications are considered matching in this context.
Definition at line 2885 of file qcolor.cpp.
|
noexcept |
Returns the red color component of this color.
Definition at line 1526 of file qcolor.cpp.
|
noexcept |
Returns the red color component of this color.
Definition at line 1609 of file qcolor.cpp.
|
noexcept |
Returns the RGB value of the color.
The alpha value is opaque.
Definition at line 1437 of file qcolor.cpp.
|
noexcept |
Returns the RGB value of the color, including its alpha.
For an invalid color, the alpha value of the returned color is unspecified.
Definition at line 1374 of file qcolor.cpp.
|
noexcept |
Returns the RGB64 value of the color, including its alpha.
For an invalid color, the alpha value of the returned color is unspecified.
Definition at line 1406 of file qcolor.cpp.
|
noexcept |
Returns the HSV saturation color component of this color.
The color is implicitly converted to HSV.
Definition at line 1732 of file qcolor.cpp.
|
noexcept |
Returns the HSV saturation color component of this color.
The color is implicitly converted to HSV.
Definition at line 1794 of file qcolor.cpp.
void QColor::setAlpha | ( | int | alpha | ) |
Sets the alpha of this color to alpha.
Integer alpha is specified in the range 0-255.
Definition at line 1479 of file qcolor.cpp.
void QColor::setAlphaF | ( | float | alpha | ) |
Sets the alpha of this color to alpha.
float alpha is specified in the range 0.0-1.0.
Definition at line 1509 of file qcolor.cpp.
void QColor::setBlue | ( | int | blue | ) |
Sets the blue color component of this color to blue.
Integer components are specified in the range 0-255.
Definition at line 1595 of file qcolor.cpp.
void QColor::setBlueF | ( | float | blue | ) |
Sets the blue color component of this color to blue.
If blue lies outside the 0.0-1.0 range, the color model will be changed to ExtendedRgb
.
Definition at line 1688 of file qcolor.cpp.
void QColor::setCmyk | ( | int | c, |
int | m, | ||
int | y, | ||
int | k, | ||
int | a = 255 ) |
Sets the color to CMYK values, c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e.
transparency).
All the values must be in the range 0-255.
Definition at line 2680 of file qcolor.cpp.
void QColor::setCmykF | ( | float | c, |
float | m, | ||
float | y, | ||
float | k, | ||
float | a = 1.0 ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the color to CMYK values, c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e.
transparency).
All the values must be in the range 0.0-1.0.
Definition at line 2710 of file qcolor.cpp.
void QColor::setGreen | ( | int | green | ) |
Sets the green color component of this color to green.
Integer components are specified in the range 0-255.
Definition at line 1566 of file qcolor.cpp.
void QColor::setGreenF | ( | float | green | ) |
Sets the green color component of this color to green.
If green lies outside the 0.0-1.0 range, the color model will be changed to ExtendedRgb
.
Definition at line 1658 of file qcolor.cpp.
void QColor::setHsl | ( | int | h, |
int | s, | ||
int | l, | ||
int | a = 255 ) |
Sets a HSL color value; h is the hue, s is the saturation, l is the lightness and a is the alpha component of the HSL color.
The saturation, value and alpha-channel values must be in the range 0-255, and the hue value must be greater than -1.
Definition at line 1213 of file qcolor.cpp.
void QColor::setHslF | ( | float | h, |
float | s, | ||
float | l, | ||
float | a = 1.0 ) |
Sets a HSL color lightness; h is the hue, s is the saturation, l is the lightness and a is the alpha component of the HSL color.
All the values must be in the range 0.0-1.0.
Definition at line 1183 of file qcolor.cpp.
void QColor::setHsv | ( | int | h, |
int | s, | ||
int | v, | ||
int | a = 255 ) |
Sets a HSV color value; h is the hue, s is the saturation, v is the value and a is the alpha component of the HSV color.
The saturation, value and alpha-channel values must be in the range 0-255, and the hue value must be greater than -1.
Definition at line 1097 of file qcolor.cpp.
void QColor::setHsvF | ( | float | h, |
float | s, | ||
float | v, | ||
float | a = 1.0 ) |
Sets a HSV color value; h is the hue, s is the saturation, v is the value and a is the alpha component of the HSV color.
All the values must be in the range 0.0-1.0.
Definition at line 1069 of file qcolor.cpp.
void QColor::setRed | ( | int | red | ) |
Sets the red color component of this color to red.
Integer components are specified in the range 0-255.
Definition at line 1539 of file qcolor.cpp.
void QColor::setRedF | ( | float | red | ) |
Sets the red color component of this color to red.
If red lies outside the 0.0-1.0 range, the color model will be changed to ExtendedRgb
.
Definition at line 1626 of file qcolor.cpp.
void QColor::setRgb | ( | int | r, |
int | g, | ||
int | b, | ||
int | a = 255 ) |
Sets the RGB value to r, g, b and the alpha value to a.
All the values must be in the range 0-255.
Definition at line 1348 of file qcolor.cpp.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the RGB value to rgb.
The alpha value is set to opaque.
Definition at line 1449 of file qcolor.cpp.
Sets the RGB value to rgba, including its alpha.
Definition at line 1386 of file qcolor.cpp.
Sets the RGB64 value to rgba, including its alpha.
Definition at line 1420 of file qcolor.cpp.
void QColor::setRgbF | ( | float | r, |
float | g, | ||
float | b, | ||
float | a = 1.0 ) |
Sets the color channels of this color to r (red), g (green), b (blue) and a (alpha, transparency).
The alpha value must be in the range 0.0-1.0. If any of the other values are outside the range of 0.0-1.0 the color model will be set as ExtendedRgb
.
Definition at line 1315 of file qcolor.cpp.
|
inlinenoexcept |
Returns how the color was specified.
|
noexcept |
Creates and returns a CMYK QColor based on this color.
Definition at line 2293 of file qcolor.cpp.
|
noexcept |
Create and returns an extended RGB QColor based on this color.
Definition at line 2010 of file qcolor.cpp.
|
noexcept |
Creates and returns an HSL QColor based on this color.
Definition at line 2237 of file qcolor.cpp.
|
noexcept |
Creates and returns an HSV QColor based on this color.
Definition at line 2186 of file qcolor.cpp.
|
noexcept |
Create and returns an RGB QColor based on this color.
Definition at line 2033 of file qcolor.cpp.
|
noexcept |
Returns the value color component of this color.
Definition at line 1754 of file qcolor.cpp.
|
noexcept |
Returns the value color component of this color.
Definition at line 1816 of file qcolor.cpp.
|
noexcept |
Returns the yellow color component of this color.
Definition at line 1936 of file qcolor.cpp.
|
noexcept |
Returns the yellow color component of this color.
Definition at line 1985 of file qcolor.cpp.
|
friend |
Writes the color to the stream.
Definition at line 2975 of file qcolor.cpp.
|
friend |
Reads the color from the stream.
Definition at line 3011 of file qcolor.cpp.
|
related |
Returns the alpha component of the ARGB quadruplet rgba.
|
related |
Returns the blue component of the ARGB quadruplet rgb.
|
related |
|
related |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Returns a gray value (0 to 255) from the given ARGB quadruplet rgb.
The gray value is calculated using the formula (R * 11 + G * 16 + B * 5)/32; the alpha-channel is ignored.
Definition at line 39 of file qrgb.h.
References qBlue(), qGray(), qGreen(), and qRed().
|
related |
Returns the green component of the ARGB quadruplet rgb.
Converts an unpremultiplied ARGB quadruplet rgb into a premultiplied ARGB quadruplet.
|
related |
Returns the red component of the ARGB quadruplet rgb.
|
related |
An ARGB quadruplet on the format #AARRGGBB, equivalent to an unsigned int.
The type also holds a value for the alpha-channel. The default alpha channel is ff
, i.e opaque. For more information, see the \l{QColor#Alpha-Blended Drawing}{Alpha-Blended Drawing} section.
Here are some examples of how QRgb values can be created:
|
related |
|
related |