QWaylandSurfaceGrabber Class

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

头：	#include <QWaylandSurfaceGrabber>
CMake:	find_package(Qt6 REQUIRED COMPONENTS WaylandCompositor) target_link_libraries(mytarget PRIVATE Qt6::WaylandCompositor)
qmake:	QT += waylandcompositor
继承：	QObject

所有成员列表，包括继承成员

公共类型

enum	Error { InvalidSurface, NoBufferAttached, UnknownBufferType, RendererNotReady }

公共函数

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

详细描述

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.

成员函数文档编制

`[explicit]` 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