wayland::zwp_i...t_manager_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💖 wayland::zwp_i...t_manager_v1_t(3) 💖

Hii bestie! Welcome to the Wayland++ page for wayland::zwp_i...t_manager_v1_t(3) — yes, the title is long and dramatic, and we are obsessed. The manual name is Wayland++, and this whole page is about controlling what happens when the display gets sleepy. 💅

✨ NAME ✨

wayland::zwp_idle_inhibit_manager_v1_t — control behavior when display idles 💤

🦋 SYNOPSIS 🦋

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

Inherits wayland::proxy_t.

👑 Public Types 👑

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper }

💜 Public Member Functions 💜

  • zwp_idle_inhibitor_v1_t create_inhibitor (surface_t const &surface) — create a new inhibitor object
  • uint32_t get_id () const — grab the id of a proxy object.
  • std::string get_class () const — grab the interface name (class) of a proxy object.
  • uint32_t get_version () const — grab the protocol object version of a proxy object.
  • wrapper_type get_wrapper_type () const — grab 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 — grab 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_inhibitor_since_version = 1 — minimum protocol version required for the create_inhibitor function.

🌸 Detailed Description 🌸

control behavior when display idles

Bestie, this interface lets you inhibit the idle behavior such as screen blanking, locking, and screensaving. The client binds the idle manager globally, then creates idle-inhibitor objects for each surface. It is literally giving “please do not fall asleep on me” energy. 😭

⚠️ Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the 'z' prefix and the version number in the protocol and interface names are removed and the interface version number is reset.

Definition at line 600 of file wayland-client-protocol-unstable.hpp.

🧚 Member Enumeration Documentation 🧚

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

This is the underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling. Very main character meta, 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.
  • 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. No cap, it just hands you the C pointer.

Returns

  • The underlying wl_proxy wrapped by this proxy_t if it exists, otherwise an exception is thrown

🌟 zwp_idle_inhibitor_v1_t zwp_idle_inhibit_manager_v1_t::create_inhibitor (surface_t const & surface) 🌟

create a new inhibitor object

Parameters

  • surface — the surface that inhibits the idle behavior

Create a new inhibitor object associated with the given surface. Slay, now that surface has main character anti-nap energy.

Definition at line 4424 of file wayland-client-protocol-unstable.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.

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. So do not try it with a display_t, bestie — it is not that kind of party.

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.

See also: display_t::dispatch_queue().

Examples

  • proxy_wrapper.cpp

🎀 Member Data Documentation 🎀

⭐ std::uint32_t wayland::zwp_idle_inhibit_manager_v1_t::create_inhibitor_since_version = 1 [static], [constexpr] ⭐

Minimum protocol version required for the create_inhibitor function.

Definition at line 632 of file wayland-client-protocol-unstable.hpp.

🌈 Author 🌈

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

💖 That is the whole vibe, bestie! This page was generated automatically by Doxygen for Wayland++ from the source code — Version 1.0.1, dated Fri Mar 27 2026. Stay hydrated, keep your surfaces awake when you need them, and may your idle inhibitors always slay. 💅✨🦋
📦 where this page comes from