KDE output device v2

The geometry event describes geometric properties of the output. The event is sent when binding to the output object and whenever any of the properties change.

This event describes the mode currently in use for this head. It is only sent if the output is enabled.

The mode event describes an available mode for the output.

When the client binds to the output_device object, the server sends this event once for every available mode the output_device can be operated by.

There will always be at least one event sent out on initial binding, which represents the current mode.

Later if an output changes, its mode event is sent again for the eventual added modes and lastly the current mode. In other words, the current mode is always represented by the latest event sent with the current flag set.

The size of a mode is given in physical hardware units of the output device. This is not necessarily the same as the output size in the global compositor space. For instance, the output may be scaled, as described in kde_output_device_v2.scale, or transformed, as described in kde_output_device_v2.transform.

This event is sent after all other properties have been sent on binding to the output object as well as after any other output property change have been applied later on. This allows to see changes to the output properties as atomic, even if multiple events successively announce them.

This event contains scaling geometry information that is not in the geometry event. It may be sent after binding the output object or if the output scale changes later. If it is not sent, the client should assume a scale of 1.

A scale larger than 1 means that the compositor will automatically scale surface buffers by this amount when rendering. This is used for high resolution displays where applications rendering at the native resolution would be too small to be legible.

It is intended that scaling aware clients track the current output of a surface, and if it is on a scaled output it should use wl_surface.set_buffer_scale with the scale of the output. That way the compositor can avoid scaling the surface, and the client can supply a higher detail image.

The edid event encapsulates the EDID data for the outputdevice.

The event is sent when binding to the output object. The EDID data may be empty, in which case this event is sent anyway. If the EDID information is empty, you can fall back to the name et al. properties of the outputdevice.

The enabled event notifies whether this output is currently enabled and used for displaying content by the server. The event is sent when binding to the output object and whenever later on an output changes its state by becoming enabled or disabled.

The uuid can be used to identify the output. It's controlled by the server entirely. The server should make sure the uuid is persistent across restarts. An empty uuid is considered invalid.

Serial ID of the monitor, sent on startup before the first done event.

EISA ID of the monitor, sent on startup before the first done event.

What capabilities this device has, sent on startup before the first done event.

Overscan value of the monitor in percent, sent on startup before the first done event.

What policy the compositor will employ regarding its use of variable refresh rate.

What rgb range the compositor is using for this output

Name of the output, it's useful to cross-reference to an zxdg_output_v1 and ultimately QScreen

Whether or not high dynamic range is enabled for this output

If high dynamic range is used, this value defines the brightness in nits for content that's in standard dynamic range format. Note that while the value is in nits, that doesn't necessarily translate to the same brightness on the screen.

Whether or not the use of a wide color gamut is enabled for this output

This can be used to provide the colors users assume sRGB applications should have based on the default experience on many modern sRGB screens.

This is the brightness modifier of the output. It doesn't specify any absolute values, but is merely a multiplier on top of other brightness values, like sdr_brightness and brightness_metadata. 0 is the minimum brightness (not completely dark) and 10000 is the maximum brightness. This is currently only supported / meaningful while HDR is active.

This enumeration describes how the physical pixels on an output are laid out.

This describes the transform, that a compositor will apply to a surface to compensate for the rotation or mirroring of an output device.

The flipped values correspond to an initial flip around a vertical axis followed by rotation.

The purpose is mainly to allow clients to render accordingly and tell the compositor, so that for fullscreen surfaces, the compositor is still able to scan out directly client surfaces.

Describes what capabilities this device has.

Describes when the compositor may employ variable refresh rate

Whether full or limited color range should be used

This event describes the mode size. The size is given in physical hardware units of the output device. This is not necessarily the same as the output size in the global compositor space. For instance, the output may be scaled or transformed.

This event describes the mode's fixed vertical refresh rate. It is only sent if the mode has a fixed refresh rate.

This event advertises this mode as preferred.

The compositor will destroy the object immediately after sending this event, so it will become invalid and the client should release any resources associated with it.