- Qt 6.8
- Qt Wayland Compositor
- QML Types
- WaylandOutput
- Qt Wayland Compositor | Commercial or GPLv3

# WaylandOutput QML Type

Provides access to a displayable area managed by the compositor. More...

Import Statement: | import QtWayland.Compositor
Instantiates: | QWaylandOutput

- List of all members, including inherited members

## Properties

- automaticFrameCallback : bool
- availableGeometry : rect
- compositor : WaylandCompositor
- geometry : rect
- manufacturer : string
- model : string
- physicalSize : size
- position : point
- scaleFactor : int
- sizeFollowsWindow : bool
- subpixel : enum
- transform : enum
- window : Window

## Detailed Description

The WaylandOutput manages a rectangular area within bounds of the compositor's geometry, to use it for displaying client content. This could, for instance, be a screen managed by the WaylandCompositor.

The type corresponds to the `wl_output` interface in the Wayland protocol.

Note: If the compositor has multiple Wayland outputs, the Qt::AA_ShareOpenGLContexts attribute must be set before the QGuiApplication object is constructed.

## Property Documentation

automaticFrameCallback : bool

This property holds whether the WaylandOutput automatically sends frame callbacks when rendering.

The default is true.

availableGeometry : rect

This property holds the geometry of the WaylandOutput available for displaying content. The available geometry is in output coordinates space, starts from 0,0 and it's as big as the output by default.

See also QWaylandOutput::geometry.

compositor : WaylandCompositor

This property holds the compositor displaying content on this WaylandOutput.

Note: This property can be set only once, before the WaylandOutput component is completed.

geometry : rect `[read-only]`

This property holds the geometry of the WaylandOutput.

manufacturer : string

This property holds a textual description of the manufacturer of this WaylandOutput.

model : string

This property holds a textual description of the model of this WaylandOutput.

physicalSize : size

This property holds the physical size of the WaylandOutput in millimeters.

See also QWaylandOutput::geometry.

position : point

This property holds the position of this WaylandOutput in the compositor's coordinate system.

scaleFactor : int

This property holds the factor by which the WaylandCompositor scales surface buffers before they are displayed. It is used on high density output devices where unscaled content would be too small to be practical. The client can in turn set the scale factor of its buffer to match the output if it prefers to provide high resolution content that is suitable for the output device.

The default is 1 (no scaling).

sizeFollowsWindow : bool

This property controls whether the size of the WaylandOutput matches the size of its window.

If this property is true, all modes previously added are replaced by a mode that matches window size and screen refresh rate.

The default is false.

subpixel : enum

This property holds the subpixel arrangement of this WaylandOutput.

- WaylandOutput.SubpixelUnknown The subpixel arrangement is not set.
- WaylandOutput.SubpixelNone There are no subpixels.
- WaylandOutput.SubpixelHorizontalRgb The subpixels are arranged horizontally in red, green, blue order.
- WaylandOutput.SubpixelHorizontalBgr The subpixels are arranged horizontally in blue, green, red order.
- WaylandOutput.SubpixelVerticalRgb The subpixels are arranged vertically in red, green, blue order.
- WaylandOutput.SubpixelVerticalBgr The subpixels are arranged vertically in blue, green, red order.

The default is WaylandOutput.SubpixelUnknown.

transform : enum

This property holds the transformation that the QWaylandCompositor applies to a surface to compensate for the orientation of the QWaylandOutput.

- WaylandOutput.TransformNormal The orientation is normal.
- WaylandOutput.Transform90 The orientation is rotated 90 degrees.
- WaylandOutput.Transform180 The orientation is rotated 180 degrees.
- WaylandOutput.Transform270 The orientation is rotated 270 degrees.
- WaylandOutput.TransformFlipped The orientation is mirrored.
- WaylandOutput.TransformFlipped90 The orientation is mirrored, then rotated 90 degrees.
- WaylandOutput.TransformFlipped180 The orientation is mirrored, then rotated 180 degrees.
- WaylandOutput.TransformFlipped270 The orientation is mirrored, then rotated 270 degrees.

The default is WaylandOutput.TransformNormal.

window : Window

This property holds the Window for this WaylandOutput.

Note: This property can be set only once, before the WaylandOutput component is completed.