ImageColors

#include <imagecolors.h>

Inheritance diagram for ImageColors:

Properties
QColor	average

QColor	background

QColor	closestToBlack

QColor	closestToWhite

QColor	dominant

QColor	dominantContrast

QColor	fallbackAverage

QColor	fallbackBackground

QColor	fallbackDominant

QColor	fallbackDominantContrasting

QColor	fallbackForeground

QColor	fallbackHighlight

QList< PaletteSwatch >	fallbackPalette

ColorUtils::Brightness	fallbackPaletteBrightness

QColor	foreground

QColor	highlight

QList< PaletteSwatch >	palette

ColorUtils::Brightness	paletteBrightness

QML_ELEMENTQVariant	source

Properties inherited from QObject
	objectName

Signals
void	fallbackAverageChanged ()

void	fallbackBackgroundChanged ()

void	fallbackDominantChanged ()

void	fallbackDominantContrastingChanged ()

void	fallbackForegroundChanged ()

void	fallbackHighlightChanged ()

void	fallbackPaletteBrightnessChanged ()

void	fallbackPaletteChanged ()

void	paletteChanged ()

void	sourceChanged ()

Public Member Functions
	ImageColors (QObject *parent=nullptr)

QColor	average () const

QColor	background () const

QColor	closestToBlack () const

QColor	closestToWhite () const

QColor	dominant () const

QColor	dominantContrast () const

QColor	foreground () const

QColor	highlight () const

QList< PaletteSwatch >	palette () const

ColorUtils::Brightness	paletteBrightness () const

void	setSource (const QVariant &source)

void	setSourceImage (const QImage &image)

void	setSourceItem (QQuickItem *source)

QVariant	source () const

QImage	sourceImage () const

QQuickItem *	sourceItem () const

Q_INVOKABLE void	update ()

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Extracts the dominant colors from an element or an image and exports it to a color palette.

Definition at line 76 of file imagecolors.h.

Property Documentation

◆ average

QColor ImageColors::average

read

The average color of the source image.

Definition at line 121 of file imagecolors.h.

◆ background

QColor ImageColors::background

read

A color suitable for rendering a background behind the source image.

On dark items, this will be the color closest to black in the image if it's dark enough, or a dark gray otherwise. On light items, this will be the color closest to white in the image if it's light enough, or a bright gray otherwise.

Definition at line 168 of file imagecolors.h.

◆ closestToBlack

QColor ImageColors::closestToBlack

read

The darkest color of the source image.

Definition at line 178 of file imagecolors.h.

◆ closestToWhite

QColor ImageColors::closestToWhite

read

The lightest color of the source image.

Definition at line 173 of file imagecolors.h.

◆ dominant

QColor ImageColors::dominant

read

The dominant color of the source image.

The dominant color of the image is the color of the largest cluster in the image.

See also: https://en.wikipedia.org/wiki/K-means_clustering

Definition at line 131 of file imagecolors.h.

◆ dominantContrast

QColor ImageColors::dominantContrast

read

Suggested "contrasting" color to the dominant one.

It's the color in the palette nearest to the negative of the dominant

Definition at line 136 of file imagecolors.h.