QWaylandSurfaceGrabber Class

The QWaylandSurfaceGrabber class allows to read the content of a QWaylandSurface. More...

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

This class was introduced in Qt 5.8.

Public Types

enum Error { InvalidSurface, NoBufferAttached, UnknownBufferType, RendererNotReady }

Public Functions

QWaylandSurfaceGrabber(QWaylandSurface *surface, QObject *parent = nullptr)
void grab()
QWaylandSurface *surface() const

Detailed Description

Sometimes it is needed to get the contents of a surface, for example to provide a screenshot to the user. The QWaylandSurfaceGrabber class provides a simple method to do so, without having to care what type of buffer backs the surface, be it shared memory, OpenGL or something else.

Member Type Documentation

enum QWaylandSurfaceGrabber::Error

The Error enum describes the reason for a grab failure.

ConstantValueDescription
QWaylandSurfaceGrabber::InvalidSurface0The surface is null or otherwise not valid.
QWaylandSurfaceGrabber::NoBufferAttached1The client has not attached a buffer on the surface yet.
QWaylandSurfaceGrabber::UnknownBufferType2The buffer attached on the surface is of an unknown type.
QWaylandSurfaceGrabber::RendererNotReady3The compositor renderer is not ready to grab the surface content.

Member Function Documentation

QWaylandSurfaceGrabber::QWaylandSurfaceGrabber(QWaylandSurface *surface, QObject *parent = nullptr)

Create a QWaylandSurfaceGrabber object with the given surface and parent

void QWaylandSurfaceGrabber::grab()

Grab the content of the surface set on this object. It may not be possible to do that immediately so the success and failed signals should be used to be notified of when the grab is completed.

QWaylandSurface *QWaylandSurfaceGrabber::surface() const

Returns the surface set on this object

© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.