the compositor singleton More...

#include <wayland-client-protocol.hpp>

Inheritance diagram for wayland::compositor_t:

Collaboration diagram for wayland::compositor_t:

Public Types
enum	wrapper_type { wrapper_type::standard, wrapper_type::display, wrapper_type::foreign, wrapper_type::proxy_wrapper }

Public Member Functions
surface_t	create_surface ()
	create new surface More...

region_t	create_region ()
	create new region More...

uint32_t	get_id () const
	Get the id of a proxy object. More...

std::string	get_class () const
	Get the interface name (class) of a proxy object. More...

uint32_t	get_version () const
	Get the protocol object version of a proxy object. More...

wrapper_type	get_wrapper_type () const
	Get the type of a proxy object. More...

void	set_queue (event_queue_t queue)
	Assign a proxy to an event queue. More...

wl_proxy *	c_ptr () const
	Get a pointer to the underlying C struct. More...

bool	proxy_has_object () const
	Check whether this wrapper actually wraps an object. More...

	operator bool () const
	Check whether this wrapper actually wraps an object. More...

bool	operator== (const proxy_t &right) const
	Check whether two wrappers refer to the same object. More...

bool	operator!= (const proxy_t &right) const
	Check whether two wrappers refer to different objects. More...

void	proxy_release ()
	Release the wrapped object (if any), making this an empty wrapper. More...

Static Public Attributes
static constexpr std::uint32_t	create_surface_since_version = 1
	Minimum protocol version required for the create_surface function. More...

static constexpr std::uint32_t	create_region_since_version = 1
	Minimum protocol version required for the create_region function. More...

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.

Examples: egl.cpp, and shm.cpp.

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

Member Enumeration Documentation

◆ wrapper_type

enum wayland::proxy_t::wrapper_type

stronginherited

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 105 of file wayland-client.hpp.

Member Function Documentation

◆ c_ptr()

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

◆ create_region()

region_t compositor_t::create_region ( )

create new region

Returns: the new region

Ask the compositor to create a new region.

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

◆ create_surface()

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 1707 of file wayland-client-protocol.cpp.

◆ get_class()

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

◆ get_id()

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

Examples: dump.cpp.

◆ get_version()

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

◆ get_wrapper_type()

wrapper_type wayland::proxy_t::get_wrapper_type ( ) const

inlineinherited

Get the type of a proxy object.

Definition at line 288 of file wayland-client.hpp.

◆ operator bool()

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

◆ operator!=()

bool wayland::proxy_t::operator!= ( const proxy_t & right ) const

inherited

Check whether two wrappers refer to different objects.

◆ operator==()

bool wayland::proxy_t::operator== ( const proxy_t & right ) const

inherited

Check whether two wrappers refer to the same object.

◆ proxy_has_object()

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

◆ proxy_release()

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.

◆ set_queue()

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.

Member Data Documentation

◆ create_region_since_version

constexpr std::uint32_t wayland::compositor_t::create_region_since_version = 1

staticconstexpr

Minimum protocol version required for the create_region function.

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

◆ create_surface_since_version

constexpr std::uint32_t wayland::compositor_t::create_surface_since_version = 1

staticconstexpr

Minimum protocol version required for the create_surface function.

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

The documentation for this class was generated from the following files:

build/wayland-client-protocol.hpp
build/wayland-client-protocol.cpp

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ wrapper_type

Member Function Documentation

◆ c_ptr()

◆ create_region()

◆ create_surface()

◆ get_class()

◆ get_id()

◆ get_version()

◆ get_wrapper_type()

◆ operator bool()

◆ operator!=()

◆ operator==()

◆ proxy_has_object()

◆ proxy_release()

◆ set_queue()

Member Data Documentation

◆ create_region_since_version

◆ create_surface_since_version