wayland::compositor_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 NAME

wayland::compositor_t — the compositor singleton, bestie. That's it, that's the whole name. (This is a page from the Wayland++ manual, section 3, and we're gonna get through it together, ok? 🫶)

✨ SYNOPSIS ✨

#include <wayland-client-protocol.hpp>

Inherits wayland::proxy_t. So like, everything the parent has? She has it too. Genetics 💅

🎀 Public Types

  • enum class wrapper_type — with values standard, display, foreign, proxy_wrapper

🌸 Public Member Functions

  • surface_t create_surface () — create new surface
  • region_t create_region () — create new region
  • 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 create_surface_since_version = 1 — Minimum protocol version required for the create_surface function.
  • static constexpr std::uint32_t create_region_since_version = 1 — Minimum protocol version required for the create_region function.

🦋 Detailed Description

the compositor singleton 💫

Okay so picture this: a compositor. This object is a singleton global. The compositor is literally the one in charge of combining the contents of multiple surfaces into one displayable output. She's the main character combining everyone's windows into one gorgeous screen. No cap. 🔥

Examples

  • egl.cpp.

Definition at line 253 of file wayland-client-protocol.hpp.

🌈 Member Enumeration Documentation

enum class wayland::proxy_t::wrapper_type [strong], [inherited]

This enum describes the underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling. It's giving "character sheet for your proxy" honestly. 🧚

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. 🙈 (bestie, don't poke the other library's stuff. hands off.)
  • 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 117 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. 😭 (yes, exception. it's a whole thing.)

region_t compositor_t::create_region ()

create new region

Returns the new region

Ask the compositor to create a new region. You're literally asking her. Politely. 💅

Definition at line 1753 of file wayland-client-protocol.cpp.

surface_t compositor_t::create_surface ()

create new surface

Returns the new surface

Ask the compositor to create a new surface. Same energy, different object. ✨

Definition at line 1746 of file wayland-client-protocol.cpp.

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. ⚠️ like, don't assume, bestie.

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 303 of file wayland-client.hpp.

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.

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. 💀 sobbing, the display said no thank you.

Examples

  • foreign_display.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. It's giving "rerouting your mail to a different mailbox". 🎀

See also: display_t::dispatch_queue().

Examples

  • proxy_wrapper.cpp.

👑 Member Data Documentation

std::uint32_t wayland::compositor_t::create_region_since_version = 1 [static], [constexpr]

Minimum protocol version required for the create_region function.

Definition at line 297 of file wayland-client-protocol.hpp.

std::uint32_t wayland::compositor_t::create_surface_since_version = 1 [static], [constexpr]

Minimum protocol version required for the create_surface function.

Definition at line 285 of file wayland-client-protocol.hpp.

🧚 Author

Generated automatically by Doxygen for Wayland++ from the source code. (Doxygen wrote this, not a human, and honestly she ate. 🤖✨)

okay that's the whole page, you made it!! 💜 This was Version 1.0.1, dated Fri Mar 27 2026 13:15:00, and it's the wayland::compositor_t(3) page from the Wayland++ manual — go forth and composite your little heart out, bestie. 🦋🎀⭐
📦 where this page comes from