#include <qquickmultieffect_p.h>

Inheritance diagram for QQuickMultiEffect:

Collaboration diagram for QQuickMultiEffect:

Signals
void	shaderChanged ()

void	itemSizeChanged ()

void	sourceChanged ()

void	autoPaddingEnabledChanged ()

void	paddingRectChanged ()

void	brightnessChanged ()

void	contrastChanged ()

void	saturationChanged ()

void	colorizationChanged ()

void	colorizationColorChanged ()

void	blurEnabledChanged ()

void	blurChanged ()

void	blurMaxChanged ()

void	blurMultiplierChanged ()

void	shadowEnabledChanged ()

void	shadowOpacityChanged ()

void	shadowBlurChanged ()

void	shadowHorizontalOffsetChanged ()

void	shadowVerticalOffsetChanged ()

void	shadowColorChanged ()

void	shadowScaleChanged ()

void	maskEnabledChanged ()

void	maskSourceChanged ()

void	maskThresholdMinChanged ()

void	maskSpreadAtMinChanged ()

void	maskThresholdMaxChanged ()

void	maskSpreadAtMaxChanged ()

void	maskInvertedChanged ()

void	itemRectChanged ()

void	fragmentShaderChanged ()

void	vertexShaderChanged ()

void	hasProxySourceChanged ()

Signals inherited from QQuickItem
void	childrenRectChanged (const QRectF &)

void	baselineOffsetChanged (qreal)

void	stateChanged (const QString &)

void	focusChanged (bool)

void	activeFocusChanged (bool)

Q_REVISION(6, 7) void focusPolicyChanged(Qt	Q_REVISION (2, 1) void activeFocusOnTabChanged(bool)

void	parentChanged (QQuickItem *)

void	transformOriginChanged (TransformOrigin)

void	smoothChanged (bool)

void	antialiasingChanged (bool)

void	clipChanged (bool)

	Q_REVISION (2, 1) void windowChanged(QQuickWindow *window)

void	childrenChanged ()

void	opacityChanged ()

void	enabledChanged ()

void	visibleChanged ()

void	visibleChildrenChanged ()

void	rotationChanged ()

void	scaleChanged ()

void	xChanged ()

void	yChanged ()

void	widthChanged ()

void	heightChanged ()

void	zChanged ()

void	implicitWidthChanged ()

void	implicitHeightChanged ()

	Q_REVISION (2, 11) void containmentMaskChanged()

	Q_REVISION (6, 0) void paletteChanged()

	Q_REVISION (6, 0) void paletteCreated()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickMultiEffect (QQuickItem *parent=nullptr)
	\keyword Qt Quick Effects \qmlmodule QtQuick.Effects \title Qt Quick Effects QML Types

	~QQuickMultiEffect () override

QQuickItem *	source () const
	\qmlproperty Item QtQuick.Effects::MultiEffect::source

void	setSource (QQuickItem *item)

bool	autoPaddingEnabled () const
	\qmlproperty bool QtQuick.Effects::MultiEffect::autoPaddingEnabled

void	setAutoPaddingEnabled (bool enabled)

QRectF	paddingRect () const
	\qmlproperty rect QtQuick.Effects::MultiEffect::paddingRect

void	setPaddingRect (const QRectF &rect)

qreal	brightness () const
	\qmlproperty real QtQuick.Effects::MultiEffect::brightness

void	setBrightness (qreal brightness)

qreal	contrast () const
	\qmlproperty real QtQuick.Effects::MultiEffect::contrast

void	setContrast (qreal contrast)

qreal	saturation () const
	\qmlproperty real QtQuick.Effects::MultiEffect::saturation

void	setSaturation (qreal saturation)

qreal	colorization () const
	\qmlproperty real QtQuick.Effects::MultiEffect::colorization

void	setColorization (qreal colorization)

QColor	colorizationColor () const
	\qmlproperty color QtQuick.Effects::MultiEffect::colorizationColor

void	setColorizationColor (const QColor &color)

bool	blurEnabled () const
	\qmlproperty bool QtQuick.Effects::MultiEffect::blurEnabled

void	setBlurEnabled (bool enabled)

qreal	blur () const
	\qmlproperty real QtQuick.Effects::MultiEffect::blur

void	setBlur (qreal blur)

int	blurMax () const
	\qmlproperty int QtQuick.Effects::MultiEffect::blurMax

void	setBlurMax (int blurMax)

qreal	blurMultiplier () const
	\qmlproperty real QtQuick.Effects::MultiEffect::blurMultiplier

void	setBlurMultiplier (qreal blurMultiplier)

bool	shadowEnabled () const
	\qmlproperty bool QtQuick.Effects::MultiEffect::shadowEnabled

void	setShadowEnabled (bool enabled)

qreal	shadowOpacity () const
	\qmlproperty real QtQuick.Effects::MultiEffect::shadowOpacity

void	setShadowOpacity (qreal shadowOpacity)

qreal	shadowBlur () const
	\qmlproperty real QtQuick.Effects::MultiEffect::shadowBlur

void	setShadowBlur (qreal shadowBlur)

qreal	shadowHorizontalOffset () const
	\qmlproperty real QtQuick.Effects::MultiEffect::shadowHorizontalOffset

void	setShadowHorizontalOffset (qreal offset)

qreal	shadowVerticalOffset () const
	\qmlproperty real QtQuick.Effects::MultiEffect::shadowVerticalOffset

void	setShadowVerticalOffset (qreal offset)

QColor	shadowColor () const
	\qmlproperty color QtQuick.Effects::MultiEffect::shadowColor

void	setShadowColor (const QColor &color)

qreal	shadowScale () const
	\qmlproperty real QtQuick.Effects::MultiEffect::shadowScale

void	setShadowScale (qreal shadowScale)

bool	maskEnabled () const
	\qmlproperty bool QtQuick.Effects::MultiEffect::maskEnabled

void	setMaskEnabled (bool enabled)

QQuickItem *	maskSource () const
	\qmlproperty Item QtQuick.Effects::MultiEffect::maskSource

void	setMaskSource (QQuickItem *item)

qreal	maskThresholdMin () const
	\qmlproperty real QtQuick.Effects::MultiEffect::maskThresholdMin

void	setMaskThresholdMin (qreal threshold)

qreal	maskSpreadAtMin () const
	\qmlproperty real QtQuick.Effects::MultiEffect::maskSpreadAtMin

void	setMaskSpreadAtMin (qreal spread)

qreal	maskThresholdMax () const
	\qmlproperty real QtQuick.Effects::MultiEffect::maskThresholdMax

void	setMaskThresholdMax (qreal threshold)

qreal	maskSpreadAtMax () const
	\qmlproperty real QtQuick.Effects::MultiEffect::maskSpreadAtMax

void	setMaskSpreadAtMax (qreal spread)

bool	maskInverted () const
	\qmlproperty bool QtQuick.Effects::MultiEffect::maskInverted

void	setMaskInverted (bool inverted)

QRectF	itemRect () const
	\qmlproperty rect QtQuick.Effects::MultiEffect::itemRect \readonly

QString	fragmentShader () const
	\qmlproperty string QtQuick.Effects::MultiEffect::fragmentShader \readonly

QString	vertexShader () const
	\qmlproperty string QtQuick.Effects::MultiEffect::vertexShader \readonly

bool	hasProxySource () const
	\qmlproperty bool QtQuick.Effects::MultiEffect::hasProxySource \readonly

Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent=nullptr)
	Constructs a QQuickItem with the given parent.

	~QQuickItem () override
	Destroys the QQuickItem.

QQuickWindow *	window () const
	Returns the window in which this item is rendered.

QQuickItem *	parentItem () const

void	setParentItem (QQuickItem *parent)

void	stackBefore (const QQuickItem *)
	Moves the specified sibling item to the index before this item within the list of children.

void	stackAfter (const QQuickItem *)
	Moves the specified sibling item to the index after this item within the list of children.

QRectF	childrenRect ()
	\qmlpropertygroup QtQuick::Item::childrenRect \qmlproperty real QtQuick::Item::childrenRect.x \qmlproperty real QtQuick::Item::childrenRect.y \qmlproperty real QtQuick::Item::childrenRect.width \qmlproperty real QtQuick::Item::childrenRect.height \readonly

QList< QQuickItem * >	childItems () const
	Returns the children of this item.

bool	clip () const
	\qmlproperty bool QtQuick::Item::clip This property holds whether clipping is enabled.

void	setClip (bool)

QString	state () const
	\qmlproperty string QtQuick::Item::state

void	setState (const QString &)

qreal	baselineOffset () const
	\qmlproperty int QtQuick::Item::baselineOffset

void	setBaselineOffset (qreal)

QQmlListProperty< QQuickTransform >	transform ()

qreal	x () const

qreal	y () const

QPointF	position () const

void	setX (qreal)

void	setY (qreal)

void	setPosition (const QPointF &)

QBindable< qreal >	bindableX ()

QBindable< qreal >	bindableY ()

qreal	width () const

void	setWidth (qreal)

void	resetWidth ()

void	setImplicitWidth (qreal)

qreal	implicitWidth () const
	Returns the width of the item that is implied by other properties that determine the content.

QBindable< qreal >	bindableWidth ()

qreal	height () const

void	setHeight (qreal)

void	resetHeight ()

void	setImplicitHeight (qreal)

qreal	implicitHeight () const

QBindable< qreal >	bindableHeight ()

QSizeF	size () const

void	setSize (const QSizeF &size)

TransformOrigin	transformOrigin () const

void	setTransformOrigin (TransformOrigin)

QPointF	transformOriginPoint () const

void	setTransformOriginPoint (const QPointF &)

qreal	z () const

void	setZ (qreal)

qreal	rotation () const

void	setRotation (qreal)

qreal	scale () const

void	setScale (qreal)

qreal	opacity () const

void	setOpacity (qreal)

bool	isVisible () const

void	setVisible (bool)

bool	isEnabled () const

void	setEnabled (bool)

bool	smooth () const

void	setSmooth (bool)

bool	activeFocusOnTab () const
	\qmlproperty bool QtQuick::Item::activeFocusOnTab

void	setActiveFocusOnTab (bool)

bool	antialiasing () const

void	setAntialiasing (bool)

void	resetAntialiasing ()

Flags	flags () const
	Returns the item flags for this item.

void	setFlag (Flag flag, bool enabled=true)
	Enables the specified flag for this item if enabled is true; if enabled is false, the flag is disabled.

void	setFlags (Flags flags)
	Enables the specified flags for this item.

virtual QRectF	boundingRect () const
	Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().

virtual QRectF	clipRect () const
	Returns the rectangular area within this item that is currently visible in \l viewportItem(), if there is a viewport and the \l ItemObservesViewport flag is set; otherwise, the extents of this item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().

QQuickItem *	viewportItem () const
	If the \l ItemObservesViewport flag is set, returns the nearest parent with the \l ItemIsViewport flag.

bool	hasActiveFocus () const

bool	hasFocus () const

void	setFocus (bool)

void	setFocus (bool focus, Qt::FocusReason reason)

bool	isFocusScope () const
	Returns true if this item is a focus scope, and false otherwise.

QQuickItem *	scopedFocusItem () const
	If this item is a focus scope, this returns the item in its focus chain that currently has focus.

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)
	Sets the focus policy of this item to policy.

bool	isAncestorOf (const QQuickItem *child) const
	Returns `true` if this item is an ancestor of child (i.e., if this item is child's parent, or one of child's parent's ancestors).

Qt::MouseButtons	acceptedMouseButtons () const
	Returns the mouse buttons accepted by this item.

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)
	Sets the mouse buttons accepted by this item to buttons.

bool	acceptHoverEvents () const
	Returns whether hover events are accepted by this item.

void	setAcceptHoverEvents (bool enabled)
	If enabled is true, this sets the item to accept hover events; otherwise, hover events are not accepted by this item.

bool	acceptTouchEvents () const
	Returns whether touch events are accepted by this item.

void	setAcceptTouchEvents (bool accept)
	If enabled is true, this sets the item to accept touch events; otherwise, touch events are not accepted by this item.

bool	isUnderMouse () const

void	grabMouse ()

void	ungrabMouse ()

bool	keepMouseGrab () const
	Returns whether mouse input should exclusively remain with this item.

void	setKeepMouseGrab (bool)
	Sets whether the mouse input should remain exclusively with this item.

bool	filtersChildMouseEvents () const
	Returns whether pointer events intended for this item's children should be filtered through this item.

void	setFiltersChildMouseEvents (bool filter)
	Sets whether pointer events intended for this item's children should be filtered through this item.

void	grabTouchPoints (const QList< int > &ids)

void	ungrabTouchPoints ()

bool	keepTouchGrab () const
	Returns whether the touch points grabbed by this item should exclusively remain with this item.

void	setKeepTouchGrab (bool)
	Sets whether the touch points grabbed by this item should remain exclusively with this item.

	Q_REVISION (2, 4) Q_INVOKABLE bool grabToImage(const QJSValue &callback

QSharedPointer< QQuickItemGrabResult >	grabToImage (const QSize &targetSize=QSize())
	Grabs the item into an in-memory image.

virtual Q_INVOKABLE bool	contains (const QPointF &point) const
	\qmlmethod bool QtQuick::Item::contains(point point)

QObject *	containmentMask () const

void	setContainmentMask (QObject *mask)

QTransform	itemTransform (QQuickItem , bool ) const
	\qmlmethod point QtQuick::Item::mapFromItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapFromItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, rect r)

QPointF	mapToScene (const QPointF &point) const
	Maps the given point in this item's coordinate system to the equivalent point within the scene's coordinate system, and returns the mapped coordinate.

QRectF	mapRectToItem (const QQuickItem *item, const QRectF &rect) const
	Maps the given rect in this item's coordinate system to the equivalent rectangular area within item's coordinate system, and returns the mapped rectangle value.

QRectF	mapRectToScene (const QRectF &rect) const
	Maps the given rect in this item's coordinate system to the equivalent rectangular area within the scene's coordinate system, and returns the mapped rectangle value.

QPointF	mapFromScene (const QPointF &point) const
	Maps the given point in the scene's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.

QRectF	mapRectFromItem (const QQuickItem *item, const QRectF &rect) const
	Maps the given rect in item's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.

QRectF	mapRectFromScene (const QRectF &rect) const
	Maps the given rect in the scene's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.

void	polish ()
	Schedules a polish event for this item.

Q_INVOKABLE QPointF	mapFromItem (const QQuickItem *item, const QPointF &point) const
	Maps the given point in item's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.

Q_INVOKABLE QPointF	mapFromItem (const QQuickItem *item, qreal x, qreal y)

Q_INVOKABLE QRectF	mapFromItem (const QQuickItem *item, const QRectF &rect) const

Q_INVOKABLE QRectF	mapFromItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const

Q_INVOKABLE QPointF	mapToItem (const QQuickItem *item, const QPointF &point) const
	Maps the given point in this item's coordinate system to the equivalent point within item's coordinate system, and returns the mapped coordinate.

Q_INVOKABLE QPointF	mapToItem (const QQuickItem *item, qreal x, qreal y)

Q_INVOKABLE QRectF	mapToItem (const QQuickItem *item, const QRectF &rect) const

Q_INVOKABLE QRectF	mapToItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const

	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(qreal x

	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(const QPointF &point) const

	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(qreal x

	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(const QPointF &point) const

Q_INVOKABLE void	forceActiveFocus ()
	\qmlmethod point QtQuick::Item::mapToItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapToItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapToItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapToItem(Item item, rect r)

Q_INVOKABLE void	forceActiveFocus (Qt::FocusReason reason)
	\qmlmethod QtQuick::Item::forceActiveFocus(Qt::FocusReason reason) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Forces active focus on the item with the given reason.

	Q_REVISION (2, 1) Q_INVOKABLE QQuickItem *nextItemInFocusChain(bool forward

Q_INVOKABLE QQuickItem *	childAt (qreal x, qreal y) const
	\qmlmethod QtQuick::Item::childAt(real x, real y)

	Q_REVISION (6, 3) Q_INVOKABLE void ensurePolished()

	Q_REVISION (6, 3) Q_INVOKABLE void dumpItemTree() const

virtual bool	isTextureProvider () const
	Returns true if this item is a texture provider.

virtual QSGTextureProvider *	textureProvider () const
	Returns the texture provider for an item.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

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

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

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

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Protected Member Functions
void	componentComplete () override
	\reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.

void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override

void	itemChange (ItemChange change, const ItemChangeData &value) override
	Called when change occurs for this item.

Protected Member Functions inherited from QQuickItem
bool	event (QEvent *) override
	\reimp

bool	isComponentComplete () const
	Returns true if construction of the QML component is complete; otherwise returns false.

bool	widthValid () const
	Returns whether the width property has been set explicitly.

bool	heightValid () const
	Returns whether the height property has been set explicitly.

void	setImplicitSize (qreal, qreal)

void	classBegin () override
	\reimp Derived classes should call the base class method before adding their own action to perform at classBegin.

virtual void	keyPressEvent (QKeyEvent *event)
	This event handler can be reimplemented in a subclass to receive key press events for an item.

virtual void	keyReleaseEvent (QKeyEvent *event)
	This event handler can be reimplemented in a subclass to receive key release events for an item.

virtual void	focusInEvent (QFocusEvent *)
	This event handler can be reimplemented in a subclass to receive focus-in events for an item.

virtual void	focusOutEvent (QFocusEvent *)
	This event handler can be reimplemented in a subclass to receive focus-out events for an item.

virtual void	mousePressEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse press events for an item.

virtual void	mouseMoveEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse move events for an item.

virtual void	mouseReleaseEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse release events for an item.

virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse double-click events for an item.

virtual void	mouseUngrabEvent ()
	This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.

virtual void	touchUngrabEvent ()
	This event handler can be reimplemented in a subclass to be notified when a touch ungrab event has occurred on this item.

virtual void	touchEvent (QTouchEvent *event)
	This event handler can be reimplemented in a subclass to receive touch events for an item.

virtual void	hoverEnterEvent (QHoverEvent *event)
	This event handler can be reimplemented in a subclass to receive hover-enter events for an item.

virtual void	hoverMoveEvent (QHoverEvent *event)
	This event handler can be reimplemented in a subclass to receive hover-move events for an item.

virtual void	hoverLeaveEvent (QHoverEvent *event)
	This event handler can be reimplemented in a subclass to receive hover-leave events for an item.

virtual bool	childMouseEventFilter (QQuickItem , QEvent )
	Reimplement this method to filter the pointer events that are received by this item's children.

virtual bool	contextMenuEvent (QContextMenuEvent *event)

virtual QSGNode *	updatePaintNode (QSGNode , UpdatePaintNodeData )
	Called on the render thread when it is time to sync the state of the item with the scene graph.

virtual void	releaseResources ()
	This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode().

virtual void	updatePolish ()
	This function should perform any layout as required for this item.

	QQuickItem (QQuickItemPrivate &dd, QQuickItem *parent=nullptr)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties
QQuickItem *	source

bool	autoPaddingEnabled

QRectF	paddingRect

qreal	brightness

qreal	contrast

qreal	saturation

qreal	colorization

QColor	colorizationColor

bool	blurEnabled

qreal	blur

int	blurMax

qreal	blurMultiplier

bool	shadowEnabled

qreal	shadowOpacity

qreal	shadowBlur

qreal	shadowHorizontalOffset

qreal	shadowVerticalOffset

QColor	shadowColor

qreal	shadowScale

bool	maskEnabled

QQuickItem *	maskSource

qreal	maskThresholdMin

qreal	maskSpreadAtMin

qreal	maskThresholdMax

qreal	maskSpreadAtMax

bool	maskInverted

QRectF	itemRect

QString	fragmentShader

QString	vertexShader

bool	hasProxySource

Properties inherited from QQuickItem
QQuickItem *	parent
	\qmlproperty Item QtQuick::Item::parent This property holds the visual parent of the item.

qreal	x
	\qmlproperty real QtQuick::Item::x \qmlproperty real QtQuick::Item::y \qmlproperty real QtQuick::Item::width \qmlproperty real QtQuick::Item::height

qreal	y
	Defines the item's y position relative to its parent.

qreal	z
	\qmlproperty real QtQuick::Item::z

qreal	width
	This property holds the width of this item.

qreal	height
	This property holds the height of this item.

qreal	opacity
	\qmlproperty real QtQuick::Item::opacity

bool	enabled
	\qmlproperty bool QtQuick::Item::enabled

bool	visible
	\qmlproperty bool QtQuick::Item::visible

Qt::FocusPolicy	focusPolicy
	\qmlproperty enumeration QtQuick::Item::focusPolicy

qreal	rotation
	\qmlproperty real QtQuick::Item::rotation This property holds the rotation of the item in degrees clockwise around its transformOrigin.

qreal	scale
	\qmlproperty real QtQuick::Item::scale This property holds the scale factor for this item.

TransformOrigin	transformOrigin
	\qmlproperty enumeration QtQuick::Item::transformOrigin This property holds the origin point around which scale and rotation transform.

QPointF	transformOriginPoint

QQmlListProperty< QQuickTransform >	transform
	\qmlproperty list<Transform> QtQuick::Item::transform

bool	smooth
	\qmlproperty bool QtQuick::Item::smooth

bool	antialiasing
	\qmlproperty bool QtQuick::Item::antialiasing

qreal	implicitWidth

qreal	implicitHeight

QObject *	containmentMask
	\qmlproperty QObject* QtQuick::Item::containmentMask

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Types inherited from QQuickItem
enum	Flag { ItemClipsChildrenToShape = 0x01 , ItemIsFocusScope = 0x04 , ItemHasContents = 0x08 , ItemAcceptsDrops = 0x10 , ItemIsViewport = 0x20 , ItemObservesViewport = 0x40 }
	\qmltype Item \nativetype QQuickItem \inherits QtObject \inqmlmodule QtQuick More...

enum	ItemChange { ItemChildAddedChange , ItemChildRemovedChange , ItemSceneChange , ItemVisibleHasChanged , ItemParentHasChanged , ItemOpacityHasChanged , ItemActiveFocusHasChanged , ItemRotationHasChanged , ItemAntialiasingHasChanged , ItemDevicePixelRatioHasChanged , ItemEnabledHasChanged , ItemScaleHasChanged , ItemTransformHasChanged }
	Used in conjunction with QQuickItem::itemChange() to notify the item about certain types of changes. More...

enum	TransformOrigin { TopLeft , Top , TopRight , Left , Center , Right , BottomLeft , Bottom , BottomRight }
	\variable QQuickItem::ItemChangeData::realValue The numeric value that has changed: \l {QQuickItem::opacity()}{opacity}, \l {QQuickItem::rotation()}{rotation}, or \l {QQuickItem::scale()}{scale}, or \l {QScreen::devicePixelRatio}{device pixel ratio}. More...

Public Slots inherited from QQuickItem
void	update ()
	Schedules a call to updatePaintNode() for this item.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

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

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

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

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Public Attributes inherited from QQuickItem
const QSize &	targetSize = QSize())

qreal y	const

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 32 of file qquickmultieffect_p.h.

Constructor & Destructor Documentation

◆ QQuickMultiEffect()

QT_BEGIN_NAMESPACE QQuickMultiEffect::QQuickMultiEffect ( QQuickItem * parent = nullptr )

\keyword Qt Quick Effects \qmlmodule QtQuick.Effects \title Qt Quick Effects QML Types

Provides QML types for applying one or more simple graphical effects to Qt Quick items.

To use the types in this module, import the module with the following line:

\qml import QtQuick.Effects \endqml

\qmltype MultiEffect
\nativetype QQuickMultiEffect
\inqmlmodule QtQuick.Effects
\inherits Item
\ingroup qtquick-effects
\brief Applies post-processing effect to an item.

The MultiEffect type, the successor to the deprecated Qt Graphical Effects
from Qt 5, applies a post-processing effect to the \l source item. Compared
to the Qt Graphical Effects module, MultiEffect combines multiple
effects (blur, shadow, colorization etc.) into a single item and shader
which makes it better for multiple effects. There are several shader
variations and the most optimal one gets selected based on the features
used.

MultiEffect is designed specifically for most common effects and can be easily animated.
If the MultiEffect doesn't contain the effect you need, consider implementing a custom
effect using \l {Qt Quick Effect Maker}. For more information about shader effects,
see the \l ShaderEffect reference documentation.

Note that MultiEffect type renders a new visual item alongside the source
item. To apply the effect to the source item, you need to place the new
MultiEffect item at the position of the source item. If the source item and
the MultiEffect item are not opaque, both the items can be visible, thus you
may not get the desired effect. To hide the source item, do any of
these:

\list
    \li Set \c{visible: false} for the source item. In this case, the source
        item is not rendered at all and cannot receive touch or click input.
    \li Set \c{opacity: 0} for the source item. In this case, the source
        item is completely transparent, but still can receive touch or click
        input.
\endlist

\section1 Example Usage

The following example shows how to apply a saturation effect to an item:

\table 70%
\row
\li \image multieffect-example1.png
\li \qml
    import QtQuick
    import QtQuick.Effects

    ...
    Image {
        id: sourceItem
        source: "qt_logo_green_rgb.png"

Hide the source item, otherwise both the source item and MultiEffect will be rendered visible: false or you can set: opacity: 0 } Renders a new item with the specified effects rendered at the same position where the source item was rendered MultiEffect { source: sourceItem anchors.fill: sourceItem saturation: -1.0 } \endqml \endtable

The following example shows how to apply a saturation effect to a \l [QML]{Item#Item Layers}{layered Item}:

\table 70% \row

\qml import QtQuick import QtQuick.Effects

... Image { id: sourceItem source: "qt_logo_green_rgb.png" layer.enabled: true For the layered items, you can assign a MultiEffect directly to layer.effect. layer.effect: MultiEffect { saturation: -1.0 } } \endqml \endtable

The following example shows how to apply multiple effects at the same time:

\table 70% \row

\qml import QtQuick import QtQuick.Effects

... MultiEffect { source: sourceItem anchors.fill: sourceItem brightness: 0.4 saturation: 0.2 blurEnabled: true blurMax: 64 blur: 1.0 } \endqml \endtable

Below is an example of how to use the mask, colorization and brightness effects together to fade away an element. This kind of hiding/showing of elements can be, for example, bind to a slider value or animations like NumberAnimation. Note how the visible property is false when the item is totally faded away, to avoid unnecessary rendering of the effect.

\table 70% \row

\qml import QtQuick import QtQuick.Effects import QtQuick.Controls.Material

... MultiEffect { property real effectAmount: effectSlider.value source: sourceItem anchors.fill: sourceItem brightness: effectAmount colorizationColor: "#ff20d0" colorization: effectAmount maskEnabled: true maskSource: Image { source: "mask.png" } maskSpreadAtMin: 0.2 maskThresholdMin: effectAmount visible: effectAmount < 1.0 } Slider { id: effectSlider anchors.bottom: parent.bottom anchors.horizontalCenter: parent.horizontalCenter } \endqml \endtable

Definition at line 207 of file qquickmultieffect.cpp.

◆ ~QQuickMultiEffect()

QQuickMultiEffect::~QQuickMultiEffect ( )

override

Definition at line 213 of file qquickmultieffect.cpp.

Member Function Documentation

◆ autoPaddingEnabled()

bool QQuickMultiEffect::autoPaddingEnabled ( ) const

\qmlproperty bool QtQuick.Effects::MultiEffect::autoPaddingEnabled

When blur or shadow effects are enabled and this is set to true (default), the item size is padded automatically based on blurMax and blurMultiplier. Note that \l paddingRect is always added to the size.

See also: paddingRect

performance item size

performance item resize

Definition at line 261 of file qquickmultieffect.cpp.

◆ autoPaddingEnabledChanged

void QQuickMultiEffect::autoPaddingEnabledChanged ( )

signal

◆ blur()

qreal QQuickMultiEffect::blur ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::blur

This property defines how much blur (radius) is applied to the source.

The value ranges from 0.0 (no blur) to 1.0 (full blur). By default, the property is set to 0.0 (no change). The amount of full blur is affected by blurMax and blurMultiplier.

{Performance note:} If you don't need to go close to 1.0 at any point of blur animations, consider reducing blurMax or blurMultiplier for optimal performance.

Definition at line 443 of file qquickmultieffect.cpp.

◆ blurChanged

void QQuickMultiEffect::blurChanged ( )

signal

◆ blurEnabled()

bool QQuickMultiEffect::blurEnabled ( ) const

\qmlproperty bool QtQuick.Effects::MultiEffect::blurEnabled

Enables the blur effect.

performance shader regen

Definition at line 418 of file qquickmultieffect.cpp.

◆ blurEnabledChanged

void QQuickMultiEffect::blurEnabledChanged ( )

signal

◆ blurMax()

int QQuickMultiEffect::blurMax ( ) const

\qmlproperty int QtQuick.Effects::MultiEffect::blurMax

This property defines the maximum pixel radius that blur with value 1.0 will reach.

Meaningful range of this value is from 2 (subtle blur) to 64 (high blur). By default, the property is set to 32. For the most optimal performance, select as small value as you need.

Note: This affects to both blur and shadow effects.

performance shader regen

performance item resize

Definition at line 471 of file qquickmultieffect.cpp.

◆ blurMaxChanged

void QQuickMultiEffect::blurMaxChanged ( )

signal

◆ blurMultiplier()

qreal QQuickMultiEffect::blurMultiplier ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::blurMultiplier

This property defines a multiplier for extending the blur radius.

The value ranges from 0.0 (not multiplied) to inf. By default, the property is set to 0.0. Incresing the multiplier extends the blur radius, but decreases the blur quality. This is more performant option for a bigger blur radius than blurMax as it doesn't increase the amount of texture lookups.

Note: This affects to both blur and shadow effects.

performance item resize

Definition at line 498 of file qquickmultieffect.cpp.

◆ blurMultiplierChanged

void QQuickMultiEffect::blurMultiplierChanged ( )

signal

◆ brightness()

qreal QQuickMultiEffect::brightness ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::brightness

This property defines how much the source brightness is increased or decreased.

The value ranges from -1.0 to 1.0. By default, the property is set to 0.0 (no change).

Definition at line 314 of file qquickmultieffect.cpp.

◆ brightnessChanged

void QQuickMultiEffect::brightnessChanged ( )

signal

◆ colorization()

qreal QQuickMultiEffect::colorization ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::colorization

This property defines how much the source is colorized with the colorizationColor.

The value ranges from 0.0 (not colorized) to 1.0 (fully colorized). By default, the property is set to 0.0 (no change).

Definition at line 377 of file qquickmultieffect.cpp.

◆ colorizationChanged

void QQuickMultiEffect::colorizationChanged ( )

signal

◆ colorizationColor()

QColor QQuickMultiEffect::colorizationColor ( ) const

\qmlproperty color QtQuick.Effects::MultiEffect::colorizationColor

This property defines the RGBA color value which is used to colorize the source.

By default, the property is set to {Qt.rgba(1.0, 0.0, 0.0, 1.0)} (red).

See also: colorization

Definition at line 399 of file qquickmultieffect.cpp.

◆ colorizationColorChanged

void QQuickMultiEffect::colorizationColorChanged ( )

signal

◆ componentComplete()

void QQuickMultiEffect::componentComplete ( )

overrideprotectedvirtual

\reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.

Reimplemented from QQuickItem.

Definition at line 886 of file qquickmultieffect.cpp.

◆ contrast()

qreal QQuickMultiEffect::contrast ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::contrast

This property defines how much the source contrast is increased or decreased.

The value ranges from -1.0 to 1.0. By default, the property is set to 0.0 (no change).

Definition at line 335 of file qquickmultieffect.cpp.

◆ contrastChanged

void QQuickMultiEffect::contrastChanged ( )

signal

◆ fragmentShader()

QString QQuickMultiEffect::fragmentShader ( ) const

\qmlproperty string QtQuick.Effects::MultiEffect::fragmentShader \readonly

Read-only access to filename of the currently used fragment shader.

Definition at line 850 of file qquickmultieffect.cpp.

◆ fragmentShaderChanged

void QQuickMultiEffect::fragmentShaderChanged ( )

signal

◆ geometryChange()

void QQuickMultiEffect::geometryChange	(	const QRectF &	newGeometry,
		const QRectF &	oldGeometry )

overrideprotectedvirtual

Since: 6.0

This function is called to handle this item's changes in geometry from oldGeometry to newGeometry. If the two geometries are the same, it doesn't do anything.

Derived classes must call the base class method within their implementation.

Reimplemented from QQuickItem.

Definition at line 893 of file qquickmultieffect.cpp.

◆ hasProxySource()

bool QQuickMultiEffect::hasProxySource ( ) const

\qmlproperty bool QtQuick.Effects::MultiEffect::hasProxySource \readonly

Returns true when the MultiEffect internally creates \l ShaderEffectSource for the \l source item and false when \l source item is used as-is. For example when source is \l Image element or \l Item with \l {QtQuick::Item::layer.enabled} {layer.enabled} set to true, this additional proxy source is not needed.

Definition at line 878 of file qquickmultieffect.cpp.

◆ hasProxySourceChanged

void QQuickMultiEffect::hasProxySourceChanged ( )

signal

◆ itemChange()

void QQuickMultiEffect::itemChange	(	ItemChange	change,
		const ItemChangeData &	value )

overrideprotectedvirtual

Called when change occurs for this item.

value contains extra information relating to the change, when applicable.

If you re-implement this method in a subclass, be sure to call

QQuickItem::itemChange(change, value);

QQuickItem::itemChange

virtual void itemChange(ItemChange, const ItemChangeData &)

Called when change occurs for this item.

Definition qquickitem.cpp:5846

value

EGLOutputLayerEXT EGLint EGLAttrib value

[5]

Definition qeglstreamconvenience_p.h:46

typically at the end of your implementation, to ensure the \l windowChanged() signal will be emitted.

Reimplemented from QQuickItem.

Definition at line 901 of file qquickmultieffect.cpp.

◆ itemRect()

QRectF QQuickMultiEffect::itemRect ( ) const

\qmlproperty rect QtQuick.Effects::MultiEffect::itemRect \readonly

Read-only access to effect item rectangle. This can be used e.g. to see the area item covers.

See also: paddingRect, autoPaddingEnabled

Definition at line 838 of file qquickmultieffect.cpp.

◆ itemRectChanged

void QQuickMultiEffect::itemRectChanged ( )

signal

◆ itemSizeChanged

void QQuickMultiEffect::itemSizeChanged ( )

signal

◆ maskEnabled()

bool QQuickMultiEffect::maskEnabled ( ) const

\qmlproperty bool QtQuick.Effects::MultiEffect::maskEnabled

Enables the mask effect.

performance shader regen

Definition at line 679 of file qquickmultieffect.cpp.

◆ maskEnabledChanged

void QQuickMultiEffect::maskEnabledChanged ( )

signal

◆ maskInverted()

bool QQuickMultiEffect::maskInverted ( ) const

\qmlproperty bool QtQuick.Effects::MultiEffect::maskInverted

This property switches the mask to the opposite side; instead of masking away the content outside maskThresholdMin and maskThresholdMax, content between them will get masked away.

By default, the property is set to false.

Definition at line 817 of file qquickmultieffect.cpp.

◆ maskInvertedChanged

void QQuickMultiEffect::maskInvertedChanged ( )

signal

◆ maskSource()

QQuickItem * QQuickMultiEffect::maskSource ( ) const

\qmlproperty Item QtQuick.Effects::MultiEffect::maskSource

Source item for the mask effect. Should point to ShaderEffectSource, item with \l {QtQuick::Item::layer.enabled} {layer.enabled} set to true, or to an item that can be directly used as a texture source (for example, \l [QML] Image). The alpha channel of the source item is used for masking.

If the maskSource and the source have different dimensions, the maskSource image is stretched to match the source size.

Definition at line 702 of file qquickmultieffect.cpp.

◆ maskSourceChanged

void QQuickMultiEffect::maskSourceChanged ( )

signal

◆ maskSpreadAtMax()

qreal QQuickMultiEffect::maskSpreadAtMax ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::maskSpreadAtMax

This property defines the smoothness of the mask edges near the maskThresholdMax. Using higher spread values softens the transition from the transparent mask pixels towards opaque mask pixels by adding interpolated values between them.

The value ranges from 0.0 (sharp mask edge) to 1.0 (smooth mask edge). By default, the property is set to 0.0.

Definition at line 796 of file qquickmultieffect.cpp.

◆ maskSpreadAtMaxChanged

void QQuickMultiEffect::maskSpreadAtMaxChanged ( )

signal

◆ maskSpreadAtMin()

qreal QQuickMultiEffect::maskSpreadAtMin ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::maskSpreadAtMin

This property defines the smoothness of the mask edges near the maskThresholdMin. Setting higher spread values softens the transition from the transparent mask pixels towards opaque mask pixels by adding interpolated values between them.

The value ranges from 0.0 (sharp mask edge) to 1.0 (smooth mask edge). By default, the property is set to 0.0.

Definition at line 749 of file qquickmultieffect.cpp.

◆ maskSpreadAtMinChanged

void QQuickMultiEffect::maskSpreadAtMinChanged ( )

signal

◆ maskThresholdMax()

qreal QQuickMultiEffect::maskThresholdMax ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::maskThresholdMax

This property defines an upper threshold value for the mask pixels. The mask pixels that have an alpha value below this property are used to completely mask away the corresponding pixels from the source item. The mask pixels that have a higher alpha value are used to alphablend the source item to the display.

The value ranges from 0.0 (alpha value 0) to 1.0 (alpha value 255). By default, the property is set to 1.0.

Definition at line 773 of file qquickmultieffect.cpp.

◆ maskThresholdMaxChanged

void QQuickMultiEffect::maskThresholdMaxChanged ( )

signal

◆ maskThresholdMin()

qreal QQuickMultiEffect::maskThresholdMin ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::maskThresholdMin

This property defines a lower threshold value for the mask pixels. The mask pixels that have an alpha value below this property are used to completely mask away the corresponding pixels from the source item. The mask pixels that have a higher alpha value are used to alphablend the source item to the display.

The value ranges from 0.0 (alpha value 0) to 1.0 (alpha value 255). By default, the property is set to 0.0.

Definition at line 726 of file qquickmultieffect.cpp.

◆ maskThresholdMinChanged

void QQuickMultiEffect::maskThresholdMinChanged ( )

signal

◆ paddingRect()

QRectF QQuickMultiEffect::paddingRect ( ) const

\qmlproperty rect QtQuick.Effects::MultiEffect::paddingRect

Set this to increase item size manually so that blur and/or shadows will fit. If autoPaddingEnabled is true and paddingRect is not set, the item is padded to fit maximally blurred item based on blurMax and blurMultiplier. When enabling the shadow, you typically need to take \l shadowHorizontalOffset and \l shadowVerticalOffset into account and adjust this paddingRect accordingly.

Below is an example of adjusting paddingRect with autoPaddingEnabled set to false so that the shadow fits inside the MultiEffect item.

See also: autoPaddingEnabled

performance item size

performance item resize

Definition at line 293 of file qquickmultieffect.cpp.

◆ paddingRectChanged

void QQuickMultiEffect::paddingRectChanged ( )

signal

◆ saturation()

qreal QQuickMultiEffect::saturation ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::saturation

This property defines how much the source saturation is increased or decreased.

The value ranges from -1.0 (totally desaturated) to inf. By default, the property is set to 0.0 (no change).

Definition at line 356 of file qquickmultieffect.cpp.

◆ saturationChanged

void QQuickMultiEffect::saturationChanged ( )

signal

◆ setAutoPaddingEnabled()

void QQuickMultiEffect::setAutoPaddingEnabled ( bool enabled )

Definition at line 267 of file qquickmultieffect.cpp.

◆ setBlur()

void QQuickMultiEffect::setBlur ( qreal blur )

Definition at line 449 of file qquickmultieffect.cpp.

◆ setBlurEnabled()

void QQuickMultiEffect::setBlurEnabled ( bool enabled )

Definition at line 424 of file qquickmultieffect.cpp.

◆ setBlurMax()

void QQuickMultiEffect::setBlurMax ( int blurMax )

Definition at line 477 of file qquickmultieffect.cpp.

◆ setBlurMultiplier()

void QQuickMultiEffect::setBlurMultiplier ( qreal blurMultiplier )

Definition at line 504 of file qquickmultieffect.cpp.

◆ setBrightness()

void QQuickMultiEffect::setBrightness ( qreal brightness )

Definition at line 320 of file qquickmultieffect.cpp.

◆ setColorization()

void QQuickMultiEffect::setColorization ( qreal colorization )

Definition at line 383 of file qquickmultieffect.cpp.

◆ setColorizationColor()

void QQuickMultiEffect::setColorizationColor ( const QColor & color )

Definition at line 405 of file qquickmultieffect.cpp.

◆ setContrast()

void QQuickMultiEffect::setContrast ( qreal contrast )

Definition at line 341 of file qquickmultieffect.cpp.

◆ setMaskEnabled()

void QQuickMultiEffect::setMaskEnabled ( bool enabled )

Definition at line 685 of file qquickmultieffect.cpp.

◆ setMaskInverted()

void QQuickMultiEffect::setMaskInverted ( bool inverted )

Definition at line 823 of file qquickmultieffect.cpp.

◆ setMaskSource()

void QQuickMultiEffect::setMaskSource ( QQuickItem * item )

Definition at line 708 of file qquickmultieffect.cpp.

◆ setMaskSpreadAtMax()

void QQuickMultiEffect::setMaskSpreadAtMax ( qreal spread )

Definition at line 802 of file qquickmultieffect.cpp.

◆ setMaskSpreadAtMin()

void QQuickMultiEffect::setMaskSpreadAtMin ( qreal spread )

Definition at line 755 of file qquickmultieffect.cpp.

◆ setMaskThresholdMax()

void QQuickMultiEffect::setMaskThresholdMax ( qreal threshold )

Definition at line 779 of file qquickmultieffect.cpp.

◆ setMaskThresholdMin()

void QQuickMultiEffect::setMaskThresholdMin ( qreal threshold )

Definition at line 732 of file qquickmultieffect.cpp.

◆ setPaddingRect()

void QQuickMultiEffect::setPaddingRect ( const QRectF & rect )

Definition at line 299 of file qquickmultieffect.cpp.

◆ setSaturation()

void QQuickMultiEffect::setSaturation ( qreal saturation )

Definition at line 362 of file qquickmultieffect.cpp.

◆ setShadowBlur()

void QQuickMultiEffect::setShadowBlur ( qreal shadowBlur )

Definition at line 569 of file qquickmultieffect.cpp.

◆ setShadowColor()

void QQuickMultiEffect::setShadowColor ( const QColor & color )

Definition at line 641 of file qquickmultieffect.cpp.

◆ setShadowEnabled()

void QQuickMultiEffect::setShadowEnabled ( bool enabled )

Definition at line 523 of file qquickmultieffect.cpp.

◆ setShadowHorizontalOffset()

void QQuickMultiEffect::setShadowHorizontalOffset ( qreal offset )

Definition at line 594 of file qquickmultieffect.cpp.

◆ setShadowOpacity()

void QQuickMultiEffect::setShadowOpacity ( qreal shadowOpacity )

Definition at line 544 of file qquickmultieffect.cpp.

◆ setShadowScale()

void QQuickMultiEffect::setShadowScale ( qreal shadowScale )

Definition at line 666 of file qquickmultieffect.cpp.

◆ setShadowVerticalOffset()

void QQuickMultiEffect::setShadowVerticalOffset ( qreal offset )

Definition at line 619 of file qquickmultieffect.cpp.

◆ setSource()

void QQuickMultiEffect::setSource ( QQuickItem * item )

Definition at line 240 of file qquickmultieffect.cpp.

◆ shaderChanged

void QQuickMultiEffect::shaderChanged ( )

signal

◆ shadowBlur()

qreal QQuickMultiEffect::shadowBlur ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::shadowBlur

This property defines how much blur (radius) is applied to the shadow.

The value ranges from 0.0 (no blur) to 1.0 (full blur). By default, the property is set to 1.0. The amount of full blur is affected by blurMax and blurMultiplier.

{Performance note:} The most optimal way to reduce shadow blurring is to make blurMax smaller (if it isn't needed for item blur). Just remember to not adjust blurMax during animations.

Definition at line 563 of file qquickmultieffect.cpp.

◆ shadowBlurChanged

void QQuickMultiEffect::shadowBlurChanged ( )

signal

◆ shadowColor()

QColor QQuickMultiEffect::shadowColor ( ) const

\qmlproperty color QtQuick.Effects::MultiEffect::shadowColor

This property defines the RGBA color value which is used for the shadow. It is useful for example when a shadow is used for simulating a glow effect.

By default, the property is set to {Qt.rgba(0.0, 0.0, 0.0, 1.0)} (black).

Definition at line 635 of file qquickmultieffect.cpp.

◆ shadowColorChanged

void QQuickMultiEffect::shadowColorChanged ( )

signal

◆ shadowEnabled()

bool QQuickMultiEffect::shadowEnabled ( ) const

\qmlproperty bool QtQuick.Effects::MultiEffect::shadowEnabled

Enables the shadow effect.

performance shader regen

Definition at line 517 of file qquickmultieffect.cpp.

◆ shadowEnabledChanged

void QQuickMultiEffect::shadowEnabledChanged ( )

signal

◆ shadowHorizontalOffset()

qreal QQuickMultiEffect::shadowHorizontalOffset ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::shadowHorizontalOffset

This property defines the horizontal offset of the shadow from the item center.

The value ranges from -inf to inf. By default, the property is set to 0.0.

Note: When moving shadow position away from center and adding shadowBlur, you possibly also need to increase the paddingRect accordingly if you want the shadow to not be clipped.

Definition at line 588 of file qquickmultieffect.cpp.

◆ shadowHorizontalOffsetChanged

void QQuickMultiEffect::shadowHorizontalOffsetChanged ( )

signal

◆ shadowOpacity()

qreal QQuickMultiEffect::shadowOpacity ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::shadowOpacity

This property defines the opacity of the drop shadow. This value is multiplied with the shadowColor alpha value.

The value ranges from 0.0 (fully transparent) to 1.0 (fully opaque). By default, the property is set to 1.0.

Definition at line 538 of file qquickmultieffect.cpp.

◆ shadowOpacityChanged

void QQuickMultiEffect::shadowOpacityChanged ( )

signal

◆ shadowScale()

qreal QQuickMultiEffect::shadowScale ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::shadowScale

This property defines the scale of the shadow. Scaling is applied from the center of the item.

The value ranges from 0 to inf. By default, the property is set to 1.0.

Note: When increasing the shadowScale, you possibly also need to increase the paddingRect accordingly to avoid the shadow from being clipped.

Definition at line 660 of file qquickmultieffect.cpp.

◆ shadowScaleChanged

void QQuickMultiEffect::shadowScaleChanged ( )

signal

◆ shadowVerticalOffset()

qreal QQuickMultiEffect::shadowVerticalOffset ( ) const

\qmlproperty real QtQuick.Effects::MultiEffect::shadowVerticalOffset

This property defines the vertical offset of the shadow from the item center.

The value ranges from -inf to inf. By default, the property is set to 0.0.

Note: When moving shadow position away from center and adding shadowBlur, you possibly also need to increase the paddingRect accordingly if you want the shadow to not be clipped.

Definition at line 613 of file qquickmultieffect.cpp.

◆ shadowVerticalOffsetChanged

void QQuickMultiEffect::shadowVerticalOffsetChanged ( )

signal

◆ source()

QQuickItem * QQuickMultiEffect::source ( ) const

\qmlproperty Item QtQuick.Effects::MultiEffect::source

This property holds the item to be used as a source for the effect. If needed, MultiEffect will internally generate a \l ShaderEffectSource as the texture source.

Note: It is not supported to let the effect include itself, for instance by setting source to the effect's parent.; If the source item has \l {QtQuick::Item::layer.enabled} {layer.enabled} set to true, it will be used directly. This is good for the performance and often desired, when the source is hidden. But if the source remains visible and the effect adds padding (autoPaddingEnabled, paddingRect), that padding can affect the appearance of the source item.

See also: hasProxySource

Definition at line 234 of file qquickmultieffect.cpp.

◆ sourceChanged

void QQuickMultiEffect::sourceChanged ( )

signal

◆ vertexShader()

QString QQuickMultiEffect::vertexShader ( ) const

\qmlproperty string QtQuick.Effects::MultiEffect::vertexShader \readonly

Read-only access to filename of the currently used vertex shader.

Definition at line 862 of file qquickmultieffect.cpp.

◆ vertexShaderChanged

void QQuickMultiEffect::vertexShaderChanged ( )

signal

Property Documentation

◆ autoPaddingEnabled

bool QQuickMultiEffect::autoPaddingEnabled

readwrite

Definition at line 36 of file qquickmultieffect_p.h.

◆ blur

qreal QQuickMultiEffect::blur

readwrite

Definition at line 44 of file qquickmultieffect_p.h.

◆ blurEnabled

bool QQuickMultiEffect::blurEnabled

readwrite

Definition at line 43 of file qquickmultieffect_p.h.

◆ blurMax

int QQuickMultiEffect::blurMax

readwrite

Definition at line 45 of file qquickmultieffect_p.h.

◆ blurMultiplier

qreal QQuickMultiEffect::blurMultiplier

readwrite

Definition at line 46 of file qquickmultieffect_p.h.

◆ brightness

qreal QQuickMultiEffect::brightness

readwrite

Definition at line 38 of file qquickmultieffect_p.h.

◆ colorization

qreal QQuickMultiEffect::colorization

readwrite

Definition at line 41 of file qquickmultieffect_p.h.

◆ colorizationColor

QColor QQuickMultiEffect::colorizationColor

readwrite

Definition at line 42 of file qquickmultieffect_p.h.

◆ contrast

qreal QQuickMultiEffect::contrast

readwrite

Definition at line 39 of file qquickmultieffect_p.h.

◆ fragmentShader

QString QQuickMultiEffect::fragmentShader

read

Definition at line 62 of file qquickmultieffect_p.h.

◆ hasProxySource

bool QQuickMultiEffect::hasProxySource

read

Definition at line 64 of file qquickmultieffect_p.h.

◆ itemRect

QRectF QQuickMultiEffect::itemRect

read

Definition at line 61 of file qquickmultieffect_p.h.

◆ maskEnabled

bool QQuickMultiEffect::maskEnabled

readwrite

Definition at line 54 of file qquickmultieffect_p.h.

◆ maskInverted

bool QQuickMultiEffect::maskInverted

readwrite

Definition at line 60 of file qquickmultieffect_p.h.

◆ maskSource

QQuickItem * QQuickMultiEffect::maskSource

readwrite

Definition at line 55 of file qquickmultieffect_p.h.

◆ maskSpreadAtMax

qreal QQuickMultiEffect::maskSpreadAtMax

readwrite

Definition at line 59 of file qquickmultieffect_p.h.

◆ maskSpreadAtMin

qreal QQuickMultiEffect::maskSpreadAtMin

readwrite

Definition at line 57 of file qquickmultieffect_p.h.

◆ maskThresholdMax

qreal QQuickMultiEffect::maskThresholdMax

readwrite

Definition at line 58 of file qquickmultieffect_p.h.

◆ maskThresholdMin

qreal QQuickMultiEffect::maskThresholdMin

readwrite

Definition at line 56 of file qquickmultieffect_p.h.

◆ paddingRect

QRectF QQuickMultiEffect::paddingRect

readwrite

Definition at line 37 of file qquickmultieffect_p.h.

◆ saturation

qreal QQuickMultiEffect::saturation

readwrite

Definition at line 40 of file qquickmultieffect_p.h.

◆ shadowBlur

qreal QQuickMultiEffect::shadowBlur

readwrite

Definition at line 49 of file qquickmultieffect_p.h.

◆ shadowColor

QColor QQuickMultiEffect::shadowColor

readwrite

Definition at line 52 of file qquickmultieffect_p.h.

◆ shadowEnabled

bool QQuickMultiEffect::shadowEnabled

readwrite

Definition at line 47 of file qquickmultieffect_p.h.

◆ shadowHorizontalOffset

qreal QQuickMultiEffect::shadowHorizontalOffset

readwrite

Definition at line 50 of file qquickmultieffect_p.h.

◆ shadowOpacity

qreal QQuickMultiEffect::shadowOpacity

readwrite

Definition at line 48 of file qquickmultieffect_p.h.

◆ shadowScale

qreal QQuickMultiEffect::shadowScale

readwrite

Definition at line 53 of file qquickmultieffect_p.h.

◆ shadowVerticalOffset

qreal QQuickMultiEffect::shadowVerticalOffset

readwrite

Definition at line 51 of file qquickmultieffect_p.h.

◆ source

QQuickItem * QQuickMultiEffect::source

readwrite

Definition at line 35 of file qquickmultieffect_p.h.

◆ vertexShader

QString QQuickMultiEffect::vertexShader

read

Definition at line 63 of file qquickmultieffect_p.h.

The documentation for this class was generated from the following files:

qtdeclarative/src/effects/qquickmultieffect_p.h (59aea7084c84711917ee40ab7a2c9babb01f00b6)
qtdeclarative/src/effects/qquickmultieffect.cpp (711bb5ab2a175638f96f5d38b7e7f9cf3067b684)

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickMultiEffect()

◆ ~QQuickMultiEffect()

Member Function Documentation

◆ autoPaddingEnabled()

◆ autoPaddingEnabledChanged

◆ blur()

◆ blurChanged

◆ blurEnabled()

◆ blurEnabledChanged

◆ blurMax()

◆ blurMaxChanged

◆ blurMultiplier()

◆ blurMultiplierChanged

◆ brightness()

◆ brightnessChanged

◆ colorization()

◆ colorizationChanged

◆ colorizationColor()

◆ colorizationColorChanged

◆ componentComplete()

◆ contrast()

◆ contrastChanged

◆ fragmentShader()

◆ fragmentShaderChanged

◆ geometryChange()

◆ hasProxySource()

◆ hasProxySourceChanged

◆ itemChange()

◆ itemRect()

◆ itemRectChanged

◆ itemSizeChanged

◆ maskEnabled()

◆ maskEnabledChanged

◆ maskInverted()

◆ maskInvertedChanged

◆ maskSource()

◆ maskSourceChanged

◆ maskSpreadAtMax()

◆ maskSpreadAtMaxChanged

◆ maskSpreadAtMin()

◆ maskSpreadAtMinChanged

◆ maskThresholdMax()

◆ maskThresholdMaxChanged

◆ maskThresholdMin()

◆ maskThresholdMinChanged

◆ paddingRect()

◆ paddingRectChanged

◆ saturation()

◆ saturationChanged

◆ setAutoPaddingEnabled()

◆ setBlur()

◆ setBlurEnabled()

◆ setBlurMax()

◆ setBlurMultiplier()

◆ setBrightness()

◆ setColorization()

◆ setColorizationColor()

◆ setContrast()

◆ setMaskEnabled()

◆ setMaskInverted()

◆ setMaskSource()

◆ setMaskSpreadAtMax()

◆ setMaskSpreadAtMin()

◆ setMaskThresholdMax()

◆ setMaskThresholdMin()

◆ setPaddingRect()

◆ setSaturation()

◆ setShadowBlur()

◆ setShadowColor()

◆ setShadowEnabled()

◆ setShadowHorizontalOffset()

◆ setShadowOpacity()

◆ setShadowScale()