WaylandSurface QML Type▲
-
Import Statement: import QtWayland.Compositor 1.13
-
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.
bufferSize : size▲
This property holds the size of the current buffer of this WaylandSurface in pixels, not in surface coordinates.
For the size in surface coordinates, use destinationSize instead.
See Also▲
See also destinationSize, bufferScale
client : WaylandClient▲
This property holds the client using this WaylandSurface.
contentOrientation : enum▲
This property holds the orientation of the WaylandSurface's contents.
See Also▲
See also WaylandOutput.transform
cursorSurface : bool▲
This property holds whether the WaylandSurface is a cursor surface.
[since 5.13] destinationSize : size▲
This property holds the size of this WaylandSurface in surface coordinates.
This property was introduced in Qt 5.13.
See Also▲
See also bufferScale, bufferSize
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.
[since 5.13] sourceGeometry : rect▲
This property describes the portion of the attached Wayland buffer that should be drawn on the screen. The coordinates are from the corner of the buffer and are scaled by bufferScale.
This property was introduced in Qt 5.13.
See Also▲
See also bufferScale, bufferSize, destinationSize
useTextureAlpha : bool▲
This property specifies whether the surface should use texture alpha.
Signal Documentation▲
childAdded(WaylandSurface child)▲
This signal is emitted when a wl_subsurface, child, has been added to the surface.
The corresponding handler is onChildAdded.
void dragStarted(WaylandDrag drag)▲
This signal is emitted when a drag has started from this surface.
The corresponding handler is onDragStarted.
surfaceDestroyed()▲
This signal is emitted when the corresponding wl_surface is destroyed.
The corresponding handler is onSurfaceDestroyed.
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.
Obsolete Members for WaylandSurface▲
The following members of QML type WaylandSurface are deprecated. We strongly advise against using them in new code.
Obsolete Property Documentation▲
clientRenderingEnabled : bool▲
This property is deprecated. We strongly advise against using it in new code.
This property used to specify whether client rendering was enabled for the surface. It depended on a Wayland extension that was part of the private API. The surface extension is not used anymore, so this property does nothing.
size : size▲
This property is deprecated. We strongly advise against using it in new code.
use bufferSize or destinationSize instead
This property has been deprecated, use bufferSize or destinationSize instead.