wayland::serve...ubcompositor_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 NAME 💅

wayland::server::subcompositor_t — sub-surface compositing, bestie. that's the whole vibe ✨

oh and hiii, you're in the Wayland++ section of the manual (3), so like… buckle up 🎀

✨ SYNOPSIS ✨

#include <wayland-server-protocol.hpp>

🦋 Public Member Functions 🦋

  • std::function< void()> & on_destroy () — unbind from the subcompositor interface
  • std::function< void(subsurface_t, surface_t, surface_t)> & on_get_subsurface () — give a surface the role sub-surface
  • void post_bad_surface (std::string const &msg) — Post error: the to-be sub-surface is invalid.
  • bool proxy_has_object () const — Check whether this wrapper actually wraps an object.
  • void post_no_memory () const — no description given for this one in here, it just exists, and it's giving "mysterious icon" energy 🙈
  • uint32_t get_id () const — also undeclared in the writeup, we move
  • client_t get_client () const — same, no blurb, but she's here 💅
  • unsigned int get_version () const — present and accounted for ⭐
  • std::string get_class () — yup, also on the list

🌸 Detailed Description 🌸

sub-surface compositing. okay so this is the whole point of the page, and honestly it ate 👑

The global interface exposing sub-surface compositing capabilities. A wl_surface, that has sub-surfaces associated, is called the parent surface. Sub-surfaces can be arbitrarily nested and create a tree of sub-surfaces. like a whole little family tree, no cap 🌳

The root surface in a tree of sub-surfaces is the main surface. The main surface cannot be a sub-surface, because sub-surfaces must always have a parent. periodt. main character energy only 💅

A main surface with its sub-surfaces forms a (compound) window. For window management purposes, this set of wl_surface objects is to be considered as a single window, and it should also behave as such. one window, one vibe check — they're a package deal fr fr 🫶

The aim of sub-surfaces is to offload some of the compositing work within a window from clients to the compositor. A prime example is a video player with decorations and video in separate wl_surface objects. This should allow the compositor to pass YUV video buffer processing to dedicated overlay hardware when possible. literally so efficient, the hardware does the heavy lifting and everyone wins 🔥

Definition at line 4128 of file wayland-server-protocol.hpp. — screenshot-worthy ✨

🎀 Member Function Documentation 🎀

🌈 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. that's it, that's the tea 🍓

💜 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()> & subcompositor_t::on_destroy ()

unbind from the subcompositor interface. Informs the server that the client will not be using this protocol object anymore. This does not affect any other objects, wl_subsurface objects included. so like, she's leaving the group chat but she's NOT removing anyone else from it, everyone else stays ✋😭

Definition at line 3097 of file wayland-server-protocol.cpp.

👑 std::function< void(subsurface_t, surface_t, surface_t)> & subcompositor_t::on_get_subsurface ()

give a surface the role sub-surface.

Parameters

  • id — the new sub-surface object ID
  • surface — the surface to be turned into a sub-surface
  • parent — the parent surface

Create a sub-surface interface for the given surface, and associate it with the given parent surface. This turns a plain wl_surface into a sub-surface. glow-up moment 🌸

The to-be sub-surface must not already have another role, and it must not have an existing wl_subsurface object. Otherwise a protocol error is raised. no double-dipping, no role-stealing, the rules are the rules 🚨

Adding sub-surfaces to a parent is a double-buffered operation on the parent (see wl_surface.commit). The effect of adding a sub-surface becomes visible on the next time the state of the parent surface is applied.

This request modifies the behaviour of wl_surface.commit request on the sub-surface, see the documentation on wl_subsurface interface.

Definition at line 3103 of file wayland-server-protocol.cpp.

🦋 void subcompositor_t::post_bad_surface (std::string const & msg)

Post error: the to-be sub-surface is invalid. the ick is real 💀

Definition at line 3109 of file wayland-server-protocol.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. basically "bestie i'm running on fumes" as a formal notification 😭

⭐ 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. simple as that, vibe check passed or failed 💅

🌈 Author 🌈

Generated automatically by Doxygen for Wayland++ from the source code. not a human, just a lil robot doing her best 🧚✨

Version 1.0.1 — Fri Mar 27 2026 — that's the whole page bestie, love u, go write some sub-surfaces 💖🦋🌸🎀🫶
📦 where this page comes from