QWaylandXdgOutputV1 Class

Represents a display in a compositor. More...

Header: #include <QWaylandXdgOutputV1>
CMake: find_package(Qt6 REQUIRED COMPONENTS WaylandCompositor)
target_link_libraries(mytarget PRIVATE Qt6::WaylandCompositor)
qmake: QT += waylandcompositor
In QML: XdgOutputV1
Inherits: QObject

Properties

Public Functions

QString description() const
QRect logicalGeometry() const
QPoint logicalPosition() const
QSize logicalSize() const
QWaylandXdgOutputManagerV1 *manager() const
QString name() const
QWaylandOutput *output() const
void setDescription(const QString &name)
void setLogicalPosition(const QPoint &position)
void setLogicalSize(const QSize &size)
void setName(const QString &name)

Signals

Detailed Description

Property Documentation

description : QString

This property holds the description of this output.

No convention is defined for the description.

Changing this property after initialization doesn't take effect.

Access functions:

QString description() const
void setDescription(const QString &name)

Notifier signal:

void descriptionChanged()

[read-only] logicalGeometry : QRect

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.

Access functions:

QRect logicalGeometry() const

Notifier signal:

void logicalGeometryChanged()

See also QWaylandXdgOutputV1::logicalPosition and QWaylandXdgOutputV1::logicalSize.

logicalPosition : QPoint

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

The default value is 0,0.

Access functions:

QPoint logicalPosition() const
void setLogicalPosition(const QPoint &position)

Notifier signal:

void logicalPositionChanged()

logicalSize : QSize

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.

Access functions:

QSize logicalSize() const
void setLogicalSize(const QSize &size)

Notifier signal:

void logicalSizeChanged()

name : QString

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.

Access functions:

QString name() const
void setName(const QString &name)

Notifier signal:

void nameChanged()

[read-only] output : QWaylandOutput*

This property holds the QWaylandOutput associated with this QWaylandXdgOutputV1.

Access functions:

QWaylandOutput *output() const

Notifier signal:

void outputChanged()