wayland::server::compositor_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::server::compositor_t(3) 💅

okay so bestie, this is the wayland::server::compositor_t manpage from Wayland++ — the compositor singleton itself, no cap. sit down, grab a boba, we're learning today 🧋✨

🌸 NAME 🌸

wayland::server::compositor_t — the compositor singleton 👑

✨ SYNOPSIS ✨

#include <wayland-server-protocol.hpp>

🎀 Public Member Functions 🎀

  • std::function< void(surface_t)> & on_create_surface () — create new surface
  • std::function< void(region_t)> & on_create_region () — create new region
  • 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 ()

🦋 Detailed Description 🦋

the compositor singleton. yes, that's literally the whole vibe — it's a singleton global, main character energy, only one of them, periodt 💫

A compositor. This object is a singleton global. The compositor is in charge of combining the contents of multiple surfaces into one displayable output.

fr fr, it's the thing that takes all ur surfaces and smushes them into one output you can actually look at. iconic behavior honestly 🖥️✨

Definition at line 269 of file wayland-server-protocol.hpp.

🌈 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.

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(region_t)> & compositor_t::on_create_region ()

create new region 🫶

Parameters

  • id — the new region

Ask the compositor to create a new region.

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

std::function< void(surface_t)> & compositor_t::on_create_surface ()

create new surface ✨

Parameters

  • id — the new surface

Ask the compositor to create a new surface.

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

ngl this is the sad one — no memory left, so you call this to break it to the client gently. (and yes, the original really does say "certail", we stan a typo queen 💀)

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

👑 Author 👑

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

okay that's the whole page bestie, you ate that 🍓💜 — this was Version 1.0.1, dated Fri Mar 27 2026, and that's the whole vibe check, byeee 🧚‍♀️🎀

📦 where this page comes from