QWaylandSurface Class▲
-
Header: QWaylandSurface
-
Since: Qt 5.8
-
qmake: QT += waylandcompositor
Detailed Description▲
This class encapsulates a rectangular area of pixels that is displayed on an output device. It corresponds to the interface wl_surface in the Wayland protocol.
Member Type Documentation▲
enum QWaylandSurface::Origin▲
This enum type is used to specify the origin of a https://'s buffer.
|
Constant |
Value |
Description |
|---|---|---|
|
https://::OriginTopLeft |
0 |
The origin is the top left corner of the buffer. |
|
https://::OriginBottomLeft |
1 |
The origin is the bottom left corner of the buffer. |
Property Documentation▲
[read-only] bufferScale : const int▲
This property holds the https://'s buffer scale. The buffer scale lets a client supply higher resolution buffer data for use on high resolution outputs.
Access functions:
-
int bufferScale() const
Notifier signal:
-
void bufferScaleChanged()
[read-only] client : QWaylandClient* const▲
This property holds the client using this https://.
Access functions:
-
*client() const
[read-only] contentOrientation : const Qt::ScreenOrientation▲
This property holds the orientation of the https://'s contents.
Access functions:
-
contentOrientation() const
Notifier signal:
-
void contentOrientationChanged()
See Also▲
See also QWaylandOutput::transform
cursorSurface : bool▲
This property holds whether the https:// is a cursor surface.
Access functions:
-
bool isCursorSurface() const
-
void markAsCursorSurface(bool cursorSurface)
Notifier signal:
-
void cursorSurfaceChanged()
[read-only] hasContent : const bool▲
This property holds whether the https:// has content.
Access functions:
-
bool hasContent() const
Notifier signal:
-
void hasContentChanged()
[read-only] origin : const QWaylandSurface::Origin▲
This property holds the origin of the https://'s buffer, or https:// if the surface has no buffer.
Access functions:
-
origin() const
Notifier signal:
-
void originChanged()
[read-only] size : const QSize▲
This property holds the https://'s size in pixels.
Access functions:
-
size() const
Notifier signal:
-
void sizeChanged()
Member Function Documentation▲
QWaylandSurface::QWaylandSurface()▲
Constructs a an uninitialized https://.
QWaylandSurface::QWaylandSurface(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version)▲
Constructs and initializes a https:// for the given compositor and client, and with the given id and version.
QWaylandSurface::~QWaylandSurface()▲
Destroys the https://.
void QWaylandSurface::childAdded(QWaylandSurface *child)▲
This signal is emitted when a wl_subsurface, child, has been added to the surface.
QWaylandCompositor *QWaylandSurface::compositor() const▲
Returns the compositor for this https://.
void QWaylandSurface::destroy()▲
Destroys the https://.
void QWaylandSurface::dragStarted(QWaylandDrag *drag)▲
This signal is emitted when a drag has started from this surface.
void QWaylandSurface::frameStarted()▲
Prepares all frame callbacks for sending.
[static] QWaylandSurface *QWaylandSurface::fromResource(::wl_resource *res)▲
Returns the https:// corresponding to the Wayland resource res.
void QWaylandSurface::initialize(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version)▲
Initializes the https:// with the given compositor and client, and with the given id and version.
bool QWaylandSurface::inputRegionContains(const QPoint &p) const▲
Returns true if the https://'s input region contains the point p. Otherwise returns false.
bool QWaylandSurface::isDestroyed() const▲
Returns true if the https:// has been destroyed. Otherwise returns false.
bool QWaylandSurface::isInitialized() const▲
Returns true if the https:// has been initialized.
QWaylandView *QWaylandSurface::primaryView() const▲
struct wl_resource *QWaylandSurface::resource() const▲
Returns the Wayland resource corresponding to this https://.
void QWaylandSurface::sendFrameCallbacks()▲
Sends pending frame callbacks.
void QWaylandSurface::setPrimaryView(QWaylandView *view)▲
Sets this https://'s primary view to view, in case there are multiple views of this surface. The primary view is the view that governs the client's refresh rate. It takes care of discarding buffer references when QWaylandView::advance() is called. See the documentation for QWaylandView::advance() for more details.
In shell surface integrations, such as QWaylandWlShellIntegration and QWaylandXdgShellV5Integration, maximize and fullscreen requests from the client will only have an effect if the integration has the primary view of the surface.
See Also▲
See also https://(), QWaylandView::advance()
bool QWaylandSurface::setRole(QWaylandSurfaceRole *role, wl_resource *errorResource, uint32_t errorCode)▲
Sets a role on the surface. A role defines how a surface will be mapped on screen, without a role a surface is supposed to be hidden. Only one role at all times can be set on a surface. Although setting the same role many times is allowed, attempting to change the role of a surface will trigger a protocol error to the errorResource and send an errorCode to the client.
void QWaylandSurface::surfaceDestroyed()▲
This signal is emitted when the corresponing wl_surface is destroyed.
void QWaylandSurface::updateSelection()▲
Updates the surface with the compositor's retained clipboard selection. Although this is done automatically when the surface receives keyboard focus, this function is useful for updating clients which do not have keyboard focus.
QList<QWaylandView *> QWaylandSurface::views() const▲
Returns the views for this https://.