Product SiteDocumentation Site

A.19. wl_output - compositor output region

An output describes part of the compositor geometry. The compositor work in the 'compositor coordinate system' and an output corresponds to 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 screen is hot plugged.

A.19.1. Events provided by wl_output

A.19.1.1. wl_output::geometry - properties of the output

wl_output::geometry arguments
x
Type: int
x position within the global compositor space
y
Type: int
y position within the global compositor space
physical_width
Type: int
width in millimeters of the output
physical_height
Type: int
height in millimeters of the output
subpixel
Type: int
subpixel orientation of the output
make
Type: string
textual description of the manufacturer
model
Type: string
textual description of the model
transform
Type: int
transform that maps framebuffer to output

A.19.1.2. wl_output::mode - 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.
wl_output::mode arguments
flags
Type: uint
mask of wl_output_mode flags
width
Type: int
width of the mode in pixels
height
Type: int
height of the mode in pixels
refresh
Type: int
vertical refresh rate in mHz