Wayland++  0.2.6
C++ Bindings for Wayland
wayland::shm_t Class Reference

shared memory support More...

#include <wayland-client-protocol.hpp>

Inheritance diagram for wayland::shm_t:
Collaboration diagram for wayland::shm_t:

Public Types

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

Public Member Functions

shm_pool_t create_pool (int fd, int32_t size)
 create a shm pool More...
 
std::function< void(shm_format)> & on_format ()
 pixel format description 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_pool_since_version = 1
 Minimum protocol version required for the create_pool function. More...
 

Detailed Description

shared memory support

A singleton global object that provides support for shared memory.

Clients can create wl_shm_pool objects using the create_pool request.

At connection setup time, the wl_shm object emits one or more format events to inform clients about the valid pixel formats that can be used for buffers.

Examples
egl.cpp, and shm.cpp.

Definition at line 391 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_pool()

shm_pool_t shm_t::create_pool ( int  fd,
int32_t  size 
)

create a shm pool

Returns
pool to create
Parameters
fdfile descriptor for the pool
sizepool size, in bytes

Create a new wl_shm_pool object.

The pool can be used to create shared memory based buffer objects. The server will mmap size bytes of the passed file descriptor, to use as backing memory for the pool.

Examples
shm.cpp.

Definition at line 1840 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.

◆ on_format()

std::function< void(shm_format)> & shm_t::on_format ( )

pixel format description

Parameters
formatbuffer pixel format

Informs the client about a valid pixel format that can be used for buffers. Known formats include argb8888 and xrgb8888.

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

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

Member Data Documentation

◆ create_pool_since_version

constexpr std::uint32_t wayland::shm_t::create_pool_since_version = 1
staticconstexpr

Minimum protocol version required for the create_pool function.

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


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