wayland::zwp_f...een_shell_v1_t(3)

💖 wayland::zwp_fullscreen_shell_v1_t(3) — Wayland++ 💖

okay bestie, welcome to the manual page for wayland::zwp_fullscreen_shell_v1_t(3) from Wayland++. It’s giving “one full-screen surface per output” energy, and we’re gonna walk through every type, function, static constant, and warning. No cap. 🫶

🌸 NAME 🌸

wayland::zwp_fullscreen_shell_v1_t — displays a single surface per output. periodt. 💅

✨ SYNOPSIS ✨

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

It inherits from wayland::proxy_t. Yeah, it’s a proxy baby. 🦋

🎀 Public Types 🎀

• enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the enum squad that tells you what kind of underlying wl_proxy vibe a proxy_t has. Full breakdown is down in the Member Enumeration Documentation, bestie. 👑

🌈 Public Member Functions 🌈

• void release() — release the wl_fullscreen_shell interface. say bye, bestie. 👋
• void present_surface(surface_t const &surface, zwp_fullscreen_shell_v1_present_method const &method, output_t const &output) — present surface for display. 🎬
• zwp_fullscreen_shell_mode_feedback_v1_t present_surface_for_mode(surface_t const &surface, output_t const &output, int32_t framerate) — present surface for display at a particular mode. 🔥
• std::function< void(zwp_fullscreen_shell_v1_capability)> & on_capability() — advertises a capability of the compositor. 💫
• 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 — 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 release_since_version = 1 — minimum protocol version required for the release function.
• static constexpr std::uint32_t present_surface_since_version = 1 — minimum protocol version required for the present_surface function.
• static constexpr std::uint32_t present_surface_for_mode_since_version = 1 — minimum protocol version required for the present_surface_for_mode function.

🦋 Detailed Description 🦋

displays a single surface per output.

Displays a single surface per output. (Yes, it said it twice. Iconic repetition, honestly. 👑)

This interface provides a mechanism for a single client to display simple full-screen surfaces. While there technically may be multiple clients bound to this interface, only one of those clients should be shown at a time.

To present a surface, the client uses either the present_surface or present_surface_for_mode requests. Presenting a surface takes effect on the next wl_surface.commit. See the individual requests for details about scaling and mode switches.

The client can have at most one surface per output at any time. Requesting a surface to be presented on an output that already has a surface replaces the previously presented surface. Presenting a null surface removes its content and effectively disables the output. Exactly what happens when an output is "disabled" is compositor-specific. The same surface may be presented on multiple outputs simultaneously.

Once a surface is presented on an output, it stays on that output until either the client removes it or the compositor destroys the output. This way, the client can update the output’s contents by simply attaching a new buffer.

⚠️ 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. So yeah, this is experimental territory, bestie — do not expect forever-stability. 😭

Definition at line 306 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.

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 💅

okay bestie, this is the part where we go function by function. buckle up 🎀

wl_proxy * wayland::proxy_t::c_ptr () const [inherited]

hands you the raw C struct pointer underneath everything — like, the actual real one.

Returns: the underlying wl_proxy that this proxy_t is wrapping, if it exists. if it doesn't exist? yeah, an exception gets thrown. no vibes, just consequences 😭

std::string wayland::proxy_t::get_class () const [inherited]

gives you the interface name (the 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]

the id of a proxy object. that's it, that's the whole function, and honestly? iconic for knowing what it is.

Returns: the id the object associated with the proxy 🫶

uint32_t wayland::proxy_t::get_version () const [inherited]

gets the protocol object version of a proxy object — or 0 if the proxy was created with the unversioned API.

ngl, a returned value of 0 means there's no version info available at all, so the caller has to make safe assumptions about the object's real version. don't be out here guessing wild, okay? 💀

also important: 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]

tells you the type of a proxy object. short king of a function.

Definition at line 303 of file wayland-client.hpp.

std::function< void(zwp_fullscreen_shell_v1_capability)> & zwp_fullscreen_shell_v1_t::on_capability ()

okay this one advertises a capability of the compositor, which is lowkey such a slay.

Parameters: capability

Advertises a single capability of the compositor.

When the wl_fullscreen_shell interface is bound, this event is emitted once for each capability advertised. Valid capabilities are given by the wl_fullscreen_shell.capability enum. If clients want to take advantage of any of these capabilities, they should use a wl_display.sync request immediately after binding to make sure they receive all the capability events. timing is everything bestie ⏰

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

wayland::proxy_t::operator bool () const [inherited]

vibe check for your wrapper: does it actually wrap an object or is it just empty energy?

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

bool wayland::proxy_t::operator!= (const proxy_t & right) const [inherited]

checks whether two wrappers refer to different objects. not the same, fr.

bool wayland::proxy_t::operator== (const proxy_t & right) const [inherited]

checks whether two wrappers refer to the same object. twins. 🫶

void zwp_fullscreen_shell_v1_t::present_surface (surface_t const & surface, zwp_fullscreen_shell_v1_present_method const & method, output_t const & output)

presents a surface for display. main character moment for your surface 👑

Parameters: surface, method, output

Presents a surface on the given output.

If the output is null, the compositor will present the surface on whatever display (or displays) it thinks best. and listen — in particular, this may replace any or all surfaces currently presented, so it should not be used in combination with placing surfaces on specific outputs. pick a lane 💅

The method parameter is a hint to the compositor for how the surface is to be presented. specifically, it tells the compositor how to handle a size mismatch between the presented surface and the output. the compositor is free to ignore this parameter. it's a hint, not a decree, iykyk.

The "zoom", "zoom_crop", and "stretch" methods imply a scaling operation on the surface. this will override any kind of output scaling, so the buffer_scale property of the surface is effectively ignored. ignored!! okay!! 😭

This request gives the surface the role of a fullscreen shell surface. If the surface already has another role, it raises a role protocol error. don't give a surface two roles, that's messy.

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

zwp_fullscreen_shell_mode_feedback_v1_t zwp_fullscreen_shell_v1_t::present_surface_for_mode (surface_t const & surface, output_t const & output, int32_t framerate)

presents a surface for display at a particular mode — the fancy version ✨

Parameters: surface, output, framerate

Presents a surface on the given output for a particular mode.

If the current size of the output differs from that of the surface, the compositor will attempt to change the size of the output to match the surface. the result of the mode-switch operation is returned via the provided wl_fullscreen_shell_mode_feedback object.

If the current output mode matches the one requested, or if the compositor successfully switches the mode to match the surface, then the mode_successful event is sent and the output will contain the contents of the given surface. If the compositor cannot match the output size to the surface size, mode_failed gets sent and the output will contain the contents of the previously presented surface (if any). and if another surface is presented on the given output before either of these has a chance to happen, the present_cancelled event is sent. so many plot twists 🌀

Due to race conditions and other issues unknown to the client, no mode-switch operation is guaranteed to succeed. however, if the mode is one advertised by wl_output.mode, or if the compositor advertises the ARBITRARY_MODES capability, then the client should expect that the mode-switch operation will usually succeed. "usually" is doing a lot of heavy lifting there ngl.

If the size of the presented surface changes, the resulting output is undefined. the compositor may attempt to change the output mode to compensate, but there's no guarantee a suitable mode will be found, and the client has no way to be notified of success or failure. that's the risk you take 💀

The framerate parameter specifies the desired framerate for the output in mHz. the compositor is free to ignore this parameter too (of course it is). a value of 0 indicates that the client has no preference.

If the value of wl_output.scale differs from wl_surface.buffer_scale, then the compositor may choose a mode that matches either the buffer size or the surface size. in either case, the surface will fill the output.

This request gives the surface the role of a fullscreen shell surface. If the surface already has another role, it raises a role protocol error. same rule as before, bestie, no double roles.

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

bool wayland::proxy_t::proxy_has_object () const [inherited]

one more vibe check: does this wrapper actually wrap an object?

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

void wayland::proxy_t::proxy_release () [inherited]

releases the wrapped object (if any), making this an empty wrapper. like, closing the tab on it.

Note: display_t instances cannot be released this way. attempts to do so are ignored. don't try it, it's not gonna work 🙈

Examples: foreign_display.cpp.

void zwp_fullscreen_shell_v1_t::release ()

releases the binding from the wl_fullscreen_shell interface.

This destroys the server-side object and frees this binding. If the client binds to wl_fullscreen_shell multiple times, it may wish to free some of those bindings. declutter your life, queen 🧚

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

void wayland::proxy_t::set_queue (event_queue_t queue) [inherited]

assigns a proxy to an event queue.

Parameters: queue — the event queue that will handle this proxy

Assigns the proxy to an event queue. Events coming from the proxy will be queued in queue instead of the display's main queue. off to a new home ✨

See also: display_t::dispatch_queue().

Examples: proxy_wrapper.cpp.

---

🎀 MEMBER DATA DOCUMENTATION 🎀

three little static constexpr legends, all set to 1, all about minimum protocol versions 💖

std::uint32_t wayland::zwp_fullscreen_shell_v1_t::present_surface_for_mode_since_version = 1 [static], [constexpr]

the minimum protocol version required for the present_surface_for_mode function.

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

std::uint32_t wayland::zwp_fullscreen_shell_v1_t::present_surface_since_version = 1 [static], [constexpr]

the minimum protocol version required for the present_surface function.

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

std::uint32_t wayland::zwp_fullscreen_shell_v1_t::release_since_version = 1 [static], [constexpr]

the minimum protocol version required for the release function.

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

---

🌸 AUTHOR 🌸

Generated automatically by Doxygen for Wayland++ from the source code. not a human, just doxygen doing doxygen things 🤖✨

---

and that's the whole page bestie, you ate that 💅💖 this gem came from Wayland++ version 1.0.1, dated Fri Mar 27 2026 — go forth and fullscreen responsibly, mwah 🫶🎀