WaylandOutput QML Type

Type providing access to a displayable area managed by the compositor. More...

Import Statement: import QtWayland.Compositor 1.0

Properties

Detailed Description

The WaylandOutput manages a rectangular part of the compositor's geometry that can be used 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.

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 : object

This property holds the compositor displaying content on this QWaylandOutput. This property can only be set once, before the WaylandOutput component is completed.


geometry : rect

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. This 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.

The default is true if this WaylandOutput has a window.


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.

The default is WaylandOutput.TransformNormal.


window : object

This property holds the Window for this WaylandOutput. This property can only be set once, before the WaylandOutput component is completed.