wayland::zxdg_exporter_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

🌸 NAME 🌸

wayland::zxdg_exporter_v1_t — interface for exporting surfaces. Bestie, you're on the wayland::zxdg_exporter_v1_t(3) page from Wayland++ 💅✨

✨ 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 🫶

  • zxdg_exported_v1_t _export (surface_t const &surface) — export a surface
  • 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 export_since_version = 1 — Minimum protocol version required for the _export function.

💖 Detailed Description 💖

interface for exporting surfaces

A global interface used for exporting surfaces that can later be imported using xdg_importer. No cap, that's the whole vibe of this one 🦋

Definition at line 7050 of file wayland-client-protocol-unstable.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. This is the little enum that tells you what kind of proxy wrapper you're holding, bestie 🎀

  • 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 🫶

🌟 zxdg_exported_v1_t zxdg_exporter_v1_t::_export (surface_t const & surface)

export a surface

Returns: the new xdg_exported object 💖

Parameters: surface — the surface to export

The export request exports the passed surface so that it can later be imported via xdg_importer. When called, a new xdg_exported object will be created and xdg_exported.handle will be sent immediately. See the corresponding interface and event for details. Literally all the important handle magic happens right here ✨

A surface may be exported multiple times, and each exported handle may be used to create an xdg_imported multiple times. Only xdg_surface surfaces may be exported.

Definition at line 8978 of file wayland-client-protocol-unstable.cpp.

🦋 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. So yeah, be ready for feelings if it's empty 😭

🐚 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. That's a big mood, so don't go assuming stuff, 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. So don't try to release a display_t, it's giving "not today" 💀

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::zxdg_exporter_v1_t::export_since_version = 1 [static], [constexpr]

Minimum protocol version required for the _export function.

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

👑 Author 👑

Generated automatically by Doxygen for Wayland++ from the source code. Iconic tooling behavior, honestly 🫶

Version 1.0.1 — Fri Mar 27 2026 13:15. That's the footer bestie, Wayland++ version 1.0.1, dated Fri Mar 27 2026 13:15, and we are so done here 💖✨🎀

📦 where this page comes from