A generic OpenGL-based compositor. More...

#include <qopenglcompositor_p.h>

Inheritance diagram for QOpenGLCompositor:

Collaboration diagram for QOpenGLCompositor:

Public Types
enum	GrabOrientation { Flipped , NotFlipped }

Signals
void	topWindowChanged (QOpenGLCompositorWindow *window)

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
void	setTargetWindow (QWindow *window, const QRect &nativeTargetGeometry)

void	setTargetContext (QOpenGLContext *context)

void	setRotation (int degrees)

QOpenGLContext *	context () const

QWindow *	targetWindow () const

QRect	nativeTargetGeometry () const

void	update ()

QImage	grab ()

bool	grabToFrameBufferObject (QOpenGLFramebufferObject *fbo, GrabOrientation orientation=Flipped)

QList< QOpenGLCompositorWindow * >	windows () const

void	addWindow (QOpenGLCompositorWindow *window)

void	removeWindow (QOpenGLCompositorWindow *window)

void	moveToTop (QOpenGLCompositorWindow *window)

void	changeWindowIndex (QOpenGLCompositorWindow *window, int newIdx)

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

Static Public Member Functions
static QOpenGLCompositor *	instance ()

static void	destroy ()

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)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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

Properties inherited from QObject
QString	objectName
	the name of this object

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

A generic OpenGL-based compositor.

Since: 5.4

This class provides a lightweight compositor that maintains the basic stacking order of windows and composites them by drawing textured quads via OpenGL.

It it meant to be used by platform plugins that run without a windowing system.

It is up to the platform plugin to manage the lifetime of the compositor (instance(), destroy()), set the correct destination context and window as early as possible (setTarget()), register the composited windows as they are shown, activated, raised and lowered (addWindow(), moveToTop(), etc.), and to schedule repaints (update()).

Note: To get support for QWidget-based windows, just use QOpenGLCompositorBackingStore. It will automatically create textures from the raster-rendered content and trigger the necessary repaints.

Definition at line 45 of file qopenglcompositor_p.h.

Member Enumeration Documentation

◆ GrabOrientation

enum QOpenGLCompositor::GrabOrientation

Enumerator
Flipped
NotFlipped

Definition at line 50 of file qopenglcompositor_p.h.

Member Function Documentation

◆ addWindow()

void QOpenGLCompositor::addWindow ( QOpenGLCompositorWindow * window )

Definition at line 264 of file qopenglcompositor.cpp.

References QList< T >::append(), QList< T >::constLast(), QListSpecialMethodsBase< T >::contains(), emit, topWindowChanged(), and window().

Here is the call graph for this function:

◆ changeWindowIndex()

void QOpenGLCompositor::changeWindowIndex	(	QOpenGLCompositorWindow *	window,
		int	newIdx )

Definition at line 296 of file qopenglcompositor.cpp.

References QList< T >::constLast(), emit, QListSpecialMethodsBase< T >::indexOf(), QList< T >::last(), QList< T >::move(), topWindowChanged(), and window().

Here is the call graph for this function:

◆ context()

QOpenGLContext * QOpenGLCompositor::context ( ) const

inline

Definition at line 61 of file qopenglcompositor_p.h.

Referenced by setTargetContext().

Here is the caller graph for this function:

◆ destroy()

void QOpenGLCompositor::destroy ( )

static

Definition at line 258 of file qopenglcompositor.cpp.

References compositor.

Referenced by QEglFSWindow::destroy().

Here is the caller graph for this function:

◆ grab()

QImage QOpenGLCompositor::grab ( )

Definition at line 85 of file qopenglcompositor.cpp.

References grabToFrameBufferObject(), Q_ASSERT, QRect::size(), and QOpenGLFramebufferObject::toImage().

Here is the call graph for this function:

◆ grabToFrameBufferObject()

bool QOpenGLCompositor::grabToFrameBufferObject	(	QOpenGLFramebufferObject *	fbo,
		GrabOrientation	orientation = Flipped )

Definition at line 93 of file qopenglcompositor.cpp.

References Flipped, QOpenGLFramebufferObject::format(), QOpenGLContext::makeCurrent(), QOpenGLTextureBlitter::OriginBottomLeft, QOpenGLTextureBlitter::OriginTopLeft, Q_ASSERT, QOpenGLFramebufferObject::size(), QRect::size(), and QOpenGLFramebufferObjectFormat::textureTarget().

Referenced by grab().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ instance()

QOpenGLCompositor * QOpenGLCompositor::instance ( )

static

Definition at line 251 of file qopenglcompositor.cpp.

References compositor.

Referenced by QEglFSWindow::create(), QEglFSWindow::destroy(), QOpenGLCompositorBackingStore::flush(), QEglfsScreenCapture::Grabber::grabFrame(), QEglFSScreen::grabWindow(), QEglFSScreen::handleCursorMove(), QEglFSWindow::lower(), QEglFSWindow::raise(), QEglFSWindow::requestActivateWindow(), QOpenGLCompositorBackingStore::resize(), QOpenGLCompositorBackingStore::rhiFlush(), QEglFSWindow::setBackingStore(), setCurrentOpenGLContext(), QEglFSWindow::setVisible(), and QEglFSScreen::topLevelAt().

Here is the caller graph for this function:

◆ moveToTop()

void QOpenGLCompositor::moveToTop ( QOpenGLCompositorWindow * window )

Definition at line 281 of file qopenglcompositor.cpp.

References QList< T >::append(), QList< T >::constLast(), emit, QList< T >::isEmpty(), QList< T >::removeOne(), topWindowChanged(), and window().

Here is the call graph for this function:

◆ nativeTargetGeometry()

QRect QOpenGLCompositor::nativeTargetGeometry ( ) const

inline

Definition at line 63 of file qopenglcompositor_p.h.

Referenced by setTargetWindow().

Here is the caller graph for this function:

◆ removeWindow()

void QOpenGLCompositor::removeWindow ( QOpenGLCompositorWindow * window )

Definition at line 274 of file qopenglcompositor.cpp.

References emit, QList< T >::isEmpty(), QList< T >::last(), QList< T >::removeOne(), topWindowChanged(), and window().

Here is the call graph for this function:

◆ setRotation()

void QOpenGLCompositor::setRotation ( int degrees )

Definition at line 72 of file qopenglcompositor.cpp.

References QMatrix4x4::rotate(), and QMatrix4x4::setToIdentity().

Here is the call graph for this function:

◆ setTargetContext()

void QOpenGLCompositor::setTargetContext ( QOpenGLContext * context )

Definition at line 67 of file qopenglcompositor.cpp.

References context().

Here is the call graph for this function:

◆ setTargetWindow()

void QOpenGLCompositor::setTargetWindow	(	QWindow *	window,
		const QRect &	nativeTargetGeometry )

Definition at line 61 of file qopenglcompositor.cpp.

References nativeTargetGeometry(), and targetWindow().

Here is the call graph for this function:

◆ targetWindow()

QWindow * QOpenGLCompositor::targetWindow ( ) const

inline

Definition at line 62 of file qopenglcompositor_p.h.

Referenced by setTargetWindow().

Here is the caller graph for this function:

◆ topWindowChanged

void QOpenGLCompositor::topWindowChanged ( QOpenGLCompositorWindow * window )

signal

Referenced by addWindow(), changeWindowIndex(), moveToTop(), and removeWindow().

Here is the caller graph for this function:

◆ update()

void QOpenGLCompositor::update ( )

Definition at line 79 of file qopenglcompositor.cpp.

References QTimer::isActive(), and QTimer::start().

Here is the call graph for this function:

◆ windows()

QList< QOpenGLCompositorWindow * > QOpenGLCompositor::windows ( ) const

inline

Definition at line 70 of file qopenglcompositor_p.h.

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

qtbase/src/opengl/qopenglcompositor_p.h (342ae435a198acdd794e575dc54ccab1d33b320b)
qtbase/src/opengl/qopenglcompositor.cpp (342ae435a198acdd794e575dc54ccab1d33b320b)

Public Types

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GrabOrientation

Member Function Documentation

◆ addWindow()

◆ changeWindowIndex()

◆ context()

◆ destroy()

◆ grab()

◆ grabToFrameBufferObject()

◆ instance()

◆ moveToTop()

◆ nativeTargetGeometry()

◆ removeWindow()

◆ setRotation()

◆ setTargetContext()

◆ setTargetWindow()

◆ targetWindow()

◆ topWindowChanged

◆ update()

◆ windows()