table of contents
wayland::server::compositor_t(3) | Wayland++ | wayland::server::compositor_t(3) |
NAME¶
wayland::server::compositor_t - the compositor singleton
SYNOPSIS¶
#include <wayland-server-protocol.hpp>
Inherits wayland::server::resource_t.
Public Member Functions¶
std::function< void(surface_t)> &
on_create_surface ()
create new surface std::function< void(region_t)> &
on_create_region ()
create new region 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¶
the compositor singleton
A compositor. This object is a singleton global. The compositor is in charge of combining the contents of multiple surfaces into one displayable output.
Definition at line 268 of file wayland-server-protocol.hpp.
Member Function Documentation¶
std::string wayland::server::resource_t::get_class () [inherited]¶
Retrieve the interface name (class) of a resource object.
Returns
client_t wayland::server::resource_t::get_client () const [inherited]¶
Get the associated client
Returns
uint32_t wayland::server::resource_t::get_id () const [inherited]¶
Get the internal ID of the resource
Returns
unsigned int wayland::server::resource_t::get_version () const [inherited]¶
Get interface version
Returns
std::function< void(region_t)> & compositor_t::on_create_region ()¶
create new region
Parameters
Ask the compositor to create a new region.
Definition at line 1652 of file wayland-server-protocol.cpp.
std::function< void(surface_t)> & compositor_t::on_create_surface ()¶
create new surface
Parameters
Ask the compositor to create a new surface.
Definition at line 1646 of file wayland-server-protocol.cpp.
void wayland::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.
bool wayland::server::resource_t::proxy_has_object () const [inherited]¶
Check whether this wrapper actually wraps an object.
Returns
Author¶
Generated automatically by Doxygen for Wayland++ from the source code.
Sat Feb 1 2025 21:28:29 | Version 1.0.0 |