Wayland++ 1.0.0
C++ Bindings for Wayland
Loading...
Searching...
No Matches
wayland::server::region_t Class Reference

region interface More...

#include <wayland-server-protocol.hpp>

Public Member Functions

std::function< void()> & on_destroy ()
 destroy region
 
std::function< void(int32_t, int32_t, int32_t, int32_t)> & on_add ()
 add rectangle to region
 
std::function< void(int32_t, int32_t, int32_t, int32_t)> & on_subtract ()
 subtract rectangle from 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

region interface

A region object describes an area.

Region objects are used to describe the opaque and input regions of a surface.

Definition at line 4043 of file wayland-server-protocol.hpp.

Member Function Documentation

◆ get_class()

std::string wayland::server::resource_t::get_class ( )
inherited

Retrieve the interface name (class) of a resource object.

Returns
Interface name of the resource object.

◆ get_client()

client_t wayland::server::resource_t::get_client ( ) const
inherited

Get the associated client

Returns
the client that owns the resource.

◆ get_id()

uint32_t wayland::server::resource_t::get_id ( ) const
inherited

Get the internal ID of the resource

Returns
the internal ID of the resource

◆ get_version()

unsigned int wayland::server::resource_t::get_version ( ) const
inherited

Get interface version

Returns
Interface version this resource has been constructed with.

◆ on_add()

std::function< void(int32_t, int32_t, int32_t, int32_t)> & region_t::on_add ( )

add rectangle to region

Parameters
xregion-local x coordinate
yregion-local y coordinate
widthrectangle width
heightrectangle height

Add the specified rectangle to the region.

Definition at line 3048 of file wayland-server-protocol.cpp.

◆ on_destroy()

std::function< void()> & region_t::on_destroy ( )

destroy region

Destroy the region. This will invalidate the object ID.

Definition at line 3042 of file wayland-server-protocol.cpp.

◆ on_subtract()

std::function< void(int32_t, int32_t, int32_t, int32_t)> & region_t::on_subtract ( )

subtract rectangle from region

Parameters
xregion-local x coordinate
yregion-local y coordinate
widthrectangle width
heightrectangle height

Subtract the specified rectangle from the region.

Definition at line 3054 of file wayland-server-protocol.cpp.

◆ post_no_memory()

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.

◆ proxy_has_object()

bool wayland::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

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