#include <qcocoabackingstore.h>

Inheritance diagram for QCALayerBackingStore:

Collaboration diagram for QCALayerBackingStore:

Public Member Functions
	QCALayerBackingStore (QWindow *window)

	~QCALayerBackingStore ()

void	resize (const QSize &size, const QRegion &staticContents) override

void	beginPaint (const QRegion &region) override
	This function is called before painting onto the surface begins, with the region in which the painting will occur.

QPaintDevice *	paintDevice () override
	Implement this function to return the appropriate paint device.

void	endPaint () override
	This function is called after painting onto the surface has ended.

bool	scroll (const QRegion &region, int dx, int dy) override
	Scrolls the given area dx pixels to the right and dy downward; both dx and dy may be negative.

void	flush (QWindow *, const QRegion &, const QPoint &) override
	Flushes the given region from the specified window.

FlushResult	rhiFlush (QWindow window, qreal sourceDevicePixelRatio, const QRegion &region, const QPoint &offset, QPlatformTextureList textures, bool translucentBackground) override
	Flushes the given region from the specified window, and compositing it with the specified textures list.

QImage	toImage () const override
	Implemented in subclasses to return the content of the backingstore as a QImage.

QPlatformGraphicsBuffer *	graphicsBuffer () const override
	Accessor for a backingstores graphics buffer abstraction.

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

Public Member Functions inherited from QPlatformBackingStore
	QPlatformBackingStore (QWindow *window)
	Constructs an empty surface for the given top-level window.

virtual	~QPlatformBackingStore ()
	Destroys this surface.

QWindow *	window () const
	Returns a pointer to the top-level window associated with this surface.

QBackingStore *	backingStore () const
	Returns a pointer to the backing store associated with this surface.

virtual QPaintDevice *	paintDevice ()=0
	Implement this function to return the appropriate paint device.

virtual void	flush (QWindow *window, const QRegion &region, const QPoint &offset)
	Flushes the given region from the specified window.

virtual FlushResult	rhiFlush (QWindow window, qreal sourceDevicePixelRatio, const QRegion &region, const QPoint &offset, QPlatformTextureList textures, bool translucentBackground)
	Flushes the given region from the specified window, and compositing it with the specified textures list.

virtual QImage	toImage () const
	Implemented in subclasses to return the content of the backingstore as a QImage.

virtual QRhiTexture *	toTexture (QRhiResourceUpdateBatch resourceUpdates, const QRegion &dirtyRegion, TextureFlags flags) const
	May be reimplemented in subclasses to return the content of the backingstore as an QRhiTexture.

virtual QPlatformGraphicsBuffer *	graphicsBuffer () const
	Accessor for a backingstores graphics buffer abstraction.

virtual void	resize (const QSize &size, const QRegion &staticContents)=0

virtual bool	scroll (const QRegion &area, int dx, int dy)
	Scrolls the given area dx pixels to the right and dy downward; both dx and dy may be negative.

virtual void	beginPaint (const QRegion &)
	This function is called before painting onto the surface begins, with the region in which the painting will occur.

virtual void	endPaint ()
	This function is called after painting onto the surface has ended.

void	setRhiConfig (const QPlatformBackingStoreRhiConfig &config)

QRhi *	rhi () const

QRhiSwapChain *	rhiSwapChain () const

void	surfaceAboutToBeDestroyed ()

void	graphicsDeviceReportedLost ()

Private Member Functions
bool	eventFilter (QObject watched, QEvent event) override
	Filters events if this object has been installed as an event filter for the watched object.

Additional Inherited Members
Public Types inherited from QPlatformBackingStore
enum	FlushResult { FlushSuccess , FlushFailed , FlushFailedDueToLostDevice }

enum	TextureFlag { TextureSwizzle = 0x01 , TextureFlip = 0x02 , TexturePremultiplied = 0x04 }

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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.

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 Member Functions inherited from QCocoaBackingStore
	QCocoaBackingStore (QWindow *window)

QCFType< CGColorSpaceRef >	colorSpace () const

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

Definition at line 25 of file qcocoabackingstore.h.

Constructor & Destructor Documentation

◆ QCALayerBackingStore()

QCALayerBackingStore::QCALayerBackingStore ( QWindow * window )

Definition at line 32 of file qcocoabackingstore.mm.

References QWindow::format(), QObject::installEventFilter(), qCDebug, and QPlatformBackingStore::window().

Here is the call graph for this function:

◆ ~QCALayerBackingStore()

QCALayerBackingStore::~QCALayerBackingStore ( )

Definition at line 44 of file qcocoabackingstore.mm.

Member Function Documentation

◆ beginPaint()

void QCALayerBackingStore::beginPaint ( const QRegion & )

overridevirtual

This function is called before painting onto the surface begins, with the region in which the painting will occur.

See also: endPaint(), paintDevice()

Reimplemented from QPlatformBackingStore.

Definition at line 83 of file qcocoabackingstore.mm.

References QPainter::CompositionMode_Source, QPainter::fillRect(), hasAlpha(), painter, pool, Q_UNUSED, qCDebug, qCInfo, rect, QPainter::setCompositionMode(), QPlatformGraphicsBuffer::SWWriteAccess, Qt::transparent, and QPlatformBackingStore::window().

Here is the call graph for this function:

◆ endPaint()

void QCALayerBackingStore::endPaint ( )

overridevirtual

This function is called after painting onto the surface has ended.

See also: beginPaint(), paintDevice()

Reimplemented from QPlatformBackingStore.

Definition at line 209 of file qcocoabackingstore.mm.

References qCInfo.

◆ eventFilter()

bool QCALayerBackingStore::eventFilter	(	QObject *	watched,
		QEvent *	event
	)

overrideprivatevirtual

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
    MainWindow();
 
protected:
    bool eventFilter(QObject *obj, QEvent *ev) override;
 
private:
    QTextEdit *textEdit;
};
 
MainWindow::MainWindow()
{
    textEdit = new QTextEdit;
    setCentralWidget(textEdit);
 
    textEdit->installEventFilter(this);
}
 
bool MainWindow::eventFilter(QObject *obj, QEvent *event)
{
    if (obj == textEdit) {
        if (event->type() == QEvent::KeyPress) {
            QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
            qDebug() << "Ate key press" << keyEvent->key();
            return true;
        } else {
            return false;
        }
    } else {
        // pass the event on to the parent class
        return QMainWindow::eventFilter(obj, event);
    }
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.

Warning: If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.

See also: installEventFilter()

Reimplemented from QObject.

Definition at line 58 of file qcocoabackingstore.mm.

References QEvent::PlatformSurface, Q_ASSERT, QPlatformSurfaceEvent::SurfaceCreated, and QPlatformBackingStore::window().

Here is the call graph for this function:

◆ flush()

void QCALayerBackingStore::flush	(	QWindow *	window,
		const QRegion &	region,
		const QPoint &	offset
	)

overridevirtual

Flushes the given region from the specified window.

Note: region is relative to the window which may not be top-level in case window corresponds to a native child widget. offset is the position of the native child relative to the top-level window.

Unlike rhiFlush(), this function's default implementation does nothing. It is expected that subclasses provide a platform-specific (non-QRhi-based) implementation, if applicable on the given platform.

See also: rhiFlush()

Reimplemented from QPlatformBackingStore.

Definition at line 275 of file qcocoabackingstore.mm.

References QWindow::format(), pool, Q_UNUSED, qCInfo, qCWarning, QSurfaceFormat::SingleBuffer, QSurfaceFormat::swapBehavior(), view, and QPlatformBackingStore::window().

Here is the call graph for this function:

◆ graphicsBuffer()

QPlatformGraphicsBuffer * QCALayerBackingStore::graphicsBuffer ( ) const

overridevirtual

Accessor for a backingstores graphics buffer abstraction.

Reimplemented from QPlatformBackingStore.

Definition at line 450 of file qcocoabackingstore.mm.

◆ paintDevice()

QPaintDevice * QCALayerBackingStore::paintDevice ( )

overridevirtual

Implement this function to return the appropriate paint device.

Implements QPlatformBackingStore.

Definition at line 203 of file qcocoabackingstore.mm.

References Q_ASSERT.

◆ resize()

void QCALayerBackingStore::resize	(	const QSize &	size,
		const QRegion &	staticContents
	)

overridevirtual

Implements QPlatformBackingStore.

Definition at line 73 of file qcocoabackingstore.mm.

References QRegion::isNull(), qCDebug, and qCWarning.

Here is the call graph for this function:

◆ rhiFlush()

QPlatformBackingStore::FlushResult QCALayerBackingStore::rhiFlush	(	QWindow *	window,
		qreal	sourceDevicePixelRatio,
		const QRegion &	region,
		const QPoint &	offset,
		QPlatformTextureList *	textures,
		bool	translucentBackground
	)

overridevirtual

Flushes the given region from the specified window, and compositing it with the specified textures list.

The default implementation retrieves the contents using toTexture() and composes using QRhi with OpenGL, Metal, Vulkan, or Direct 3D underneath. May be reimplemented in subclasses if customization is desired.

Note: region is relative to the window which may not be top-level in case window corresponds to a native child widget. offset is the position of the native child relative to the top-level window.

See also: flush()

Reimplemented from QPlatformBackingStore.

Definition at line 398 of file qcocoabackingstore.mm.

References QPlatformBackingStore::FlushFailed, qCWarning, QPlatformBackingStore::rhiFlush(), and QPlatformBackingStore::window().

Here is the call graph for this function:

◆ scroll()

bool QCALayerBackingStore::scroll	(	const QRegion &	area,
		int	dx,
		int	dy
	)

overridevirtual

Scrolls the given area dx pixels to the right and dy downward; both dx and dy may be negative.

Returns true if the area was scrolled successfully; false otherwise.

Reimplemented from QPlatformBackingStore.

Definition at line 218 of file qcocoabackingstore.mm.

References QRegion::boundingRect(), QImage::devicePixelRatio(), QRegion::isEmpty(), pool, qCDebug, qCInfo, qt_scrollRectInImage(), QRect::size(), QPlatformGraphicsBuffer::SWWriteAccess, QRect::topLeft(), and QRegion::translated().

Here is the call graph for this function:

◆ toImage()

QImage QCALayerBackingStore::toImage ( ) const

overridevirtual

Implemented in subclasses to return the content of the backingstore as a QImage.

If composition via a 3D graphics API is supported, either this function or toTexture() must be implemented.

The returned image is only valid until the next operation (resize, paint, scroll, or flush) on the backingstore. The caller must not store the return value between calls, but instead call this function before each use, or make an explicit copy.

See also: toTexture()

Reimplemented from QPlatformBackingStore.

Definition at line 415 of file qcocoabackingstore.mm.

References QPlatformGraphicsBuffer::SWReadAccess.

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

qtbase/src/plugins/platforms/cocoa/qcocoabackingstore.h
qtbase/src/plugins/platforms/cocoa/qcocoabackingstore.mm

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QCALayerBackingStore()

◆ ~QCALayerBackingStore()

Member Function Documentation

◆ beginPaint()

◆ endPaint()

◆ eventFilter()

◆ flush()

◆ graphicsBuffer()

◆ paintDevice()

◆ resize()

◆ rhiFlush()

◆ scroll()

◆ toImage()