WaylandSurface QML Type

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

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

• List of all members, including inherited members

Properties

• bufferScale : size
• client : WaylandClient
• contentOrientation : enum
• cursorSurface : bool
• hasContent : bool
• origin : enum
• size : size

Signals

• childAdded(WaylandSurface child)
• void dragStarted(WaylandDrag drag)
• surfaceDestroyed()

Methods

• void destroy()
• void initialize(WaylandCompositor compositor, WaylandClient client, int id, int version)
• bool isDestroyed()

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

childAdded(WaylandSurface child)

This signal is emitted when a wl_subsurface, child, has been added to the surface.

void dragStarted(WaylandDrag drag)

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

surfaceDestroyed()

This signal is emitted when the corresponding wl_surface is destroyed.

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.