XdgOutputV1 QML Type

Represents a display in a compositor. More...

Import Statement: import QtWayland.Compositor.XdgShell
In C++: QWaylandXdgOutputV1

Properties

Detailed Description

Property Documentation

description : string

This property holds the description of this output.

No convention is defined for the description.

Changing this property after initialization doesn't take effect.

logicalGeometry : rect [read-only]

This property holds the position and size of the output in the global compositor space. It's the combination of the logical position and logical size.

See also XdgOutputV1::logicalPosition and XdgOutputV1::logicalSize.

logicalPosition : point

This property holds the coordinates of the output within the global compositor space.

The default value is 0,0.

logicalSize : size

This property holds the size of the output in the global compositor space.

The default value is -1,-1 which is invalid.

Please remember that this is the logical size, not the physical size. For example, for a WaylandOutput mode 3840x2160 and a scale factor 2:

  • A compositor not scaling the surface buffers, will report a logical size of 3840x2160.
  • A compositor automatically scaling the surface buffers, will report a logical size of 1920x1080.
  • A compositor using a fractional scale of 1.5, will report a logical size of 2560x1620.

manager : XdgOutputManagerV1 [read-only]

This property holds the object that manages this XdgOutputV1.

name : string

This property holds the name of this output.

The naming convention is compositor defined, but limited to alphanumeric characters and dashes ("-"). Each name is unique and will also remain consistent across sessions with the same hardware and software configuration.

Examples of names include "HDMI-A-1", "WL-1", "X11-1" etc... However don't assume the name reflects the underlying technology.

Changing this property after initialization doesn't take effect.

output : WaylandOutput [read-only]

This property holds the WaylandOutput associated with this XdgOutputV1.