wayland::server::viewporter_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

🌸 NAME 🌸

wayland::server::viewporter_t — surface cropping and scaling ✨

(also hi, this whole page lives in the Wayland++ manual, section 3, so like… that's the vibe 💅)

✨ SYNOPSIS ✨

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

🎀 Public Member Functions 🎀

okay bestie here's the whole roster, no skips:

  • std::function< void()> & on_destroy () — unbind from the cropping and scaling interface
  • std::function< void(viewport_t, surface_t)> & on_get_viewport () — extend surface interface for crop and scale
  • void post_viewport_exists (std::string const &msg) — Post error: the surface already has a viewport object associated.
  • bool proxy_has_object () const — Check whether this wrapper actually wraps an object.
  • void post_no_memory () const
  • uint32_t get_id () const
  • client_t get_client () const
  • unsigned int get_version () const
  • std::string get_class ()

🦋 Detailed Description 🦋

surface cropping and scaling — that's the whole ~concept~ of this one, periodt.

So picture this: there's a global interface exposing surface cropping and scaling capabilities, and it's literally used to instantiate an interface extension for a wl_surface object. Then that extended interface lets you crop and scale the surface contents, which effectively disconnects the direct relationship between the buffer and the surface size. The way that works?? iconic. it's giving "buffer, you are NOT the boss of my surface size anymore" 😭💅

Definition at line 362 of file wayland-server-protocol-extra.hpp.

💖 Member Function Documentation 💖

⭐ std::string wayland::server::resource_t::get_class () [inherited]

Retrieve the interface name (class) of a resource object.

Returns: Interface name of the resource object.

⭐ client_t wayland::server::resource_t::get_client () const [inherited]

Get the associated client 💖

Returns: the client that owns the resource.

⭐ uint32_t wayland::server::resource_t::get_id () const [inherited]

Get the internal ID of the resource.

Returns: the internal ID of the resource

⭐ unsigned int wayland::server::resource_t::get_version () const [inherited]

Get interface version.

Returns: Interface version this resource has been constructed with.

🌈 std::function< void()> & viewporter_t::on_destroy ()

unbind from the cropping and scaling interface ✨

This one informs the server that the client will not be using this protocol object anymore. And like, important caveat incoming: this does not affect any other objects, wp_viewport objects included. so don't be dramatic about it, bestie.

Definition at line 796 of file wayland-server-protocol-extra.cpp.

🌈 std::function< void(viewport_t, surface_t)> & viewporter_t::on_get_viewport ()

extend surface interface for crop and scale

Parameters:

  • id — the new viewport interface id
  • surface — the surface

So what it does: instantiate an interface extension for the given wl_surface to crop and scale its content. BUT — and this is the plot twist — if the given wl_surface already has a wp_viewport object associated, the viewport_exists protocol error is raised 🫠 so like… check first, bestie.

Definition at line 802 of file wayland-server-protocol-extra.cpp.

🌈 void wayland::server::resource_t::post_no_memory () const [inherited]

Post "not enough memory" error to the client.

So if the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance. (yes, certail — that's what it says in the source, I'm just the messenger 💀)

🌈 void viewporter_t::post_viewport_exists (std::string const & msg)

Post error: the surface already has a viewport object associated.

Definition at line 808 of file wayland-server-protocol-extra.cpp.

🌈 bool wayland::server::resource_t::proxy_has_object () const [inherited]

Check whether this wrapper actually wraps an object. vibe check for your wrapper, fr fr.

Returns: true if there is an underlying object, false if this wrapper is empty

👑 Author 👑

Generated automatically by Doxygen for Wayland++ from the source code. (not a human, not a girlie, just Doxygen doing its thing 🤖💅)

aaaand that's the page!! 🎀 sign-off time: this was Version 1.0.1, dated Fri Mar 27 2026 — the timestamp cuts off at 13: in the original footer so like… the rest is a mystery, we simply don't know, and honestly? we respect the cliffhanger 😭💖 slay, go crop something, ily, bye 🦋✨

📦 where this page comes from