wayland::viewporter_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::viewporter_t(3) — the Wayland++ glow-up

okay so bestie, welcome to the wayland::viewporter_t page 💖 this is the Wayland++ manual, and this particular entry is all about surface cropping and scaling. we're gonna walk through every single member, flag, and inherited lil function, no cap. let's go ✨

🌸 NAME

wayland::viewporter_t — surface cropping and scaling

🦋 SYNOPSIS

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

Inherits wayland::proxy_t.

🎀 Public Types

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the four flavors of proxy wrapper vibe

💜 Public Member Functions

  • viewport_t get_viewport (surface_t const &surface) — extend surface interface for crop and scale
  • 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 get_viewport_since_version = 1 — Minimum protocol version required for the get_viewport function.

🔥 Detailed Description

bestie. okay. surface cropping and scaling 😌

The global interface exposing surface cropping and scaling capabilities is used to instantiate an interface extension for a wl_surface object. This extended interface will then allow cropping and scaling the surface contents, effectively disconnecting the direct relationship between the buffer and the surface size. it's giving main character energy for your surfaces, fr fr 💅

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

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

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

🍓 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

🌸 viewport_t viewporter_t::get_viewport (surface_t const & surface)

extend surface interface for crop and scale — literally the whole point of this page, bestie 🎀

Returns — the new viewport interface id

Parameters

  • surface — the surface

Instantiate an interface extension for the given wl_surface to crop and scale its content. If the given wl_surface already has a wp_viewport object associated, the viewport_exists protocol error is raised. 🚨 so like, don't do that.

Definition at line 883 of file wayland-client-protocol-extra.cpp.

🦋 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. 🙈

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

Minimum protocol version required for the get_viewport function.

Definition at line 358 of file wayland-client-protocol-extra.hpp.

🫶 Author

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

💌 and that's the whole page bestie, every last member accounted for, no cap 🫶

Version 1.0.1 · Fri Mar 27 2026 13:15:00 — mwah, that's the sign-off, hope this helped, ily, go crop some surfaces 💅✨🎀

📦 where this page comes from