#include <qwaylandquicksurface.h>

Inheritance diagram for QWaylandQuickSurface:

Collaboration diagram for QWaylandQuickSurface:

Signals
void	useTextureAlphaChanged ()

Signals inherited from QWaylandSurface
void	hasContentChanged ()

void	damaged (const QRegion &rect)

void	parentChanged (QWaylandSurface newParent, QWaylandSurface oldParent)

void	childAdded (QWaylandSurface *child)
	\qmlsignal QtWayland.Compositor::WaylandSurface::childAdded(WaylandSurface child)

	Q_REVISION (1, 13) void sourceGeometryChanged()

	Q_REVISION (1, 13) void destinationSizeChanged()

	Q_REVISION (1, 13) void bufferSizeChanged()

void	bufferScaleChanged ()

void	offsetForNextFrame (const QPoint &offset)

void	contentOrientationChanged ()

void	surfaceDestroyed ()
	\qmlsignal QtWayland.Compositor::WaylandSurface::surfaceDestroyed()

void	originChanged ()

void	subsurfacePositionChanged (const QPoint &position)

void	subsurfacePlaceAbove (QWaylandSurface *sibling)

void	subsurfacePlaceBelow (QWaylandSurface *sibling)

void	dragStarted (QWaylandDrag *drag)
	\qmlsignal void QtWayland.Compositor::WaylandSurface::dragStarted(WaylandDrag drag)

void	cursorSurfaceChanged ()

	Q_REVISION (14) void inhibitsIdleChanged()

	Q_REVISION (6, 4) void isOpaqueChanged()

void	configure (bool hasBuffer)

void	redraw ()

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
	QWaylandQuickSurface ()

	QWaylandQuickSurface (QWaylandCompositor compositor, QWaylandClient client, quint32 id, int version)

	~QWaylandQuickSurface () override

bool	useTextureAlpha () const
	\qmlproperty bool QtWayland.Compositor::WaylandSurface::useTextureAlpha

void	setUseTextureAlpha (bool useTextureAlpha)

Public Member Functions inherited from QWaylandSurface
	QWaylandSurface ()
	Constructs a an uninitialized QWaylandSurface.

	QWaylandSurface (QWaylandCompositor compositor, QWaylandClient client, uint id, int version)
	Constructs and initializes a QWaylandSurface for the given compositor and client, and with the given id and version.

	~QWaylandSurface () override
	Destroys the QWaylandSurface.

Q_INVOKABLE void	initialize (QWaylandCompositor compositor, QWaylandClient client, uint id, int version)
	\qmlmethod void QtWayland.Compositor::WaylandSurface::initialize(WaylandCompositor compositor, WaylandClient client, int id, int version)

bool	isInitialized () const
	Returns true if the QWaylandSurface has been initialized.

QWaylandClient *	client () const

::wl_client *	waylandClient () const
	Holds the `wl_client` using this QWaylandSurface.

bool	setRole (QWaylandSurfaceRole role, wl_resource errorResource, uint32_t errorCode)
	Sets a role on the surface.

QWaylandSurfaceRole *	role () const

bool	hasContent () const

QRectF	sourceGeometry () const

QSize	destinationSize () const

QSize	bufferSize () const

int	bufferScale () const

Qt::ScreenOrientation	contentOrientation () const

Origin	origin () const

QWaylandCompositor *	compositor () const
	Returns the compositor for this QWaylandSurface.

bool	inputRegionContains (const QPoint &p) const
	Returns `true` if the QWaylandSurface's input region contains the point p.

bool	inputRegionContains (const QPointF &position) const
	Returns `true` if the QWaylandSurface's input region contains the point position.

Q_INVOKABLE void	destroy ()
	\qmlmethod void QtWayland.Compositor::WaylandSurface::destroy()

Q_INVOKABLE bool	isDestroyed () const
	\qmlmethod bool QtWayland.Compositor::WaylandSurface::isDestroyed()

Q_INVOKABLE void	frameStarted ()
	Prepares all frame callbacks for sending.

Q_INVOKABLE void	sendFrameCallbacks ()
	Sends pending frame callbacks.

QWaylandView *	primaryView () const
	Updates the surface with the compositor's retained clipboard selection.

void	setPrimaryView (QWaylandView *view)
	Sets this QWaylandSurface's primary view to view, in case there are multiple views of this surface.

QList< QWaylandView * >	views () const
	Returns the views for this QWaylandSurface.

struct wl_resource *	resource () const
	Returns the Wayland resource corresponding to this QWaylandSurface.

void	markAsCursorSurface (bool cursorSurface)

bool	isCursorSurface () const

bool	inhibitsIdle () const

bool	isOpaque () const

Public Member Functions inherited from QWaylandObject
	~QWaylandObject () override

QWaylandCompositorExtension *	extension (const QByteArray &name)
	Returns the compositor extension which matches name if one has been registered with the QWaylandObject.

QWaylandCompositorExtension *	extension (const wl_interface *interface)
	Returns the compositor extension which matches interface if one has been registered with the QWaylandObject.

QList< QWaylandCompositorExtension * >	extensions () const
	Returns the list of compositor extensions that have been registered with this QWaylandObject.

void	addExtension (QWaylandCompositorExtension *extension)
	Registers extension with this QWaylandObject.

void	removeExtension (QWaylandCompositorExtension *extension)
	Removes extension from the list of registered extensions in this QWaylandObject, if it has previously been registered using \l{addExtension()}.

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.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

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

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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`.

Protected Member Functions
	QWaylandQuickSurface (QWaylandQuickSurfacePrivate &dptr)

Protected Member Functions inherited from QWaylandSurface
	QWaylandSurface (QWaylandSurfacePrivate &dptr)

Protected Member Functions inherited from QWaylandObject
	QWaylandObject (QObject *parent=nullptr)
	Creates a QWaylandObject as a child of parent.

	QWaylandObject (QObjectPrivate &d, 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)

Properties
bool	useTextureAlpha

Properties inherited from QWaylandSurface
QWaylandClient *	client
	\qmlproperty WaylandClient QtWayland.Compositor::WaylandSurface::client

QRectF	sourceGeometry
	\qmlproperty rect QtWayland.Compositor::WaylandSurface::sourceGeometry

QSize	destinationSize
	\qmlproperty size QtWayland.Compositor::WaylandSurface::destinationSize

QSize	bufferSize
	\qmlproperty size QtWayland.Compositor::WaylandSurface::bufferSize

int	bufferScale
	\qmlproperty size QtWayland.Compositor::WaylandSurface::bufferScale

Qt::ScreenOrientation	contentOrientation
	\qmlproperty enum QtWayland.Compositor::WaylandSurface::contentOrientation

QWaylandSurface::Origin	origin
	\qmlproperty enum QtWayland.Compositor::WaylandSurface::origin

bool	hasContent
	\qmlproperty bool QtWayland.Compositor::WaylandSurface::hasContent

bool	cursorSurface
	\qmlproperty bool QtWayland.Compositor::WaylandSurface::cursorSurface

bool	inhibitsIdle
	\qmlproperty bool QtWayland.Compositor::WaylandSurface::inhibitsIdle

bool	isOpaque
	\qmlproperty bool QtWayland.Compositor::WaylandSurface::isOpaque

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Types inherited from QWaylandSurface
enum	Origin { OriginTopLeft , OriginBottomLeft }
	This enum type is used to specify the origin of a QWaylandSurface's buffer. More...

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QWaylandSurface
static QWaylandSurface *	fromResource (::wl_resource *resource)
	Returns the QWaylandSurface corresponding to the Wayland resource resource.

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 Attributes inherited from QWaylandObject
QList< QWaylandCompositorExtension * >	extension_vector

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 19 of file qwaylandquicksurface.h.

Constructor & Destructor Documentation

◆ QWaylandQuickSurface() [1/3]

QT_BEGIN_NAMESPACE QWaylandQuickSurface::QWaylandQuickSurface ( )

Definition at line 18 of file qwaylandquicksurface.cpp.

◆ QWaylandQuickSurface() [2/3]

QWaylandQuickSurface::QWaylandQuickSurface	(	QWaylandCompositor *	compositor,
		QWaylandClient *	client,
		quint32	id,
		int	version
	)

Definition at line 23 of file qwaylandquicksurface.cpp.

References QWaylandSurface::client, QWaylandSurface::compositor(), and initialize().

Here is the call graph for this function:

◆ ~QWaylandQuickSurface()

QWaylandQuickSurface::~QWaylandQuickSurface ( )

override

Definition at line 34 of file qwaylandquicksurface.cpp.

◆ QWaylandQuickSurface() [3/3]

QWaylandQuickSurface::QWaylandQuickSurface ( QWaylandQuickSurfacePrivate & dptr )

protected

Definition at line 29 of file qwaylandquicksurface.cpp.

Member Function Documentation

◆ setUseTextureAlpha()

void QWaylandQuickSurface::setUseTextureAlpha ( bool useTextureAlpha )

Definition at line 50 of file qwaylandquicksurface.cpp.

References QWaylandSurface::configure(), d, emit, useTextureAlpha, and useTextureAlphaChanged().

Here is the call graph for this function:

◆ useTextureAlpha()

bool QWaylandQuickSurface::useTextureAlpha ( ) const

\qmlproperty bool QtWayland.Compositor::WaylandSurface::useTextureAlpha

This property specifies whether the surface should use texture alpha.

Definition at line 44 of file qwaylandquicksurface.cpp.

References d.

◆ useTextureAlphaChanged

void QWaylandQuickSurface::useTextureAlphaChanged ( )

signal

Referenced by setUseTextureAlpha().

Here is the caller graph for this function:

Property Documentation

◆ useTextureAlpha

bool QWaylandQuickSurface::useTextureAlpha

readwrite

Definition at line 42 of file qwaylandquicksurface.h.

Referenced by QWaylandSurfaceTextureProvider::setBufferRef(), and setUseTextureAlpha().

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

qtwayland/src/compositor/compositor_api/qwaylandquicksurface.h
qtwayland/src/compositor/compositor_api/qwaylandquicksurface.cpp

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members