.TH "wayland::zwp_fullscreen_shell_v1_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*- .ad l .nh .SH NAME wayland::zwp_fullscreen_shell_v1_t \- displays a single surface per output .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBwayland::proxy_t\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "enum class \fBwrapper_type\fP { \fBstandard\fP, \fBdisplay\fP, \fBforeign\fP, \fBproxy_wrapper\fP }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "void \fBrelease\fP ()" .br .RI "release the wl_fullscreen_shell interface " .ti -1c .RI "void \fBpresent_surface\fP (\fBsurface_t\fP const &surface, zwp_fullscreen_shell_v1_present_method const &method, \fBoutput_t\fP const &output)" .br .RI "present surface for display " .ti -1c .RI "zwp_fullscreen_shell_mode_feedback_v1_t \fBpresent_surface_for_mode\fP (\fBsurface_t\fP const &surface, \fBoutput_t\fP const &output, int32_t framerate)" .br .RI "present surface for display at a particular mode " .ti -1c .RI "std::function< void(zwp_fullscreen_shell_v1_capability)> & \fBon_capability\fP ()" .br .RI "advertises a capability of the compositor " .ti -1c .RI "uint32_t \fBget_id\fP () const" .br .RI "Get the id of a proxy object\&. " .ti -1c .RI "std::string \fBget_class\fP () const" .br .RI "Get the interface name (class) of a proxy object\&. " .ti -1c .RI "uint32_t \fBget_version\fP () const" .br .RI "Get the protocol object version of a proxy object\&. " .ti -1c .RI "\fBwrapper_type\fP \fBget_wrapper_type\fP () const" .br .RI "Get the type of a proxy object\&. " .ti -1c .RI "void \fBset_queue\fP (\fBevent_queue_t\fP queue)" .br .RI "Assign a proxy to an event queue\&. " .ti -1c .RI "wl_proxy * \fBc_ptr\fP () const" .br .RI "Get a pointer to the underlying C struct\&. " .ti -1c .RI "bool \fBproxy_has_object\fP () const" .br .RI "Check whether this wrapper actually wraps an object\&. " .ti -1c .RI "\fBoperator bool\fP () const" .br .RI "Check whether this wrapper actually wraps an object\&. " .ti -1c .RI "bool \fBoperator==\fP (const \fBproxy_t\fP &right) const" .br .RI "Check whether two wrappers refer to the same object\&. " .ti -1c .RI "bool \fBoperator!=\fP (const \fBproxy_t\fP &right) const" .br .RI "Check whether two wrappers refer to different objects\&. " .ti -1c .RI "void \fBproxy_release\fP ()" .br .RI "Release the wrapped object (if any), making this an empty wrapper\&. " .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "static constexpr std::uint32_t \fBrelease_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBrelease\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBpresent_surface_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBpresent_surface\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBpresent_surface_for_mode_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBpresent_surface_for_mode\fP function\&. " .in -1c .SH "Detailed Description" .PP displays a single surface per output Displays a single surface per output\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP Definition at line \fB305\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&. .SH "Member Enumeration Documentation" .PP .SS "enum class \fBwayland::proxy_t::wrapper_type\fP\fC [strong]\fP, \fC [inherited]\fP" Underlying wl_proxy type and properties of a \fBproxy_t\fP that affect construction, destruction, and event handling .PP \fBEnumerator\fP .in +1c .TP \fB\fIstandard \fP\fP C pointer is a standard type compatible with wl_proxy*\&. Events are dispatched and it is destructed when the \fBproxy_t\fP is destructed\&. User data is set\&. .TP \fB\fIdisplay \fP\fP C pointer is a wl_display*\&. No events are dispatched, wl_display_disconnect is called when the \fBproxy_t\fP is destructed\&. User data is set\&. .TP \fB\fIforeign \fP\fP 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 \fBproxy_t\fP is destructed, user data is not touched\&. Consequently, there is no reference counting for the \fBproxy_t\fP\&. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl_proxy\&. .TP \fB\fIproxy_wrapper \fP\fP 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 \fBproxy_t\fP is destroyed\&. Reference counting is active\&. A reference to the \fBproxy_t\fP creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed\&. .PP Definition at line \fB115\fP of file \fBwayland\-client\&.hpp\fP\&. .SH "Member Function Documentation" .PP .SS "wl_proxy * wayland::proxy_t::c_ptr () const\fC [inherited]\fP" .PP Get a pointer to the underlying C struct\&. .PP \fBReturns\fP .RS 4 The underlying wl_proxy wrapped by this \fBproxy_t\fP if it exists, otherwise an exception is thrown .RE .PP .SS "std::string wayland::proxy_t::get_class () const\fC [inherited]\fP" .PP Get the interface name (class) of a proxy object\&. .PP \fBReturns\fP .RS 4 The interface name of the object associated with the proxy .RE .PP .SS "uint32_t wayland::proxy_t::get_id () const\fC [inherited]\fP" .PP Get the id of a proxy object\&. .PP \fBReturns\fP .RS 4 The id the object associated with the proxy .RE .PP .SS "uint32_t wayland::proxy_t::get_version () const\fC [inherited]\fP" .PP 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\&. .PP 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\&. .PP \fBdisplay_t\fP will always return version 0\&. .PP \fBReturns\fP .RS 4 The protocol object version of the proxy or 0 .RE .PP .SS "\fBwrapper_type\fP wayland::proxy_t::get_wrapper_type () const\fC [inline]\fP, \fC [inherited]\fP" .PP Get the type of a proxy object\&. .PP Definition at line \fB301\fP of file \fBwayland\-client\&.hpp\fP\&. .SS "std::function< void(zwp_fullscreen_shell_v1_capability)> & zwp_fullscreen_shell_v1_t::on_capability ()" .PP advertises a capability of the compositor .PP \fBParameters\fP .RS 4 \fIcapability\fP .RE .PP Advertises a single capability of the compositor\&. .PP 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\&. .PP Definition at line \fB4271\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "wayland::proxy_t::operator bool () const\fC [inherited]\fP" .PP Check whether this wrapper actually wraps an object\&. .PP \fBReturns\fP .RS 4 true if there is an underlying object, false if this wrapper is empty .RE .PP .SS "bool wayland::proxy_t::operator!= (const \fBproxy_t\fP & right) const\fC [inherited]\fP" .PP Check whether two wrappers refer to different objects\&. .SS "bool wayland::proxy_t::operator== (const \fBproxy_t\fP & right) const\fC [inherited]\fP" .PP Check whether two wrappers refer to the same object\&. .SS "void zwp_fullscreen_shell_v1_t::present_surface (\fBsurface_t\fP const & surface, zwp_fullscreen_shell_v1_present_method const & method, \fBoutput_t\fP const & output)" .PP present surface for display .PP \fBParameters\fP .RS 4 \fIsurface\fP .br \fImethod\fP .br \fIoutput\fP .RE .PP Present a surface on the given output\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP Definition at line \fB4258\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "zwp_fullscreen_shell_mode_feedback_v1_t zwp_fullscreen_shell_v1_t::present_surface_for_mode (\fBsurface_t\fP const & surface, \fBoutput_t\fP const & output, int32_t framerate)" .PP present surface for display at a particular mode .PP \fBParameters\fP .RS 4 \fIsurface\fP .br \fIoutput\fP .br \fIframerate\fP .RE .PP Presents a surface on the given output for a particular mode\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP Definition at line \fB4264\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "bool wayland::proxy_t::proxy_has_object () const\fC [inherited]\fP" .PP Check whether this wrapper actually wraps an object\&. .PP \fBReturns\fP .RS 4 true if there is an underlying object, false if this wrapper is empty .RE .PP .SS "void wayland::proxy_t::proxy_release ()\fC [inherited]\fP" .PP Release the wrapped object (if any), making this an empty wrapper\&. Note that \fBdisplay_t\fP instances cannot be released this way\&. Attempts to do so are ignored\&. .PP \fBExamples\fP .in +1c \fBforeign_display\&.cpp\fP\&. .SS "void zwp_fullscreen_shell_v1_t::release ()" .PP release the wl_fullscreen_shell interface Release the binding from the wl_fullscreen_shell interface\&. .PP 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\&. .PP Definition at line \fB4252\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "void wayland::proxy_t::set_queue (\fBevent_queue_t\fP queue)\fC [inherited]\fP" .PP Assign a proxy to an event queue\&. .PP \fBParameters\fP .RS 4 \fIqueue\fP The event queue that will handle this proxy .RE .PP Assign proxy to event queue\&. Events coming from proxy will be queued in queue instead of the display's main queue\&. .PP See also: \fBdisplay_t::dispatch_queue()\fP\&. .PP \fBExamples\fP .in +1c \fBproxy_wrapper\&.cpp\fP\&. .SH "Member Data Documentation" .PP .SS "constexpr std::uint32_t wayland::zwp_fullscreen_shell_v1_t::present_surface_for_mode_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBpresent_surface_for_mode\fP function\&. .PP Definition at line \fB429\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::zwp_fullscreen_shell_v1_t::present_surface_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBpresent_surface\fP function\&. .PP Definition at line \fB375\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::zwp_fullscreen_shell_v1_t::release_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBrelease\fP function\&. .PP Definition at line \fB341\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Wayland++ from the source code\&.