libei: doc/api/libeis.h Source File

libei 1.5.0 A library for Emulated Input

libeis.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
26#pragma once
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#include <stddef.h>
33#include <stdbool.h>
34#include <stdint.h>
35#include <sys/types.h>
36
116
121
125struct eis;
129struct eis_client;
133struct eis_device;
137struct eis_seat;
141struct eis_event;
145struct eis_keymap;
149struct eis_touch;
150
159struct eis_ping;
160
189struct eis_region;
190
213 enum eis_device_type {
214 EIS_DEVICE_TYPE_VIRTUAL = 1,
215 EIS_DEVICE_TYPE_PHYSICAL
216};
217
222 enum eis_device_capability {
223 EIS_DEVICE_CAP_POINTER = (1 << 0),
224 EIS_DEVICE_CAP_POINTER_ABSOLUTE = (1 << 1),
225 EIS_DEVICE_CAP_KEYBOARD = (1 << 2),
226 EIS_DEVICE_CAP_TOUCH = (1 << 3),
227 EIS_DEVICE_CAP_SCROLL = (1 << 4),
228 EIS_DEVICE_CAP_BUTTON = (1 << 5),
229};
230
235 enum eis_keymap_type {
236 EIS_KEYMAP_TYPE_XKB = 1,
237};
238
248 enum eis_event_type {
255 EIS_EVENT_CLIENT_CONNECT = 1,
260 EIS_EVENT_CLIENT_DISCONNECT,
261
267 EIS_EVENT_SEAT_BIND,
268
273 EIS_EVENT_DEVICE_CLOSED,
274
278 EIS_EVENT_PONG = 90,
279
292 EIS_EVENT_SYNC,
293
304 EIS_EVENT_FRAME = 100,
305
322 EIS_EVENT_DEVICE_START_EMULATING = 200,
326 EIS_EVENT_DEVICE_STOP_EMULATING,
327
328 /* These events are only generated on a receiving EIS context */
329
334 EIS_EVENT_POINTER_MOTION = 300,
339 EIS_EVENT_POINTER_MOTION_ABSOLUTE = 400,
343 EIS_EVENT_BUTTON_BUTTON = 500,
348 EIS_EVENT_SCROLL_DELTA = 600,
352 EIS_EVENT_SCROLL_STOP,
356 EIS_EVENT_SCROLL_CANCEL,
361 EIS_EVENT_SCROLL_DISCRETE,
362
366 EIS_EVENT_KEYBOARD_KEY = 700,
367
374 EIS_EVENT_TOUCH_DOWN = 800,
379 EIS_EVENT_TOUCH_UP,
384 EIS_EVENT_TOUCH_MOTION,
385};
386
392const char*
393eis_event_type_to_string(enum eis_event_type);
394
398struct eis *
399eis_new(void *user_data);
400
404 enum eis_log_priority {
405 EIS_LOG_PRIORITY_DEBUG = 10,
406 EIS_LOG_PRIORITY_INFO = 20,
407 EIS_LOG_PRIORITY_WARNING = 30,
408 EIS_LOG_PRIORITY_ERROR = 40,
409};
410
414struct eis_log_context;
415
420unsigned int
421eis_log_context_get_line(struct eis_log_context *ctx);
422
427const char *
428eis_log_context_get_file(struct eis_log_context *ctx);
429
434const char *
435eis_log_context_get_func(struct eis_log_context *ctx);
436
449 typedef void (*eis_log_handler)(struct eis *eis,
450 enum eis_log_priority priority,
451 const char *message,
452 struct eis_log_context *ctx);
463void
464eis_log_set_handler(struct eis *eis, eis_log_handler log_handler);
465
469void
470eis_log_set_priority(struct eis *eis, enum eis_log_priority priority);
471
475enum eis_log_priority
476eis_log_get_priority(const struct eis *eis);
477
486 typedef uint64_t (*eis_clock_now_func)(struct eis *eis);
487
493void
494eis_clock_set_now_func(struct eis *, eis_clock_now_func func);
495
496struct eis *
497eis_ref(struct eis *eis);
498
499struct eis *
500eis_unref(struct eis *eis);
501
502void *
503eis_get_user_data(struct eis *eis);
504
505void
506eis_set_user_data(struct eis *eis, void *user_data);
507
516int
517eis_setup_backend_fd(struct eis *ctx);
518
524int
525eis_backend_fd_add_client(struct eis *ctx);
526
536int
537eis_setup_backend_socket(struct eis *ctx, const char *path);
538
539
548pid_t
549eis_backend_socket_get_client_pid(struct eis_client *client);
550
557int
558eis_get_fd(struct eis *eis);
559
569void
570eis_dispatch(struct eis *eis);
571
584uint64_t
585eis_ping_get_id(struct eis_ping *ping);
586
595struct eis_ping *
596eis_ping_ref(struct eis_ping *eis_ping);
597
607struct eis_ping *
608eis_ping_unref(struct eis_ping *eis_ping);
609
617void
618eis_ping_set_user_data(struct eis_ping *eis_ping, void *user_data);
619
626void *
627eis_ping_get_user_data(struct eis_ping *eis_ping);
628
641void
642eis_ping(struct eis_ping *ping);
643
654struct eis_event *
655eis_get_event(struct eis *eis);
656
673struct eis_event *
674eis_peek_event(struct eis *eis);
675
684struct eis_event *
685eis_event_ref(struct eis_event *event);
686
696struct eis_event *
697eis_event_unref(struct eis_event *event);
698
699enum eis_event_type
700eis_event_get_type(struct eis_event *event);
701
702struct eis_client *
703eis_event_get_client(struct eis_event *event);
704
705struct eis_seat *
706eis_event_get_seat(struct eis_event *event);
707
717struct eis_ping *
718eis_event_pong_get_ping(struct eis_event *event);
719
727bool
728eis_event_seat_has_capability(struct eis_event *event, enum eis_device_capability cap);
729
736struct eis_device *
737eis_event_get_device(struct eis_event *event);
738
748uint64_t
749eis_event_get_time(struct eis_event *event);
750
760struct eis_ping *
761eis_client_new_ping(struct eis_client *client);
762
763struct eis_client *
764eis_client_ref(struct eis_client *client);
765
766struct eis_client *
767eis_client_unref(struct eis_client *client);
768
769void *
770eis_client_get_user_data(struct eis_client *eis_client);
771
772void
773eis_client_set_user_data(struct eis_client *eis_client, void *user_data);
774
775struct eis*
776eis_client_get_context(struct eis_client *client);
777
783bool
784eis_client_is_sender(struct eis_client *client);
785
790const char *
791eis_client_get_name(struct eis_client *client);
792
802void
803eis_client_connect(struct eis_client *client);
804
813void
814eis_client_disconnect(struct eis_client *client);
815
828struct eis_seat *
829eis_client_new_seat(struct eis_client *client, const char *name);
830
834struct eis_seat *
835eis_seat_ref(struct eis_seat *seat);
836
840struct eis_seat *
841eis_seat_unref(struct eis_seat *seat);
842
846struct eis_client *
847eis_seat_get_client(struct eis_seat *eis_seat);
848
852const char *
853eis_seat_get_name(struct eis_seat *eis_seat);
854
858void *
859eis_seat_get_user_data(struct eis_seat *eis_seat);
860
864void
865eis_seat_set_user_data(struct eis_seat *eis_seat, void *user_data);
866
870bool
871eis_seat_has_capability(struct eis_seat *seat,
872 enum eis_device_capability cap);
873
886void
887eis_seat_configure_capability(struct eis_seat *seat,
888 enum eis_device_capability cap);
889
896void
897eis_seat_add(struct eis_seat *seat);
898
904void
905eis_seat_remove(struct eis_seat *seat);
906
910struct eis *
911eis_seat_get_context(struct eis_seat *seat);
912
916struct eis *
917eis_device_get_context(struct eis_device *device);
918
922struct eis_client *
923eis_device_get_client(struct eis_device *device);
924
928struct eis_seat *
929eis_device_get_seat(struct eis_device *device);
930
934struct eis_device *
935eis_device_ref(struct eis_device *device);
936
940struct eis_device *
941eis_device_unref(struct eis_device *device);
942
946void *
947eis_device_get_user_data(struct eis_device *eis_device);
948
952void
953eis_device_set_user_data(struct eis_device *eis_device, void *user_data);
954
962const char *
963eis_device_get_name(struct eis_device *device);
964
968bool
969eis_device_has_capability(struct eis_device *device,
970 enum eis_device_capability cap);
971
978uint32_t
979eis_device_get_width(struct eis_device *device);
980
987uint32_t
988eis_device_get_height(struct eis_device *device);
989
1009struct eis_device *
1010eis_seat_new_device(struct eis_seat *seat);
1011
1020void
1021eis_device_configure_type(struct eis_device *device, enum eis_device_type type);
1022
1026enum eis_device_type
1027eis_device_get_type(struct eis_device *device);
1028
1032void
1033eis_device_configure_name(struct eis_device *device, const char *name);
1034
1038void
1039eis_device_configure_capability(struct eis_device *device, enum eis_device_capability cap);
1040
1055void
1056eis_device_configure_size(struct eis_device *device, uint32_t width, uint32_t height);
1057
1070struct eis_region *
1071eis_device_new_region(struct eis_device *device);
1072
1078void
1079eis_region_set_size(struct eis_region *region, uint32_t w, uint32_t h);
1080
1086void
1087eis_region_set_offset(struct eis_region *region, uint32_t x, uint32_t y);
1088
1101void
1102eis_region_set_physical_scale(struct eis_region *region, double scale);
1103
1127void
1128eis_region_set_mapping_id(struct eis_region *region, const char *mapping_id);
1129
1148const char *
1149eis_region_get_mapping_id(struct eis_region *region);
1150
1159void
1160eis_region_add(struct eis_region *region);
1161
1181struct eis_region *
1182eis_device_get_region(struct eis_device *device, size_t index);
1183
1192struct eis_region *
1193eis_device_get_region_at(struct eis_device *device, double x, double y);
1194
1198struct eis_region *
1199eis_region_ref(struct eis_region *region);
1200
1204struct eis_region *
1205eis_region_unref(struct eis_region *region);
1206
1210void *
1211eis_region_get_user_data(struct eis_region *region);
1212
1216void
1217eis_region_set_user_data(struct eis_region *region, void *user_data);
1218
1222uint32_t
1223eis_region_get_x(struct eis_region *region);
1224
1228uint32_t
1229eis_region_get_y(struct eis_region *region);
1230
1234uint32_t
1235eis_region_get_width(struct eis_region *region);
1236
1240uint32_t
1241eis_region_get_height(struct eis_region *region);
1242
1246double
1247eis_region_get_physical_scale(struct eis_region *region);
1248
1254bool
1255eis_region_contains(struct eis_region *region, double x, double y);
1256
1266void
1267eis_device_add(struct eis_device *device);
1268
1276void
1277eis_device_remove(struct eis_device *device);
1278
1299void
1300eis_device_pause(struct eis_device *device);
1301
1310void
1311eis_device_resume(struct eis_device *device);
1312
1332struct eis_keymap *
1333eis_device_new_keymap(struct eis_device *device,
1334 enum eis_keymap_type type, int fd, size_t size);
1335
1351void
1352eis_keymap_add(struct eis_keymap *keymap);
1353
1358size_t
1359eis_keymap_get_size(struct eis_keymap *keymap);
1360
1367enum eis_keymap_type
1368eis_keymap_get_type(struct eis_keymap *keymap);
1369
1377int
1378eis_keymap_get_fd(struct eis_keymap *keymap);
1379
1383struct eis_keymap *
1384eis_keymap_ref(struct eis_keymap *keymap);
1385
1389struct eis_keymap *
1390eis_keymap_unref(struct eis_keymap *keymap);
1391
1395void *
1396eis_keymap_get_user_data(struct eis_keymap *eis_keymap);
1397
1401void
1402eis_keymap_set_user_data(struct eis_keymap *eis_keymap, void *user_data);
1403
1409struct eis_device *
1410eis_keymap_get_device(struct eis_keymap *keymap);
1411
1419struct eis_keymap *
1420eis_device_keyboard_get_keymap(struct eis_device *device);
1421
1443void
1444eis_device_keyboard_send_xkb_modifiers(struct eis_device *device,
1445 uint32_t depressed,
1446 uint32_t latched,
1447 uint32_t locked,
1448 uint32_t group);
1449
1455void
1456eis_device_start_emulating(struct eis_device *device, uint32_t sequence);
1457
1463void
1464eis_device_stop_emulating(struct eis_device *device);
1465
1471void
1472eis_device_frame(struct eis_device *device, uint64_t time);
1473
1479void
1480eis_device_pointer_motion(struct eis_device *device, double x, double y);
1481
1487void
1488eis_device_pointer_motion_absolute(struct eis_device *device,
1489 double x, double y);
1490
1496void
1497eis_device_button_button(struct eis_device *device,
1498 uint32_t button, bool is_press);
1499
1505void
1506eis_device_scroll_delta(struct eis_device *device, double x, double y);
1507
1513void
1514eis_device_scroll_discrete(struct eis_device *device, int32_t x, int32_t y);
1515
1521void
1522eis_device_scroll_stop(struct eis_device *device, bool stop_x, bool stop_y);
1523
1529void
1530eis_device_scroll_cancel(struct eis_device *device, bool cancel_x, bool cancel_y);
1531
1537void
1538eis_device_keyboard_key(struct eis_device *device, uint32_t keycode, bool is_press);
1539
1545struct eis_touch *
1546eis_device_touch_new(struct eis_device *device);
1547
1553void
1554eis_touch_down(struct eis_touch *touch, double x, double y);
1555
1561void
1562eis_touch_motion(struct eis_touch *touch, double x, double y);
1563
1569void
1570eis_touch_up(struct eis_touch *touch);
1571
1577void
1578eis_touch_cancel(struct eis_touch *touch);
1579
1585struct eis_touch *
1586eis_touch_ref(struct eis_touch *touch);
1587
1593struct eis_touch *
1594eis_touch_unref(struct eis_touch *touch);
1595
1601void
1602eis_touch_set_user_data(struct eis_touch *touch, void *user_data);
1603
1609void *
1610eis_touch_get_user_data(struct eis_touch *touch);
1611
1617struct eis_device *
1618eis_touch_get_device(struct eis_touch *touch);
1619
1628uint32_t
1629eis_event_emulating_get_sequence(struct eis_event *event);
1630
1637double
1638eis_event_pointer_get_dx(struct eis_event *event);
1639
1646double
1647eis_event_pointer_get_dy(struct eis_event *event);
1648
1655double
1656eis_event_pointer_get_absolute_x(struct eis_event *event);
1657
1664double
1665eis_event_pointer_get_absolute_y(struct eis_event *event);
1666
1673uint32_t
1674eis_event_button_get_button(struct eis_event *event);
1675
1682bool
1683eis_event_button_get_is_press(struct eis_event *event);
1684
1691double
1692eis_event_scroll_get_dx(struct eis_event *event);
1693
1700double
1701eis_event_scroll_get_dy(struct eis_event *event);
1702
1712bool
1713eis_event_scroll_get_stop_x(struct eis_event *event);
1714
1724bool
1725eis_event_scroll_get_stop_y(struct eis_event *event);
1726
1733int32_t
1734eis_event_scroll_get_discrete_dx(struct eis_event *event);
1735
1742int32_t
1743eis_event_scroll_get_discrete_dy(struct eis_event *event);
1744
1751uint32_t
1752eis_event_keyboard_get_key(struct eis_event *event);
1753
1760bool
1761eis_event_keyboard_get_key_is_press(struct eis_event *event);
1762
1775uint32_t
1776eis_event_touch_get_id(struct eis_event *event);
1777
1785double
1786eis_event_touch_get_x(struct eis_event *event);
1787
1795double
1796eis_event_touch_get_y(struct eis_event *event);
1797
1808bool
1809eis_event_touch_get_is_cancel(struct eis_event *event);
1810
1818uint64_t
1819eis_now(struct eis *eis);
1820
1824
1825#ifdef __cplusplus
1826}
1827#endif
eis_device_configure_type
void eis_device_configure_type(struct eis_device *device, enum eis_device_type type)
Set the device type for this device.
eis_device_has_capability
bool eis_device_has_capability(struct eis_device *device, enum eis_device_capability cap)
eis_device_remove
void eis_device_remove(struct eis_device *device)
Remove the device.
eis_device_get_height
uint32_t eis_device_get_height(struct eis_device *device)
Return the height in mm of a device of type EIS_DEVICE_TYPE_PHYSICAL, or zero otherwise.
eis_device_new_keymap
struct eis_keymap * eis_device_new_keymap(struct eis_device *device, enum eis_keymap_type type, int fd, size_t size)
Create a new keymap of the given type.
eis_device_set_user_data
void eis_device_set_user_data(struct eis_device *eis_device, void *user_data)
eis_device_unref
struct eis_device * eis_device_unref(struct eis_device *device)
eis_device_configure_size
void eis_device_configure_size(struct eis_device *device, uint32_t width, uint32_t height)
Configure the size in mm of a device of type EIS_DEVICE_TYPE_PHYSICAL.
eis_device_get_user_data
void * eis_device_get_user_data(struct eis_device *eis_device)
eis_device_resume
void eis_device_resume(struct eis_device *device)
Notify the client that the capabilities are resumed and that events from the device will be processed...
eis_device_get_name
const char * eis_device_get_name(struct eis_device *device)
Return the name of the device.
eis_device_keyboard_send_xkb_modifiers
void eis_device_keyboard_send_xkb_modifiers(struct eis_device *device, uint32_t depressed, uint32_t latched, uint32_t locked, uint32_t group)
Notify the client of the current XKB modifier state.
eis_device_ref
struct eis_device * eis_device_ref(struct eis_device *device)
eis_device_pause
void eis_device_pause(struct eis_device *device)
Notify the client that the device is paused and that no events from the client will be processed.
eis_device_get_seat
struct eis_seat * eis_device_get_seat(struct eis_device *device)
eis_device_configure_name
void eis_device_configure_name(struct eis_device *device, const char *name)
eis_device_get_type
enum eis_device_type eis_device_get_type(struct eis_device *device)
eis_device_new_region
struct eis_region * eis_device_new_region(struct eis_device *device)
Create a new region on the device of type EIS_DEVICE_TYPE_VIRTUAL with an initial refcount of 1.
eis_device_configure_capability
void eis_device_configure_capability(struct eis_device *device, enum eis_device_capability cap)
eis_device_keyboard_get_keymap
struct eis_keymap * eis_device_keyboard_get_keymap(struct eis_device *device)
Return the keymap assigned to this device.
eis_device_get_region_at
struct eis_region * eis_device_get_region_at(struct eis_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...
eis_device_get_width
uint32_t eis_device_get_width(struct eis_device *device)
Return the width in mm of a device of type EIS_DEVICE_TYPE_PHYSICAL, or zero otherwise.
eis_device_get_context
struct eis * eis_device_get_context(struct eis_device *device)
eis_device_get_region
struct eis_region * eis_device_get_region(struct eis_device *device, size_t index)
Obtain a region from the device.
eis_device_add
void eis_device_add(struct eis_device *device)
Add this device to its seat and notify the client of the device's availability.
eis_device_get_client
struct eis_client * eis_device_get_client(struct eis_device *device)
eis_keymap_unref
struct eis_keymap * eis_keymap_unref(struct eis_keymap *keymap)
eis_keymap_get_size
size_t eis_keymap_get_size(struct eis_keymap *keymap)
eis_keymap_get_user_data
void * eis_keymap_get_user_data(struct eis_keymap *eis_keymap)
eis_keymap_get_type
enum eis_keymap_type eis_keymap_get_type(struct eis_keymap *keymap)
Returns the type for this keymap.
eis_keymap_ref
struct eis_keymap * eis_keymap_ref(struct eis_keymap *keymap)
eis_keymap_get_fd
int eis_keymap_get_fd(struct eis_keymap *keymap)
Return a memmap-able file descriptor pointing to the keymap used by the device.
eis_keymap_get_device
struct eis_device * eis_keymap_get_device(struct eis_keymap *keymap)
Return the device this keymap belongs to.
eis_keymap_set_user_data
void eis_keymap_set_user_data(struct eis_keymap *eis_keymap, void *user_data)
eis_keymap_add
void eis_keymap_add(struct eis_keymap *keymap)
Set the keymap on the device.
eis_log_handler
void(* eis_log_handler)(struct eis *eis, enum eis_log_priority priority, const char *message, struct eis_log_context *ctx)
The log handler for library logging.
Definition libeis.h:449
eis_log_priority
eis_log_priority
Definition libeis.h:404
eis_log_set_handler
void eis_log_set_handler(struct eis *eis, eis_log_handler log_handler)
Change the log handler for this context.
eis_log_context_get_func
const char * eis_log_context_get_func(struct eis_log_context *ctx)
eis_log_set_priority
void eis_log_set_priority(struct eis *eis, enum eis_log_priority priority)
eis_log_context_get_line
unsigned int eis_log_context_get_line(struct eis_log_context *ctx)
eis_log_get_priority
enum eis_log_priority eis_log_get_priority(const struct eis *eis)
eis_log_context_get_file
const char * eis_log_context_get_file(struct eis_log_context *ctx)
EIS_LOG_PRIORITY_INFO
@ EIS_LOG_PRIORITY_INFO
Definition libeis.h:406
EIS_LOG_PRIORITY_WARNING
@ EIS_LOG_PRIORITY_WARNING
Definition libeis.h:407
EIS_LOG_PRIORITY_ERROR
@ EIS_LOG_PRIORITY_ERROR
Definition libeis.h:408
EIS_LOG_PRIORITY_DEBUG
@ EIS_LOG_PRIORITY_DEBUG
Definition libeis.h:405
eis_device_pointer_motion_absolute
void eis_device_pointer_motion_absolute(struct eis_device *device, double x, double y)
see ei_device_pointer_motion_absolute
eis_touch_set_user_data
void eis_touch_set_user_data(struct eis_touch *touch, void *user_data)
see ei_touch_set_user_data
eis_touch_get_user_data
void * eis_touch_get_user_data(struct eis_touch *touch)
see ei_touch_get_user_data
eis_device_pointer_motion
void eis_device_pointer_motion(struct eis_device *device, double x, double y)
see ei_device_pointer_motion
eis_device_scroll_stop
void eis_device_scroll_stop(struct eis_device *device, bool stop_x, bool stop_y)
see ei_device_scroll_stop
eis_touch_ref
struct eis_touch * eis_touch_ref(struct eis_touch *touch)
see ei_touch_ref
eis_touch_cancel
void eis_touch_cancel(struct eis_touch *touch)
see ei_touch_cancel
eis_touch_unref
struct eis_touch * eis_touch_unref(struct eis_touch *touch)
see ei_touch_unref
eis_touch_up
void eis_touch_up(struct eis_touch *touch)
see ei_touch_up
eis_device_start_emulating
void eis_device_start_emulating(struct eis_device *device, uint32_t sequence)
see ei_device_start_emulating
eis_touch_motion
void eis_touch_motion(struct eis_touch *touch, double x, double y)
see ei_touch_motion
eis_device_scroll_delta
void eis_device_scroll_delta(struct eis_device *device, double x, double y)
see ei_device_scroll_delta
eis_device_touch_new
struct eis_touch * eis_device_touch_new(struct eis_device *device)
see ei_device_touch_new
eis_device_stop_emulating
void eis_device_stop_emulating(struct eis_device *device)
see ei_device_stop_emulating
eis_touch_down
void eis_touch_down(struct eis_touch *touch, double x, double y)
see ei_touch_down
eis_device_keyboard_key
void eis_device_keyboard_key(struct eis_device *device, uint32_t keycode, bool is_press)
see ei_device_keyboard_key
eis_device_scroll_discrete
void eis_device_scroll_discrete(struct eis_device *device, int32_t x, int32_t y)
see ei_device_scroll_discrete
eis_device_button_button
void eis_device_button_button(struct eis_device *device, uint32_t button, bool is_press)
see ei_device_button_button
eis_touch_get_device
struct eis_device * eis_touch_get_device(struct eis_touch *touch)
see ei_touch_get_device
eis_device_frame
void eis_device_frame(struct eis_device *device, uint64_t time)
see ei_device_frame
eis_device_scroll_cancel
void eis_device_scroll_cancel(struct eis_device *device, bool cancel_x, bool cancel_y)
see ei_device_scroll_cancel
eis_region_set_size
void eis_region_set_size(struct eis_region *region, uint32_t w, uint32_t h)
This call has no effect if called after eis_region_add()
eis_region_unref
struct eis_region * eis_region_unref(struct eis_region *region)
eis_region_add
void eis_region_add(struct eis_region *region)
Add the given region to its device.
eis_region_set_offset
void eis_region_set_offset(struct eis_region *region, uint32_t x, uint32_t y)
This call has no effect if called after eis_region_add()
eis_region_get_y
uint32_t eis_region_get_y(struct eis_region *region)
eis_region_get_user_data
void * eis_region_get_user_data(struct eis_region *region)
eis_region_get_height
uint32_t eis_region_get_height(struct eis_region *region)
eis_region_contains
bool eis_region_contains(struct eis_region *region, double x, double y)
eis_region_set_user_data
void eis_region_set_user_data(struct eis_region *region, void *user_data)
eis_region_set_physical_scale
void eis_region_set_physical_scale(struct eis_region *region, double scale)
Set the physical scale for this region.
eis_region_get_width
uint32_t eis_region_get_width(struct eis_region *region)
eis_region_set_mapping_id
void eis_region_set_mapping_id(struct eis_region *region, const char *mapping_id)
Attach a unique identifier representing an external resource to this region.
eis_region_get_mapping_id
const char * eis_region_get_mapping_id(struct eis_region *region)
Get the unique ID for this region previously set by this caller, if any, or NULL if the client does n...
eis_region_get_x
uint32_t eis_region_get_x(struct eis_region *region)
eis_region_get_physical_scale
double eis_region_get_physical_scale(struct eis_region *region)
eis_region_ref
struct eis_region * eis_region_ref(struct eis_region *region)
eis_seat_unref
struct eis_seat * eis_seat_unref(struct eis_seat *seat)
eis_seat_remove
void eis_seat_remove(struct eis_seat *seat)
Remove this seat and all its remaining devices.
eis_seat_get_client
struct eis_client * eis_seat_get_client(struct eis_seat *eis_seat)
eis_seat_add
void eis_seat_add(struct eis_seat *seat)
Add this seat to its client and notify the client of the seat's availability.
eis_seat_get_context
struct eis * eis_seat_get_context(struct eis_seat *seat)
eis_seat_new_device
struct eis_device * eis_seat_new_device(struct eis_seat *seat)
Create a new device on the seat.
eis_seat_ref
struct eis_seat * eis_seat_ref(struct eis_seat *seat)
eis_seat_get_name
const char * eis_seat_get_name(struct eis_seat *eis_seat)
eis_seat_get_user_data
void * eis_seat_get_user_data(struct eis_seat *eis_seat)
eis_seat_has_capability
bool eis_seat_has_capability(struct eis_seat *seat, enum eis_device_capability cap)
eis_seat_configure_capability
void eis_seat_configure_capability(struct eis_seat *seat, enum eis_device_capability cap)
Allow a capability on the seat.
eis_seat_set_user_data
void eis_seat_set_user_data(struct eis_seat *eis_seat, void *user_data)
eis_event_keyboard_get_key
uint32_t eis_event_keyboard_get_key(struct eis_event *event)
For an event of type EIS_EVENT_KEYBOARD_KEY return the key code (as defined in include/linux/input-ev...
eis_event_touch_get_id
uint32_t eis_event_touch_get_id(struct eis_event *event)
For an event of type EIS_EVENT_TOUCH_DOWN, EIS_EVENT_TOUCH_MOTION, or EIS_EVENT_TOUCH_UP,...
eis_event_touch_get_x
double eis_event_touch_get_x(struct eis_event *event)
For an event of type EIS_EVENT_TOUCH_DOWN, or EIS_EVENT_TOUCH_MOTION, return the x coordinate of the ...
eis_event_scroll_get_discrete_dy
int32_t eis_event_scroll_get_discrete_dy(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_DISCRETE return the y scroll distance in fractions or multiples...
eis_event_scroll_get_dy
double eis_event_scroll_get_dy(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_DELTA return the y scroll distance in logical pixels or mm,...
eis_event_scroll_get_discrete_dx
int32_t eis_event_scroll_get_discrete_dx(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_DISCRETE return the x scroll distance in fractions or multiples...
eis_event_scroll_get_dx
double eis_event_scroll_get_dx(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_DELTA return the x scroll distance in logical pixels or mm,...
eis_event_button_get_button
uint32_t eis_event_button_get_button(struct eis_event *event)
For an event of type EIS_EVENT_BUTTON_BUTTON return the button code as defined in linux/input-event-c...
eis_event_scroll_get_stop_x
bool eis_event_scroll_get_stop_x(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_STOP return whether the x axis has stopped scrolling.
eis_event_keyboard_get_key_is_press
bool eis_event_keyboard_get_key_is_press(struct eis_event *event)
For an event of type EIS_EVENT_KEYBOARD_KEY return true if the event is a key down,...
eis_event_touch_get_is_cancel
bool eis_event_touch_get_is_cancel(struct eis_event *event)
For an event of type EIS_EVENT_TOUCH_UP return true if the touch was cancelled instead of logically r...
eis_event_scroll_get_stop_y
bool eis_event_scroll_get_stop_y(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_STOP return whether the y axis has stopped scrolling.
eis_event_touch_get_y
double eis_event_touch_get_y(struct eis_event *event)
For an event of type EIS_EVENT_TOUCH_DOWN, or EIS_EVENT_TOUCH_MOTION, return the y coordinate of the ...
eis_event_pointer_get_dy
double eis_event_pointer_get_dy(struct eis_event *event)
For an event of type EIS_EVENT_POINTER_MOTION return the relative y movement in logical pixels or mm,...
eis_event_pointer_get_absolute_y
double eis_event_pointer_get_absolute_y(struct eis_event *event)
For an event of type EIS_EVENT_POINTER_MOTION_ABSOLUTE return the y position in logical pixels or mm,...
eis_event_pointer_get_absolute_x
double eis_event_pointer_get_absolute_x(struct eis_event *event)
For an event of type EIS_EVENT_POINTER_MOTION_ABSOLUTE return the x position in logical pixels or mm,...
eis_event_button_get_is_press
bool eis_event_button_get_is_press(struct eis_event *event)
For an event of type EIS_EVENT_BUTTON_BUTTON return true if the event is a button press,...
eis_event_pointer_get_dx
double eis_event_pointer_get_dx(struct eis_event *event)
For an event of type EIS_EVENT_POINTER_MOTION return the relative x movement in logical pixels or mm,...
eis_event_emulating_get_sequence
uint32_t eis_event_emulating_get_sequence(struct eis_event *event)
For an event of type EIS_EVENT_DEVICE_START_EMULATING, return the sequence number set by the ei clien...
eis_backend_fd_add_client
int eis_backend_fd_add_client(struct eis *ctx)
Add a new client to a context set up with eis_setup_backend_fd().
eis_event_type_to_string
const char * eis_event_type_to_string(enum eis_event_type)
This is a debugging helper to return a string of the name of the event type, or NULL if the event typ...
eis_event_unref
struct eis_event * eis_event_unref(struct eis_event *event)
Decrease the refcount of this struct by one.
eis_device_type
eis_device_type
The device type determines what the device represents.
Definition libeis.h:213
eis_client_set_user_data
void eis_client_set_user_data(struct eis_client *eis_client, void *user_data)
eis_device_capability
eis_device_capability
Definition libeis.h:222
eis_event_get_seat
struct eis_seat * eis_event_get_seat(struct eis_event *event)
eis_client_get_context
struct eis * eis_client_get_context(struct eis_client *client)
eis_event_type
eis_event_type
This enum is not exhaustive, future versions of this library may add new event types.
Definition libeis.h:248
eis_backend_socket_get_client_pid
pid_t eis_backend_socket_get_client_pid(struct eis_client *client)
Return the pid of the client.
eis_keymap_type
eis_keymap_type
Definition libeis.h:235
eis_client_new_ping
struct eis_ping * eis_client_new_ping(struct eis_client *client)
Create a new eis_ping object to trigger a round trip to the client.
eis_client_connect
void eis_client_connect(struct eis_client *client)
Allow connection from the client.
eis_client_is_sender
bool eis_client_is_sender(struct eis_client *client)
Returns true if the client is a sender, false otherwise.
eis_client_new_seat
struct eis_seat * eis_client_new_seat(struct eis_client *client, const char *name)
Create a new logical seat with a given name.
eis_clock_now_func
uint64_t(* eis_clock_now_func)(struct eis *eis)
Optional override function for eis_now().
Definition libeis.h:486
eis_event_pong_get_ping
struct eis_ping * eis_event_pong_get_ping(struct eis_event *event)
Returns the associated eis_ping struct with this event.
eis_ping
void eis_ping(struct eis_ping *ping)
Issue a roundtrip request to the client, resulting in an EIS_EVENT_PONG event when this roundtrip has...
eis_event_get_type
enum eis_event_type eis_event_get_type(struct eis_event *event)
eis_get_fd
int eis_get_fd(struct eis *eis)
libeis keeps a single file descriptor for all events.
eis_new
struct eis * eis_new(void *user_data)
Create a new libeis context with a refcount of 1.
eis_ping_set_user_data
void eis_ping_set_user_data(struct eis_ping *eis_ping, void *user_data)
Set a custom data pointer for this struct.
eis_clock_set_now_func
void eis_clock_set_now_func(struct eis *, eis_clock_now_func func)
Override the function that returns the current time eis_now().
eis_client_get_name
const char * eis_client_get_name(struct eis_client *client)
Return the name set by this client.
eis_ref
struct eis * eis_ref(struct eis *eis)
eis_event_get_time
uint64_t eis_event_get_time(struct eis_event *event)
Return the time for the event of type EIS_EVENT_FRAME in microseconds.
eis_client_get_user_data
void * eis_client_get_user_data(struct eis_client *eis_client)
eis_get_event
struct eis_event * eis_get_event(struct eis *eis)
Returns the next event in the internal event queue (or NULL) and removes it from the queue.
eis_event_get_device
struct eis_device * eis_event_get_device(struct eis_event *event)
Return the device from this event.
eis_set_user_data
void eis_set_user_data(struct eis *eis, void *user_data)
eis_peek_event
struct eis_event * eis_peek_event(struct eis *eis)
Returns the next event in the internal event queue (or NULL) without removing that event from the que...
eis_client_disconnect
void eis_client_disconnect(struct eis_client *client)
Disconnect this client.
eis_client_unref
struct eis_client * eis_client_unref(struct eis_client *client)
eis_unref
struct eis * eis_unref(struct eis *eis)
eis_ping_unref
struct eis_ping * eis_ping_unref(struct eis_ping *eis_ping)
Decrease the refcount of this struct by one.
eis_ping_get_id
uint64_t eis_ping_get_id(struct eis_ping *ping)
Return a unique, increasing id for this struct.
eis_event_ref
struct eis_event * eis_event_ref(struct eis_event *event)
Increase the refcount of this struct by one.
eis_now
uint64_t eis_now(struct eis *eis)
eis_setup_backend_socket
int eis_setup_backend_socket(struct eis *ctx, const char *path)
Initialize the context with a UNIX socket name.
eis_event_get_client
struct eis_client * eis_event_get_client(struct eis_event *event)
eis_ping_get_user_data
void * eis_ping_get_user_data(struct eis_ping *eis_ping)
Return the custom data pointer for this struct.
eis_client_ref
struct eis_client * eis_client_ref(struct eis_client *client)
eis_setup_backend_fd
int eis_setup_backend_fd(struct eis *ctx)
Initialize the context that can take pre-configured socket file descriptors, see eis_backend_fd_add_c...
eis_ping_ref
struct eis_ping * eis_ping_ref(struct eis_ping *eis_ping)
Increase the refcount of this struct by one.
eis_dispatch
void eis_dispatch(struct eis *eis)
Main event dispatching function.
eis_get_user_data
void * eis_get_user_data(struct eis *eis)
eis_event_seat_has_capability
bool eis_event_seat_has_capability(struct eis_event *event, enum eis_device_capability cap)
For an event of type EIS_EVENT_SEAT_BIND, return the capabilities requested by the client.
EIS_DEVICE_TYPE_VIRTUAL
@ EIS_DEVICE_TYPE_VIRTUAL
Definition libeis.h:214
EIS_DEVICE_TYPE_PHYSICAL
@ EIS_DEVICE_TYPE_PHYSICAL
Definition libeis.h:215
EIS_DEVICE_CAP_POINTER
@ EIS_DEVICE_CAP_POINTER
Definition libeis.h:223
EIS_DEVICE_CAP_SCROLL
@ EIS_DEVICE_CAP_SCROLL
Definition libeis.h:227
EIS_DEVICE_CAP_TOUCH
@ EIS_DEVICE_CAP_TOUCH
Definition libeis.h:226
EIS_DEVICE_CAP_KEYBOARD
@ EIS_DEVICE_CAP_KEYBOARD
Definition libeis.h:225
EIS_DEVICE_CAP_BUTTON
@ EIS_DEVICE_CAP_BUTTON
Definition libeis.h:228
EIS_DEVICE_CAP_POINTER_ABSOLUTE
@ EIS_DEVICE_CAP_POINTER_ABSOLUTE
Definition libeis.h:224
EIS_EVENT_TOUCH_UP
@ EIS_EVENT_TOUCH_UP
Event for a single touch released from the device's logical surface.
Definition libeis.h:379
EIS_EVENT_SCROLL_STOP
@ EIS_EVENT_SCROLL_STOP
An ongoing scroll sequence stopped.
Definition libeis.h:352
EIS_EVENT_DEVICE_START_EMULATING
@ EIS_EVENT_DEVICE_START_EMULATING
The client is about to send events for a device.
Definition libeis.h:322
EIS_EVENT_BUTTON_BUTTON
@ EIS_EVENT_BUTTON_BUTTON
A button press or release event.
Definition libeis.h:343
EIS_EVENT_PONG
@ EIS_EVENT_PONG
Returned in response to eis_ping().
Definition libeis.h:278
EIS_EVENT_CLIENT_DISCONNECT
@ EIS_EVENT_CLIENT_DISCONNECT
The client has disconnected, any pending requests for this client should be discarded.
Definition libeis.h:260
EIS_EVENT_DEVICE_CLOSED
@ EIS_EVENT_DEVICE_CLOSED
The client no longer listens to events from this device.
Definition libeis.h:273
EIS_EVENT_TOUCH_DOWN
@ EIS_EVENT_TOUCH_DOWN
Event for a single touch set down on the device's logical surface.
Definition libeis.h:374
EIS_EVENT_POINTER_MOTION
@ EIS_EVENT_POINTER_MOTION
A relative motion event with delta coordinates in logical pixels or mm, depending on the device type.
Definition libeis.h:334
EIS_EVENT_SYNC
@ EIS_EVENT_SYNC
This event represents a synchronization request (ping) from the client implementation.
Definition libeis.h:292
EIS_EVENT_FRAME
@ EIS_EVENT_FRAME
"Hardware" frame event.
Definition libeis.h:304
EIS_EVENT_DEVICE_STOP_EMULATING
@ EIS_EVENT_DEVICE_STOP_EMULATING
Stop emulating events on this device, see EIS_EVENT_DEVICE_START_EMULATING.
Definition libeis.h:326
EIS_EVENT_SCROLL_DELTA
@ EIS_EVENT_SCROLL_DELTA
A vertical and/or horizontal scroll event with logical-pixels or mm precision, depending on the devic...
Definition libeis.h:348
EIS_EVENT_SCROLL_CANCEL
@ EIS_EVENT_SCROLL_CANCEL
An ongoing scroll sequence was cancelled.
Definition libeis.h:356
EIS_EVENT_TOUCH_MOTION
@ EIS_EVENT_TOUCH_MOTION
Event for a single currently-down touch changing position (or other properties).
Definition libeis.h:384
EIS_EVENT_CLIENT_CONNECT
@ EIS_EVENT_CLIENT_CONNECT
A client has connected.
Definition libeis.h:255
EIS_EVENT_KEYBOARD_KEY
@ EIS_EVENT_KEYBOARD_KEY
A key press or release event.
Definition libeis.h:366
EIS_EVENT_SCROLL_DISCRETE
@ EIS_EVENT_SCROLL_DISCRETE
A vertical and/or horizontal scroll event with a discrete range in logical scroll steps,...
Definition libeis.h:361
EIS_EVENT_SEAT_BIND
@ EIS_EVENT_SEAT_BIND
The client wants to bind or unbind a capability on this seat.
Definition libeis.h:267
EIS_EVENT_POINTER_MOTION_ABSOLUTE
@ EIS_EVENT_POINTER_MOTION_ABSOLUTE
An absolute motion event with absolute position within the device's regions or size,...
Definition libeis.h:339
EIS_KEYMAP_TYPE_XKB
@ EIS_KEYMAP_TYPE_XKB
Definition libeis.h:236
eis_client
eis_device
eis_event
eis_keymap
eis_ping
A callback struct returned by eis_new_ping() to handle roundtrips to the client.
eis_region
Regions are only available on devices of type EIS_DEVICE_TYPE_VIRTUAL.
eis_seat
eis_touch
eis