--- name: "wayland_output_t" section: "3" platform: "linux" package: "waylandpp-dev" version: "1.0.0-6+b2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/wayland_output_t" --- # wayland\_output\_t(3) compositor output region ## NAME wayland::output\_t - compositor output region ## SYNOPSIS `#include ` Inherits **wayland::proxy\_t**. ### Public Types enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\ ### Public Member Functions void **release** ()\ release the output object bool **can\_release** () const\ Check whether the **release** function is available with the currently bound version of the protocol. std::function\< void(int32\_t, int32\_t, int32\_t, int32\_t, output\_subpixel, std::string, std::string, **output\_transform**)\> & **on\_geometry** ()\ properties of the output std::function\< void(**output\_mode**, int32\_t, int32\_t, int32\_t)\> & **on\_mode** ()\ advertise available modes for the output std::function\< void()\> & **on\_done** ()\ sent all information about output std::function\< void(int32\_t)\> & **on\_scale** ()\ output scaling properties std::function\< void(std::string)\> & **on\_name** ()\ name of this output std::function\< void(std::string)\> & **on\_description** ()\ human-readable description of this output uint32\_t **get\_id** () const\ Get the id of a proxy object. std::string **get\_class** () const\ Get the interface name (class) of a proxy object. uint32\_t **get\_version** () const\ Get the protocol object version of a proxy object. **wrapper\_type** **get\_wrapper\_type** () const\ Get the type of a proxy object. void **set\_queue** (**event\_queue\_t** queue)\ Assign a proxy to an event queue. wl\_proxy \* **c\_ptr** () const\ Get a pointer to the underlying C struct. bool **proxy\_has\_object** () const\ Check whether this wrapper actually wraps an object. **operator bool** () const\ Check whether this wrapper actually wraps an object. bool **operator==** (const **proxy\_t** &right) const\ Check whether two wrappers refer to the same object. bool **operator!=** (const **proxy\_t** &right) const\ Check whether two wrappers refer to different objects. void **proxy\_release** ()\ Release the wrapped object (if any), making this an empty wrapper. ### Static Public Attributes static constexpr std::uint32\_t **release\_since\_version** = 3\ Minimum protocol version required for the **release** function. ## Detailed Description 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. Definition at line **3483** of file **wayland-client-protocol.hpp**. ## Member Enumeration Documentation ### enum class wayland::proxy\_t::wrapper\_type` [strong]`, ` [inherited]` Underlying wl\_proxy type and properties of a **proxy\_t** that affect construction, destruction, and event handling **Enumerator** - *standard* *C pointer is a standard type compatible with wl\_proxy\*. Events are dispatched and it is destructed when the* **proxy\_t** *is destructed. User data is set.* - *display* *C pointer is a wl\_display\*. No events are dispatched, wl\_display\_disconnect is called when the* **proxy\_t** *is destructed. User data is set.* - *foreign* *C pointer is a standard type compatible with wl\_proxy\*, but another library owns it and it should not be touched in a way that could affect the operation of the other library. No events are dispatched, wl\_proxy\_destroy is not called when the* **proxy\_t** *is destructed, user data is not touched. Consequently, there is no reference counting for the* **proxy\_t***. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl\_proxy.* - *proxy\_wrapper* *C pointer is a wl\_proxy\* that was constructed with wl\_proxy\_create\_wrapper. No events are dispatched, wl\_proxy\_wrapper\_destroy is called when the* **proxy\_t** *is destroyed. Reference counting is active. A reference to the* **proxy\_t** *creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.* *Definition at line* **116** *of file* **wayland-client.hpp***.* ## Member Function Documentation ### wl\_proxy \* wayland::proxy\_t::c\_ptr () const` [inherited]` *Get a pointer to the underlying C struct.* **Returns** *The underlying wl\_proxy wrapped by this* **proxy\_t** *if it exists, otherwise an exception is thrown* ### bool output\_t::can\_release () const *Check whether the* **release** *function is available with the currently bound version of the protocol.* *Definition at line* **3368** *of file* **wayland-client-protocol.cpp***.* ### std::string wayland::proxy\_t::get\_class () const` [inherited]` *Get the interface name (class) of a proxy object.* **Returns** *The interface name of the object associated with the proxy* ### uint32\_t wayland::proxy\_t::get\_id () const` [inherited]` *Get the id of a proxy object.* **Returns** *The id the object associated with the proxy* ### uint32\_t wayland::proxy\_t::get\_version () const` [inherited]` *Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API.* *A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version.* **display\_t** *will always return version 0.* **Returns** *The protocol object version of the proxy or 0* ### wrapper\_type wayland::proxy\_t::get\_wrapper\_type () const` [inline]`, ` [inherited]` *Get the type of a proxy object.* *Definition at line* **302** *of file* **wayland-client.hpp***.* ### std::function\< void(std::string)\> & output\_t::on\_description () *human-readable description of this output* **Parameters** *description output description* *Many compositors can produce human-readable descriptions of their outputs. The client may wish to know this description as well, e.g. for output selection purposes.* *The description is a UTF-8 string with no convention defined for its contents. The description is not guaranteed to be unique among all wl\_output globals. Examples might include 'Foocorp 11" Display' or 'Virtual X11 output via :1'.* *The description event is sent after binding the output object and whenever the description changes. The description is optional, and may not be sent at all.* *The description event will be followed by a done event.* *Definition at line* **3399** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void()\> & output\_t::on\_done () *sent all information about output 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.* *Definition at line* **3384** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(int32\_t, int32\_t, int32\_t, int32\_t, output\_subpixel, std::string, std::string, output\_transform)\> & output\_t::on\_geometry () *properties of the output* **Parameters** *x x position within the global compositor space* \ *y y position within the global compositor space* \ *physical\_width width in millimeters of the output* \ *physical\_height 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* *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.* *The physical size can be set to zero if it doesn't make sense for this output (e.g. for projectors or virtual outputs).* *The geometry event will be followed by a done event (starting from version 2).* *Note: wl\_output only advertises partial information about the output position and identification. Some compositors, for instance those not implementing a desktop-style output layout or those exposing virtual outputs, might fake this information. Instead of using x and y, clients should use xdg\_output.logical\_position. Instead of using make and model, clients should use name and description.* *Definition at line* **3374** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(output\_mode, int32\_t, int32\_t, int32\_t)\> & output\_t::on\_mode () *advertise available modes for the output* **Parameters** *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* *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.* *Non-current modes are deprecated. A compositor can decide to only advertise the current mode and never send other modes. Clients should not rely on non-current modes.* *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. Clients willing to retrieve the output size in the global compositor space should use xdg\_output.logical\_size instead.* *The vertical refresh rate can be set to zero if it doesn't make sense for this output (e.g. for virtual outputs).* *The mode event will be followed by a done event (starting from version 2).* *Clients should not use the refresh rate to schedule frames. Instead, they should use the wl\_surface.frame event or the presentation-time protocol.* *Note: this information is not always meaningful for all outputs. Some compositors, such as those exposing virtual outputs, might fake the refresh rate or the size.* *Definition at line* **3379** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(std::string)\> & output\_t::on\_name () *name of this output* **Parameters** *name output name* *Many compositors will assign user-friendly names to their outputs, show them to the user, allow the user to refer to an output, etc. The client may wish to know this name as well to offer the user similar behaviors.* *The name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wl\_output globals. The name is only guaranteed to be unique for the compositor instance.* *The same output name is used for all clients for a given wl\_output global. Thus, the name can be shared across processes to refer to a specific wl\_output global.* *The name is not guaranteed to be persistent across sessions, thus cannot be used to reliably identify an output in e.g. configuration files.* *Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do not assume that the name is a reflection of an underlying DRM connector, X11 connection, etc.* *The name event is sent after binding the output object. This event is only sent once per output object, and the name does not change over the lifetime of the wl\_output global.* *Compositors may re-use the same output name if the wl\_output global is destroyed and re-created later. Compositors should avoid re-using the same name if possible.* *The name event will be followed by a done event.* *Definition at line* **3394** *of file* **wayland-client-protocol.cpp***.* ### std::function\< void(int32\_t)\> & output\_t::on\_scale () *output scaling properties* **Parameters** *factor scaling factor of output* *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.* *The scale event will be followed by a done event.* *Definition at line* **3389** *of file* **wayland-client-protocol.cpp***.* ### wayland::proxy\_t::operator bool () const` [inherited]` *Check whether this wrapper actually wraps an object.* **Returns** *true if there is an underlying object, false if this wrapper is empty* ### bool wayland::proxy\_t::operator!= (const proxy\_t & right) const` [inherited]` *Check whether two wrappers refer to different objects.* ### bool wayland::proxy\_t::operator== (const proxy\_t & right) const` [inherited]` *Check whether two wrappers refer to the same object.* ### bool wayland::proxy\_t::proxy\_has\_object () const` [inherited]` *Check whether this wrapper actually wraps an object.* **Returns** *true if there is an underlying object, false if this wrapper is empty* ### void wayland::proxy\_t::proxy\_release ()` [inherited]` *Release the wrapped object (if any), making this an empty wrapper. Note that* **display\_t** *instances cannot be released this way. Attempts to do so are ignored.* **Examples** **foreign\_display.cpp***.* ### void output\_t::release () *release the output object Using this request a client can tell the server that it is not going to use the output object anymore.* *Definition at line* **3363** *of file* **wayland-client-protocol.cpp***.* ### void wayland::proxy\_t::set\_queue (event\_queue\_t queue)` [inherited]` *Assign a proxy to an event queue.* **Parameters** *queue The event queue that will handle this proxy* *Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.* *See also:* **display\_t::dispatch\_queue()***.* **Examples** **proxy\_wrapper.cpp***.* ## Member Data Documentation ### constexpr std::uint32\_t wayland::output\_t::release\_since\_version = 3` [static]`, ` [constexpr]` *Minimum protocol version required for the* **release** *function.* *Definition at line* **3521** *of file* **wayland-client-protocol.hpp***.* ## Author *Generated automatically by Doxygen for Wayland++ from the source code.*