The QPlatformGraphicsBuffer is a windowsystem abstraction for native graphics buffers. More...

#include <qplatformgraphicsbuffer.h>

Inheritance diagram for QPlatformGraphicsBuffer:

Collaboration diagram for QPlatformGraphicsBuffer:

Public Types
enum	AccessType { None = 0x00 , SWReadAccess = 0x01 , SWWriteAccess = 0x02 , TextureAccess = 0x04 , HWCompositor = 0x08 }

enum	Origin { OriginBottomLeft , OriginTopLeft }

Signals
void	unlocked (AccessTypes previousAccessTypes)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Public Member Functions
	Q_ENUM (AccessType)

	Q_DECLARE_FLAGS (AccessTypes, AccessType)

	Q_ENUM (Origin)

	~QPlatformGraphicsBuffer ()

AccessTypes	isLocked () const

bool	lock (AccessTypes access, const QRect &rect=QRect())

void	unlock ()

virtual bool	bindToTexture (const QRect &rect=QRect()) const

virtual const uchar *	data () const

virtual uchar *	data ()

virtual int	bytesPerLine () const

int	byteCount () const

virtual Origin	origin () const

QSize	size () const

QPixelFormat	format () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	event (QEvent *event)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Protected Member Functions
	QPlatformGraphicsBuffer (const QSize &size, const QPixelFormat &format)

virtual bool	doLock (AccessTypes access, const QRect &rect=QRect())=0

virtual void	doUnlock ()=0

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

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

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)

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::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::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 QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object More...

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

The QPlatformGraphicsBuffer is a windowsystem abstraction for native graphics buffers.

\inmodule QtGui

Since: 5.5

Different platforms have different ways of representing graphics buffers. On some platforms, it is possible to create one graphics buffer that you can bind to a texture and also get main memory access to the image bits. On the other hand, on some platforms all graphics buffer abstraction is completely hidden.

QPlatformGraphicsBuffer is an abstraction of a single Graphics Buffer.

There is no public constructor nor any public factory function.

Definition at line 62 of file qplatformgraphicsbuffer.h.

Member Enumeration Documentation

◆ AccessType

enum QPlatformGraphicsBuffer::AccessType

This enum describes the access that is desired or granted for the graphics buffer.

\value None \value SWReadAccess \value SWWriteAccess \value TextureAccess \value HWCompositor

Enumerator
None
SWReadAccess
SWWriteAccess
TextureAccess
HWCompositor

Definition at line 66 of file qplatformgraphicsbuffer.h.

◆ Origin

enum QPlatformGraphicsBuffer::Origin

This enum describes the origin of the content of the buffer.

\value OriginTopLeft \value OriginBottomLeft

Enumerator
OriginBottomLeft
OriginTopLeft

Definition at line 77 of file qplatformgraphicsbuffer.h.

Constructor & Destructor Documentation

◆ ~QPlatformGraphicsBuffer()

QPlatformGraphicsBuffer::~QPlatformGraphicsBuffer ( )

Virtual destructor.

Definition at line 106 of file qplatformgraphicsbuffer.cpp.

◆ QPlatformGraphicsBuffer()

QPlatformGraphicsBuffer::QPlatformGraphicsBuffer	(	const QSize &	size,
		const QPixelFormat &	format
	)

protected

Protected constructor to initialize the private members.

size is the size of the buffer. format is the format of the buffer.

See also: size() format()

Definition at line 96 of file qplatformgraphicsbuffer.cpp.

Member Function Documentation

◆ bindToTexture()

bool QPlatformGraphicsBuffer::bindToTexture ( const QRect & rect = QRect() ) const

virtual

Binds the content of this graphics buffer into the currently bound texture.

This function should fail for buffers not capable of locking to TextureAccess.

rect is the subrect which is desired to be bounded to the texture. This argument has a no less than semantic, meaning more (if not all) of the buffer can be bounded to the texture. An empty QRect is interpreted as entire buffer should be bound.

This function only supports binding buffers to the GL_TEXTURE_2D texture target.

Returns true on success, otherwise false.

Definition at line 125 of file qplatformgraphicsbuffer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ byteCount()

int QPlatformGraphicsBuffer::byteCount ( ) const

Accessor for the length of the data buffer. This function is a convenience function multiplying height of buffer with bytesPerLine().

See also: data() bytesPerLine() size()

Definition at line 234 of file qplatformgraphicsbuffer.cpp.

Here is the call graph for this function:

◆ bytesPerLine()

int QPlatformGraphicsBuffer::bytesPerLine ( ) const

virtual

Accessor for bytes per line in the graphics buffer.

Reimplemented in QXcbGraphicsBuffer, and QIOSurfaceGraphicsBuffer.

Definition at line 242 of file qplatformgraphicsbuffer.cpp.

Here is the caller graph for this function:

◆ data() [1/2]

uchar * QPlatformGraphicsBuffer::data ( )

virtual

Accessor for the bytes of the buffer. This function needs to be called on a buffer with SWReadAccess access lock. Behavior is undefined for modifying the memory returned when not having a SWWriteAccess.

Reimplemented in QXcbGraphicsBuffer, and QIOSurfaceGraphicsBuffer.

Definition at line 223 of file qplatformgraphicsbuffer.cpp.

Here is the caller graph for this function:

◆ data() [2/2]

const uchar * QPlatformGraphicsBuffer::data ( ) const

virtual

Accessor for the bytes of the buffer. This function needs to be called on a buffer with SWReadAccess access lock. Behavior is undefined for modifying the memory returned when not having a SWWriteAccess.

Reimplemented in QXcbGraphicsBuffer, and QIOSurfaceGraphicsBuffer.

Definition at line 215 of file qplatformgraphicsbuffer.cpp.

Here is the caller graph for this function:

◆ doLock()

QPlatformGraphicsBuffer::doLock	(	AccessTypes	access,
		const QRect &	rect = `QRect()`
	)

protectedpure virtual

This function should be reimplemented by subclasses. If one of the access types specified cannot be locked, then all should fail and this function should return false.

rect is the subrect which is desired to be locked. This argument has a no less than semantic, meaning more (if not all) of the buffer can be locked. An empty QRect should be interpreted as the entire buffer should be locked.

It is safe to call isLocked() to verify the current lock state.

Implemented in QXcbGraphicsBuffer, and QIOSurfaceGraphicsBuffer.

Here is the caller graph for this function:

◆ doUnlock()

QPlatformGraphicsBuffer::doUnlock ( )

protectedpure virtual

This function should remove all locks set on the buffer.

It is safe to call isLocked() to verify the current lock state.

Implemented in QXcbGraphicsBuffer, and QIOSurfaceGraphicsBuffer.

Here is the caller graph for this function:

◆ format()

QPlatformGraphicsBuffer::format ( ) const

inline

Accessor for the pixel format of the buffer.

Definition at line 99 of file qplatformgraphicsbuffer.h.

Here is the caller graph for this function:

◆ isLocked()

QPlatformGraphicsBuffer::AccessTypes QPlatformGraphicsBuffer::isLocked ( ) const

inline

Function to check if the buffer is locked.

See also: lock()

Definition at line 85 of file qplatformgraphicsbuffer.h.

Here is the caller graph for this function:

◆ lock()

bool QPlatformGraphicsBuffer::lock	(	AccessTypes	access,
		const QRect &	rect = `QRect()`
	)

Before the data can be retrieved or before a buffer can be bound to a texture it needs to be locked. This is a separate function call since this operation might be time consuming, and it would not be satisfactory to do it per function call.

access is the access type wanted.

rect is the subrect which is desired to be locked. This argument has a no less than semantic, meaning more (if not all) of the buffer can be locked. An empty QRect is interpreted as entire buffer should be locked.

Return true on successfully locking all AccessTypes specified access otherwise returns false and no locks have been granted.

Definition at line 153 of file qplatformgraphicsbuffer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ origin()

QPlatformGraphicsBuffer::Origin QPlatformGraphicsBuffer::origin ( ) const

virtual

In origin of the content of the graphics buffer.

Default implementation is OriginTopLeft, as this is the coordinate system default for Qt. However, for most regular OpenGL textures this will be OriginBottomLeft.

Reimplemented in QXcbGraphicsBuffer.

Definition at line 255 of file qplatformgraphicsbuffer.cpp.

◆ Q_DECLARE_FLAGS()

QPlatformGraphicsBuffer::Q_DECLARE_FLAGS	(	AccessTypes	,
		AccessType
	)

◆ Q_ENUM() [1/2]

QPlatformGraphicsBuffer::Q_ENUM ( AccessType )

◆ Q_ENUM() [2/2]

QPlatformGraphicsBuffer::Q_ENUM ( Origin )

◆ size()

QPlatformGraphicsBuffer::size ( ) const

inline

Accessor for content size.

Definition at line 98 of file qplatformgraphicsbuffer.h.

Here is the caller graph for this function:

◆ unlock()

void QPlatformGraphicsBuffer::unlock ( )

Unlocks the current buffer lock.

This function calls doUnlock, and then emits the unlocked signal with the AccessTypes from before doUnlock was called.

Definition at line 168 of file qplatformgraphicsbuffer.cpp.

Here is the call graph for this function:

◆ unlocked

QPlatformGraphicsBuffer::unlocked ( AccessTypes previousAccessTypes )

signal

Signal that is emitted after unlocked has been called.

previousAccessTypes is the access types locked before unlock was called.

Here is the caller graph for this function:

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

src/gui/kernel/qplatformgraphicsbuffer.h
src/gui/kernel/qplatformgraphicsbuffer.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AccessType

◆ Origin

Constructor & Destructor Documentation

◆ ~QPlatformGraphicsBuffer()

◆ QPlatformGraphicsBuffer()

Member Function Documentation

◆ bindToTexture()

◆ byteCount()

◆ bytesPerLine()

◆ data() [1/2]

◆ data() [2/2]

◆ doLock()

◆ doUnlock()

◆ format()

◆ isLocked()

◆ lock()

◆ origin()

◆ Q_DECLARE_FLAGS()

◆ Q_ENUM() [1/2]

◆ Q_ENUM() [2/2]

◆ size()

◆ unlock()

◆ unlocked