---
name: "wayland_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_zxdg_output_v1_t"
---

# wayland\_zxdg\_output\_v1\_t(3)

compositor logical output region

## NAME

wayland::zxdg\_output\_v1\_t - compositor logical output region

## SYNOPSIS

`#include <wayland-client-protocol-unstable.hpp>`

Inherits **wayland::proxy\_t**.

### Public Types

enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\

### Public Member Functions

std::function\< void(int32\_t, int32\_t)\> & **on\_logical\_position** ()\
 position of the output within the global compositor space  std::function\< void(int32\_t, int32\_t)\> & **on\_logical\_size** ()\
 size of the output in the global compositor space  std::function\< void()\> & **on\_done** ()\
 all information about the output have been sent  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.

## 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 **7530** of file **wayland-client-protocol-unstable.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*

### 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)\> & zxdg\_output\_v1\_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, 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* **9599** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void()\> & zxdg\_output\_v1\_t::on\_done ()

*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* **9589** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(int32\_t, int32\_t)\> & zxdg\_output\_v1\_t::on\_logical\_position ()

*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* **9579** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(int32\_t, int32\_t)\> & zxdg\_output\_v1\_t::on\_logical\_size ()

*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* **9584** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(std::string)\> & zxdg\_output\_v1\_t::on\_name ()

*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* **9594** *of file* **wayland-client-protocol-unstable.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 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***.*

## Author

*Generated automatically by Doxygen for Wayland++ from the source code.*