libei  1.4.1
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
29 extern "C" {
30 #endif
31 
32 #include <stddef.h>
33 #include <stdbool.h>
34 #include <stdint.h>
35 
124 struct eis;
128 struct eis_client;
132 struct eis_device;
136 struct eis_seat;
140 struct eis_event;
144 struct eis_keymap;
148 struct eis_touch;
149 
158 struct eis_ping;
159 
188 struct eis_region;
189 
215 };
216 
228 };
229 
236 };
237 
260 
267 
273 
278 
292 
304 
326 
327  /* These events are only generated on a receiving EIS context */
328 
361 
366 
384 };
385 
391 const char*
393 
397 struct eis *
398 eis_new(void *user_data);
399 
408 };
409 
413 struct eis_log_context;
414 
419 unsigned int
420 eis_log_context_get_line(struct eis_log_context *ctx);
421 
426 const char *
427 eis_log_context_get_file(struct eis_log_context *ctx);
428 
433 const char *
434 eis_log_context_get_func(struct eis_log_context *ctx);
435 
448 typedef void (*eis_log_handler)(struct eis *eis,
449  enum eis_log_priority priority,
450  const char *message,
451  struct eis_log_context *ctx);
462 void
463 eis_log_set_handler(struct eis *eis, eis_log_handler log_handler);
464 
468 void
469 eis_log_set_priority(struct eis *eis, enum eis_log_priority priority);
470 
474 enum eis_log_priority
475 eis_log_get_priority(const struct eis *eis);
476 
485 typedef uint64_t (*eis_clock_now_func)(struct eis *eis);
486 
492 void
493 eis_clock_set_now_func(struct eis *, eis_clock_now_func func);
494 
495 struct eis *
496 eis_ref(struct eis *eis);
497 
498 struct eis *
499 eis_unref(struct eis *eis);
500 
501 void *
502 eis_get_user_data(struct eis *eis);
503 
504 void
505 eis_set_user_data(struct eis *eis, void *user_data);
506 
515 int
516 eis_setup_backend_fd(struct eis *ctx);
517 
523 int
524 eis_backend_fd_add_client(struct eis *ctx);
525 
535 int
536 eis_setup_backend_socket(struct eis *ctx, const char *path);
537 
544 int
545 eis_get_fd(struct eis *eis);
546 
556 void
557 eis_dispatch(struct eis *eis);
558 
571 uint64_t
572 eis_ping_get_id(struct eis_ping *ping);
573 
582 struct eis_ping *
584 
594 struct eis_ping *
596 
604 void
605 eis_ping_set_user_data(struct eis_ping *eis_ping, void *user_data);
606 
613 void *
615 
628 void
629 eis_ping(struct eis_ping *ping);
630 
641 struct eis_event *
642 eis_get_event(struct eis *eis);
643 
660 struct eis_event *
661 eis_peek_event(struct eis *eis);
662 
672 struct eis_event *
673 eis_event_unref(struct eis_event *event);
674 
675 enum eis_event_type
676 eis_event_get_type(struct eis_event *event);
677 
678 struct eis_client *
679 eis_event_get_client(struct eis_event *event);
680 
681 struct eis_seat *
682 eis_event_get_seat(struct eis_event *event);
683 
693 struct eis_ping *
694 eis_event_pong_get_ping(struct eis_event *event);
695 
703 bool
705 
712 struct eis_device *
713 eis_event_get_device(struct eis_event *event);
714 
724 uint64_t
725 eis_event_get_time(struct eis_event *event);
726 
736 struct eis_ping *
737 eis_client_new_ping(struct eis_client *client);
738 
739 struct eis_client *
740 eis_client_ref(struct eis_client *client);
741 
742 struct eis_client *
743 eis_client_unref(struct eis_client *client);
744 
745 void *
747 
748 void
749 eis_client_set_user_data(struct eis_client *eis_client, void *user_data);
750 
751 struct eis*
752 eis_client_get_context(struct eis_client *client);
753 
759 bool
760 eis_client_is_sender(struct eis_client *client);
761 
766 const char *
767 eis_client_get_name(struct eis_client *client);
768 
778 void
779 eis_client_connect(struct eis_client *client);
780 
789 void
790 eis_client_disconnect(struct eis_client *client);
791 
804 struct eis_seat *
805 eis_client_new_seat(struct eis_client *client, const char *name);
806 
810 struct eis_seat *
811 eis_seat_ref(struct eis_seat *seat);
812 
816 struct eis_seat *
817 eis_seat_unref(struct eis_seat *seat);
818 
822 struct eis_client *
824 
828 const char *
830 
834 void *
836 
840 void
841 eis_seat_set_user_data(struct eis_seat *eis_seat, void *user_data);
842 
846 bool
847 eis_seat_has_capability(struct eis_seat *seat,
848  enum eis_device_capability cap);
849 
862 void
864  enum eis_device_capability cap);
865 
872 void
873 eis_seat_add(struct eis_seat *seat);
874 
880 void
881 eis_seat_remove(struct eis_seat *seat);
882 
886 struct eis *
887 eis_seat_get_context(struct eis_seat *seat);
888 
892 struct eis *
893 eis_device_get_context(struct eis_device *device);
894 
898 struct eis_client *
899 eis_device_get_client(struct eis_device *device);
900 
904 struct eis_seat *
905 eis_device_get_seat(struct eis_device *device);
906 
910 struct eis_device *
911 eis_device_ref(struct eis_device *device);
912 
916 struct eis_device *
917 eis_device_unref(struct eis_device *device);
918 
922 void *
924 
928 void
929 eis_device_set_user_data(struct eis_device *eis_device, void *user_data);
930 
938 const char *
939 eis_device_get_name(struct eis_device *device);
940 
944 bool
946  enum eis_device_capability cap);
947 
954 uint32_t
955 eis_device_get_width(struct eis_device *device);
956 
963 uint32_t
964 eis_device_get_height(struct eis_device *device);
965 
985 struct eis_device *
986 eis_seat_new_device(struct eis_seat *seat);
987 
996 void
997 eis_device_configure_type(struct eis_device *device, enum eis_device_type type);
998 
1002 enum eis_device_type
1003 eis_device_get_type(struct eis_device *device);
1004 
1008 void
1009 eis_device_configure_name(struct eis_device *device, const char *name);
1010 
1014 void
1016 
1031 void
1032 eis_device_configure_size(struct eis_device *device, uint32_t width, uint32_t height);
1033 
1046 struct eis_region *
1047 eis_device_new_region(struct eis_device *device);
1048 
1054 void
1055 eis_region_set_size(struct eis_region *region, uint32_t w, uint32_t h);
1056 
1062 void
1063 eis_region_set_offset(struct eis_region *region, uint32_t x, uint32_t y);
1064 
1077 void
1078 eis_region_set_physical_scale(struct eis_region *region, double scale);
1079 
1103 void
1104 eis_region_set_mapping_id(struct eis_region *region, const char *mapping_id);
1105 
1124 const char *
1125 eis_region_get_mapping_id(struct eis_region *region);
1126 
1135 void
1136 eis_region_add(struct eis_region *region);
1137 
1157 struct eis_region *
1158 eis_device_get_region(struct eis_device *device, size_t index);
1159 
1168 struct eis_region *
1169 eis_device_get_region_at(struct eis_device *device, double x, double y);
1170 
1174 struct eis_region *
1175 eis_region_ref(struct eis_region *region);
1176 
1180 struct eis_region *
1181 eis_region_unref(struct eis_region *region);
1182 
1186 void *
1187 eis_region_get_user_data(struct eis_region *region);
1188 
1192 void
1193 eis_region_set_user_data(struct eis_region *region, void *user_data);
1194 
1198 uint32_t
1199 eis_region_get_x(struct eis_region *region);
1200 
1204 uint32_t
1205 eis_region_get_y(struct eis_region *region);
1206 
1210 uint32_t
1211 eis_region_get_width(struct eis_region *region);
1212 
1216 uint32_t
1217 eis_region_get_height(struct eis_region *region);
1218 
1222 double
1224 
1230 bool
1231 eis_region_contains(struct eis_region *region, double x, double y);
1232 
1242 void
1243 eis_device_add(struct eis_device *device);
1244 
1252 void
1253 eis_device_remove(struct eis_device *device);
1254 
1275 void
1276 eis_device_pause(struct eis_device *device);
1277 
1286 void
1287 eis_device_resume(struct eis_device *device);
1288 
1308 struct eis_keymap *
1309 eis_device_new_keymap(struct eis_device *device,
1310  enum eis_keymap_type type, int fd, size_t size);
1311 
1327 void
1328 eis_keymap_add(struct eis_keymap *keymap);
1329 
1334 size_t
1335 eis_keymap_get_size(struct eis_keymap *keymap);
1336 
1343 enum eis_keymap_type
1344 eis_keymap_get_type(struct eis_keymap *keymap);
1345 
1353 int
1354 eis_keymap_get_fd(struct eis_keymap *keymap);
1355 
1359 struct eis_keymap *
1360 eis_keymap_ref(struct eis_keymap *keymap);
1361 
1365 struct eis_keymap *
1366 eis_keymap_unref(struct eis_keymap *keymap);
1367 
1371 void *
1373 
1377 void
1378 eis_keymap_set_user_data(struct eis_keymap *eis_keymap, void *user_data);
1379 
1385 struct eis_device *
1386 eis_keymap_get_device(struct eis_keymap *keymap);
1387 
1395 struct eis_keymap *
1397 
1419 void
1421  uint32_t depressed,
1422  uint32_t latched,
1423  uint32_t locked,
1424  uint32_t group);
1425 
1431 void
1432 eis_device_start_emulating(struct eis_device *device, uint32_t sequence);
1433 
1439 void
1440 eis_device_stop_emulating(struct eis_device *device);
1441 
1447 void
1448 eis_device_frame(struct eis_device *device, uint64_t time);
1449 
1455 void
1456 eis_device_pointer_motion(struct eis_device *device, double x, double y);
1457 
1463 void
1465  double x, double y);
1466 
1472 void
1473 eis_device_button_button(struct eis_device *device,
1474  uint32_t button, bool is_press);
1475 
1481 void
1482 eis_device_scroll_delta(struct eis_device *device, double x, double y);
1483 
1489 void
1490 eis_device_scroll_discrete(struct eis_device *device, int32_t x, int32_t y);
1491 
1497 void
1498 eis_device_scroll_stop(struct eis_device *device, bool stop_x, bool stop_y);
1499 
1505 void
1506 eis_device_scroll_cancel(struct eis_device *device, bool cancel_x, bool cancel_y);
1507 
1513 void
1514 eis_device_keyboard_key(struct eis_device *device, uint32_t keycode, bool is_press);
1515 
1521 struct eis_touch *
1522 eis_device_touch_new(struct eis_device *device);
1523 
1529 void
1530 eis_touch_down(struct eis_touch *touch, double x, double y);
1531 
1537 void
1538 eis_touch_motion(struct eis_touch *touch, double x, double y);
1539 
1545 void
1546 eis_touch_up(struct eis_touch *touch);
1547 
1553 void
1554 eis_touch_cancel(struct eis_touch *touch);
1555 
1561 struct eis_touch *
1562 eis_touch_ref(struct eis_touch *touch);
1563 
1569 struct eis_touch *
1570 eis_touch_unref(struct eis_touch *touch);
1571 
1577 void
1578 eis_touch_set_user_data(struct eis_touch *touch, void *user_data);
1579 
1585 void *
1586 eis_touch_get_user_data(struct eis_touch *touch);
1587 
1593 struct eis_device *
1594 eis_touch_get_device(struct eis_touch *touch);
1595 
1604 uint32_t
1606 
1613 double
1614 eis_event_pointer_get_dx(struct eis_event *event);
1615 
1622 double
1623 eis_event_pointer_get_dy(struct eis_event *event);
1624 
1631 double
1633 
1640 double
1642 
1649 uint32_t
1650 eis_event_button_get_button(struct eis_event *event);
1651 
1658 bool
1660 
1667 double
1668 eis_event_scroll_get_dx(struct eis_event *event);
1669 
1676 double
1677 eis_event_scroll_get_dy(struct eis_event *event);
1678 
1688 bool
1689 eis_event_scroll_get_stop_x(struct eis_event *event);
1690 
1700 bool
1701 eis_event_scroll_get_stop_y(struct eis_event *event);
1702 
1709 int32_t
1711 
1718 int32_t
1720 
1727 uint32_t
1728 eis_event_keyboard_get_key(struct eis_event *event);
1729 
1736 bool
1738 
1751 uint32_t
1752 eis_event_touch_get_id(struct eis_event *event);
1753 
1761 double
1762 eis_event_touch_get_x(struct eis_event *event);
1763 
1771 double
1772 eis_event_touch_get_y(struct eis_event *event);
1773 
1784 bool
1786 
1794 uint64_t
1795 eis_now(struct eis *eis);
1796 
1801 #ifdef __cplusplus
1802 }
1803 #endif
void eis_touch_up(struct eis_touch *touch)
see ei_touch_up
An ongoing scroll sequence was cancelled.
Definition: libeis.h:355
A relative motion event with delta coordinates in logical pixels or mm, depending on the device type...
Definition: libeis.h:333
The client is about to send events for a device.
Definition: libeis.h:321
void * eis_region_get_user_data(struct eis_region *region)
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...
void * eis_ping_get_user_data(struct eis_ping *eis_ping)
Return the custom data pointer for this struct.
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...
struct eis_keymap * eis_keymap_ref(struct eis_keymap *keymap)
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...
A callback struct returned by eis_new_ping() to handle roundtrips to the client.
Definition: libeis.h:148
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, false for a release.
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...
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.
void eis_device_configure_type(struct eis_device *device, enum eis_device_type type)
Set the device type for this device.
void eis_device_keyboard_key(struct eis_device *device, uint32_t keycode, bool is_press)
see ei_device_keyboard_key
void eis_touch_down(struct eis_touch *touch, double x, double y)
see ei_touch_down
struct eis_touch * eis_touch_unref(struct eis_touch *touch)
see ei_touch_unref
void eis_device_scroll_cancel(struct eis_device *device, bool cancel_x, bool cancel_y)
see ei_device_scroll_cancel
struct eis * eis_seat_get_context(struct eis_seat *seat)
enum eis_device_type eis_device_get_type(struct eis_device *device)
void eis_client_connect(struct eis_client *client)
Allow connection from the client.
eis_keymap_type
Definition: libeis.h:234
The client wants to bind or unbind a capability on this seat.
Definition: libeis.h:266
void eis_seat_configure_capability(struct eis_seat *seat, enum eis_device_capability cap)
Allow a capability on the seat.
void eis_device_scroll_stop(struct eis_device *device, bool stop_x, bool stop_y)
see ei_device_scroll_stop
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.
struct eis_client * eis_client_ref(struct eis_client *client)
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 ...
void eis_keymap_set_user_data(struct eis_keymap *eis_keymap, void *user_data)
struct eis_seat * eis_seat_ref(struct eis_seat *seat)
bool eis_client_is_sender(struct eis_client *client)
Returns true if the client is a sender, false otherwise.
struct eis_ping * eis_event_pong_get_ping(struct eis_event *event)
Returns the associated eis_ping struct with this event.
struct eis_seat * eis_client_new_seat(struct eis_client *client, const char *name)
Create a new logical seat with a given name.
int eis_backend_fd_add_client(struct eis *ctx)
Add a new client to a context set up with eis_setup_backend_fd().
void eis_log_set_handler(struct eis *eis, eis_log_handler log_handler)
Change the log handler for this context.
struct eis * eis_new(void *user_data)
Create a new libeis context with a refcount of 1.
Definition: libeis.h:405
bool eis_seat_has_capability(struct eis_seat *seat, enum eis_device_capability cap)
void eis_device_frame(struct eis_device *device, uint64_t time)
see ei_device_frame
struct eis_region * eis_device_get_region(struct eis_device *device, size_t index)
Obtain a region from the device.
struct eis_device * eis_device_ref(struct eis_device *device)
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...
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:448
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.
struct eis_region * eis_region_ref(struct eis_region *region)
struct eis_touch * eis_device_touch_new(struct eis_device *device)
see ei_device_touch_new
struct eis_device * eis_event_get_device(struct eis_event *event)
Return the device from this event.
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...
struct eis_seat * eis_device_get_seat(struct eis_device *device)
Definition: libeis.h:224
void eis_region_set_user_data(struct eis_region *region, void *user_data)
Definition: libeis.h:226
void * eis_keymap_get_user_data(struct eis_keymap *eis_keymap)
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.
struct eis * eis_unref(struct eis *eis)
const char * eis_seat_get_name(struct eis_seat *eis_seat)
void eis_device_button_button(struct eis_device *device, uint32_t button, bool is_press)
see ei_device_button_button
Definition: libeis.h:407
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...
void eis_device_configure_capability(struct eis_device *device, enum eis_device_capability cap)
Event for a single touch set down on the device's logical surface.
Definition: libeis.h:373
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...
Event for a single currently-down touch changing position (or other properties).
Definition: libeis.h:383
void eis_device_scroll_discrete(struct eis_device *device, int32_t x, int32_t y)
see ei_device_scroll_discrete
enum eis_keymap_type eis_keymap_get_type(struct eis_keymap *keymap)
Returns the type for this keymap.
void eis_device_configure_name(struct eis_device *device, const char *name)
struct eis_device * eis_device_unref(struct eis_device *device)
Definition: libeis.h:404
void eis_clock_set_now_func(struct eis *, eis_clock_now_func func)
Override the function that returns the current time eis_now().
struct eis * eis_device_get_context(struct eis_device *device)
A vertical and/or horizontal scroll event with a discrete range in logical scroll steps...
Definition: libeis.h:360
struct eis_event * eis_event_unref(struct eis_event *event)
Release resources associated with this event.
enum eis_log_priority eis_log_get_priority(const struct eis *eis)
void eis_device_remove(struct eis_device *device)
Remove the device.
uint64_t eis_event_get_time(struct eis_event *event)
Return the time for the event of type EIS_EVENT_FRAME in microseconds.
Definition: libeis.h:140
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.
void eis_region_set_physical_scale(struct eis_region *region, double scale)
Set the physical scale for this region.
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...
void eis_device_start_emulating(struct eis_device *device, uint32_t sequence)
see ei_device_start_emulating
void eis_seat_add(struct eis_seat *seat)
Add this seat to its client and notify the client of the seat's availability.
A vertical and/or horizontal scroll event with logical-pixels or mm precision, depending on the devic...
Definition: libeis.h:347
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...
struct eis_touch * eis_touch_ref(struct eis_touch *touch)
see ei_touch_ref
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_capability
Definition: libeis.h:221
An ongoing scroll sequence stopped.
Definition: libeis.h:351
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...
void eis_device_set_user_data(struct eis_device *eis_device, void *user_data)
Definition: libeis.h:213
Returned in response to eis_ping().
Definition: libeis.h:277
Definition: libeis.h:136
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...
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...
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...
A button press or release event.
Definition: libeis.h:342
Definition: libeis.h:223
enum eis_event_type eis_event_get_type(struct eis_event *event)
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 ...
Definition: libeis.h:128
Definition: libeis.h:235
struct eis * eis_client_get_context(struct eis_client *client)
struct eis_device * eis_keymap_get_device(struct eis_keymap *keymap)
Return the device this keymap belongs to.
bool eis_device_has_capability(struct eis_device *device, enum eis_device_capability cap)
struct eis_device * eis_touch_get_device(struct eis_touch *touch)
see ei_touch_get_device
void eis_device_pointer_motion_absolute(struct eis_device *device, double x, double y)
see ei_device_pointer_motion_absolute
struct eis * eis_ref(struct eis *eis)
struct eis_device * eis_seat_new_device(struct eis_seat *seat)
Create a new device on the seat.
Definition: libeis.h:406
int eis_keymap_get_fd(struct eis_keymap *keymap)
Return a memmap-able file descriptor pointing to the keymap used by the device.
struct eis_ping * eis_ping_ref(struct eis_ping *eis_ping)
Increase the refcount of this struct by one.
Definition: libeis.h:222
void eis_touch_cancel(struct eis_touch *touch)
see ei_touch_cancel
void * eis_get_user_data(struct eis *eis)
unsigned int eis_log_context_get_line(struct eis_log_context *ctx)
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()
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...
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()
void eis_device_pointer_motion(struct eis_device *device, double x, double y)
see ei_device_pointer_motion
bool eis_region_contains(struct eis_region *region, double x, double y)
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...
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.
void eis_device_stop_emulating(struct eis_device *device)
see ei_device_stop_emulating
struct eis_client * eis_device_get_client(struct eis_device *device)
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_device_type
The device type determines what the device represents.
Definition: libeis.h:212
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.
struct eis_region * eis_region_unref(struct eis_region *region)
void eis_set_user_data(struct eis *eis, void *user_data)
void eis_device_scroll_delta(struct eis_device *device, double x, double y)
see ei_device_scroll_delta
struct eis_client * eis_client_unref(struct eis_client *client)
Definition: libeis.h:132
Regions are only available on devices of type EIS_DEVICE_TYPE_VIRTUAL.
Definition: libeis.h:158
Definition: libeis.h:144
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, return the tracking ID of the touch.
void eis_seat_set_user_data(struct eis_seat *eis_seat, void *user_data)
The client no longer listens to events from this device.
Definition: libeis.h:272
void * eis_device_get_user_data(struct eis_device *eis_device)
void * eis_client_get_user_data(struct eis_client *eis_client)
struct eis_keymap * eis_device_keyboard_get_keymap(struct eis_device *device)
Return the keymap assigned to this device.
void eis_touch_set_user_data(struct eis_touch *touch, void *user_data)
see ei_touch_set_user_data
void * eis_seat_get_user_data(struct eis_seat *eis_seat)
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.
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...
uint64_t(* eis_clock_now_func)(struct eis *eis)
Optional override function for eis_now().
Definition: libeis.h:485
void * eis_touch_get_user_data(struct eis_touch *touch)
see ei_touch_get_user_data
A client has connected.
Definition: libeis.h:254
uint64_t eis_now(struct eis *eis)
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.
void eis_dispatch(struct eis *eis)
Main event dispatching function.
void eis_ping_set_user_data(struct eis_ping *eis_ping, void *user_data)
Set a custom data pointer for this struct.
size_t eis_keymap_get_size(struct eis_keymap *keymap)
Definition: libeis.h:225
This event represents a synchronization request (ping) from the client implementation.
Definition: libeis.h:291
Event for a single touch released from the device's logical surface.
Definition: libeis.h:378
int eis_get_fd(struct eis *eis)
libeis keeps a single file descriptor for all events.
Definition: libeis.h:124
Stop emulating events on this device, see EIS_EVENT_DEVICE_START_EMULATING.
Definition: libeis.h:325
struct eis_seat * eis_event_get_seat(struct eis_event *event)
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...
uint32_t eis_region_get_height(struct eis_region *region)
eis_log_priority
Definition: libeis.h:403
int eis_setup_backend_socket(struct eis *ctx, const char *path)
Initialize the context with a UNIX socket name.
struct eis_ping * eis_ping_unref(struct eis_ping *eis_ping)
Decrease the refcount of this struct by one.
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...
void eis_seat_remove(struct eis_seat *seat)
Remove this seat and all its remaining devices.
struct eis_keymap * eis_keymap_unref(struct eis_keymap *keymap)
const char * eis_log_context_get_func(struct eis_log_context *ctx)
const char * eis_device_get_name(struct eis_device *device)
Return the name of the device.
uint32_t eis_region_get_width(struct eis_region *region)
void eis_touch_motion(struct eis_touch *touch, double x, double y)
see ei_touch_motion
struct eis_client * eis_seat_get_client(struct eis_seat *eis_seat)
"Hardware" frame event.
Definition: libeis.h:303
void eis_client_set_user_data(struct eis_client *eis_client, void *user_data)
double eis_region_get_physical_scale(struct eis_region *region)
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...
A key press or release event.
Definition: libeis.h:365
void eis_log_set_priority(struct eis *eis, enum eis_log_priority priority)
The client has disconnected, any pending requests for this client should be discarded.
Definition: libeis.h:259
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...
uint32_t eis_region_get_y(struct eis_region *region)
void eis_region_add(struct eis_region *region)
Add the given region to its device.
void eis_device_add(struct eis_device *device)
Add this device to its seat and notify the client of the device's availability.
struct eis_seat * eis_seat_unref(struct eis_seat *seat)
uint64_t eis_ping_get_id(struct eis_ping *ping)
Return a unique, increasing id for this struct.
const char * eis_client_get_name(struct eis_client *client)
Return the name set by this client.
uint32_t eis_region_get_x(struct eis_region *region)
const char * eis_log_context_get_file(struct eis_log_context *ctx)
struct eis_client * eis_event_get_client(struct eis_event *event)
Definition: libeis.h:214
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...
void eis_keymap_add(struct eis_keymap *keymap)
Set the keymap on the device.
eis_event_type
This enum is not exhaustive, future versions of this library may add new event types.
Definition: libeis.h:247
void eis_client_disconnect(struct eis_client *client)
Disconnect this client.
An absolute motion event with absolute position within the device's regions or size, depending on the device type.
Definition: libeis.h:338
Definition: libeis.h:227