voidzwp_fullscreen_shell_v1_t::capability(zwp_fullscreen_shell_v1_capabilityconst&capability,boolpost=true)
advertises a capability of the compositor
Parameterscapability
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 4242 of file wayland-server-protocol-unstable.cpp.
std::stringwayland::server::resource_t::get_class()[inherited]
Retrieve the interface name (class) of a resource object.
Returns
Interface name of the resource object.
client_twayland::server::resource_t::get_client()const[inherited]
Get the associated client
Returns
the client that owns the resource.
uint32_twayland::server::resource_t::get_id()const[inherited]
Get the internal ID of the resource
Returns
the internal ID of the resource
unsignedintwayland::server::resource_t::get_version()const[inherited]
Get interface version
Returns
Interface version this resource has been constructed with.
std::function<void(surface_t,zwp_fullscreen_shell_v1_present_method,output_t)>&zwp_fullscreen_shell_v1_t::on_present_surface()
present surface for display
Parameterssurfacemethodoutput
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 4230 of file wayland-server-protocol-unstable.cpp.
std::function<void(surface_t,output_t,int32_t,zwp_fullscreen_shell_mode_feedback_v1_t)>&zwp_fullscreen_shell_v1_t::on_present_surface_for_mode()
present surface for display at a particular mode
Parameterssurfaceoutputframeratefeedback
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 4236 of file wayland-server-protocol-unstable.cpp.
std::function<void()>&zwp_fullscreen_shell_v1_t::on_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 4224 of file wayland-server-protocol-unstable.cpp.
voidzwp_fullscreen_shell_v1_t::post_invalid_method(std::stringconst&msg)
Post error: present_method is not known.
Definition at line 4247 of file wayland-server-protocol-unstable.cpp.
voidwayland::server::resource_t::post_no_memory()const[inherited]
Post 'not enough memory' error to the client
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.
voidzwp_fullscreen_shell_v1_t::post_role(std::stringconst&msg)
Post error: given wl_surface has another role.
Definition at line 4252 of file wayland-server-protocol-unstable.cpp.
boolwayland::server::resource_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
Install Now
PNG Icons