public interface WlOutputEventsV3 extends WlOutputEventsV2
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.
| Modifier and Type | Field and Description |
|---|---|
static int |
VERSION |
| Modifier and Type | Method and Description |
|---|---|
void |
done(WlOutputProxy emitter)
sent all information about output
|
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
|
void |
scale(WlOutputProxy emitter,
int factor)
output scaling properties
|
static final int VERSION
void geometry(WlOutputProxy emitter, int x, int y, int physicalWidth, int physicalHeight, int subpixel, @Nonnull String make, @Nonnull String model, int transform)
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.
geometry in interface WlOutputEventsgeometry in interface WlOutputEventsV2emitter - The protocol object that emitted the event.x - x position within the global compositor spacey - y position within the global compositor spacephysicalWidth - width in millimeters of the outputphysicalHeight - height in millimeters of the outputsubpixel - subpixel orientation of the outputmake - textual description of the manufacturermodel - textual description of the modeltransform - transform that maps framebuffer to outputvoid mode(WlOutputProxy emitter, int flags, int width, int height, int refresh)
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.
mode in interface WlOutputEventsmode in interface WlOutputEventsV2emitter - The protocol object that emitted the event.flags - bitfield of mode flagswidth - width of the mode in hardware unitsheight - height of the mode in hardware unitsrefresh - vertical refresh rate in mHzvoid done(WlOutputProxy emitter)
This event is sent after all other properties have been sent after binding to the output object and after any other property changes done after that. This allows changes to the output properties to be seen as atomic, even if they happen via multiple events.
done in interface WlOutputEventsV2emitter - The protocol object that emitted the event.void scale(WlOutputProxy emitter, int factor)
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 very 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.
scale in interface WlOutputEventsV2emitter - The protocol object that emitted the event.factor - scaling factor of outputCopyright © 2016. All rights reserved.