libei: doc/api/libei.h Source File

libei 1.5.0 A library for Emulated Input

libei.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: MIT */
2/*
3 * Copyright © 2020 Red Hat, Inc.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25#pragma once
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31#include <stdbool.h>
32#include <stdint.h>
33#include <stddef.h>
34
120
125
135struct ei;
136
148struct ei_device;
149
163struct ei_seat;
164
173struct ei_event;
174
182struct ei_keymap;
183
204struct ei_region;
205
216struct ei_touch;
217
226struct ei_ping;
227
250 enum ei_device_type {
251 EI_DEVICE_TYPE_VIRTUAL = 1,
252 EI_DEVICE_TYPE_PHYSICAL
253};
254
278 enum ei_device_capability {
282 EI_DEVICE_CAP_POINTER = (1 << 0),
286 EI_DEVICE_CAP_POINTER_ABSOLUTE = (1 << 1),
290 EI_DEVICE_CAP_KEYBOARD = (1 << 2),
294 EI_DEVICE_CAP_TOUCH = (1 << 3),
298 EI_DEVICE_CAP_SCROLL = (1 << 4),
302 EI_DEVICE_CAP_BUTTON = (1 << 5),
303};
304
310 enum ei_keymap_type {
314 EI_KEYMAP_TYPE_XKB = 1,
315};
316
326 enum ei_event_type {
335 EI_EVENT_CONNECT = 1,
336
349 EI_EVENT_DISCONNECT,
350
360 EI_EVENT_SEAT_ADDED,
361
372 EI_EVENT_SEAT_REMOVED,
373
383 EI_EVENT_DEVICE_ADDED,
384
395 EI_EVENT_DEVICE_REMOVED,
396
403 EI_EVENT_DEVICE_PAUSED,
407 EI_EVENT_DEVICE_RESUMED,
408
447 EI_EVENT_KEYBOARD_MODIFIERS,
448
456 EI_EVENT_PONG = 90,
457
467 EI_EVENT_SYNC,
468
477 EI_EVENT_FRAME = 100,
478
493 EI_EVENT_DEVICE_START_EMULATING = 200,
501 EI_EVENT_DEVICE_STOP_EMULATING,
502
510 EI_EVENT_POINTER_MOTION = 300,
511
519 EI_EVENT_POINTER_MOTION_ABSOLUTE = 400,
520
527 EI_EVENT_BUTTON_BUTTON = 500,
528
536 EI_EVENT_SCROLL_DELTA = 600,
543 EI_EVENT_SCROLL_STOP,
550 EI_EVENT_SCROLL_CANCEL,
558 EI_EVENT_SCROLL_DISCRETE,
559
566 EI_EVENT_KEYBOARD_KEY = 700,
567
577 EI_EVENT_TOUCH_DOWN = 800,
585 EI_EVENT_TOUCH_UP,
593 EI_EVENT_TOUCH_MOTION,
594};
595
601const char*
602ei_event_type_to_string(enum ei_event_type);
603
607struct ei *
608ei_new(void *user_data);
609
627struct ei *
628ei_new_sender(void *user_data);
629
647struct ei *
648ei_new_receiver(void *user_data);
649
656struct ei *
657ei_ref(struct ei *ei);
658
666struct ei *
667ei_unref(struct ei *ei);
668
674void
675ei_set_user_data(struct ei *ei, void *user_data);
676
681void *
682ei_get_user_data(struct ei *ei);
683
687bool
688ei_is_sender(struct ei *ei);
689
693 enum ei_log_priority {
694 EI_LOG_PRIORITY_DEBUG = 10,
695 EI_LOG_PRIORITY_INFO = 20,
696 EI_LOG_PRIORITY_WARNING = 30,
697 EI_LOG_PRIORITY_ERROR = 40,
698};
699
700struct ei_log_context;
701
706unsigned int
707ei_log_context_get_line(struct ei_log_context *ctx);
708
713const char *
714ei_log_context_get_file(struct ei_log_context *ctx);
715
720const char *
721ei_log_context_get_func(struct ei_log_context *ctx);
722
740 typedef void (*ei_log_handler)(struct ei *ei,
741 enum ei_log_priority priority,
742 const char *message,
743 struct ei_log_context *context);
754void
755ei_log_set_handler(struct ei *ei, ei_log_handler log_handler);
756
760void
761ei_log_set_priority(struct ei *ei, enum ei_log_priority priority);
762
766enum ei_log_priority
767ei_log_get_priority(const struct ei *ei);
768
777 typedef uint64_t (*ei_clock_now_func)(struct ei *ei);
778
784void
785ei_clock_set_now_func(struct ei *, ei_clock_now_func func);
786
799void
800ei_configure_name(struct ei * ei, const char *name);
801
823int
824ei_setup_backend_fd(struct ei *ei, int fd);
825
852int
853ei_setup_backend_socket(struct ei *ei, const char *socketpath);
854
861int
862ei_get_fd(struct ei *ei);
863
873struct ei_ping *
874ei_new_ping(struct ei *ei);
875
888uint64_t
889ei_ping_get_id(struct ei_ping *ping);
890
899struct ei_ping *
900ei_ping_ref(struct ei_ping *ei_ping);
901
910struct ei_ping *
911ei_ping_unref(struct ei_ping *ei_ping);
912
920void
921ei_ping_set_user_data(struct ei_ping *ei_ping, void *user_data);
922
929void *
930ei_ping_get_user_data(struct ei_ping *ei_ping);
931
949void
950ei_ping(struct ei_ping *ping);
951
961void
962ei_dispatch(struct ei *ei);
963
970struct ei_event *
971ei_get_event(struct ei *ei);
972
989struct ei_event *
990ei_peek_event(struct ei *ei);
991
999uint64_t
1000ei_now(struct ei *ei);
1001
1017void
1018ei_disconnect(struct ei *ei);
1019
1027void
1028ei_seat_set_user_data(struct ei_seat *seat, void *user_data);
1029
1036void *
1037ei_seat_get_user_data(struct ei_seat *seat);
1038
1042const char *
1043ei_seat_get_name(struct ei_seat *seat);
1044
1052bool
1053ei_seat_has_capability(struct ei_seat *seat,
1054 enum ei_device_capability cap);
1055
1073void
1074ei_seat_bind_capabilities(struct ei_seat *seat, ...)
1075__attribute__((sentinel));
1076
1088void
1089ei_seat_unbind_capabilities(struct ei_seat *seat, ...)
1090__attribute__((sentinel));
1091
1092
1096struct ei_seat *
1097ei_seat_ref(struct ei_seat *seat);
1098
1102struct ei_seat *
1103ei_seat_unref(struct ei_seat *seat);
1104
1110struct ei *
1111ei_seat_get_context(struct ei_seat *seat);
1112
1121struct ei_event *
1122ei_event_ref(struct ei_event *event);
1123
1133struct ei_event *
1134ei_event_unref(struct ei_event *event);
1135
1139enum ei_event_type
1140ei_event_get_type(struct ei_event *event);
1141
1151struct ei_device *
1152ei_event_get_device(struct ei_event *event);
1153
1163uint64_t
1164ei_event_get_time(struct ei_event *event);
1165
1174struct ei_device *
1175ei_device_ref(struct ei_device *device);
1176
1185struct ei_device *
1186ei_device_unref(struct ei_device *device);
1187
1191struct ei_seat *
1192ei_device_get_seat(struct ei_device *device);
1193
1201void
1202ei_device_set_user_data(struct ei_device *device, void *user_data);
1203
1210void *
1211ei_device_get_user_data(struct ei_device *device);
1212
1219uint32_t
1220ei_device_get_width(struct ei_device *device);
1221
1228uint32_t
1229ei_device_get_height(struct ei_device *device);
1230
1236size_t
1237ei_keymap_get_size(struct ei_keymap *keymap);
1238
1245enum ei_keymap_type
1246ei_keymap_get_type(struct ei_keymap *keymap);
1247
1255int
1256ei_keymap_get_fd(struct ei_keymap *keymap);
1257
1268struct ei_device *
1269ei_keymap_get_device(struct ei_keymap *keymap);
1270
1279struct ei_keymap *
1280ei_keymap_ref(struct ei_keymap *keymap);
1281
1290struct ei_keymap *
1291ei_keymap_unref(struct ei_keymap *keymap);
1292
1296void
1297ei_keymap_set_user_data(struct ei_keymap *keymap, void *user_data);
1298
1302void *
1303ei_keymap_get_user_data(struct ei_keymap *keymap);
1304
1324void
1325ei_device_close(struct ei_device *device);
1326
1332const char *
1333ei_device_get_name(struct ei_device *device);
1334
1340enum ei_device_type
1341ei_device_get_type(struct ei_device *device);
1342
1350bool
1351ei_device_has_capability(struct ei_device *device,
1352 enum ei_device_capability cap);
1353
1354
1376struct ei_region *
1377ei_device_get_region(struct ei_device *device, size_t index);
1378
1387struct ei_region *
1388ei_device_get_region_at(struct ei_device *device, double x, double y);
1389
1393struct ei_region *
1394ei_region_ref(struct ei_region *region);
1395
1399struct ei_region *
1400ei_region_unref(struct ei_region *region);
1401
1405void
1406ei_region_set_user_data(struct ei_region *region, void *user_data);
1407
1411void *
1412ei_region_get_user_data(struct ei_region *region);
1413
1417uint32_t
1418ei_region_get_x(struct ei_region *region);
1419
1423uint32_t
1424ei_region_get_y(struct ei_region *region);
1425
1429uint32_t
1430ei_region_get_width(struct ei_region *region);
1431
1435uint32_t
1436ei_region_get_height(struct ei_region *region);
1437
1465const char *
1466ei_region_get_mapping_id(struct ei_region *region);
1467
1474bool
1475ei_region_contains(struct ei_region *region, double x, double y);
1476
1487bool
1488ei_region_convert_point(struct ei_region *region, double *x, double *y);
1489
1559double
1560ei_region_get_physical_scale(struct ei_region *region);
1561
1576/* FIXME: the current API makes it impossible to know when the keymap has
1577 * been consumed so the file stays open forever.
1578 */
1579struct ei_keymap *
1580ei_device_keyboard_get_keymap(struct ei_device *device);
1581
1587struct ei_device *
1588ei_keymap_get_context(struct ei_keymap *keymap);
1589
1595struct ei *
1596ei_device_get_context(struct ei_device *device);
1597
1627void
1628ei_device_start_emulating(struct ei_device *device, uint32_t sequence);
1629
1642void
1643ei_device_stop_emulating(struct ei_device *device);
1644
1661void
1662ei_device_frame(struct ei_device *device, uint64_t time);
1663
1676void
1677ei_device_pointer_motion(struct ei_device *device, double x, double y);
1678
1694void
1695ei_device_pointer_motion_absolute(struct ei_device *device,
1696 double x, double y);
1697
1712void
1713ei_device_button_button(struct ei_device *device,
1714 uint32_t button, bool is_press);
1715
1734void
1735ei_device_scroll_delta(struct ei_device *device, double x, double y);
1736
1759void
1760ei_device_scroll_discrete(struct ei_device *device, int32_t x, int32_t y);
1761
1791void
1792ei_device_scroll_stop(struct ei_device *device, bool stop_x, bool stop_y);
1793
1822void
1823ei_device_scroll_cancel(struct ei_device *device, bool cancel_x, bool cancel_y);
1824
1845void
1846ei_device_keyboard_key(struct ei_device *device, uint32_t keycode, bool is_press);
1847
1860struct ei_touch *
1861ei_device_touch_new(struct ei_device *device);
1862
1876void
1877ei_touch_down(struct ei_touch *touch, double x, double y);
1878
1884void
1885ei_touch_motion(struct ei_touch *touch, double x, double y);
1886
1894void
1895ei_touch_up(struct ei_touch *touch);
1896
1908void
1909ei_touch_cancel(struct ei_touch *touch);
1910
1919struct ei_touch *
1920ei_touch_ref(struct ei_touch *touch);
1921
1930struct ei_touch *
1931ei_touch_unref(struct ei_touch *touch);
1932
1940void
1941ei_touch_set_user_data(struct ei_touch *touch, void *user_data);
1942
1949void *
1950ei_touch_get_user_data(struct ei_touch *touch);
1951
1957struct ei_device *
1958ei_touch_get_device(struct ei_touch *touch);
1959
1969struct ei_seat *
1970ei_event_get_seat(struct ei_event *event);
1971
1981struct ei_ping *
1982ei_event_pong_get_ping(struct ei_event *event);
1983
1992uint32_t
1993ei_event_emulating_get_sequence(struct ei_event *event);
1994
2002uint32_t
2003ei_event_keyboard_get_xkb_mods_depressed(struct ei_event *event);
2004
2012uint32_t
2013ei_event_keyboard_get_xkb_mods_latched(struct ei_event *event);
2014
2022uint32_t
2023ei_event_keyboard_get_xkb_mods_locked(struct ei_event *event);
2024
2045uint32_t
2046ei_event_keyboard_get_xkb_group(struct ei_event *event);
2047
2048
2055double
2056ei_event_pointer_get_dx(struct ei_event *event);
2057
2064double
2065ei_event_pointer_get_dy(struct ei_event *event);
2066
2073double
2074ei_event_pointer_get_absolute_x(struct ei_event *event);
2075
2082double
2083ei_event_pointer_get_absolute_y(struct ei_event *event);
2084
2091uint32_t
2092ei_event_button_get_button(struct ei_event *event);
2093
2100bool
2101ei_event_button_get_is_press(struct ei_event *event);
2102
2109double
2110ei_event_scroll_get_dx(struct ei_event *event);
2111
2118double
2119ei_event_scroll_get_dy(struct ei_event *event);
2120
2127bool
2128ei_event_scroll_get_stop_x(struct ei_event *event);
2129
2136bool
2137ei_event_scroll_get_stop_y(struct ei_event *event);
2138
2145int32_t
2146ei_event_scroll_get_discrete_dx(struct ei_event *event);
2147
2154int32_t
2155ei_event_scroll_get_discrete_dy(struct ei_event *event);
2156
2163uint32_t
2164ei_event_keyboard_get_key(struct ei_event *event);
2165
2172bool
2173ei_event_keyboard_get_key_is_press(struct ei_event *event);
2174
2187uint32_t
2188ei_event_touch_get_id(struct ei_event *event);
2189
2197double
2198ei_event_touch_get_x(struct ei_event *event);
2199
2207double
2208ei_event_touch_get_y(struct ei_event *event);
2209
2220bool
2221ei_event_touch_get_is_cancel(struct ei_event *event);
2222
2226
2227#ifdef __cplusplus
2228}
2229#endif
ei_device_keyboard_get_keymap
struct ei_keymap * ei_device_keyboard_get_keymap(struct ei_device *device)
Return the keymap for this device or NULL.
ei_device_get_width
uint32_t ei_device_get_width(struct ei_device *device)
Return the width of the device in mm if the device is of type EI_DEVICE_TYPE_PHYSICAL,...
ei_device_set_user_data
void ei_device_set_user_data(struct ei_device *device, void *user_data)
Set a custom data pointer for this context.
ei_device_get_type
enum ei_device_type ei_device_get_type(struct ei_device *device)
ei_device_get_region_at
struct ei_region * ei_device_get_region_at(struct ei_device *device, double x, double y)
Return the region that contains the given point x/y (in desktop-wide coordinates) or NULL if the coor...
ei_device_close
void ei_device_close(struct ei_device *device)
Notify the server that the client is no longer interested in this device.
ei_device_unref
struct ei_device * ei_device_unref(struct ei_device *device)
Decrease the refcount of this struct by one.
ei_device_get_context
struct ei * ei_device_get_context(struct ei_device *device)
Return the struct ei context this device is associated with.
ei_device_get_seat
struct ei_seat * ei_device_get_seat(struct ei_device *device)
ei_device_get_name
const char * ei_device_get_name(struct ei_device *device)
ei_device_has_capability
bool ei_device_has_capability(struct ei_device *device, enum ei_device_capability cap)
Return true if the device has the requested capability.
ei_device_get_height
uint32_t ei_device_get_height(struct ei_device *device)
Return the height of the device in mm if the device is of type EI_DEVICE_TYPE_PHYSICAL,...
ei_device_ref
struct ei_device * ei_device_ref(struct ei_device *device)
Increase the refcount of this struct by one.
ei_device_get_user_data
void * ei_device_get_user_data(struct ei_device *device)
Return the custom data pointer for this context.
ei_device_get_region
struct ei_region * ei_device_get_region(struct ei_device *device, size_t index)
Obtain a region from a device of type EI_DEVICE_TYPE_VIRTUAL.
ei_keymap_get_fd
int ei_keymap_get_fd(struct ei_keymap *keymap)
Return a memmap-able file descriptor pointing to the keymap used by the device.
ei_keymap_get_user_data
void * ei_keymap_get_user_data(struct ei_keymap *keymap)
ei_keymap_get_size
size_t ei_keymap_get_size(struct ei_keymap *keymap)
ei_keymap_get_type
enum ei_keymap_type ei_keymap_get_type(struct ei_keymap *keymap)
Returns the type for this keymap.
ei_keymap_ref
struct ei_keymap * ei_keymap_ref(struct ei_keymap *keymap)
Increase the refcount of this struct by one.
ei_keymap_unref
struct ei_keymap * ei_keymap_unref(struct ei_keymap *keymap)
Decrease the refcount of this struct by one.
ei_keymap_set_user_data
void ei_keymap_set_user_data(struct ei_keymap *keymap, void *user_data)
ei_keymap_get_device
struct ei_device * ei_keymap_get_device(struct ei_keymap *keymap)
Return the device this keymap belongs to, or NULL if it has not yet been assigned to a device.
ei_keymap_get_context
struct ei_device * ei_keymap_get_context(struct ei_keymap *keymap)
Return the struct ei_device this keymap is associated with.
ei_log_context_get_func
const char * ei_log_context_get_func(struct ei_log_context *ctx)
ei_log_get_priority
enum ei_log_priority ei_log_get_priority(const struct ei *ei)
ei_log_context_get_line
unsigned int ei_log_context_get_line(struct ei_log_context *ctx)
ei_log_context_get_file
const char * ei_log_context_get_file(struct ei_log_context *ctx)
ei_log_priority
ei_log_priority
Definition libei.h:693
ei_log_handler
void(* ei_log_handler)(struct ei *ei, enum ei_log_priority priority, const char *message, struct ei_log_context *context)
The log handler for library logging.
Definition libei.h:740
ei_log_set_priority
void ei_log_set_priority(struct ei *ei, enum ei_log_priority priority)
ei_log_set_handler
void ei_log_set_handler(struct ei *ei, ei_log_handler log_handler)
Change the log handler for this context.
EI_LOG_PRIORITY_INFO
@ EI_LOG_PRIORITY_INFO
Definition libei.h:695
EI_LOG_PRIORITY_DEBUG
@ EI_LOG_PRIORITY_DEBUG
Definition libei.h:694
EI_LOG_PRIORITY_WARNING
@ EI_LOG_PRIORITY_WARNING
Definition libei.h:696
EI_LOG_PRIORITY_ERROR
@ EI_LOG_PRIORITY_ERROR
Definition libei.h:697
ei_event_touch_get_id
uint32_t ei_event_touch_get_id(struct ei_event *event)
For an event of type EI_EVENT_TOUCH_DOWN, EI_EVENT_TOUCH_MOTION, or EI_EVENT_TOUCH_UP,...
ei_event_emulating_get_sequence
uint32_t ei_event_emulating_get_sequence(struct ei_event *event)
For an event of type EI_EVENT_DEVICE_START_EMULATING, return the sequence number set by the EIS imple...
ei_event_scroll_get_dx
double ei_event_scroll_get_dx(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_DELTA return the x scroll distance in logical pixels or mm,...
ei_event_scroll_get_dy
double ei_event_scroll_get_dy(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_DELTA return the y scroll distance in logical pixels or mm,...
ei_event_pointer_get_absolute_x
double ei_event_pointer_get_absolute_x(struct ei_event *event)
For an event of type EI_EVENT_POINTER_MOTION_ABSOLUTE return the x position in logical pixels or mm,...
ei_event_button_get_is_press
bool ei_event_button_get_is_press(struct ei_event *event)
For an event of type EI_EVENT_BUTTON_BUTTON return true if the event is a button press,...
ei_event_scroll_get_stop_y
bool ei_event_scroll_get_stop_y(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_STOP return whether the y axis has stopped scrolling.
ei_event_keyboard_get_xkb_mods_locked
uint32_t ei_event_keyboard_get_xkb_mods_locked(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_MODIFIERS, get the mask of currently logically locked modifier...
ei_event_scroll_get_discrete_dy
int32_t ei_event_scroll_get_discrete_dy(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_DISCRETE return the y scroll distance in fractions or multiples ...
ei_event_keyboard_get_key
uint32_t ei_event_keyboard_get_key(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_KEY return the key code (as defined in include/linux/input-eve...
ei_event_touch_get_x
double ei_event_touch_get_x(struct ei_event *event)
For an event of type EI_EVENT_TOUCH_DOWN, or EI_EVENT_TOUCH_MOTION, return the x coordinate of the to...
ei_event_keyboard_get_xkb_mods_depressed
uint32_t ei_event_keyboard_get_xkb_mods_depressed(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_MODIFIERS, get the mask of currently logically pressed-down mo...
ei_event_touch_get_y
double ei_event_touch_get_y(struct ei_event *event)
For an event of type EI_EVENT_TOUCH_DOWN, or EI_EVENT_TOUCH_MOTION, return the y coordinate of the to...
ei_event_pointer_get_dy
double ei_event_pointer_get_dy(struct ei_event *event)
For an event of type EI_EVENT_POINTER_MOTION return the relative y movement in logical pixels or mm,...
ei_event_touch_get_is_cancel
bool ei_event_touch_get_is_cancel(struct ei_event *event)
For an event of type EI_EVENT_TOUCH_UP return true if the event was cancelled instead of logically re...
ei_event_scroll_get_stop_x
bool ei_event_scroll_get_stop_x(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_CANCEL return whether the x axis has cancelled scrolling.
ei_event_keyboard_get_xkb_mods_latched
uint32_t ei_event_keyboard_get_xkb_mods_latched(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_MODIFIERS, get the mask of currently logically latched modifie...
ei_event_scroll_get_discrete_dx
int32_t ei_event_scroll_get_discrete_dx(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_DISCRETE return the x scroll distance in fractions or multiples ...
ei_event_button_get_button
uint32_t ei_event_button_get_button(struct ei_event *event)
For an event of type EI_EVENT_BUTTON_BUTTON return the button code as defined in linux/input-event-co...
ei_event_pointer_get_dx
double ei_event_pointer_get_dx(struct ei_event *event)
For an event of type EI_EVENT_POINTER_MOTION return the relative x movement in logical pixels or mm,...
ei_event_keyboard_get_xkb_group
uint32_t ei_event_keyboard_get_xkb_group(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_MODIFIERS, get the current effective group.
ei_event_pointer_get_absolute_y
double ei_event_pointer_get_absolute_y(struct ei_event *event)
For an event of type EI_EVENT_POINTER_MOTION_ABSOLUTE return the y position in logical pixels or mm,...
ei_event_keyboard_get_key_is_press
bool ei_event_keyboard_get_key_is_press(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_KEY return true if the event is a key down,...
ei_region_set_user_data
void ei_region_set_user_data(struct ei_region *region, void *user_data)
ei_region_get_physical_scale
double ei_region_get_physical_scale(struct ei_region *region)
Return the physical scale for this region.
ei_region_get_width
uint32_t ei_region_get_width(struct ei_region *region)
ei_region_get_mapping_id
const char * ei_region_get_mapping_id(struct ei_region *region)
Get the unique identifier (representing an external resource) that is attached to this region,...
ei_region_unref
struct ei_region * ei_region_unref(struct ei_region *region)
ei_region_get_user_data
void * ei_region_get_user_data(struct ei_region *region)
ei_region_get_y
uint32_t ei_region_get_y(struct ei_region *region)
ei_region_contains
bool ei_region_contains(struct ei_region *region, double x, double y)
Return true if the point x/y (in desktop-wide coordinates) is within region.
ei_region_get_x
uint32_t ei_region_get_x(struct ei_region *region)
ei_region_convert_point
bool ei_region_convert_point(struct ei_region *region, double *x, double *y)
Convert the point x/y in a desktop-wide coordinate system into the corresponding point relative to th...
ei_region_ref
struct ei_region * ei_region_ref(struct ei_region *region)
ei_region_get_height
uint32_t ei_region_get_height(struct ei_region *region)
ei_seat_set_user_data
void ei_seat_set_user_data(struct ei_seat *seat, void *user_data)
Set a custom data pointer for this context.
ei_seat_get_context
struct ei * ei_seat_get_context(struct ei_seat *seat)
Return the struct ei context this seat is associated with.
ei_seat_bind_capabilities
void ei_seat_bind_capabilities(struct ei_seat *seat,...) __attribute__((sentinel))
Bind this client to the given seat capabilities, terminated by NULL.
ei_seat_get_name
const char * ei_seat_get_name(struct ei_seat *seat)
ei_seat_get_user_data
void * ei_seat_get_user_data(struct ei_seat *seat)
Return the custom data pointer for this context.
ei_seat_ref
struct ei_seat * ei_seat_ref(struct ei_seat *seat)
ei_seat_has_capability
bool ei_seat_has_capability(struct ei_seat *seat, enum ei_device_capability cap)
Return true if the capability is available on this seat or false otherwise.
ei_seat_unref
struct ei_seat * ei_seat_unref(struct ei_seat *seat)
ei_seat_unbind_capabilities
void ei_seat_unbind_capabilities(struct ei_seat *seat,...) __attribute__((sentinel))
Unbind a seat's capabilities, terminated by NULL.
ei_device_stop_emulating
void ei_device_stop_emulating(struct ei_device *device)
Notify the EIS implementation that the given device is no longer sending events.
ei_device_start_emulating
void ei_device_start_emulating(struct ei_device *device, uint32_t sequence)
Notify the EIS implementation that the given device is about to start sending events.
ei_touch_get_device
struct ei_device * ei_touch_get_device(struct ei_touch *touch)
ei_touch_down
void ei_touch_down(struct ei_touch *touch, double x, double y)
This function can only be called once on an ei_touch object.
ei_device_scroll_cancel
void ei_device_scroll_cancel(struct ei_device *device, bool cancel_x, bool cancel_y)
Generate a scroll cancel event on a device with the EI_DEVICE_CAP_SCROLL capability.
ei_device_pointer_motion_absolute
void ei_device_pointer_motion_absolute(struct ei_device *device, double x, double y)
Generate an absolute motion event on a device with the EI_DEVICE_CAP_POINTER_ABSOLUTE capability.
ei_touch_up
void ei_touch_up(struct ei_touch *touch)
Release this touch.
ei_device_scroll_delta
void ei_device_scroll_delta(struct ei_device *device, double x, double y)
Generate a smooth (pixel-precise) scroll event on a device with the EI_DEVICE_CAP_SCROLL capability.
ei_touch_get_user_data
void * ei_touch_get_user_data(struct ei_touch *touch)
Return the custom data pointer for this context.
ei_device_scroll_stop
void ei_device_scroll_stop(struct ei_device *device, bool stop_x, bool stop_y)
Generate a scroll stop event on a device with the EI_DEVICE_CAP_SCROLL capability.
ei_device_button_button
void ei_device_button_button(struct ei_device *device, uint32_t button, bool is_press)
Generate a button event on a device with the EI_DEVICE_CAP_BUTTON capability.
ei_touch_ref
struct ei_touch * ei_touch_ref(struct ei_touch *touch)
Increase the refcount of this struct by one.
ei_touch_motion
void ei_touch_motion(struct ei_touch *touch, double x, double y)
Move this touch to the new coordinates.
ei_device_keyboard_key
void ei_device_keyboard_key(struct ei_device *device, uint32_t keycode, bool is_press)
Generate a key event on a device with the EI_DEVICE_CAP_KEYBOARD capability.
ei_device_frame
void ei_device_frame(struct ei_device *device, uint64_t time)
Generate a frame event to group the current set of events into a logical hardware event.
ei_device_scroll_discrete
void ei_device_scroll_discrete(struct ei_device *device, int32_t x, int32_t y)
Generate a discrete scroll event on a device with the EI_DEVICE_CAP_SCROLL capability.
ei_touch_unref
struct ei_touch * ei_touch_unref(struct ei_touch *touch)
Decrease the refcount of this struct by one.
ei_device_touch_new
struct ei_touch * ei_device_touch_new(struct ei_device *device)
Initiate a new touch on a device with the EI_DEVICE_CAP_TOUCH capability.
ei_touch_cancel
void ei_touch_cancel(struct ei_touch *touch)
Cancel this touch.
ei_device_pointer_motion
void ei_device_pointer_motion(struct ei_device *device, double x, double y)
Generate a relative motion event on a device with the EI_DEVICE_CAP_POINTER capability.
ei_touch_set_user_data
void ei_touch_set_user_data(struct ei_touch *touch, void *user_data)
Set a custom data pointer for this context.
ei_setup_backend_socket
int ei_setup_backend_socket(struct ei *ei, const char *socketpath)
Set this ei context to use the socket backend.
ei_is_sender
bool ei_is_sender(struct ei *ei)
Returns true if the context is was created with ei_new_sender() or false otherwise.
ei_ping_ref
struct ei_ping * ei_ping_ref(struct ei_ping *ei_ping)
Increase the refcount of this struct by one.
ei_clock_set_now_func
void ei_clock_set_now_func(struct ei *, ei_clock_now_func func)
Override the function that returns the current time ei_now().
ei_new_receiver
struct ei * ei_new_receiver(void *user_data)
Create a new receiver ei context.
ei_dispatch
void ei_dispatch(struct ei *ei)
Main event dispatching function.
ei_disconnect
void ei_disconnect(struct ei *ei)
Disconnect the current ei context from the EIS implementation.
ei_get_fd
int ei_get_fd(struct ei *ei)
libei keeps a single file descriptor for all events.
ei_set_user_data
void ei_set_user_data(struct ei *ei, void *user_data)
Set a custom data pointer for this context.
ei_ping_get_id
uint64_t ei_ping_get_id(struct ei_ping *ping)
Return a unique, increasing id for this struct.
ei_event_get_seat
struct ei_seat * ei_event_get_seat(struct ei_event *event)
Return the seat from this event.
ei_event_pong_get_ping
struct ei_ping * ei_event_pong_get_ping(struct ei_event *event)
Returns the associated ei_ping struct with this event.
ei_device_type
ei_device_type
The device type determines what the device represents.
Definition libei.h:250
ei_new_ping
struct ei_ping * ei_new_ping(struct ei *ei)
Create a new ei_ping object to trigger a round trip to the EIS implementation.
ei_unref
struct ei * ei_unref(struct ei *ei)
Decrease the refcount of this struct by one.
ei_new_sender
struct ei * ei_new_sender(void *user_data)
Create a new sender ei context.
ei_now
uint64_t ei_now(struct ei *ei)
ei_event_get_device
struct ei_device * ei_event_get_device(struct ei_event *event)
Return the device from this event.
ei_peek_event
struct ei_event * ei_peek_event(struct ei *ei)
Returns the next event in the internal event queue (or NULL) without removing that event from the que...
ei_setup_backend_fd
int ei_setup_backend_fd(struct ei *ei, int fd)
Initialize the ei context on the given socket file descriptor.
ei_keymap_type
ei_keymap_type
The set of supported keymap types for a struct ei_keymap.
Definition libei.h:310
ei_clock_now_func
uint64_t(* ei_clock_now_func)(struct ei *ei)
Optional override function for ei_now().
Definition libei.h:777
ei_ping_get_user_data
void * ei_ping_get_user_data(struct ei_ping *ei_ping)
Return the custom data pointer for this struct.
ei_event_get_time
uint64_t ei_event_get_time(struct ei_event *event)
Return the time for the event of type EI_EVENT_FRAME in microseconds.
ei_event_ref
struct ei_event * ei_event_ref(struct ei_event *event)
Increase the refcount of this struct by one.
ei_device_capability
ei_device_capability
The set of supported capabilities.
Definition libei.h:278
ei_ping
void ei_ping(struct ei_ping *ping)
Issue a roundtrip request to the EIS implementation, resulting in an EI_EVENT_PONG event when this ro...
ei_get_event
struct ei_event * ei_get_event(struct ei *ei)
Return the next event from the event queue, removing it from the queue.
ei_event_unref
struct ei_event * ei_event_unref(struct ei_event *event)
Decrease the refcount of this struct by one.
ei_event_get_type
enum ei_event_type ei_event_get_type(struct ei_event *event)
ei_event_type
ei_event_type
This enum is not exhaustive, future versions of this library may add new event types.
Definition libei.h:326
ei_ping_set_user_data
void ei_ping_set_user_data(struct ei_ping *ei_ping, void *user_data)
Set a custom data pointer for this struct.
ei_ping_unref
struct ei_ping * ei_ping_unref(struct ei_ping *ei_ping)
Decrease the refcount of this struct by one.
ei_configure_name
void ei_configure_name(struct ei *ei, const char *name)
Set the name for this client.
ei_event_type_to_string
const char * ei_event_type_to_string(enum ei_event_type)
This is a debugging helper to return a string of the name of the event type, or NULL if the event typ...
ei_ref
struct ei * ei_ref(struct ei *ei)
Increase the refcount of this struct by one.
ei_new
struct ei * ei_new(void *user_data)
This is an alias for ei_new_sender.
ei_get_user_data
void * ei_get_user_data(struct ei *ei)
Return the custom data pointer for this context.
EI_DEVICE_TYPE_PHYSICAL
@ EI_DEVICE_TYPE_PHYSICAL
Definition libei.h:252
EI_DEVICE_TYPE_VIRTUAL
@ EI_DEVICE_TYPE_VIRTUAL
Definition libei.h:251
EI_KEYMAP_TYPE_XKB
@ EI_KEYMAP_TYPE_XKB
A libxkbcommon-compatible XKB keymap.
Definition libei.h:314
EI_DEVICE_CAP_POINTER
@ EI_DEVICE_CAP_POINTER
The device can send relative motion events.
Definition libei.h:282
EI_DEVICE_CAP_SCROLL
@ EI_DEVICE_CAP_SCROLL
The device can send scroll events.
Definition libei.h:298
EI_DEVICE_CAP_POINTER_ABSOLUTE
@ EI_DEVICE_CAP_POINTER_ABSOLUTE
The device can send absolute motion events.
Definition libei.h:286
EI_DEVICE_CAP_TOUCH
@ EI_DEVICE_CAP_TOUCH
The device can send touch events.
Definition libei.h:294
EI_DEVICE_CAP_BUTTON
@ EI_DEVICE_CAP_BUTTON
The device can send button events.
Definition libei.h:302
EI_DEVICE_CAP_KEYBOARD
@ EI_DEVICE_CAP_KEYBOARD
The device can send keyboard events.
Definition libei.h:290
EI_EVENT_SEAT_REMOVED
@ EI_EVENT_SEAT_REMOVED
The server has removed a seat previously available to this client.
Definition libei.h:372
EI_EVENT_POINTER_MOTION_ABSOLUTE
@ EI_EVENT_POINTER_MOTION_ABSOLUTE
An absolute motion event with absolute position within the device's regions or size,...
Definition libei.h:519
EI_EVENT_POINTER_MOTION
@ EI_EVENT_POINTER_MOTION
A relative motion event with delta coordinates in logical pixels or mm, depending on the device type.
Definition libei.h:510
EI_EVENT_SCROLL_DELTA
@ EI_EVENT_SCROLL_DELTA
A vertical and/or horizontal scroll event with logical-pixels or mm precision, depending on the devic...
Definition libei.h:536
EI_EVENT_DEVICE_START_EMULATING
@ EI_EVENT_DEVICE_START_EMULATING
The server is about to send events for a device.
Definition libei.h:493
EI_EVENT_SCROLL_DISCRETE
@ EI_EVENT_SCROLL_DISCRETE
A vertical and/or horizontal scroll event with a discrete range in logical scroll steps,...
Definition libei.h:558
EI_EVENT_SCROLL_STOP
@ EI_EVENT_SCROLL_STOP
An ongoing scroll sequence stopped.
Definition libei.h:543
EI_EVENT_SEAT_ADDED
@ EI_EVENT_SEAT_ADDED
The server has added a seat available to this client.
Definition libei.h:360
EI_EVENT_FRAME
@ EI_EVENT_FRAME
"Hardware" frame event.
Definition libei.h:477
EI_EVENT_DEVICE_REMOVED
@ EI_EVENT_DEVICE_REMOVED
The server has removed a device belonging to this client.
Definition libei.h:395
EI_EVENT_DEVICE_RESUMED
@ EI_EVENT_DEVICE_RESUMED
The client may send events.
Definition libei.h:407
EI_EVENT_SYNC
@ EI_EVENT_SYNC
This event represents a synchronization request (ping) from the EIS implementation.
Definition libei.h:467
EI_EVENT_BUTTON_BUTTON
@ EI_EVENT_BUTTON_BUTTON
A button press or release event.
Definition libei.h:527
EI_EVENT_DEVICE_ADDED
@ EI_EVENT_DEVICE_ADDED
The server has added a device for this client.
Definition libei.h:383
EI_EVENT_TOUCH_DOWN
@ EI_EVENT_TOUCH_DOWN
Event for a single touch set down on the device's logical surface.
Definition libei.h:577
EI_EVENT_DEVICE_PAUSED
@ EI_EVENT_DEVICE_PAUSED
Any events sent from this device will be discarded until the next resume.
Definition libei.h:403
EI_EVENT_CONNECT
@ EI_EVENT_CONNECT
The server has approved the connection to this client.
Definition libei.h:335
EI_EVENT_PONG
@ EI_EVENT_PONG
Returned in response to ei_ping().
Definition libei.h:456
EI_EVENT_DEVICE_STOP_EMULATING
@ EI_EVENT_DEVICE_STOP_EMULATING
The server stopped emulating events on this device, see EIS_EVENT_DEVICE_START_EMULATING.
Definition libei.h:501
EI_EVENT_TOUCH_UP
@ EI_EVENT_TOUCH_UP
Event for a single touch released from the device's logical surface.
Definition libei.h:585
EI_EVENT_KEYBOARD_KEY
@ EI_EVENT_KEYBOARD_KEY
A key press or release event.
Definition libei.h:566
EI_EVENT_TOUCH_MOTION
@ EI_EVENT_TOUCH_MOTION
Event for a single currently-down touch changing position (or other properties).
Definition libei.h:593
EI_EVENT_DISCONNECT
@ EI_EVENT_DISCONNECT
The server has disconnected this client - all resources left to reference this server are now obsolet...
Definition libei.h:349
EI_EVENT_SCROLL_CANCEL
@ EI_EVENT_SCROLL_CANCEL
An ongoing scroll sequence was cancelled.
Definition libei.h:550
EI_EVENT_KEYBOARD_MODIFIERS
@ EI_EVENT_KEYBOARD_MODIFIERS
The server has changed the modifier state on the device's keymap.
Definition libei.h:447
ei_device
A single device to generate input events from.
ei_event
An event received from the EIS implementation.
ei_keymap
An keymap for a device with the EI_DEVICE_CAP_KEYBOARD capability.
ei_ping
A callback struct returned by ei_new_ping() to handle roundtrips to the EIS implementation.
ei_region
A rectangular region, defined by an x/y offset and a width and a height.
ei_seat
A logical seat for a group of devices.
ei_touch
A single touch initiated by a sender context.
ei
The main context to interact with libei.