QColor¶

The QColor class provides colors based on RGB, HSV or CMYK values. More…

Synopsis¶

Functions¶

def __eq__ (c)
def __ne__ (c)
def __reduce__ ()
def __repr__ ()
def __setstate__ (arg__1)
def __str__ ()
def alpha ()
def alphaF ()
def black ()
def blackF ()
def blue ()
def blueF ()
def convertTo (colorSpec)
def cyan ()
def cyanF ()
def darker ([f=200])
def getCmyk ()
def getCmykF ()
def getHsl ()
def getHslF ()
def getHsv ()
def getHsvF ()
def getRgb ()
def getRgbF ()
def green ()
def greenF ()
def hslHue ()
def hslHueF ()
def hslSaturation ()
def hslSaturationF ()
def hsvHue ()
def hsvHueF ()
def hsvSaturation ()
def hsvSaturationF ()
def hue ()
def hueF ()
def isValid ()
def lighter ([f=150])
def lightness ()
def lightnessF ()
def magenta ()
def magentaF ()
def name ([format=QColor.NameFormat.HexRgb])
def red ()
def redF ()
def rgb ()
def rgba64 ()
def rgba ()
def saturation ()
def saturationF ()
def setAlpha (alpha)
def setAlphaF (alpha)
def setBlue (blue)
def setBlueF (blue)
def setCmyk (c, m, y, k[, a=255])
def setCmykF (c, m, y, k[, a=1.0])
def setGreen (green)
def setGreenF (green)
def setHsl (h, s, l[, a=255])
def setHslF (h, s, l[, a=1.0])
def setHsv (h, s, v[, a=255])
def setHsvF (h, s, v[, a=1.0])
def setNamedColor (name)
def setNamedColor (name)
def setRed (red)
def setRedF (red)
def setRgb (r, g, b[, a=255])
def setRgb (rgb)
def setRgbF (r, g, b[, a=1.0])
def setRgba64 (rgba)
def setRgba (rgba)
def spec ()
def toCmyk ()
def toExtendedRgb ()
def toHsl ()
def toHsv ()
def toRgb ()
def toTuple ()
def value ()
def valueF ()
def yellow ()
def yellowF ()

Static functions¶

def colorNames ()
def fromCmyk (c, m, y, k[, a=255])
def fromCmykF (c, m, y, k[, a=1.0])
def fromHsl (h, s, l[, a=255])
def fromHslF (h, s, l[, a=1.0])
def fromHsv (h, s, v[, a=255])
def fromHsvF (h, s, v[, a=1.0])
def fromRgb (r, g, b[, a=255])
def fromRgb (rgb)
def fromRgbF (r, g, b[, a=1.0])
def fromRgba64 (r, g, b[, a=USHRT_MAX])
def fromRgba64 (rgba)
def fromRgba (rgba)
def isValidColor (arg__1)
def isValidColor (name)

Detailed Description¶

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 “#112233”), or an ARGB string (such as “#ff112233”) or a color name (such as “blue”), 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 “#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 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:

# Specify semi-transparent red
painter.setBrush(QColor(255, 0, 0, 127))
painter.drawRect(0, 0, width() / 2, height())
# Specify semi-transparent blue
painter.setBrush(QColor(0, 0, 255, 127))
painter.drawRect(0, 0, width(), height() / 2)

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 float. 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 QColor objects in the QColorConstants namespace, including black, white, primary and secondary colors, darker versions of these colors, and three shades of gray. Furthermore, the QColorConstants::Svg namespace defines QColor objects for the standard SVG color keyword names .

The QColorConstants::Color0, QColorConstants::Color1 and QColorConstants::Transparent colors are used for special purposes.

QColorConstants::Color0 (zero pixel value) and QColorConstants::Color1 (non-zero pixel value) are special colors for drawing in QBitmaps. Painting with QColorConstants::Color0 sets the bitmap bits to 0 (transparent; i.e., background), and painting with c{QColorConstants::Color1} sets the bits to 1 (opaque; i.e., foreground).

QColorConstants::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.

For historical reasons, the 20 predefined colors are also available in the GlobalColor enumeration.

Finally, QColor recognizes a variety of color names (as strings); the static colorNames() function returns a QStringList color names that QColor knows about.

The Extended RGB Color Model¶

The extended RGB color model, also known as the scRGB color space, is the same the RGB color model except it allows values under 0.0, and over 1.0. This makes it possible to represent colors that would otherwise be outside the range of the RGB colorspace but still use the same values for colors inside the RGB colorspace.

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 “stronger than”, “darker than”, and “the opposite of” 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 which maps somewhat differently to the brightness of the color.

Similarly, the HSL saturation value is not in general the same as the HSV saturation value for the same color. hslSaturation() provides the color’s HSL saturation value, while saturation() and hsvSaturation() provides the HSV saturation value.

The hue value is defined to be the same in HSL and HSV.

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

QPalette QBrush QColorConstants

class PySide6.QtGui.QColor¶

PySide6.QtGui.QColor(spec, a1, a2, a3, a4[, a5=0])

PySide6.QtGui.QColor(rgba64)

PySide6.QtGui.QColor(name)

PySide6.QtGui.QColor(arg__1)

PySide6.QtGui.QColor(color)

PySide6.QtGui.QColor(name)

PySide6.QtGui.QColor(r, g, b[, a=255])

PySide6.QtGui.QColor(rgb)

Parameters

r – int
g – int
a5 – ushort
rgba64 – PySide6.QtGui.QRgba64
a3 – ushort
a – int
rgb – int
spec – Spec
a4 – ushort
name – QStringView
arg__1 – object
color – GlobalColor
a1 – ushort
a2 – ushort
b – int

Constructs an invalid color with the RGB value (0, 0, 0). An invalid color is a color that is not properly set up for the underlying window system.

The alpha value of an invalid color is unspecified.

See also

isValid()

Constructs a color with the value rgba64.

See also

fromRgba64()

This is an overloaded function.

Constructs a new color with a color value of color.

See also

isValid() Predefined Colors

Constructs a named color in the same way as setNamedColor() using the given name.

The color is left invalid if the name cannot be parsed.

See also

setNamedColor() name() isValid()

Constructs a color with the RGB value r, g, b, and the alpha-channel (transparency) value of a.

The color is left invalid if any of the arguments are invalid.

See also

setRgba() isValid()

PySide6.QtGui.QColor.Spec¶

The type of color specified, either RGB, extended RGB, HSV, CMYK or HSL.

Constant

Description

QColor.Rgb

QColor.Hsv

QColor.Cmyk

QColor.Hsl

QColor.ExtendedRgb

QColor.Invalid

See also

spec() convertTo()

PySide6.QtGui.QColor.NameFormat¶

How to format the output of the name() function

Constant

Description

QColor.HexRgb

#RRGGBB A “#” character followed by three two-digit hexadecimal numbers (i.e. #RRGGBB).

QColor.HexArgb

#AARRGGBB A “#” character followed by four two-digit hexadecimal numbers (i.e. #AARRGGBB).

See also

name()

PySide6.QtGui.QColor.__reduce__()¶

Return type: object

PySide6.QtGui.QColor.__repr__()¶

Return type: object

PySide6.QtGui.QColor.__setstate__(arg__1)¶

Parameters: arg__1 – object
Return type: object

PySide6.QtGui.QColor.__str__()¶

Return type: object

PySide6.QtGui.QColor.alpha()¶

Return type: int

Returns the alpha color component of this color.

See also

setAlpha() alphaF() Alpha-Blended Drawing

PySide6.QtGui.QColor.alphaF()¶

Return type: float

Returns the alpha color component of this color.

See also

setAlphaF() alpha() Alpha-Blended Drawing

PySide6.QtGui.QColor.black()¶

Return type: int

Returns the black color component of this color.

See also

blackF() getCmyk() The CMYK Color Model

PySide6.QtGui.QColor.blackF()¶

Return type: float

Returns the black color component of this color.

See also

black() getCmykF() The CMYK Color Model

PySide6.QtGui.QColor.blue()¶

Return type: int

Returns the blue color component of this color.

See also

setBlue() blueF() getRgb()

PySide6.QtGui.QColor.blueF()¶

Return type: float

Returns the blue color component of this color.

See also

setBlueF() blue() getRgbF()

static PySide6.QtGui.QColor.colorNames()¶

Return type: list of strings

Returns a QStringList containing the color names Qt knows about.

See also

Predefined Colors

PySide6.QtGui.QColor.convertTo(colorSpec)¶

Parameters: colorSpec – Spec
Return type: PySide6.QtGui.QColor

Creates a copy of this color in the format specified by colorSpec.

See also

spec() toCmyk() toHsv() toRgb() isValid()

PySide6.QtGui.QColor.cyan()¶

Return type: int

Returns the cyan color component of this color.

See also

cyanF() getCmyk() The CMYK Color Model

PySide6.QtGui.QColor.cyanF()¶

Return type: float

Returns the cyan color component of this color.

See also

cyan() getCmykF() The CMYK Color Model

PySide6.QtGui.QColor.darker([f=200])¶

Parameters: f – int
Return type: PySide6.QtGui.QColor

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.

See also

lighter() isValid()

static PySide6.QtGui.QColor.fromCmyk(c, m, y, k[, a=255])¶

Parameters

c – int
m – int
y – int
k – int
a – int

Return type

PySide6.QtGui.QColor

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.

See also

toCmyk() fromCmykF() isValid() The CMYK Color Model

static PySide6.QtGui.QColor.fromCmykF(c, m, y, k[, a=1.0])¶

Parameters

c – float
m – float
y – float
k – float
a – float

Return type

PySide6.QtGui.QColor

This is an overloaded function.

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.

See also

toCmyk() fromCmyk() isValid() The CMYK Color Model

static PySide6.QtGui.QColor.fromHsl(h, s, l[, a=255])¶

Parameters

h – int
s – int
l – int
a – int

Return type

PySide6.QtGui.QColor

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.

See also

toHsl() fromHslF() isValid() The HSL Color Model

static PySide6.QtGui.QColor.fromHslF(h, s, l[, a=1.0])¶

Parameters

h – float
s – float
l – float
a – float

Return type

PySide6.QtGui.QColor

This is an overloaded function.

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.

See also

toHsl() fromHsl() isValid() The HSL Color Model

static PySide6.QtGui.QColor.fromHsv(h, s, v[, a=255])¶

Parameters

h – int
s – int
v – int
a – int

Return type

PySide6.QtGui.QColor

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.

See also

toHsv() fromHsvF() isValid() The HSV Color Model

static PySide6.QtGui.QColor.fromHsvF(h, s, v[, a=1.0])¶

Parameters

h – float
s – float
v – float
a – float

Return type

PySide6.QtGui.QColor

This is an overloaded function.

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.

See also

toHsv() fromHsv() isValid() The HSV Color Model

static PySide6.QtGui.QColor.fromRgb(rgb)¶

Parameters: rgb – int
Return type: PySide6.QtGui.QColor

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.

See also

fromRgba() fromRgbF() toRgb() isValid()

static PySide6.QtGui.QColor.fromRgb(r, g, b[, a=255])

Parameters

r – int
g – int
b – int
a – int

Return type

PySide6.QtGui.QColor

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.

See also

toRgb() fromRgba64() fromRgbF() isValid()

static PySide6.QtGui.QColor.fromRgbF(r, g, b[, a=1.0])¶

Parameters

r – float
g – float
b – float
a – float

Return type

PySide6.QtGui.QColor

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.

See also

fromRgb() fromRgba64() toRgb() isValid()

static PySide6.QtGui.QColor.fromRgba(rgba)¶

Parameters: rgba – int
Return type: PySide6.QtGui.QColor

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.

See also

fromRgb() fromRgba64() isValid()

static PySide6.QtGui.QColor.fromRgba64(rgba)¶

Parameters: rgba – PySide6.QtGui.QRgba64
Return type: PySide6.QtGui.QColor

Static convenience function that returns a QColor constructed from the given QRgba64 value rgba64.

See also

fromRgb() fromRgbF() toRgb() isValid()

static PySide6.QtGui.QColor.fromRgba64(r, g, b[, a=USHRT_MAX])

Parameters

r – ushort
g – ushort
b – ushort
a – ushort

Return type

PySide6.QtGui.QColor

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).

See also

fromRgb() fromRgbF() toRgb() isValid()

PySide6.QtGui.QColor.getCmyk()¶

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.

See also

setCmyk() The CMYK Color Model

PySide6.QtGui.QColor.getCmykF()¶

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.

See also

setCmykF() The CMYK Color Model

PySide6.QtGui.QColor.getHsl()¶

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.

See also

getHslF() setHsl() The HSL Color Model

PySide6.QtGui.QColor.getHslF()¶

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.

See also

getHsl() setHslF() The HSL Color Model

PySide6.QtGui.QColor.getHsv()¶

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.

See also

setHsv() The HSV Color Model

PySide6.QtGui.QColor.getHsvF()¶

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.

See also

setHsv() The HSV Color Model

PySide6.QtGui.QColor.getRgb()¶

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.

These components can be retrieved individually using the red() , green() , blue() and alpha() functions.

See also

rgb() setRgb()

PySide6.QtGui.QColor.getRgbF()¶

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.

These components can be retrieved individually using the redF() , greenF() , blueF() and alphaF() functions.

See also

rgb() setRgb()

PySide6.QtGui.QColor.green()¶

Return type: int

Returns the green color component of this color.

See also

setGreen() greenF() getRgb()

PySide6.QtGui.QColor.greenF()¶

Return type: float

Returns the green color component of this color.

See also

setGreenF() green() getRgbF()

PySide6.QtGui.QColor.hslHue()¶

Return type: int

Returns the HSL hue color component of this color.

See also

hslHueF() hsvHue() getHsl() The HSL Color Model

PySide6.QtGui.QColor.hslHueF()¶

Return type: float

Returns the HSL hue color component of this color.

See also

hslHue() hsvHueF() getHslF()

PySide6.QtGui.QColor.hslSaturation()¶

Return type: int

Returns the HSL saturation color component of this color.

See also

hslSaturationF() hsvSaturation() getHsl() The HSL Color Model

PySide6.QtGui.QColor.hslSaturationF()¶

Return type: float

Returns the HSL saturation color component of this color.

See also

hslSaturation() hsvSaturationF() getHslF() The HSL Color Model

PySide6.QtGui.QColor.hsvHue()¶

Return type: int

Returns the HSV hue color component of this color.

See also

hueF() hslHue() getHsv() The HSV Color Model

PySide6.QtGui.QColor.hsvHueF()¶

Return type: float

Returns the hue color component of this color.

See also

hue() hslHueF() getHsvF() The HSV Color Model

PySide6.QtGui.QColor.hsvSaturation()¶

Return type: int

Returns the HSV saturation color component of this color.

See also

saturationF() hslSaturation() getHsv() The HSV Color Model

PySide6.QtGui.QColor.hsvSaturationF()¶

Return type: float

Returns the HSV saturation color component of this color.

See also

saturation() hslSaturationF() getHsvF() The HSV Color Model

PySide6.QtGui.QColor.hue()¶

Return type: int

Returns the HSV hue color component of this color.

The color is implicitly converted to HSV.

See also

hsvHue() hslHue() hueF() getHsv() The HSV Color Model

PySide6.QtGui.QColor.hueF()¶

Return type: float

Returns the HSV hue color component of this color.

The color is implicitly converted to HSV.

See also

hsvHueF() hslHueF() hue() getHsvF() The HSV Color Model

PySide6.QtGui.QColor.isValid()¶

Return type: bool

Returns true if the color is valid; otherwise returns false.

static PySide6.QtGui.QColor.isValidColor(arg__1)¶

Parameters: arg__1 – QStringView
Return type: bool

This is an overloaded function.

static PySide6.QtGui.QColor.isValidColor(name)

Parameters: name – str
Return type: bool

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 setNamedColor() .

See also

setNamedColor()

PySide6.QtGui.QColor.lighter([f=150])¶

Parameters: f – int
Return type: PySide6.QtGui.QColor

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.

See also

darker() isValid()

PySide6.QtGui.QColor.lightness()¶

Return type: int

Returns the lightness color component of this color.

See also

lightnessF() getHsl()

PySide6.QtGui.QColor.lightnessF()¶

Return type: float

Returns the lightness color component of this color.

See also

value() getHslF()

PySide6.QtGui.QColor.magenta()¶

Return type: int

Returns the magenta color component of this color.

See also

magentaF() getCmyk() The CMYK Color Model

PySide6.QtGui.QColor.magentaF()¶

Return type: float

Returns the magenta color component of this color.

See also

magenta() getCmykF() The CMYK Color Model

PySide6.QtGui.QColor.name([format=QColor.NameFormat.HexRgb])¶

Parameters: format – NameFormat
Return type: str

Returns the name of the color in the specified format.

See also

setNamedColor() NameFormat

PySide6.QtGui.QColor.__ne__(c)¶

Parameters: c – PySide6.QtGui.QColor
Return type: bool

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.

See also

spec()

PySide6.QtGui.QColor.__eq__(c)¶

Parameters: c – PySide6.QtGui.QColor
Return type: bool

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.

See also

spec()

PySide6.QtGui.QColor.red()¶

Return type: int

Returns the red color component of this color.

See also

setRed() redF() getRgb()

PySide6.QtGui.QColor.redF()¶

Return type: float

Returns the red color component of this color.

See also

setRedF() red() getRgbF()

PySide6.QtGui.QColor.rgb()¶

Return type: int

Returns the RGB value of the color. The alpha value is opaque.

See also

setRgb() getRgb() rgba()

PySide6.QtGui.QColor.rgba()¶

Return type: int

Returns the RGB value of the color, including its alpha.

For an invalid color, the alpha value of the returned color is unspecified.

See also

setRgba() rgb() rgba64()

PySide6.QtGui.QColor.rgba64()¶

Return type: PySide6.QtGui.QRgba64

Returns the RGB64 value of the color, including its alpha.

For an invalid color, the alpha value of the returned color is unspecified.

See also

setRgba64() rgba() rgb()

PySide6.QtGui.QColor.saturation()¶

Return type: int

Returns the HSV saturation color component of this color.

The color is implicitly converted to HSV.

See also

hsvSaturation() hslSaturation() saturationF() getHsv() The HSV Color Model

PySide6.QtGui.QColor.saturationF()¶

Return type: float

Returns the HSV saturation color component of this color.

The color is implicitly converted to HSV.

See also

hsvSaturationF() hslSaturationF() saturation() getHsvF() The HSV Color Model

PySide6.QtGui.QColor.setAlpha(alpha)¶

Parameters: alpha – int

Sets the alpha of this color to alpha. Integer alpha is specified in the range 0-255.

See also

alpha() alphaF() Alpha-Blended Drawing

PySide6.QtGui.QColor.setAlphaF(alpha)¶

Parameters: alpha – float

Sets the alpha of this color to alpha. float alpha is specified in the range 0.0-1.0.

See also

alphaF() alpha() Alpha-Blended Drawing

PySide6.QtGui.QColor.setBlue(blue)¶

Parameters: blue – int

Sets the blue color component of this color to blue. Integer components are specified in the range 0-255.

See also

blue() blueF() setRgb()

PySide6.QtGui.QColor.setBlueF(blue)¶

Parameters: blue – float

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.

See also

blueF() blue() setRgbF()

PySide6.QtGui.QColor.setCmyk(c, m, y, k[, a=255])¶

Parameters

c – int
m – int
y – int
k – int
a – int

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.

See also

getCmyk() setCmykF() The CMYK Color Model

PySide6.QtGui.QColor.setCmykF(c, m, y, k[, a=1.0])¶

Parameters

c – float
m – float
y – float
k – float
a – float

This is an overloaded function.

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.

See also

getCmykF() setCmyk() The CMYK Color Model

PySide6.QtGui.QColor.setGreen(green)¶

Parameters: green – int

Sets the green color component of this color to green. Integer components are specified in the range 0-255.

See also

green() greenF() setRgb()

PySide6.QtGui.QColor.setGreenF(green)¶

Parameters: green – float

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.

See also

greenF() green() setRgbF()

PySide6.QtGui.QColor.setHsl(h, s, l[, a=255])¶

Parameters

h – int
s – int
l – int
a – int

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.

See also

getHsl() setHslF()

PySide6.QtGui.QColor.setHslF(h, s, l[, a=1.0])¶

Parameters

h – float
s – float
l – float
a – float

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.

See also

getHslF() setHsl()

PySide6.QtGui.QColor.setHsv(h, s, v[, a=255])¶

Parameters

h – int
s – int
v – int
a – int

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.

See also

getHsv() setHsvF() The HSV Color Model

PySide6.QtGui.QColor.setHsvF(h, s, v[, a=1.0])¶

Parameters

h – float
s – float
v – float
a – float

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.

See also

getHsvF() setHsv() The HSV Color Model

PySide6.QtGui.QColor.setNamedColor(name)¶

Parameters: name – QStringView

This is an overloaded function.

PySide6.QtGui.QColor.setNamedColor(name)

Parameters: name – str

Sets the RGB value of this QColor to name, which may be in one of these formats:

#RGB (each of R, G, and B is a single hex digit)

#RRGGBB

#AARRGGBB (Since 5.2)

#RRRGGGBBB

#RRRRGGGGBBBB

A name from the list of colors defined in the list of SVG color keyword names provided by the World Wide Web Consortium; for example, “steelblue” or “gainsboro”. These color names work on all platforms. Note that these color names are not the same as defined by the GlobalColor enums, e.g. “green” and green does not refer to the same color.

transparent - representing the absence of a color.

The color is invalid if name cannot be parsed.

See also

QColor() name() isValid()

PySide6.QtGui.QColor.setRed(red)¶

Parameters: red – int

Sets the red color component of this color to red. Integer components are specified in the range 0-255.

See also

red() redF() setRgb()

PySide6.QtGui.QColor.setRedF(red)¶

Parameters: red – float

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.

See also

redF() red() setRgbF()

PySide6.QtGui.QColor.setRgb(r, g, b[, a=255])¶

Parameters

r – int
g – int
b – int
a – int

Sets the RGB value to r, g, b and the alpha value to a.

All the values must be in the range 0-255.

See also

rgb() getRgb() setRgbF()

PySide6.QtGui.QColor.setRgb(rgb)

Parameters: rgb – int

This is an overloaded function.

Sets the RGB value to rgb. The alpha value is set to opaque.

PySide6.QtGui.QColor.setRgbF(r, g, b[, a=1.0])¶

Parameters

r – float
g – float
b – float
a – float

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.

See also

rgb() getRgbF() setRgb()

PySide6.QtGui.QColor.setRgba(rgba)¶

Parameters: rgba – int

Sets the RGB value to rgba, including its alpha.

See also

rgba() rgb() setRgba64()

PySide6.QtGui.QColor.setRgba64(rgba)¶

Parameters: rgba – PySide6.QtGui.QRgba64

Sets the RGB64 value to rgba, including its alpha.

See also

setRgba() rgba64()

PySide6.QtGui.QColor.spec()¶

Return type: Spec

Returns how the color was specified.

See also

Spec convertTo()

PySide6.QtGui.QColor.toCmyk()¶

Return type: PySide6.QtGui.QColor

Creates and returns a CMYK QColor based on this color.

See also

fromCmyk() convertTo() isValid() The CMYK Color Model

PySide6.QtGui.QColor.toExtendedRgb()¶

Return type: PySide6.QtGui.QColor

Create and returns an extended RGB QColor based on this color.

See also

toRgb convertTo()

PySide6.QtGui.QColor.toHsl()¶

Return type: PySide6.QtGui.QColor

Creates and returns an HSL QColor based on this color.

See also

fromHsl() convertTo() isValid() The HSL Color Model

PySide6.QtGui.QColor.toHsv()¶

Return type: PySide6.QtGui.QColor

Creates and returns an HSV QColor based on this color.

See also

fromHsv() convertTo() isValid() The HSV Color Model

PySide6.QtGui.QColor.toRgb()¶

Return type: PySide6.QtGui.QColor

Create and returns an RGB QColor based on this color.

See also

fromRgb() convertTo() isValid()

PySide6.QtGui.QColor.toTuple()¶

Return type: object

PySide6.QtGui.QColor.value()¶

Return type: int

Returns the value color component of this color.

See also

valueF() getHsv() The HSV Color Model

PySide6.QtGui.QColor.valueF()¶

Return type: float

Returns the value color component of this color.

See also

value() getHsvF() The HSV Color Model

PySide6.QtGui.QColor.yellow()¶

Return type: int

Returns the yellow color component of this color.

See also

yellowF() getCmyk() The CMYK Color Model

PySide6.QtGui.QColor.yellowF()¶

Return type: float

Returns the yellow color component of this color.

See also

yellow() getCmykF() The CMYK Color Model

Table of Contents

Previous topic

Next topic

QColor¶

Synopsis¶

Functions¶

Static functions¶

Detailed Description¶

Integer vs. Floating Point Precision¶

Alpha-Blended Drawing¶

Predefined Colors¶

The Extended RGB Color Model¶

The HSV Color Model¶

The HSL Color Model¶

The CMYK Color Model¶

Constant	Description
QColor.Rgb
QColor.Hsv
QColor.Cmyk
QColor.Hsl
QColor.ExtendedRgb
QColor.Invalid

Constant	Description
QColor.HexRgb	#RRGGBB A “#” character followed by three two-digit hexadecimal numbers (i.e. `#RRGGBB`).
QColor.HexArgb	#AARRGGBB A “#” character followed by four two-digit hexadecimal numbers (i.e. `#AARRGGBB`).