--- name: "wayland_zwp_fullscreen_shell_v1_t" section: "3" platform: "linux" package: "waylandpp-dev" version: "1.0.0-6+b2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/wayland_zwp_fullscreen_shell_v1_t" --- # wayland\_zwp\_fullscreen\_shell\_v1\_t(3) displays a single surface per output ## NAME wayland::zwp\_fullscreen\_shell\_v1\_t - displays a single surface per output ## SYNOPSIS `#include ` Inherits **wayland::proxy\_t**. ### Public Types enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\ ### Public Member Functions void **release** ()\ release the wl\_fullscreen\_shell interface 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\ 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 **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. 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. Definition at line **305** 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* **116** *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* ### wrapper\_type wayland::proxy\_t::get\_wrapper\_type () const` [inline]`, ` [inherited]` *Get the type of a proxy object.* *Definition at line* **302** *of file* **wayland-client.hpp***.* ### std::function\< void(zwp\_fullscreen\_shell\_v1\_capability)\> & zwp\_fullscreen\_shell\_v1\_t::on\_capability () *advertises a capability of the compositor* **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 ensure that they receive all the capability events.* *Definition at line* **4271** *of file* **wayland-client-protocol-unstable.cpp***.* ### 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.* ### void zwp\_fullscreen\_shell\_v1\_t::present\_surface (surface\_t const & surface, zwp\_fullscreen\_shell\_v1\_present\_method const & method, output\_t const & output) *present surface for display* **Parameters** *surface* \ *method* \ *output* *Present 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. 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.* *The method parameter is a hint to the compositor for how the surface is to be presented. In particular, 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.* *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.* *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.* *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) *present surface for display at a particular mode* **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 will be 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 will be sent and the output will contain the contents of the given surface. If the compositor cannot match the output size to the surface size, the mode\_failed will be sent and the output will contain the contents of the previously presented surface (if any). If another surface is presented on the given output before either of these has a chance to happen, the present\_cancelled event will be sent.* *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.* *If the size of the presented surface changes, the resulting output is undefined. The compositor may attempt to change the output mode to compensate. However, there is no guarantee that a suitable mode will be found and the client has no way to be notified of success or failure.* *The framerate parameter specifies the desired framerate for the output in mHz. The compositor is free to ignore this parameter. 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.* *Definition at line* **4264** *of file* **wayland-client-protocol-unstable.cpp***.* ### 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 zwp\_fullscreen\_shell\_v1\_t::release () *release the wl\_fullscreen\_shell interface Release 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.* *Definition at line* **4252** *of file* **wayland-client-protocol-unstable.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 ### constexpr std::uint32\_t wayland::zwp\_fullscreen\_shell\_v1\_t::present\_surface\_for\_mode\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **present\_surface\_for\_mode** *function.* *Definition at line* **429** *of file* **wayland-client-protocol-unstable.hpp***.* ### constexpr std::uint32\_t wayland::zwp\_fullscreen\_shell\_v1\_t::present\_surface\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **present\_surface** *function.* *Definition at line* **375** *of file* **wayland-client-protocol-unstable.hpp***.* ### constexpr std::uint32\_t wayland::zwp\_fullscreen\_shell\_v1\_t::release\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **release** *function.* *Definition at line* **341** *of file* **wayland-client-protocol-unstable.hpp***.* ## Author *Generated automatically by Doxygen for Wayland++ from the source code.*