QColorSpace

The QColorSpace class provides a color space abstraction. More…

Inheritance diagram of PySide6.QtGui.QColorSpace

New in version 5.14.

Synopsis

Functions

Static functions

Detailed Description

Color values can be interpreted in different ways, and based on the interpretation can live in different spaces. We call this color spaces.

QColorSpace provides access to creating several predefined color spaces and can generate QColorTransforms for converting colors from one color space to another.

QColorSpace can also represent color spaces defined by ICC profiles or embedded in images, that do not otherwise fit the predefined color spaces.

A color space can generally speaking be conceived as a combination of set of primary colors and a transfer function. The primaries defines the axes of the color space, and the transfer function how values are mapped on the axes. The primaries are defined by three primary colors that represent exactly how red, green, and blue look in this particular color space, and a white color that represents where and how bright pure white is. The range of colors expressible by the primary colors is called the gamut, and a color space that can represent a wider range of colors is also known as a wide-gamut color space.

The transfer function or gamma curve determines how each component in the color space is encoded. These are used because human perception does not operate linearly, and the transfer functions try to ensure that colors will seem evenly spaced to human eyes.

class PySide6.QtGui.QColorSpace

PySide6.QtGui.QColorSpace(namedColorSpace)

PySide6.QtGui.QColorSpace(primaries, transferFunction[, gamma=0.0f])

PySide6.QtGui.QColorSpace(primaries, transferFunctionTable)

PySide6.QtGui.QColorSpace(primaries, gamma)

PySide6.QtGui.QColorSpace(colorSpace)

PySide6.QtGui.QColorSpace(whitePoint, redPoint, greenPoint, bluePoint, transferFunction[, gamma=0.0f])

PySide6.QtGui.QColorSpace(whitePoint, redPoint, greenPoint, bluePoint, redTransferFunctionTable, greenTransferFunctionTable, blueTransferFunctionTable)

PySide6.QtGui.QColorSpace(whitePoint, redPoint, greenPoint, bluePoint, transferFunctionTable)

Parameters

Creates a new colorspace object that represents an undefined and invalid colorspace.

Creates a new colorspace object that represents a namedColorSpace.

Creates a custom color space with the primaries primaries, using the transfer function transferFunction and optionally gamma.

Creates a custom color space with the primaries primaries, using a gamma transfer function of gamma.

Creates a new colorspace object that represents a namedColorSpace.

Creates a custom colorspace with a primaries based on the chromaticities of the primary colors whitePoint, redPoint, greenPoint and bluePoint, and using the transfer function transferFunction and optionally gamma.

Creates a custom color space with primaries based on the chromaticities of the primary colors whitePoint, redPoint, greenPoint and bluePoint, and using the custom transfer functions described by redTransferFunctionTable, greenTransferFunctionTable, and blueTransferFunctionTable.

Creates a custom color space with primaries based on the chromaticities of the primary colors whitePoint, redPoint, greenPoint and bluePoint, and using the custom transfer function described by transferFunctionTable.

PySide6.QtGui.QColorSpace.NamedColorSpace

Predefined color spaces.

Constant

Description

QColorSpace.SRgb

The sRGB color space, which Qt operates in by default. It is a close approximation of how most classic monitors operate, and a mode most software and hardware support. ICC registration of sRGB .

QColorSpace.SRgbLinear

The sRGB color space with linear gamma. Useful for gamma-corrected blending.

QColorSpace.AdobeRgb

The Adobe RGB color space is a classic wide-gamut color space, using a gamma of 2.2. ICC registration of Adobe RGB (1998)

QColorSpace.DisplayP3

A color-space using the primaries of DCI-P3, but with the whitepoint and transfer function of sRGB. Common in modern wide-gamut screens. ICC registration of DCI-P3

QColorSpace.ProPhotoRgb

The Pro Photo RGB color space, also known as ROMM RGB is a very wide gamut color space. ICC registration of ROMM RGB
PySide6.QtGui.QColorSpace.Primaries

Predefined sets of primary colors.

Constant

Description

QColorSpace.Primaries.Custom

The primaries are undefined or does not match any predefined sets.

QColorSpace.Primaries.SRgb

The sRGB primaries

QColorSpace.Primaries.AdobeRgb

The Adobe RGB primaries

QColorSpace.Primaries.DciP3D65

The DCI-P3 primaries with the D65 whitepoint

QColorSpace.Primaries.ProPhotoRgb

The ProPhoto RGB primaries with the D50 whitepoint
PySide6.QtGui.QColorSpace.TransferFunction

Predefined transfer functions or gamma curves.

Constant

Description

QColorSpace.TransferFunction.Custom

The custom or null transfer function

QColorSpace.TransferFunction.Linear

The linear transfer functions

QColorSpace.TransferFunction.Gamma

A transfer function that is a real gamma curve based on the value of gamma()

QColorSpace.TransferFunction.SRgb

The sRGB transfer function, composed of linear and gamma parts

QColorSpace.TransferFunction.ProPhotoRgb

The ProPhoto RGB transfer function, composed of linear and gamma parts
PySide6.QtGui.QColorSpace.description()
Return type

str

Returns the name or short description. If a description hasn’t been given in setDescription() , the original name of the profile is returned if the profile is unmodified, a guessed name is returned if the profile has been recognized as a known color space, otherwise an empty string is returned.

See also

setDescription()

static PySide6.QtGui.QColorSpace.fromIccProfile(iccProfile)
Parameters

iccProfile – PySide6.QtCore.QByteArray

Return type

PySide6.QtGui.QColorSpace

Creates a QColorSpace from ICC profile iccProfile.

Note

Not all ICC profiles are supported. QColorSpace only supports RGB-XYZ ICC profiles that are three-component matrix-based.

If the ICC profile is not supported an invalid QColorSpace is returned where you can still read the original ICC profile using iccProfile() .

See also

iccProfile()

PySide6.QtGui.QColorSpace.gamma()
Return type

float

Returns the gamma value of color spaces with TransferFunction::Gamma, an approximate gamma value for other predefined color spaces, or 0.0 if no approximate gamma is known.

PySide6.QtGui.QColorSpace.iccProfile()
Return type

PySide6.QtCore.QByteArray

Returns an ICC profile representing the color space.

If the color space was generated from an ICC profile, that profile is returned, otherwise one is generated.

Note

Even invalid color spaces may return the ICC profile if they were generated from one, to allow applications to implement wider support themselves.

See also

fromIccProfile()

PySide6.QtGui.QColorSpace.isValid()
Return type

bool

Returns true if the color space is valid.

PySide6.QtGui.QColorSpace.__ne__(colorSpace2)
Parameters

colorSpace2 – PySide6.QtGui.QColorSpace

Return type

bool

PySide6.QtGui.QColorSpace.__eq__(colorSpace2)
Parameters

colorSpace2 – PySide6.QtGui.QColorSpace

Return type

bool

PySide6.QtGui.QColorSpace.primaries()
Return type

Primaries

Returns the predefined primaries of the color space or primaries::Custom if it doesn’t match any of them.

See also

setPrimaries()

PySide6.QtGui.QColorSpace.setDescription(description)
Parameters

description – str

Sets the name or short description of the color space to description.

If set to empty description() will return original or guessed descriptions instead.

See also

description()

PySide6.QtGui.QColorSpace.setPrimaries(primariesId)
Parameters

primariesId – Primaries

Sets the primaries to those of the primariesId set.

See also

primaries()

PySide6.QtGui.QColorSpace.setPrimaries(whitePoint, redPoint, greenPoint, bluePoint)
Parameters

Set primaries to the chromaticities of whitePoint, redPoint, greenPoint and bluePoint.

See also

primaries()

PySide6.QtGui.QColorSpace.setTransferFunction(transferFunction[, gamma=0.0f])
Parameters

Sets the transfer function to transferFunction and gamma.

PySide6.QtGui.QColorSpace.setTransferFunction(transferFunctionTable)
Parameters

transferFunctionTable –

Sets the transfer function to transferFunctionTable.

PySide6.QtGui.QColorSpace.setTransferFunctions(redTransferFunctionTable, greenTransferFunctionTable, blueTransferFunctionTable)
Parameters

  • redTransferFunctionTable –

  • greenTransferFunctionTable –

  • blueTransferFunctionTable –

Sets the transfer functions to redTransferFunctionTable, greenTransferFunctionTable and blueTransferFunctionTable.

PySide6.QtGui.QColorSpace.swap(colorSpace)
Parameters

colorSpace – PySide6.QtGui.QColorSpace

Swaps color space other with this color space. This operation is very fast and never fails.

PySide6.QtGui.QColorSpace.transferFunction()
Return type

TransferFunction

Returns the predefined transfer function of the color space or TransferFunction::Custom if it doesn’t match any of them.

PySide6.QtGui.QColorSpace.transformationToColorSpace(colorspace)
Parameters

colorspace – PySide6.QtGui.QColorSpace

Return type

PySide6.QtGui.QColorTransform

Generates and returns a color space transformation from this color space to colorspace.

PySide6.QtGui.QColorSpace.withTransferFunction(transferFunction[, gamma=0.0f])
Parameters
Return type

PySide6.QtGui.QColorSpace

Returns a copy of this color space, except using the transfer function transferFunction and gamma.

PySide6.QtGui.QColorSpace.withTransferFunction(transferFunctionTable)
Parameters

transferFunctionTable –

Return type

PySide6.QtGui.QColorSpace

Returns a copy of this color space, except using the transfer function described by transferFunctionTable.

PySide6.QtGui.QColorSpace.withTransferFunctions(redTransferFunctionTable, greenTransferFunctionTable, blueTransferFunctionTable)
Parameters

  • redTransferFunctionTable –

  • greenTransferFunctionTable –

  • blueTransferFunctionTable –

Return type

PySide6.QtGui.QColorSpace

Returns a copy of this color space, except using the transfer functions described by redTransferFunctionTable, greenTransferFunctionTable and blueTransferFunctionTable.