QWaylandSurfaceGrabber Class

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

頭: #include <QWaylandSurfaceGrabber>
qmake: QT += waylandcompositor
Since: Qt 5.8
繼承: QObject

公共類型

enum Error { InvalidSurface, NoBufferAttached, UnknownBufferType, RendererNotReady }

公共函數

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

信號

void failed (QWaylandSurfaceGrabber::Error error )
void success (const QImage & image )

靜態公共成員

const QMetaObject staticMetaObject

額外繼承成員

詳細描述

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

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.

成員類型文檔編製

enum QWaylandSurfaceGrabber:: Error

The Error enum describes the reason for a grab failure.

常量 描述
QWaylandSurfaceGrabber::InvalidSurface 0 The surface is null or otherwise not valid.
QWaylandSurfaceGrabber::NoBufferAttached 1 The client has not attached a buffer on the surface yet.
QWaylandSurfaceGrabber::UnknownBufferType 2 The buffer attached on the surface is of an unknown type.
QWaylandSurfaceGrabber::RendererNotReady 3 The compositor renderer is not ready to grab the surface content.

成員函數文檔編製

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

創建 QWaylandSurfaceGrabber 對象采用給定 surface and parent

[signal] void QWaylandSurfaceGrabber:: failed ( QWaylandSurfaceGrabber::Error error )

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.

[signal] void QWaylandSurfaceGrabber:: success (const QImage & image )

QWaylandSurface *QWaylandSurfaceGrabber:: surface () const

Returns the surface set on this object