WaylandSurface QML Type

Represents a rectangular area on an output device. More...

Import Statement: import QtWayland.Compositor 1.0
Since: Qt 5.8




Detailed Description

This type encapsulates a rectangular area of pixels that is displayed on an output device. It corresponds to the interface wl_surface in the Wayland protocol.

Property Documentation

bufferScale : size

This property holds the WaylandSurface's buffer scale. The buffer scale lets a client supply higher resolution buffer data for use on high resolution outputs.

client : WaylandClient

This property holds the client using this WaylandSurface.

contentOrientation : enum

This property holds the orientation of the WaylandSurface's contents.

See also WaylandOutput.transform.

cursorSurface : bool

This property holds whether the WaylandSurface is a cursor surface.

hasContent : bool

This property holds whether the WaylandSurface has content.

origin : enum

This property holds the origin of the WaylandSurface's buffer, or WaylandSurface.OriginTopLeft if the surface has no buffer.

It can have the following values:

  • WaylandSurface.OriginTopLeft The origin is the top left corner of the buffer.
  • WaylandSurface.OriginBottomLeft The origin is the bottom left corner of the buffer.

size : size

This property holds the WaylandSurface's size in pixels.

Signal Documentation

void dragStarted(WaylandDrag drag)

This signal is emitted when a drag has started from this surface.

Method Documentation

void destroy()

Destroys the WaylandSurface.

void initialize(WaylandCompositor compositor, WaylandClient client, int id, int version)

Initializes the WaylandSurface with the given compositor and client, and with the given id and version.

bool isDestroyed()

Returns true if the WaylandSurface has been destroyed. Otherwise returns false.

© 2019 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.