QWaylandView Class

The QWaylandView class represents a view of a surface on an output. More...

Header:	#include <QWaylandView>
qmake:	QT += waylandcompositor
Since:	Qt 5.8
Inherits:	QObject

This class was introduced in Qt 5.8.

• List of all members, including inherited members

Properties

• allowDiscardFrontBuffer : bool
• bufferLocked : bool
• output : QWaylandOutput*
• surface : QWaylandSurface*

Public Functions

	QWaylandView(QObject *renderObject = nullptr, QObject *parent = nullptr)
virtual	~QWaylandView() override
virtual bool	advance()
bool	allowDiscardFrontBuffer() const
virtual void	bufferCommitted(const QWaylandBufferRef &buffer, const QRegion &damage)
virtual QWaylandBufferRef	currentBuffer()
virtual QRegion	currentDamage()
virtual void	discardCurrentBuffer()
bool	isBufferLocked() const
bool	isPrimary() const
QWaylandOutput *	output() const
void	setAllowDiscardFrontBuffer(bool discard)
void	setBufferLocked(bool locked)
void	setOutput(QWaylandOutput *output)
void	setPrimary()
void	setSurface(QWaylandSurface *surface)
QWaylandSurface *	surface() const
struct wl_resource *	surfaceResource() const

Signals

void	allowDiscardFrontBufferChanged()
void	bufferLockedChanged()
void	outputChanged()
void	surfaceChanged()

Detailed Description

The QWaylandView corresponds to the presentation of a surface on a specific output, managing the buffers that contain the contents to be rendered. You can have several views into the same surface.

Member Function Documentation

QWaylandView::QWaylandView(QObject *renderObject = nullptr, QObject *parent = nullptr)

Constructs a QWaylandView with the given renderObject and parent.

[override virtual] QWaylandView::~QWaylandView()

Destroys the QWaylandView.

[virtual] bool QWaylandView::advance()

Updates the current buffer and damage region to the latest version committed by the client. Returns true if new content was committed since the previous call to advance(). Otherwise returns false.

See also currentBuffer() and currentDamage().

[virtual] void QWaylandView::bufferCommitted(const QWaylandBufferRef &buffer, const QRegion &damage)

This function is called when a new buffer is committed to this view's surface. damage contains the region that is different from the current buffer, i.e. the region that needs to be updated. The new buffer will become current on the next call to advance().

Subclasses that reimplement this function must call the base implementation.

[virtual] QWaylandBufferRef QWaylandView::currentBuffer()

Returns a reference to this view's current buffer.

[virtual] QRegion QWaylandView::currentDamage()

Returns the current damage region of this view.

[virtual] void QWaylandView::discardCurrentBuffer()

Force the view to discard its current buffer, to allow it to be reused on the client side.

bool QWaylandView::isPrimary() const

Returns true if this QWaylandView is the primary view for the QWaylandSurface

See also QWaylandSurface::primaryView.

void QWaylandView::setPrimary()

Makes this QWaylandView the primary view for the surface.

It has no effect if this QWaylandView is not holding any QWaylandSurface

See also isPrimary() and QWaylandSurface::primaryView.

struct wl_resource *QWaylandView::surfaceResource() const

Returns the Wayland surface resource for this QWaylandView.