Man page - wayland_compositor_t(3)

Packages contas this manual

Manual

wayland::compositor_t(3) Wayland++ wayland::compositor_t(3)

wayland::compositor_t - the compositor singleton

#include <wayland-client-protocol.hpp>

Inherits wayland::proxy_t.


enum class wrapper_type { standard, display, foreign, proxy_wrapper }


surface_t create_surface ()
create new surface region_t create_region ()
create new region 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 constexpr std::uint32_t create_surface_since_version = 1
Minimum protocol version required for the create_surface function. static constexpr std::uint32_t create_region_since_version = 1
Minimum protocol version required for the create_region function.

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.

Examples
egl.cpp, and shm.cpp.

Definition at line 252 of file wayland-client-protocol.hpp.

Underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling

Enumerator

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.
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.
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.
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.

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

region_t compositor_t::create_region ()

create new region

Returns

the new region

Ask the compositor to create a new region.

Definition at line 1753 of file wayland-client-protocol.cpp.

surface_t compositor_t::create_surface ()

create new surface

Returns

the new surface

Ask the compositor to create a new surface.

Examples
egl.cpp, and shm.cpp.

Definition at line 1746 of file wayland-client-protocol.cpp.

Get the interface name (class) of a proxy object.

Returns

The interface name of the object associated with the proxy

Get the id of a proxy object.

Returns

The id the object associated with the proxy

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.

Check whether this wrapper actually wraps an object.

Returns

true if there is an underlying object, false if this wrapper is empty

Check whether two wrappers refer to different objects.

Check whether two wrappers refer to the same object.

Check whether this wrapper actually wraps an object.

Returns

true if there is an underlying object, false if this wrapper is empty

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.

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.

Minimum protocol version required for the create_region function.

Definition at line 296 of file wayland-client-protocol.hpp.

Minimum protocol version required for the create_surface function.

Definition at line 284 of file wayland-client-protocol.hpp.

Generated automatically by Doxygen for Wayland++ from the source code.

Sat Feb 1 2025 21:28:29 Version 1.0.0