KWayland::Client::Shadow Class Reference

#include <shadow.h>

Inheritance diagram for KWayland::Client::Shadow:

Public Member Functions
void	attachBottom (wl_buffer *buffer)
void	attachBottom (Buffer *buffer)
void	attachBottom (Buffer::Ptr buffer)
void	attachBottomLeft (wl_buffer *buffer)
void	attachBottomLeft (Buffer *buffer)
void	attachBottomLeft (Buffer::Ptr buffer)
void	attachBottomRight (wl_buffer *buffer)
void	attachBottomRight (Buffer *buffer)
void	attachBottomRight (Buffer::Ptr buffer)
void	attachLeft (wl_buffer *buffer)
void	attachLeft (Buffer *buffer)
void	attachLeft (Buffer::Ptr buffer)
void	attachRight (wl_buffer *buffer)
void	attachRight (Buffer *buffer)
void	attachRight (Buffer::Ptr buffer)
void	attachTop (wl_buffer *buffer)
void	attachTop (Buffer *buffer)
void	attachTop (Buffer::Ptr buffer)
void	attachTopLeft (wl_buffer *buffer)
void	attachTopLeft (Buffer *buffer)
void	attachTopLeft (Buffer::Ptr buffer)
void	attachTopRight (wl_buffer *buffer)
void	attachTopRight (Buffer *buffer)
void	attachTopRight (Buffer::Ptr buffer)
void	commit ()
void	destroy ()
bool	isValid () const
	operator org_kde_kwin_shadow * ()
	operator org_kde_kwin_shadow * () const
void	release ()
void	setOffsets (const QMarginsF &margins)
void	setup (org_kde_kwin_shadow *shadow)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Wrapper for the org_kde_kwin_shadow interface.

This class is a convenient wrapper for the org_kde_kwin_shadow interface. To create a Shadow call Compositor::createShadow.

The main purpose of this class is to setup the next frame which should be rendered. Therefore it provides methods to add damage and to attach a new Buffer and to finalize the frame by calling commit.

See also

Compositor

Definition at line 165 of file shadow.h.

Member Function Documentation

void KWayland::Client::Shadow::destroy

(

)

Destroys the data held by this Shadow.

This method is supposed to be used when the connection to the Wayland server goes away. If the connection is not valid anymore, it's not possible to call release anymore as that calls into the Wayland connection and the call would fail. This method cleans up the data, so that the instance can be deleted or set up to a new org_kde_kwin_shadow interface once there is a new connection available.

It is suggested to connect this method to ConnectionThread::connectionDied:

connect(connection, &ConnectionThread::connectionDied, shadow, &Shadow::destroy);

See also

release

Definition at line 144 of file shadow.cpp.

bool KWayland::Client::Shadow::isValid

(

)

const

Returns

true if managing a org_kde_kwin_shadow.

Definition at line 149 of file shadow.cpp.

void KWayland::Client::Shadow::release

(

)

Releases the org_kde_kwin_shadow interface.

After the interface has been released the Shadow instance is no longer valid and can be setup with another org_kde_kwin_shadow interface.

Definition at line 132 of file shadow.cpp.

void KWayland::Client::Shadow::setup

(

org_kde_kwin_shadow *

shadow

)

Setup this Shadow to manage the shadow.

When using Compositor::createSurface there is no need to call this method.

Definition at line 137 of file shadow.cpp.

---

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

• shadow.h
• shadow.cpp