\qmltype WaylandView \nativetype QWaylandView \inqmlmodule QtWayland.Compositor More...

#include <qwaylandview.h>

Inheritance diagram for QWaylandView:

Collaboration diagram for QWaylandView:

Signals
void	surfaceChanged ()

void	surfaceDestroyed ()

void	outputChanged ()

void	bufferLockedChanged ()

void	allowDiscardFrontBufferChanged ()

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
	QWaylandView (QObject renderObject=nullptr, QObject parent=nullptr)
	Constructs a QWaylandView with the given renderObject and parent.

	~QWaylandView () override
	Destroys the QWaylandView.

QObject *	renderObject () const

QWaylandSurface *	surface () const

void	setSurface (QWaylandSurface *surface)

QWaylandOutput *	output () const

void	setOutput (QWaylandOutput *output)

virtual void	bufferCommitted (const QWaylandBufferRef &buffer, const QRegion &damage)
	This function is called when a new buffer is committed to this view's surface.

virtual bool	advance ()
	Updates the current buffer and damage region to the latest version committed by the client.

virtual void	discardCurrentBuffer ()
	Force the view to discard its current buffer, to allow it to be reused on the client side.

virtual QWaylandBufferRef	currentBuffer ()
	Returns a reference to this view's current buffer.

virtual QRegion	currentDamage ()
	Returns the current damage region of this view.

bool	isBufferLocked () const

void	setBufferLocked (bool locked)

bool	allowDiscardFrontBuffer () const

void	setAllowDiscardFrontBuffer (bool discard)

void	setPrimary ()
	Makes this QWaylandView the primary view for the surface.

bool	isPrimary () const
	Returns true if this QWaylandView is the primary view for the QWaylandSurface.

struct wl_resource *	surfaceResource () const
	Returns the Wayland surface resource for this QWaylandView.

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
QObject *	renderObject

QWaylandSurface *	surface
	\qmlproperty WaylandSurface QtWayland.Compositor::WaylandView::surface

QWaylandOutput *	output
	\qmlproperty WaylandOutput QtWayland.Compositor::WaylandView::output

bool	bufferLocked
	\qmlproperty bool QtWayland.Compositor::WaylandView::bufferLocked

bool	allowDiscardFrontBuffer
	\qmlproperty bool QtWayland.Compositor::WaylandView::allowDiscardFrontBuffer

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

\qmltype WaylandView \nativetype QWaylandView \inqmlmodule QtWayland.Compositor

Since: 5.8

Represents a view of a surface on an output.

The WaylandView corresponds to the presentation of a surface on a specific output, managing the buffers that contain the contents to be rendered. You can have several views into the same surface.

\inmodule QtWaylandCompositor

Since: 5.8

The QWaylandView class represents a view of a surface on an output.

The QWaylandView corresponds to the presentation of a surface on a specific output, managing the buffers that contain the contents to be rendered. You can have several views into the same surface.

Definition at line 19 of file qwaylandview.h.

Constructor & Destructor Documentation

◆ QWaylandView()

QWaylandView::QWaylandView	(	QObject *	renderObject = nullptr,
		QObject *	parent = nullptr )

Constructs a QWaylandView with the given renderObject and parent.

Definition at line 56 of file qwaylandview.cpp.

◆ ~QWaylandView()

QWaylandView::~QWaylandView ( )

override

Destroys the QWaylandView.

Definition at line 65 of file qwaylandview.cpp.

Member Function Documentation

◆ advance()

bool QWaylandView::advance ( )

virtual

Updates the current buffer and damage region to the latest version committed by the client.

Returns true if new content was committed since the previous call to advance(). Otherwise returns false.

See also: currentBuffer(), currentDamage()

Definition at line 204 of file qwaylandview.cpp.

◆ allowDiscardFrontBuffer()

bool QWaylandView::allowDiscardFrontBuffer ( ) const

Definition at line 313 of file qwaylandview.cpp.

◆ allowDiscardFrontBufferChanged

void QWaylandView::allowDiscardFrontBufferChanged ( )

signal

◆ bufferCommitted()

void QWaylandView::bufferCommitted	(	const QWaylandBufferRef &	buffer,
		const QRegion &	damage )

virtual

This function is called when a new buffer is committed to this view's surface.

damage contains the region that is different from the current buffer, i.e. the region that needs to be updated. The new buffer will become current on the next call to advance().

Subclasses that reimplement this function must call the base implementation.

Definition at line 188 of file qwaylandview.cpp.

◆ bufferLockedChanged

void QWaylandView::bufferLockedChanged ( )

signal

◆ currentBuffer()

QWaylandBufferRef QWaylandView::currentBuffer ( )

virtual

Returns a reference to this view's current buffer.

Definition at line 244 of file qwaylandview.cpp.

◆ currentDamage()

QRegion QWaylandView::currentDamage ( )

virtual

Returns the current damage region of this view.

Definition at line 254 of file qwaylandview.cpp.

◆ discardCurrentBuffer()

void QWaylandView::discardCurrentBuffer ( )

virtual

Force the view to discard its current buffer, to allow it to be reused on the client side.

Definition at line 233 of file qwaylandview.cpp.

◆ isBufferLocked()

bool QWaylandView::isBufferLocked ( ) const

Definition at line 280 of file qwaylandview.cpp.

◆ isPrimary()

bool QWaylandView::isPrimary ( ) const

Returns true if this QWaylandView is the primary view for the QWaylandSurface.

See also: QWaylandSurface::primaryView

Definition at line 349 of file qwaylandview.cpp.

◆ output()

QWaylandOutput * QWaylandView::output ( ) const

Definition at line 157 of file qwaylandview.cpp.

◆ outputChanged

void QWaylandView::outputChanged ( )

signal

◆ renderObject()

QObject * QWaylandView::renderObject ( ) const

Didn't we decide to remove this property?

Definition at line 81 of file qwaylandview.cpp.

◆ setAllowDiscardFrontBuffer()

void QWaylandView::setAllowDiscardFrontBuffer ( bool discard )

Definition at line 319 of file qwaylandview.cpp.

◆ setBufferLocked()

void QWaylandView::setBufferLocked ( bool locked )

Definition at line 286 of file qwaylandview.cpp.

◆ setOutput()

void QWaylandView::setOutput ( QWaylandOutput * output )

Definition at line 163 of file qwaylandview.cpp.

◆ setPrimary()

void QWaylandView::setPrimary ( )

Makes this QWaylandView the primary view for the surface.

It has no effect if this QWaylandView is not holding any QWaylandSurface

See also: QWaylandSurface::primaryView

Definition at line 335 of file qwaylandview.cpp.

◆ setSurface()

void QWaylandView::setSurface ( QWaylandSurface * surface )

Definition at line 135 of file qwaylandview.cpp.

◆ surface()

QWaylandSurface * QWaylandView::surface ( ) const

Definition at line 98 of file qwaylandview.cpp.

◆ surfaceChanged

void QWaylandView::surfaceChanged ( )

signal

◆ surfaceDestroyed

void QWaylandView::surfaceDestroyed ( )

signal

◆ surfaceResource()

struct wl_resource * QWaylandView::surfaceResource ( ) const

Returns the Wayland surface resource for this QWaylandView.

Definition at line 358 of file qwaylandview.cpp.

Property Documentation

◆ allowDiscardFrontBuffer

bool QWaylandView::allowDiscardFrontBuffer

readwrite

\qmlproperty bool QtWayland.Compositor::WaylandView::allowDiscardFrontBuffer

By default, the view locks the current buffer until advance() is called. Set this property to true to allow Qt to release the buffer when the primary view is no longer using it.

This can be used to avoid the situation where a secondary view that updates on a lower frequency will throttle the frame rate of the client application.

By default, the view locks the current buffer until advance() is called. Set this property to true to allow Qt to release the buffer when the primary view is no longer using it.

This can be used to avoid the situation where a secondary view that updates on a lower frequency will throttle the frame rate of the client application.

Definition at line 27 of file qwaylandview.h.

◆ bufferLocked

bool QWaylandView::bufferLocked

readwrite

\qmlproperty bool QtWayland.Compositor::WaylandView::bufferLocked

This property holds whether the view's buffer is currently locked. When the buffer is locked, advance() will not advance to the next buffer and returns false.

The default is false.

This property holds whether the view's buffer is currently locked. When the buffer is locked, advance() will not advance to the next buffer and returns false.

The default is false.

Definition at line 26 of file qwaylandview.h.

◆ output

QWaylandOutput * QWaylandView::output

readwrite

\qmlproperty WaylandOutput QtWayland.Compositor::WaylandView::output

This property holds the output on which this view displays its surface.

Definition at line 25 of file qwaylandview.h.

◆ renderObject

QObject * QWaylandView::renderObject

read

Definition at line 23 of file qwaylandview.h.

◆ surface

QWaylandSurface * QWaylandView::surface

readwrite

\qmlproperty WaylandSurface QtWayland.Compositor::WaylandView::surface

This property holds the surface viewed by this WaylandView.

This property holds the surface viewed by this QWaylandView.

Definition at line 24 of file qwaylandview.h.

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

qtwayland/src/compositor/compositor_api/qwaylandview.h (811f060c37a58580e0697d0beb34a6f91efeeb41)
qtwayland/src/compositor/compositor_api/qwaylandview.cpp (bc861d37690e29a84c99e295329f2f7f006274f6)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QWaylandView()

◆ ~QWaylandView()

Member Function Documentation

◆ advance()

◆ allowDiscardFrontBuffer()

◆ allowDiscardFrontBufferChanged

◆ bufferCommitted()

◆ bufferLockedChanged

◆ currentBuffer()

◆ currentDamage()

◆ discardCurrentBuffer()

◆ isBufferLocked()

◆ isPrimary()

◆ output()

◆ outputChanged

◆ renderObject()

◆ setAllowDiscardFrontBuffer()

◆ setBufferLocked()

◆ setOutput()

◆ setPrimary()

◆ setSurface()

◆ surface()

◆ surfaceChanged

◆ surfaceDestroyed

◆ surfaceResource()

Property Documentation

◆ allowDiscardFrontBuffer

◆ bufferLocked

◆ output

◆ renderObject

◆ surface