--- name: "wayland_server_zxdg_output_v1_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_server_zxdg_output_v1_t" --- # wayland\_server\_zxdg\_output\_v1\_t(3) compositor logical output region ## NAME wayland::server::zxdg\_output\_v1\_t - compositor logical output region ## SYNOPSIS `#include ` Inherits wayland::server::resource\_t. ### Public Member Functions std::function\< void()\> & **on\_destroy** ()\ destroy the xdg\_output object void **logical\_position** (int32\_t x, int32\_t y, bool post=true)\ position of the output within the global compositor space void **logical\_size** (int32\_t width, int32\_t height, bool post=true)\ size of the output in the global compositor space void **done** (bool post=true)\ all information about the output have been sent void **name** (std::string const &name, bool post=true)\ name of this output bool **can\_name** () const\ Check whether the **name** function is available with the currently bound version of the protocol. void **description** (std::string const &description, bool post=true)\ human-readable description of this output bool **can\_description** () const\ Check whether the **description** function is available with the currently bound version of the protocol. bool **proxy\_has\_object** () const\ Check whether this wrapper actually wraps an object. void **post\_no\_memory** () const\ uint32\_t **get\_id** () const\ client\_t **get\_client** () const\ unsigned int **get\_version** () const\ std::string **get\_class** ()\ ### Static Public Attributes static constexpr std::uint32\_t **logical\_position\_since\_version** = 1\ Minimum protocol version required for the **logical\_position** function. static constexpr std::uint32\_t **logical\_size\_since\_version** = 1\ Minimum protocol version required for the **logical\_size** function. static constexpr std::uint32\_t **done\_since\_version** = 1\ Minimum protocol version required for the **done** function. static constexpr std::uint32\_t **name\_since\_version** = 2\ Minimum protocol version required for the **name** function. static constexpr std::uint32\_t **description\_since\_version** = 2\ Minimum protocol version required for the **description** function. ## Detailed Description compositor logical output region An xdg\_output describes part of the compositor geometry. This typically corresponds to a monitor that displays part of the compositor space. For objects version 3 onwards, after all xdg\_output properties have been sent (when the object is created and when properties are updated), a wl\_output.done event is sent. This allows changes to the output properties to be seen as atomic, even if they happen via multiple events. Definition at line **8562** of file **wayland-server-protocol-unstable.hpp**. ## Member Function Documentation ### bool zxdg\_output\_v1\_t::can\_description () const Check whether the **description** function is available with the currently bound version of the protocol. Definition at line **8149** of file **wayland-server-protocol-unstable.cpp**. ### bool zxdg\_output\_v1\_t::can\_name () const Check whether the **name** function is available with the currently bound version of the protocol. Definition at line **8139** of file **wayland-server-protocol-unstable.cpp**. ### void zxdg\_output\_v1\_t::description (std::string const & description, bool post = `true`) 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, to communicate the user for various purposes. The description is a UTF-8 string with no convention defined for its contents. Examples might include 'Foocorp 11" Display' or 'Virtual X11 output via :1'. The description event is sent after creating an xdg\_output (see xdg\_output\_manager.get\_xdg\_output) and whenever the description changes. The description is optional, and may not be sent at all. For objects of version 2 and lower, this event is only sent once per xdg\_output, and the description does not change over the lifetime of the wl\_output global. Definition at line **8144** of file **wayland-server-protocol-unstable.cpp**. ### void zxdg\_output\_v1\_t::done (bool post = `true`) all information about the output have been sent This event is sent after all other properties of an xdg\_output have been sent. This allows changes to the xdg\_output properties to be seen as atomic, even if they happen via multiple events. For objects version 3 onwards, this event is deprecated. Compositors are not required to send it anymore and must send wl\_output.done instead. Definition at line **8129** of file **wayland-server-protocol-unstable.cpp**. ### std::string wayland::server::resource\_t::get\_class ()` [inherited]` Retrieve the interface name (class) of a resource object. **Returns** Interface name of the resource object. ### client\_t wayland::server::resource\_t::get\_client () const` [inherited]` Get the associated client **Returns** the client that owns the resource. ### uint32\_t wayland::server::resource\_t::get\_id () const` [inherited]` Get the internal ID of the resource **Returns** the internal ID of the resource ### unsigned int wayland::server::resource\_t::get\_version () const` [inherited]` Get interface version **Returns** Interface version this resource has been constructed with. ### void zxdg\_output\_v1\_t::logical\_position (int32\_t x, int32\_t y, bool post = `true`) position of the output within the global compositor space **Parameters** *x* x position within the global compositor space \ *y* y position within the global compositor space The position event describes the location of the wl\_output within the global compositor space. The logical\_position event is sent after creating an xdg\_output (see xdg\_output\_manager.get\_xdg\_output) and whenever the location of the output changes within the global compositor space. Definition at line **8119** of file **wayland-server-protocol-unstable.cpp**. ### void zxdg\_output\_v1\_t::logical\_size (int32\_t width, int32\_t height, bool post = `true`) size of the output in the global compositor space **Parameters** *width* width in global compositor space \ *height* height in global compositor space The logical\_size event describes the size of the output in the global compositor space. For example, a surface without any buffer scale, transformation nor rotation set, with the size matching the logical\_size will have the same size as the corresponding output when displayed. Most regular Wayland clients should not pay attention to the logical size and would rather rely on xdg\_shell interfaces. Some clients such as Xwayland, however, need this to configure their surfaces in the global compositor space as the compositor may apply a different scale from what is advertised by the output scaling property (to achieve fractional scaling, for example). For example, for a wl\_output mode 3840×2160 and a scale factor 2: - • A compositor not scaling the surface buffers will advertise a logical size of 3840×2160, - • A compositor automatically scaling the surface buffers will advertise a logical size of 1920×1080, - • A compositor using a fractional scale of 1.5 will advertise a logical size of 2560×1440. For example, for a wl\_output mode 1920×1080 and a 90 degree rotation, the compositor will advertise a logical size of 1080x1920. The logical\_size event is sent after creating an xdg\_output (see xdg\_output\_manager.get\_xdg\_output) and whenever the logical size of the output changes, either as a result of a change in the applied scale or because of a change in the corresponding output mode(see wl\_output.mode) or transform (see wl\_output.transform). Definition at line **8124** of file **wayland-server-protocol-unstable.cpp**. ### void zxdg\_output\_v1\_t::name (std::string const & name, bool post = `true`) name of this output **Parameters** *name* output name Many compositors will assign names to their outputs, show them to the user, allow them to be configured by name, etc. The client may wish to know this name as well to offer the user similar behaviors. The naming convention is compositor defined, but limited to alphanumeric characters and dashes (-). Each name is unique among all wl\_output globals, but if a wl\_output global is destroyed the same name may be reused later. The names will also remain consistent across sessions with the same hardware and software configuration. 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 creating an xdg\_output (see xdg\_output\_manager.get\_xdg\_output). This event is only sent once per xdg\_output, and the name does not change over the lifetime of the wl\_output global. Definition at line **8134** of file **wayland-server-protocol-unstable.cpp**. ### std::function\< void()\> & zxdg\_output\_v1\_t::on\_destroy () destroy the xdg\_output object Using this request a client can tell the server that it is not going to use the xdg\_output object anymore. Definition at line **8113** of file **wayland-server-protocol-unstable.cpp**. ### void wayland::server::resource\_t::post\_no\_memory () const` [inherited]` Post 'not enough memory' error to the client If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance. ### bool wayland::server::resource\_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 ## Member Data Documentation ### constexpr std::uint32\_t wayland::server::zxdg\_output\_v1\_t::description\_since\_version = 2` [static]`, ` [constexpr]` Minimum protocol version required for the **description** function. Definition at line **8737** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zxdg\_output\_v1\_t::done\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **done** function. Definition at line **8677** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zxdg\_output\_v1\_t::logical\_position\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **logical\_position** function. Definition at line **8612** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zxdg\_output\_v1\_t::logical\_size\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **logical\_size** function. Definition at line **8658** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zxdg\_output\_v1\_t::name\_since\_version = 2` [static]`, ` [constexpr]` Minimum protocol version required for the **name** function. Definition at line **8706** of file **wayland-server-protocol-unstable.hpp**. ## Author Generated automatically by Doxygen for Wayland++ from the source code.