wayland::serve...g_surface_v6_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

🌸 NAME 🌸

wayland::server::zxdg_surface_v6_t — desktop user interface surface base interface. This is from the Wayland++ manual, bestie, and yes we’re getting into the xdg_surface lore 💖

✨ SYNOPSIS ✨

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

💅 Public Member Functions

  • std::function< void()> & on_destroy () — destroy the xdg_surface
  • std::function< void(zxdg_toplevel_v6_t)> & on_get_toplevel () — assign the xdg_toplevel surface role
  • std::function< void(zxdg_popup_v6_t, zxdg_surface_v6_t, zxdg_positioner_v6_t)> & on_get_popup () — assign the xdg_popup surface role
  • std::function< void(int32_t, int32_t, int32_t, int32_t)> & on_set_window_geometry () — set the new window geometry
  • std::function< void(uint32_t)> & on_ack_configure () — ack a configure event
  • void configure (uint32_t serial, bool post=true) — suggest a surface change
  • void post_not_constructed (std::string const &msg) — Post error:
  • void post_already_constructed (std::string const &msg) — Post error:
  • void post_unconfigured_buffer (std::string const &msg) — Post error:
  • 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 configure_since_version = 1 — Minimum protocol version required for the configure function.

💖 Detailed Description 💖

desktop user interface surface base interface

An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface. It gives you the base set of functionality you need to construct user interface elements that the compositor has to manage — think toplevel windows, menus, etc. The functionality is split into xdg_surface roles.

Creating an xdg_surface does not set the role for a wl_surface. To map an xdg_surface, the client has to create a role-specific object using, for example, get_toplevel or get_popup. The wl_surface for any given xdg_surface can have at most one role, and it may not be assigned any role that isn’t based on xdg_surface.

A role must be assigned before any other requests are made to the xdg_surface object.

The client must call wl_surface.commit on the corresponding wl_surface for the xdg_surface state to take effect.

Creating an xdg_surface from a wl_surface that already has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer before the first xdg_surface.configure call must also be treated as errors.

For a surface to be mapped by the compositor, these conditions all have to be met: (1) the client has assigned an xdg_surface based role to the surface, (2) the client has set and committed the xdg_surface state and the role dependent state to the surface, and (3) the client has committed a buffer to the surface.

Definition at line 9197 of file wayland-server-protocol-unstable.hpp.

🦋 Member Function Documentation 🦋

void zxdg_surface_v6_t::configure (uint32_t serial, bool post = true)

suggest a surface change

Parameters:

  • serial — serial of the configure event

The configure event marks the end of a configure sequence. A configure sequence is a set of one or more events configuring the state of the xdg_surface, including the final xdg_surface.configure event.

Where applicable, xdg_surface surface roles will, during a configure sequence, extend this event as a latched state sent as events before the xdg_surface.configure event. Those events should be considered as making up a set of atomically applied configuration states, where the xdg_surface.configure commits the accumulated state.

Clients should arrange their surface for the new states, then send an ack_configure request with the serial sent in this configure event at some point before committing the new surface.

If the client receives multiple configure events before it can respond to one, it is free to discard all but the last event it received. Slay, honestly.

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

std::function< void(uint32_t)> & zxdg_surface_v6_t::on_ack_configure ()

ack a configure event

Parameters:

  • serial — the serial from the configure event

When a configure event is received, if a client commits the surface in response to that configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event.

For instance, for toplevel surfaces, the compositor might use this information to move a surface to the top left only when the client has drawn itself for the maximized or fullscreen state.

If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event.

A client is not required to commit immediately after sending an ack_configure request — it may even ack_configure several times before its next surface commit.

A client may send multiple ack_configure requests before committing, but only the last request sent before a commit indicates which configure event the client is really responding to.

Definition at line 8426 of file wayland-server-protocol-unstable.cpp.

std::function< void()> & zxdg_surface_v6_t::on_destroy ()

destroy the xdg_surface

Destroy the xdg_surface object. An xdg_surface must only be destroyed after its role object has been destroyed. That part is important, bestie — no yeeting it early 💀

Definition at line 8402 of file wayland-server-protocol-unstable.cpp.

std::function< void(zxdg_popup_v6_t, zxdg_surface_v6_t, zxdg_positioner_v6_t)> & zxdg_surface_v6_t::on_get_popup ()

assign the xdg_popup surface role

Parameters:

  • id
  • parent
  • positioner

This creates an xdg_popup object for the given xdg_surface and gives the associated wl_surface the xdg_popup role.

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

Definition at line 8414 of file wayland-server-protocol-unstable.cpp.

std::function< void(zxdg_toplevel_v6_t)> & zxdg_surface_v6_t::on_get_toplevel ()

assign the xdg_toplevel surface role

Parameters:

  • id

This creates an xdg_toplevel object for the given xdg_surface and gives the associated wl_surface the xdg_toplevel role.

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

Definition at line 8408 of file wayland-server-protocol-unstable.cpp.

std::function< void(int32_t, int32_t, int32_t, int32_t)> & zxdg_surface_v6_t::on_set_window_geometry ()

set the new window geometry

Parameters:

  • x
  • y
  • width
  • height

The window geometry of a surface is its “visible bounds” from the user’s perspective. Client-side decorations often have invisible portions like drop-shadows, and those should be ignored for the purposes of aligning, placing and constraining windows.

The window geometry is double buffered, and it will be applied at the time wl_surface.commit of the corresponding wl_surface is called.

Once the window geometry of the surface is set, it is not possible to unset it. It will remain the same until set_window_geometry is called again, even if a new subsurface or buffer is attached.

If it is never set, the value is the full bounds of the surface, including any subsurfaces. This updates dynamically on every commit. This unset is meant for extremely simple clients.

The arguments are given in the surface-local coordinate space of the wl_surface associated with this xdg_surface.

The width and height must be greater than zero. Setting an invalid size will raise an error. When applied, the effective window geometry will be the set window geometry clamped to the bounding rectangle of the combined geometry of the surface of the xdg_surface and the associated subsurfaces.

Definition at line 8420 of file wayland-server-protocol-unstable.cpp.

void zxdg_surface_v6_t::post_already_constructed (std::string const & msg)

Post error:

Definition at line 8442 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 — yes, the page says “certail,” and we respect it — this function can be called to notify the client of this circumstance.

void zxdg_surface_v6_t::post_not_constructed (std::string const & msg)

Post error:

Definition at line 8437 of file wayland-server-protocol-unstable.cpp.

void zxdg_surface_v6_t::post_unconfigured_buffer (std::string const & msg)

Post error:

Definition at line 8447 of file wayland-server-protocol-unstable.cpp.

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 🌈

std::uint32_t wayland::server::zxdg_surface_v6_t::configure_since_version = 1 [static], [constexpr]

Minimum protocol version required for the configure function.

Definition at line 9346 of file wayland-server-protocol-unstable.hpp.

👑 Author 👑

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

Version 1.0.1, dated Fri Mar 27 2026, generated from the source code for Wayland++ — that’s the source/version/date tea, bestie 🫶💜✨

📦 where this page comes from