wayland::server::xdg_wm_base_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 NAME 💅

wayland::server::xdg_wm_base_t — the whole "make a desktop-style surface" situation, bestie. This is the Wayland++ server-side wrapper for xdg_wm_base, and it's giving main character energy fr fr.

✨ SYNOPSIS ✨

#include <wayland-server-protocol-extra.hpp>

🫶 Public Member Functions

  • std::function< void()> & on_destroy () — destroy xdg_wm_base
  • std::function< void(xdg_positioner_t)> & on_create_positioner () — create a positioner object
  • std::function< void(xdg_surface_t, surface_t)> & on_get_xdg_surface () — create a shell surface from a surface
  • std::function< void(uint32_t)> & on_pong () — respond to a ping event
  • void ping (uint32_t serial, bool post=true) — check if the client is alive
  • void post_role (std::string const &msg) — Post error: given wl_surface has another role.
  • void post_defunct_surfaces (std::string const &msg) — Post error: xdg_wm_base was destroyed before children.
  • void post_not_the_topmost_popup (std::string const &msg) — Post error: the client tried to map or destroy a non-topmost popup.
  • void post_invalid_popup_parent (std::string const &msg) — Post error: the client specified an invalid popup parent surface.
  • void post_invalid_surface_state (std::string const &msg) — Post error: the client provided an invalid surface state.
  • void post_invalid_positioner (std::string const &msg) — Post error: the client provided an invalid positioner.
  • 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 ping_since_version = 1 — Minimum protocol version required for the ping function. (iykyk — version gate, bestie)

🌸 Detailed Description 🌸

Okay so, create desktop-style surfaces. Literally what it says on the tin. 🎀

The xdg_wm_base interface is exposed as a global object enabling clients to turn their wl_surfaces into windows in a desktop environment. It defines the basic functionality needed for clients and the compositor to create windows that can be dragged, resized, maximized, etc, as well as creating transient windows such as popup menus. Iconic behavior, no notes. ✨

Definition at line 614 of file wayland-server-protocol-extra.hpp.

🔥 Member Function Documentation 🔥

🦋 std::string wayland::server::resource_t::get_class () [inherited]

Retrieve the interface name (class) of a resource object. Like a little name tag for your resource, bestie. 🏷️

Returns — Interface name of the resource object.

🦋 client_t wayland::server::resource_t::get_client () const [inherited]

Get the associated client. It's giving "who's your person" energy.

Returns — the client that owns the resource.

🦋 uint32_t wayland::server::resource_t::get_id () const [inherited]

Get the internal ID of the resource. The little number that says which one is which. 🔢

Returns — the internal ID of the resource

🦋 unsigned int wayland::server::resource_t::get_version () const [inherited]

Get interface version. Periodt.

Returns — Interface version this resource has been constructed with.

🧚 std::function< void(xdg_positioner_t)> & xdg_wm_base_t::on_create_positioner ()

create a positioner object. Slay, we love a positioning era. 💅

Parameters — id

Create a positioner object. A positioner object is used to position surfaces relative to some parent surface. See the interface description and xdg_surface.get_popup for details.

Definition at line 930 of file wayland-server-protocol-extra.cpp.

🧚 std::function< void()> & xdg_wm_base_t::on_destroy ()

destroy xdg_wm_base. Destroy this xdg_wm_base object. Bye bestie 👋

⚠️ Destroying a bound xdg_wm_base object while there are surfaces still alive created by this xdg_wm_base object instance is illegal and will result in a protocol error. Not a vibe check you wanna fail, fr fr.

Definition at line 924 of file wayland-server-protocol-extra.cpp.

🧚 std::function< void(xdg_surface_t, surface_t)> & xdg_wm_base_t::on_get_xdg_surface ()

create a shell surface from a surface. Glow-up for your wl_surface, honestly. ✨

Parameters — id, surface

This creates an xdg_surface for the given surface. While xdg_surface itself is not a role, the corresponding surface may only be assigned a role extending xdg_surface, such as xdg_toplevel or xdg_popup. It is illegal to create an xdg_surface for a wl_surface which already has an assigned role and this will result in a protocol error. (So like, don't double-book the surface. 💀)

This creates an xdg_surface for the given surface. An xdg_surface is used as basis to define a role to a given surface, such as xdg_toplevel or xdg_popup. It also manages functionality shared between xdg_surface based surface roles.

See the documentation of xdg_surface for more details about what an xdg_surface is and how it is used.

Definition at line 936 of file wayland-server-protocol-extra.cpp.

🧚 std::function< void(uint32_t)> & xdg_wm_base_t::on_pong ()

respond to a ping event. Classic ping/pong, the original back-and-forth. 🏓

Parameters — serial serial of the ping event

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

Definition at line 942 of file wayland-server-protocol-extra.cpp.

🌈 void xdg_wm_base_t::ping (uint32_t serial, bool post = true)

check if the client is alive. The "u up?" of the Wayland protocol, lowkey. 😭

Parameters — serial pass this to the pong request

The ping event asks the client if it's still alive. Pass the serial specified in the event back to the compositor by sending a "pong" request back with the specified serial. See xdg_wm_base.pong.

Compositors can use this to determine if the client is still alive. It's unspecified what will happen if the client doesn't respond to the ping request, or in what timeframe. Clients should try to respond in a reasonable amount of time.

A compositor is free to ping in any way it wants, but a client must always respond to any xdg_wm_base object it created. Non-negotiable, bestie. 💅

Definition at line 948 of file wayland-server-protocol-extra.cpp.

💀 void xdg_wm_base_t::post_defunct_surfaces (std::string const & msg)

Post error: xdg_wm_base was destroyed before children. Oops, outlived your kids, that's a protocol error. 🫠

Definition at line 958 of file wayland-server-protocol-extra.cpp.

💀 void xdg_wm_base_t::post_invalid_popup_parent (std::string const & msg)

Post error: the client specified an invalid popup parent surface. Ma'am, that is not a valid parent. 🙈

Definition at line 968 of file wayland-server-protocol-extra.cpp.

💀 void xdg_wm_base_t::post_invalid_positioner (std::string const & msg)

Post error: the client provided an invalid positioner. The positioner did not pass the vibe check. 🚫

Definition at line 978 of file wayland-server-protocol-extra.cpp.

💀 void xdg_wm_base_t::post_invalid_surface_state (std::string const & msg)

Post error: the client provided an invalid surface state. Bestie… no. 😭

Definition at line 973 of file wayland-server-protocol-extra.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. (Yes, "certail" — that's literally how it's spelled in the docs, we keep the lore intact. 🫶)

💀 void xdg_wm_base_t::post_not_the_topmost_popup (std::string const & msg)

Post error: the client tried to map or destroy a non-topmost popup. Only the topmost popup gets to be the main character. 👑

Definition at line 963 of file wayland-server-protocol-extra.cpp.

💀 void xdg_wm_base_t::post_role (std::string const & msg)

Post error: given wl_surface has another role. Two roles? Not on this compositor's watch. 🎭

Definition at line 953 of file wayland-server-protocol-extra.cpp.

🦋 bool wayland::server::resource_t::proxy_has_object () const [inherited]

Check whether this wrapper actually wraps an object. Like checking if there's actually a person under the fit. 🕵️

Returns — true if there is an underlying object, false if this wrapper is empty

💜 Member Data Documentation 💜

⭐ std::uint32_t wayland::server::xdg_wm_base_t::ping_since_version = 1

[static], [constexpr]

Minimum protocol version required for the ping function. Gatekeeping, but make it protocol. ✨

Definition at line 714 of file wayland-server-protocol-extra.hpp.

🎀 Author 🎀

Generated automatically by Doxygen for Wayland++ from the source code. No human hands touched this prose, bestie — it's literally a machine's magnum opus. 🤖💅

🌈 That's the whole page! Written for Wayland++, Version 1.0.1, dated Fri Mar 27 2026 13. Go forth and build windows, queen. 🫶💖🎀
📦 where this page comes from