#include <qquickshadereffectmesh_p.h>

Inheritance diagram for QQuickBorderImageMesh:

Collaboration diagram for QQuickBorderImageMesh:

Public Types
enum	TileMode { Stretch = Qt::StretchTile , Repeat = Qt::RepeatTile , Round = Qt::RoundTile }

Signals
void	sizeChanged ()

void	horizontalTileModeChanged ()

void	verticalTileModeChanged ()

Signals inherited from QQuickShaderEffectMesh
void	geometryChanged ()

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
	QQuickBorderImageMesh (QObject *parent=nullptr)
	\qmltype BorderImageMesh \instantiates QQuickBorderImageMesh \inqmlmodule QtQuick

bool	validateAttributes (const QVector< QByteArray > &attributes, int *posIndex) override

QSGGeometry *	updateGeometry (QSGGeometry *geometry, int attrCount, int posIndex, const QRectF &srcRect, const QRectF &rect) override

QQuickScaleGrid *	border () const

QSize	size () const
	\qmlproperty size QtQuick::BorderImageMesh::size

void	setSize (const QSize &size)

TileMode	horizontalTileMode () const
	\qmlproperty enumeration QtQuick::BorderImageMesh::horizontalTileMode \qmlproperty enumeration QtQuick::BorderImageMesh::verticalTileMode

void	setHorizontalTileMode (TileMode)

TileMode	verticalTileMode () const

void	setVerticalTileMode (TileMode)

Public Member Functions inherited from QQuickShaderEffectMesh
	QQuickShaderEffectMesh (QObject *parent=nullptr)

virtual QString	log () const

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	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

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

Properties
QQuickScaleGrid *	border

QSize	size

TileMode	horizontalTileMode

TileMode	verticalTileMode

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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)

Protected Member Functions inherited from QQuickShaderEffectMesh
	QQuickShaderEffectMesh (QObjectPrivate &dd, QObject *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)

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 90 of file qquickshadereffectmesh_p.h.

Member Enumeration Documentation

◆ TileMode

enum QQuickBorderImageMesh::TileMode

Enumerator
Stretch
Repeat
Round

Definition at line 111 of file qquickshadereffectmesh_p.h.

Constructor & Destructor Documentation

◆ QQuickBorderImageMesh()

QQuickBorderImageMesh::QQuickBorderImageMesh ( QObject * parent = nullptr )

\qmltype BorderImageMesh \instantiates QQuickBorderImageMesh \inqmlmodule QtQuick

Since: 5.8

Defines a mesh with vertices arranged like those of a BorderImage.

BorderImageMesh provides BorderImage-like capabilities to a ShaderEffect without the need for a potentially costly ShaderEffectSource.

The following are functionally equivalent: \qml BorderImage { id: borderImage border { left: 10 right: 10 top: 10 bottom: 10 } source: "myImage.png" visible: false } ShaderEffectSource { id: effectSource sourceItem: borderImage visible: false } ShaderEffect { property var source: effectSource ... } \endqml

\qml Image { id: image source: "myImage.png" visible: false } ShaderEffect { property var source: image mesh: BorderImageMesh { border { left: 10 right: 10 top: 10 bottom: 10 } size: image.sourceSize } ... } \endqml

But the BorderImageMesh version can typically be better optimized.

Definition at line 280 of file qquickshadereffectmesh.cpp.

Member Function Documentation

◆ border()

QQuickScaleGrid * QQuickBorderImageMesh::border ( ) const

\qmlpropertygroup QtQuick::BorderImageMesh::border
\qmlproperty int QtQuick::BorderImageMesh::border.left
\qmlproperty int QtQuick::BorderImageMesh::border.right
\qmlproperty int QtQuick::BorderImageMesh::border.top
\qmlproperty int QtQuick::BorderImageMesh::border.bottom

The 4 border lines (2 horizontal and 2 vertical) break the image into 9 sections,
as shown below:

\image declarative-scalegrid.png

Each border line (left, right, top, and bottom) specifies an offset in pixels
from the respective edge of the mesh. By default, each border line has
a value of 0.

For example, the following definition sets the bottom line 10 pixels up from
the bottom of the mesh:

\qml
BorderImageMesh {
    border.bottom: 10

... } \endqml

Definition at line 346 of file qquickshadereffectmesh.cpp.

◆ horizontalTileMode()

QQuickBorderImageMesh::TileMode QQuickBorderImageMesh::horizontalTileMode ( ) const

\qmlproperty enumeration QtQuick::BorderImageMesh::horizontalTileMode \qmlproperty enumeration QtQuick::BorderImageMesh::verticalTileMode

This property describes how to repeat or stretch the middle parts of an image.

\list

BorderImage.Stretch - Scales the image to fit to the available area.
BorderImage.Repeat - Tile the image until there is no more space. May crop the last image.
BorderImage.Round - Like Repeat, but scales the images down to ensure that the last image is not cropped. \endlist

The default tile mode for each property is BorderImage.Stretch.

Definition at line 386 of file qquickshadereffectmesh.cpp.

◆ horizontalTileModeChanged

void QQuickBorderImageMesh::horizontalTileModeChanged ( )

signal

Referenced by setHorizontalTileMode().

Here is the caller graph for this function:

◆ setHorizontalTileMode()

void QQuickBorderImageMesh::setHorizontalTileMode ( TileMode t )

Definition at line 391 of file qquickshadereffectmesh.cpp.

References QQuickShaderEffectMesh::geometryChanged(), horizontalTileModeChanged(), and Q_EMIT.

Here is the call graph for this function:

◆ setSize()

void QQuickBorderImageMesh::setSize ( const QSize & size )

Definition at line 362 of file qquickshadereffectmesh.cpp.

References QQuickShaderEffectMesh::geometryChanged(), Q_EMIT, size, and sizeChanged().

Here is the call graph for this function:

◆ setVerticalTileMode()

void QQuickBorderImageMesh::setVerticalTileMode ( TileMode t )

Definition at line 405 of file qquickshadereffectmesh.cpp.

References QQuickShaderEffectMesh::geometryChanged(), Q_EMIT, and verticalTileModeChanged().

Here is the call graph for this function:

◆ size()

QSize QQuickBorderImageMesh::size ( ) const

\qmlproperty size QtQuick::BorderImageMesh::size

The base size of the mesh. This generally corresponds to the \l {Image::}{sourceSize} of the image being used by the ShaderEffect.

Definition at line 357 of file qquickshadereffectmesh.cpp.

◆ sizeChanged

void QQuickBorderImageMesh::sizeChanged ( )

signal

Referenced by setSize().

Here is the caller graph for this function:

◆ updateGeometry()

QSGGeometry * QQuickBorderImageMesh::updateGeometry	(	QSGGeometry *	geometry,
		int	attrCount,
		int	posIndex,
		const QRectF &	srcRect,
		const QRectF &	rect )

overridevirtual

Implements QQuickShaderEffectMesh.

Definition at line 294 of file qquickshadereffectmesh.cpp.

References QQuickBorderImagePrivate::calculateRects(), QRectF::height(), Q_UNUSED, rect, QSGBasicInternalImageNode::updateGeometry(), QRectF::width(), QRectF::x(), and QRectF::y().

Here is the call graph for this function:

◆ validateAttributes()

bool QQuickBorderImageMesh::validateAttributes	(	const QVector< QByteArray > &	attributes,
		int *	posIndex )

overridevirtual

Implements QQuickShaderEffectMesh.

Definition at line 287 of file qquickshadereffectmesh.cpp.

References Q_UNUSED.

◆ verticalTileMode()

QQuickBorderImageMesh::TileMode QQuickBorderImageMesh::verticalTileMode ( ) const

Definition at line 400 of file qquickshadereffectmesh.cpp.

◆ verticalTileModeChanged

void QQuickBorderImageMesh::verticalTileModeChanged ( )

signal

Referenced by setVerticalTileMode().

Here is the caller graph for this function:

Property Documentation

◆ border

QQuickScaleGrid * QQuickBorderImageMesh::border

read

Definition at line 94 of file qquickshadereffectmesh_p.h.

◆ horizontalTileMode

TileMode QQuickBorderImageMesh::horizontalTileMode

readwrite

Definition at line 96 of file qquickshadereffectmesh_p.h.

◆ size

QSize QQuickBorderImageMesh::size

readwrite

Definition at line 95 of file qquickshadereffectmesh_p.h.

Referenced by setSize().

◆ verticalTileMode

TileMode QQuickBorderImageMesh::verticalTileMode

readwrite

Definition at line 97 of file qquickshadereffectmesh_p.h.

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

qtdeclarative/src/quick/items/qquickshadereffectmesh_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/items/qquickshadereffectmesh.cpp (958cd3ee1094a068b6d0ff27c73a4b3caff088ad)

Public Types

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TileMode

Constructor & Destructor Documentation

◆ QQuickBorderImageMesh()

Member Function Documentation

◆ border()

◆ horizontalTileMode()

◆ horizontalTileModeChanged

◆ setHorizontalTileMode()

◆ setSize()

◆ setVerticalTileMode()

◆ size()

◆ sizeChanged

◆ updateGeometry()

◆ validateAttributes()

◆ verticalTileMode()

◆ verticalTileModeChanged

Property Documentation

◆ border

◆ horizontalTileMode

◆ size

◆ verticalTileMode