---
name: "wayland_shell_surface_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_shell_surface_t"
---

# wayland\_shell\_surface\_t(3)

desktop-style metadata interface

## NAME

wayland::shell\_surface\_t - desktop-style metadata interface

## SYNOPSIS

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

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

### Public Types

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

### Public Member Functions

void **pong** (uint32\_t serial)\
 respond to a ping event  void **move** (**seat\_t** const &seat, uint32\_t serial)\
 start an interactive move  void **resize** (**seat\_t** const &seat, uint32\_t serial, **shell\_surface\_resize** const &edges)\
 start an interactive resize  void **set\_toplevel** ()\
 make the surface a toplevel surface  void **set\_transient** (**surface\_t** const &parent, int32\_t x, int32\_t y, **shell\_surface\_transient** const &flags)\
 make the surface a transient surface  void **set\_fullscreen** (shell\_surface\_fullscreen\_method const &method, uint32\_t framerate, **output\_t** const &output)\
 make the surface a fullscreen surface  void **set\_popup** (**seat\_t** const &seat, uint32\_t serial, **surface\_t** const &parent, int32\_t x, int32\_t y, **shell\_surface\_transient** const &flags)\
 make the surface a popup surface  void **set\_maximized** (**output\_t** const &output)\
 make the surface a maximized surface  void **set\_title** (std::string const &title)\
 set surface title  void **set\_class** (std::string const &class\_)\
 set surface class  std::function\< void(uint32\_t)\> & **on\_ping** ()\
 ping client  std::function\< void(**shell\_surface\_resize**, int32\_t, int32\_t)\> & **on\_configure** ()\
 suggest resize  std::function\< void()\> & **on\_popup\_done** ()\
 popup interaction is done  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 **pong\_since\_version** = 1\
 Minimum protocol version required for the **pong** function.  static constexpr std::uint32\_t **move\_since\_version** = 1\
 Minimum protocol version required for the **move** function.  static constexpr std::uint32\_t **resize\_since\_version** = 1\
 Minimum protocol version required for the **resize** function.  static constexpr std::uint32\_t **set\_toplevel\_since\_version** = 1\
 Minimum protocol version required for the **set\_toplevel** function.  static constexpr std::uint32\_t **set\_transient\_since\_version** = 1\
 Minimum protocol version required for the **set\_transient** function.  static constexpr std::uint32\_t **set\_fullscreen\_since\_version** = 1\
 Minimum protocol version required for the **set\_fullscreen** function.  static constexpr std::uint32\_t **set\_popup\_since\_version** = 1\
 Minimum protocol version required for the **set\_popup** function.  static constexpr std::uint32\_t **set\_maximized\_since\_version** = 1\
 Minimum protocol version required for the **set\_maximized** function.  static constexpr std::uint32\_t **set\_title\_since\_version** = 1\
 Minimum protocol version required for the **set\_title** function.  static constexpr std::uint32\_t **set\_class\_since\_version** = 1\
 Minimum protocol version required for the **set\_class** function.

## Detailed Description

desktop-style metadata interface

An interface that may be implemented by a wl\_surface, for implementations that provide a desktop-style user interface.

It provides requests to treat surfaces like toplevel, fullscreen or popup windows, move, resize or maximize them, associate metadata like title and class, etc.

On the server side the object is automatically destroyed when the related wl\_surface is destroyed. On the client side, wl\_shell\_surface\_destroy() must be called before destroying the wl\_surface object.

**Examples** **egl.cpp**, and **shm.cpp**.

Definition at line **1591** 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*

### 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***.*

### void shell\_surface\_t::move (seat\_t const & seat, uint32\_t serial)

*start an interactive move*

**Parameters**

*seat seat whose pointer is used* \
 *serial serial number of the implicit grab on the pointer*

*Start a pointer-driven move of the surface.*

*This request must be used in response to a button press event. The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized).*

**Examples** **egl.cpp***, and* **shm.cpp***.*

*Definition at line* **2542** *of file* **wayland-client-protocol.cpp***.*

### std::function\< void(shell\_surface\_resize, int32\_t, int32\_t)\> & shell\_surface\_t::on\_configure ()

*suggest resize*

**Parameters**

*edges how the surface was resized* \
 *width new width of the surface* \
 *height new height of the surface*

*The configure event asks the client to resize its surface.*

*The size is a hint, in the sense that the client is free to ignore it if it doesn't resize, pick a smaller size (to satisfy aspect ratio or resize in steps of NxM pixels).*

*The edges parameter provides a hint about how the surface was resized. The client may use this information to decide how to adjust its content to the new size (e.g. a scrolling area might adjust its content position to leave the viewable content unmoved).*

*The client is free to dismiss all but the last configure event it received.*

*The width and height arguments specify the size of the window in surface-local coordinates.*

*Definition at line* **2601** *of file* **wayland-client-protocol.cpp***.*

### std::function\< void(uint32\_t)\> & shell\_surface\_t::on\_ping ()

*ping client*

**Parameters**

*serial serial number of the ping*

*Ping a client to check if it is receiving events and sending requests. A client is expected to reply with a pong request.*

**Examples** **egl.cpp***, and* **shm.cpp***.*

*Definition at line* **2596** *of file* **wayland-client-protocol.cpp***.*

### std::function\< void()\> & shell\_surface\_t::on\_popup\_done ()

*popup interaction is done The popup\_done event is sent out when a popup grab is broken, that is, when the user clicks a surface that doesn't belong to the client owning the popup surface.*

*Definition at line* **2606** *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.*

### void shell\_surface\_t::pong (uint32\_t serial)

*respond to a ping event*

**Parameters**

*serial serial number of the ping event*

*A client must respond to a ping event with a pong request or the client may be deemed unresponsive.*

**Examples** **egl.cpp***, and* **shm.cpp***.*

*Definition at line* **2536** *of file* **wayland-client-protocol.cpp***.*

### 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 shell\_surface\_t::resize (seat\_t const & seat, uint32\_t serial, shell\_surface\_resize const & edges)

*start an interactive resize*

**Parameters**

*seat seat whose pointer is used* \
 *serial serial number of the implicit grab on the pointer* \
 *edges which edge or corner is being dragged*

*Start a pointer-driven resizing of the surface.*

*This request must be used in response to a button press event. The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized).*

*Definition at line* **2548** *of file* **wayland-client-protocol.cpp***.*

### void shell\_surface\_t::set\_class (std::string const & class\_)

*set surface class*

**Parameters**

*class\_ surface class*

*Set a class for the surface.*

*The surface class identifies the general class of applications to which the surface belongs. A common convention is to use the file name (or the full path if it is a non-standard location) of the application's .desktop file as the class.*

*Definition at line* **2590** *of file* **wayland-client-protocol.cpp***.*

### void shell\_surface\_t::set\_fullscreen (shell\_surface\_fullscreen\_method const & method, uint32\_t framerate, output\_t const & output)

*make the surface a fullscreen surface*

**Parameters**

*method method for resolving size conflict* \
 *framerate framerate in mHz* \
 *output output on which the surface is to be fullscreen*

*Map the surface as a fullscreen surface.*

*If an output parameter is given then the surface will be made fullscreen on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area.*

*The client may specify a method to resolve a size conflict between the output size and the surface size - this is provided through the method parameter.*

*The framerate parameter is used only when the method is set to 'driver', to indicate the preferred framerate. A value of 0 indicates that the client does not care about framerate. The framerate is specified in mHz, that is framerate of 60000 is 60Hz.*

*A method of 'scale' or 'driver' implies a scaling operation of the surface, either via a direct scaling operation or a change of the output mode. This will override any kind of output scaling, so that mapping a surface with a buffer size equal to the mode can fill the screen independent of buffer\_scale.*

*A method of 'fill' means we don't scale up the buffer, however any output scale is applied. This means that you may run into an edge case where the application maps a buffer with the same size of the output mode but buffer\_scale 1 (thus making a surface larger than the output). In this case it is allowed to downscale the results to fit the screen.*

*The compositor must reply to this request with a configure event with the dimensions for the output on which the surface will be made fullscreen.*

*Definition at line* **2566** *of file* **wayland-client-protocol.cpp***.*

### void shell\_surface\_t::set\_maximized (output\_t const & output)

*make the surface a maximized surface*

**Parameters**

*output output on which the surface is to be maximized*

*Map the surface as a maximized surface.*

*If an output parameter is given then the surface will be maximized on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area.*

*The compositor will reply with a configure event telling the expected new surface size. The operation is completed on the next buffer attach to this surface.*

*A maximized surface typically fills the entire output it is bound to, except for desktop elements such as panels. This is the main difference between a maximized shell surface and a fullscreen shell surface.*

*The details depend on the compositor implementation.*

*Definition at line* **2578** *of file* **wayland-client-protocol.cpp***.*

### void shell\_surface\_t::set\_popup (seat\_t const & seat, uint32\_t serial, surface\_t const & parent, int32\_t x, int32\_t y, shell\_surface\_transient const & flags)

*make the surface a popup surface*

**Parameters**

*seat seat whose pointer is used* \
 *serial serial number of the implicit grab on the pointer* \
 *parent parent surface* \
 *x surface-local x coordinate* \
 *y surface-local y coordinate* \
 *flags transient surface behavior*

*Map the surface as a popup.*

*A popup surface is a transient surface with an added pointer grab.*

*An existing implicit grab will be changed to owner-events mode, and the popup grab will continue after the implicit grab ends (i.e. releasing the mouse button does not cause the popup to be unmapped).*

*The popup grab continues until the window is destroyed or a mouse button is pressed in any other client's window. A click in any of the client's surfaces is reported as normal, however, clicks in other clients' surfaces will be discarded and trigger the callback.*

*The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates.*

*Definition at line* **2572** *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***.*

### void shell\_surface\_t::set\_title (std::string const & title)

*set surface title*

**Parameters**

*title surface title*

*Set a short title for the surface.*

*This string may be used to identify the surface in a task bar, window list, or other user interface elements provided by the compositor.*

*The string must be encoded in UTF-8.*

**Examples** **egl.cpp***, and* **shm.cpp***.*

*Definition at line* **2584** *of file* **wayland-client-protocol.cpp***.*

### void shell\_surface\_t::set\_toplevel ()

*make the surface a toplevel surface Map the surface as a toplevel surface.*

*A toplevel surface is not fullscreen, maximized or transient.*

**Examples** **egl.cpp***, and* **shm.cpp***.*

*Definition at line* **2554** *of file* **wayland-client-protocol.cpp***.*

### void shell\_surface\_t::set\_transient (surface\_t const & parent, int32\_t x, int32\_t y, shell\_surface\_transient const & flags)

*make the surface a transient surface*

**Parameters**

*parent parent surface* \
 *x surface-local x coordinate* \
 *y surface-local y coordinate* \
 *flags transient surface behavior*

*Map the surface relative to an existing surface.*

*The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates.*

*The flags argument controls details of the transient behaviour.*

*Definition at line* **2560** *of file* **wayland-client-protocol.cpp***.*

## Member Data Documentation

### constexpr std::uint32\_t wayland::shell\_surface\_t::move\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **move** *function.*

*Definition at line* **1644** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::shell\_surface\_t::pong\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **pong** *function.*

*Definition at line* **1627** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::shell\_surface\_t::resize\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **resize** *function.*

*Definition at line* **1662** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::shell\_surface\_t::set\_class\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_class** *function.*

*Definition at line* **1841** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::shell\_surface\_t::set\_fullscreen\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_fullscreen** *function.*

*Definition at line* **1742** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::shell\_surface\_t::set\_maximized\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_maximized** *function.*

*Definition at line* **1806** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::shell\_surface\_t::set\_popup\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_popup** *function.*

*Definition at line* **1777** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::shell\_surface\_t::set\_title\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_title** *function.*

*Definition at line* **1824** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::shell\_surface\_t::set\_toplevel\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_toplevel** *function.*

*Definition at line* **1675** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::shell\_surface\_t::set\_transient\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_transient** *function.*

*Definition at line* **1696** *of file* **wayland-client-protocol.hpp***.*

## Author

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