wayland::shm_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

🌸 wayland::shm_t(3) — the wayland::shm_t page, bestie edition 🌸

okay so like. this is a page from the Wayland++ manual, and it's all about wayland::shm_t 💖 grab a snack, we're getting into shared memory ✨

💅 NAME 💅

wayland::shm_t — shared memory support. that's it, that's the vibe 🫶

✨ SYNOPSIS ✨

#include <wayland-client-protocol.hpp>

so first things first: wayland::shm_t inherits wayland::proxy_t. like, that's its whole parent situation, respect it 👑

🎀 Public Types 🎀

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — yes queen, the full cast list 💅

🦋 Public Member Functions 🦋

  • shm_pool_t create_pool (int fd, int32_t size) — create a shm pool
  • std::function< void(shm_format)> & on_format () — pixel format description
  • 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_pool_since_version = 1 — Minimum protocol version required for the create_pool function.

💖 Detailed Description 💖

shared memory support. say it with me: shared memory support ✨

it's a singleton global object that provides support for shared memory. one of them. the main character of shm, lowkey 🌟

clients can create wl_shm_pool objects using the create_pool request. slay 🎀

on binding the wl_shm object, one or more format events are emitted to inform clients about the valid pixel formats that can be used for buffers. so like, it tells you what formats are legal before you go off and do something cursed 💀

Examples

  • egl.cpp.

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

🧚 Member Enumeration Documentation 🧚

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

underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling. so it's basically the personality types of proxy wrappers, and each one changes how the object is built, torn down, and how events come through 👑

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. this one is the "not yours, don't touch it" girlie — respect the boundaries fr fr 🙈
  • 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. bestie, if there's no object, it does NOT politely return null, it throws 😭

shm_pool_t shm_t::create_pool (int fd, int32_t size)

create a shm pool 🎀

Returns — pool to create

Parameters

  • fd — file descriptor for the pool
  • size — pool size, in bytes

Create a new wl_shm_pool object.

The pool can be used to create shared memory based buffer objects. The server will mmap size bytes of the passed file descriptor, to use as backing memory for the pool. that's the whole magic trick ✨

Definition at line 1883 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, do NOT go assuming things you don't know, that's how you get undefined behaviour energy 💀

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.

std::function< void(shm_format)> & shm_t::on_format ()

pixel format description 🌈

Parameters

  • format — buffer pixel format

Informs the client about a valid pixel format that can be used for buffers. Known formats include argb8888 and xrgb8888. iconic pixel formats honestly 💅

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

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. so if you try it on a display_t, nothing happens — it just ignores you and moves on, which honestly is such a mood 🙈

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. so you're basically telling this proxy "girl, your mail goes to THIS mailbox now" 💌

See also: display_t::dispatch_queue().

Examples

  • proxy_wrapper.cpp.

⭐ Member Data Documentation ⭐

std::uint32_t wayland::shm_t::create_pool_since_version = 1 [static], [constexpr]

Minimum protocol version required for the create_pool function. it's 1. the bare minimum. the floor. respect it 🫶

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

🦋 Author 🦋

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

okay and that's the whole page, bestie 💜 this was wayland::shm_t(3), Version 1.0.1, dated Fri Mar 27 2026 13:15:00, and it's from the Wayland++ manual. go forth and share that memory responsibly ✨🎀💅

📦 where this page comes from