org.freedesktop.wayland.client

Interface WlOutputEvents

All Known Subinterfaces:

WlOutputEventsV2, WlOutputEventsV3

public interface WlOutputEvents

compositor output region

An output describes part of the compositor geometry. The compositor works in the 'compositor coordinate system' and an output corresponds to a rectangular area in that space that is actually visible. This typically corresponds to a monitor that displays part of the compositor space. This object is published as global during start up, or when a monitor is hotplugged.

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION

Method Summary

Modifier and Type	Method and Description
void	geometry(WlOutputProxy emitter, int x, int y, int physicalWidth, int physicalHeight, int subpixel, String make, String model, int transform) properties of the output
void	mode(WlOutputProxy emitter, int flags, int width, int height, int refresh) advertise available modes for the output

Field Detail

VERSION

static final int VERSION

See Also:

Constant Field Values

Method Detail

geometry

void geometry(WlOutputProxy emitter,
              int x,
              int y,
              int physicalWidth,
              int physicalHeight,
              int subpixel,
              @Nonnull
              String make,
              @Nonnull
              String model,
              int transform)

properties of the output

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.

Parameters:

emitter - The protocol object that emitted the event.

x - x position within the global compositor space

y - y position within the global compositor space

physicalWidth - width in millimeters of the output

physicalHeight - height in millimeters of the output

subpixel - subpixel orientation of the output

make - textual description of the manufacturer

model - textual description of the model

transform - transform that maps framebuffer to output

mode

void mode(WlOutputProxy emitter,
          int flags,
          int width,
          int height,
          int refresh)

advertise available modes for the output

The mode event describes an available mode for the output.

The event is sent when binding to the output object and there will always be one mode, the current mode. The event is sent again if an output changes mode, for the mode that is now current. In other words, the current mode is always the last mode that was received 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 wl_output.scale, or transformed, as described in wl_output.transform.

Parameters:

emitter - The protocol object that emitted the event.

flags - bitfield of mode flags

width - width of the mode in hardware units

height - height of the mode in hardware units

refresh - vertical refresh rate in mHz