libei: doc/api/libeis.h Source File

libei 1.3.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
124struct eis;
128struct eis_client;
132struct eis_device;
136struct eis_seat;
140struct eis_event;
144struct eis_keymap;
148struct eis_touch;
149
178struct eis_region;
179
202 enum eis_device_type {
203 EIS_DEVICE_TYPE_VIRTUAL = 1,
204 EIS_DEVICE_TYPE_PHYSICAL
205};
206
211 enum eis_device_capability {
212 EIS_DEVICE_CAP_POINTER = (1 << 0),
213 EIS_DEVICE_CAP_POINTER_ABSOLUTE = (1 << 1),
214 EIS_DEVICE_CAP_KEYBOARD = (1 << 2),
215 EIS_DEVICE_CAP_TOUCH = (1 << 3),
216 EIS_DEVICE_CAP_SCROLL = (1 << 4),
217 EIS_DEVICE_CAP_BUTTON = (1 << 5),
218};
219
224 enum eis_keymap_type {
225 EIS_KEYMAP_TYPE_XKB = 1,
226};
227
231 enum eis_event_type {
238 EIS_EVENT_CLIENT_CONNECT = 1,
243 EIS_EVENT_CLIENT_DISCONNECT,
244
250 EIS_EVENT_SEAT_BIND,
251
256 EIS_EVENT_DEVICE_CLOSED,
257
268 EIS_EVENT_FRAME = 100,
269
286 EIS_EVENT_DEVICE_START_EMULATING = 200,
290 EIS_EVENT_DEVICE_STOP_EMULATING,
291
292 /* These events are only generated on a receiving EIS context */
293
298 EIS_EVENT_POINTER_MOTION = 300,
303 EIS_EVENT_POINTER_MOTION_ABSOLUTE = 400,
307 EIS_EVENT_BUTTON_BUTTON = 500,
312 EIS_EVENT_SCROLL_DELTA = 600,
316 EIS_EVENT_SCROLL_STOP,
320 EIS_EVENT_SCROLL_CANCEL,
325 EIS_EVENT_SCROLL_DISCRETE,
326
330 EIS_EVENT_KEYBOARD_KEY = 700,
331
338 EIS_EVENT_TOUCH_DOWN = 800,
343 EIS_EVENT_TOUCH_UP,
348 EIS_EVENT_TOUCH_MOTION,
349};
350
356const char*
357eis_event_type_to_string(enum eis_event_type);
358
362struct eis *
363eis_new(void *user_data);
364
368 enum eis_log_priority {
369 EIS_LOG_PRIORITY_DEBUG = 10,
370 EIS_LOG_PRIORITY_INFO = 20,
371 EIS_LOG_PRIORITY_WARNING = 30,
372 EIS_LOG_PRIORITY_ERROR = 40,
373};
374
378struct eis_log_context;
379
384unsigned int
385eis_log_context_get_line(struct eis_log_context *ctx);
386
391const char *
392eis_log_context_get_file(struct eis_log_context *ctx);
393
398const char *
399eis_log_context_get_func(struct eis_log_context *ctx);
400
413 typedef void (*eis_log_handler)(struct eis *eis,
414 enum eis_log_priority priority,
415 const char *message,
416 struct eis_log_context *ctx);
427void
428eis_log_set_handler(struct eis *eis, eis_log_handler log_handler);
429
433void
434eis_log_set_priority(struct eis *eis, enum eis_log_priority priority);
435
439enum eis_log_priority
440eis_log_get_priority(const struct eis *eis);
441
450 typedef uint64_t (*eis_clock_now_func)(struct eis *eis);
451
457void
458eis_clock_set_now_func(struct eis *, eis_clock_now_func func);
459
460struct eis *
461eis_ref(struct eis *eis);
462
463struct eis *
464eis_unref(struct eis *eis);
465
466void *
467eis_get_user_data(struct eis *eis);
468
469void
470eis_set_user_data(struct eis *eis, void *user_data);
471
476int
477eis_setup_backend_socket(struct eis *ctx, const char *path);
478
482int
483eis_setup_backend_fd(struct eis *ctx);
484
490int
491eis_backend_fd_add_client(struct eis *ctx);
492
499int
500eis_get_fd(struct eis *eis);
501
511void
512eis_dispatch(struct eis *eis);
513
524struct eis_event *
525eis_get_event(struct eis *eis);
526
543struct eis_event *
544eis_peek_event(struct eis *eis);
545
555struct eis_event *
556eis_event_unref(struct eis_event *event);
557
558enum eis_event_type
559eis_event_get_type(struct eis_event *event);
560
561struct eis_client *
562eis_event_get_client(struct eis_event *event);
563
564struct eis_seat *
565eis_event_get_seat(struct eis_event *event);
566
574bool
575eis_event_seat_has_capability(struct eis_event *event, enum eis_device_capability cap);
576
583struct eis_device *
584eis_event_get_device(struct eis_event *event);
585
595uint64_t
596eis_event_get_time(struct eis_event *event);
597
598
599
600struct eis_client *
601eis_client_ref(struct eis_client *client);
602
603struct eis_client *
604eis_client_unref(struct eis_client *client);
605
606void *
607eis_client_get_user_data(struct eis_client *eis_client);
608
609void
610eis_client_set_user_data(struct eis_client *eis_client, void *user_data);
611
612struct eis*
613eis_client_get_context(struct eis_client *client);
614
620bool
621eis_client_is_sender(struct eis_client *client);
622
627const char *
628eis_client_get_name(struct eis_client *client);
629
639void
640eis_client_connect(struct eis_client *client);
641
650void
651eis_client_disconnect(struct eis_client *client);
652
665struct eis_seat *
666eis_client_new_seat(struct eis_client *client, const char *name);
667
671struct eis_seat *
672eis_seat_ref(struct eis_seat *seat);
673
677struct eis_seat *
678eis_seat_unref(struct eis_seat *seat);
679
683struct eis_client *
684eis_seat_get_client(struct eis_seat *eis_seat);
685
689const char *
690eis_seat_get_name(struct eis_seat *eis_seat);
691
695void *
696eis_seat_get_user_data(struct eis_seat *eis_seat);
697
701void
702eis_seat_set_user_data(struct eis_seat *eis_seat, void *user_data);
703
707bool
708eis_seat_has_capability(struct eis_seat *seat,
709 enum eis_device_capability cap);
710
723void
724eis_seat_configure_capability(struct eis_seat *seat,
725 enum eis_device_capability cap);
726
733void
734eis_seat_add(struct eis_seat *seat);
735
741void
742eis_seat_remove(struct eis_seat *seat);
743
747struct eis *
748eis_seat_get_context(struct eis_seat *seat);
749
753struct eis *
754eis_device_get_context(struct eis_device *device);
755
759struct eis_client *
760eis_device_get_client(struct eis_device *device);
761
765struct eis_seat *
766eis_device_get_seat(struct eis_device *device);
767
771struct eis_device *
772eis_device_ref(struct eis_device *device);
773
777struct eis_device *
778eis_device_unref(struct eis_device *device);
779
783void *
784eis_device_get_user_data(struct eis_device *eis_device);
785
789void
790eis_device_set_user_data(struct eis_device *eis_device, void *user_data);
791
799const char *
800eis_device_get_name(struct eis_device *device);
801
805bool
806eis_device_has_capability(struct eis_device *device,
807 enum eis_device_capability cap);
808
815uint32_t
816eis_device_get_width(struct eis_device *device);
817
824uint32_t
825eis_device_get_height(struct eis_device *device);
826
846struct eis_device *
847eis_seat_new_device(struct eis_seat *seat);
848
857void
858eis_device_configure_type(struct eis_device *device, enum eis_device_type type);
859
863enum eis_device_type
864eis_device_get_type(struct eis_device *device);
865
869void
870eis_device_configure_name(struct eis_device *device, const char *name);
871
875void
876eis_device_configure_capability(struct eis_device *device, enum eis_device_capability cap);
877
892void
893eis_device_configure_size(struct eis_device *device, uint32_t width, uint32_t height);
894
907struct eis_region *
908eis_device_new_region(struct eis_device *device);
909
915void
916eis_region_set_size(struct eis_region *region, uint32_t w, uint32_t h);
917
923void
924eis_region_set_offset(struct eis_region *region, uint32_t x, uint32_t y);
925
938void
939eis_region_set_physical_scale(struct eis_region *region, double scale);
940
964void
965eis_region_set_mapping_id(struct eis_region *region, const char *mapping_id);
966
985const char *
986eis_region_get_mapping_id(struct eis_region *region);
987
996void
997eis_region_add(struct eis_region *region);
998
1018struct eis_region *
1019eis_device_get_region(struct eis_device *device, size_t index);
1020
1029struct eis_region *
1030eis_device_get_region_at(struct eis_device *device, double x, double y);
1031
1035struct eis_region *
1036eis_region_ref(struct eis_region *region);
1037
1041struct eis_region *
1042eis_region_unref(struct eis_region *region);
1043
1047void *
1048eis_region_get_user_data(struct eis_region *region);
1049
1053void
1054eis_region_set_user_data(struct eis_region *region, void *user_data);
1055
1059uint32_t
1060eis_region_get_x(struct eis_region *region);
1061
1065uint32_t
1066eis_region_get_y(struct eis_region *region);
1067
1071uint32_t
1072eis_region_get_width(struct eis_region *region);
1073
1077uint32_t
1078eis_region_get_height(struct eis_region *region);
1079
1083double
1084eis_region_get_physical_scale(struct eis_region *region);
1085
1091bool
1092eis_region_contains(struct eis_region *region, double x, double y);
1093
1103void
1104eis_device_add(struct eis_device *device);
1105
1113void
1114eis_device_remove(struct eis_device *device);
1115
1136void
1137eis_device_pause(struct eis_device *device);
1138
1147void
1148eis_device_resume(struct eis_device *device);
1149
1169struct eis_keymap *
1170eis_device_new_keymap(struct eis_device *device,
1171 enum eis_keymap_type type, int fd, size_t size);
1172
1188void
1189eis_keymap_add(struct eis_keymap *keymap);
1190
1195size_t
1196eis_keymap_get_size(struct eis_keymap *keymap);
1197
1204enum eis_keymap_type
1205eis_keymap_get_type(struct eis_keymap *keymap);
1206
1214int
1215eis_keymap_get_fd(struct eis_keymap *keymap);
1216
1220struct eis_keymap *
1221eis_keymap_ref(struct eis_keymap *keymap);
1222
1226struct eis_keymap *
1227eis_keymap_unref(struct eis_keymap *keymap);
1228
1232void *
1233eis_keymap_get_user_data(struct eis_keymap *eis_keymap);
1234
1238void
1239eis_keymap_set_user_data(struct eis_keymap *eis_keymap, void *user_data);
1240
1246struct eis_device *
1247eis_keymap_get_device(struct eis_keymap *keymap);
1248
1256struct eis_keymap *
1257eis_device_keyboard_get_keymap(struct eis_device *device);
1258
1264void
1265eis_device_keyboard_send_xkb_modifiers(struct eis_device *device,
1266 uint32_t depressed,
1267 uint32_t latched,
1268 uint32_t locked,
1269 uint32_t group);
1270
1276void
1277eis_device_start_emulating(struct eis_device *device, uint32_t sequence);
1278
1284void
1285eis_device_stop_emulating(struct eis_device *device);
1286
1292void
1293eis_device_frame(struct eis_device *device, uint64_t time);
1294
1300void
1301eis_device_pointer_motion(struct eis_device *device, double x, double y);
1302
1308void
1309eis_device_pointer_motion_absolute(struct eis_device *device,
1310 double x, double y);
1311
1317void
1318eis_device_button_button(struct eis_device *device,
1319 uint32_t button, bool is_press);
1320
1326void
1327eis_device_scroll_delta(struct eis_device *device, double x, double y);
1328
1334void
1335eis_device_scroll_discrete(struct eis_device *device, int32_t x, int32_t y);
1336
1342void
1343eis_device_scroll_stop(struct eis_device *device, bool stop_x, bool stop_y);
1344
1350void
1351eis_device_scroll_cancel(struct eis_device *device, bool cancel_x, bool cancel_y);
1352
1358void
1359eis_device_keyboard_key(struct eis_device *device, uint32_t keycode, bool is_press);
1360
1366struct eis_touch *
1367eis_device_touch_new(struct eis_device *device);
1368
1374void
1375eis_touch_down(struct eis_touch *touch, double x, double y);
1376
1382void
1383eis_touch_motion(struct eis_touch *touch, double x, double y);
1384
1390void
1391eis_touch_up(struct eis_touch *touch);
1392
1398struct eis_touch *
1399eis_touch_ref(struct eis_touch *touch);
1400
1406struct eis_touch *
1407eis_touch_unref(struct eis_touch *touch);
1408
1414void
1415eis_touch_set_user_data(struct eis_touch *touch, void *user_data);
1416
1422void *
1423eis_touch_get_user_data(struct eis_touch *touch);
1424
1430struct eis_device *
1431eis_touch_get_device(struct eis_touch *touch);
1432
1441uint32_t
1442eis_event_emulating_get_sequence(struct eis_event *event);
1443
1450double
1451eis_event_pointer_get_dx(struct eis_event *event);
1452
1459double
1460eis_event_pointer_get_dy(struct eis_event *event);
1461
1468double
1469eis_event_pointer_get_absolute_x(struct eis_event *event);
1470
1477double
1478eis_event_pointer_get_absolute_y(struct eis_event *event);
1479
1486uint32_t
1487eis_event_button_get_button(struct eis_event *event);
1488
1495bool
1496eis_event_button_get_is_press(struct eis_event *event);
1497
1504double
1505eis_event_scroll_get_dx(struct eis_event *event);
1506
1513double
1514eis_event_scroll_get_dy(struct eis_event *event);
1515
1525bool
1526eis_event_scroll_get_stop_x(struct eis_event *event);
1527
1537bool
1538eis_event_scroll_get_stop_y(struct eis_event *event);
1539
1546int32_t
1547eis_event_scroll_get_discrete_dx(struct eis_event *event);
1548
1555int32_t
1556eis_event_scroll_get_discrete_dy(struct eis_event *event);
1557
1564uint32_t
1565eis_event_keyboard_get_key(struct eis_event *event);
1566
1573bool
1574eis_event_keyboard_get_key_is_press(struct eis_event *event);
1575
1588uint32_t
1589eis_event_touch_get_id(struct eis_event *event);
1590
1598double
1599eis_event_touch_get_x(struct eis_event *event);
1600
1608double
1609eis_event_touch_get_y(struct eis_event *event);
1610
1618uint64_t
1619eis_now(struct eis *eis);
1620
1625#ifdef __cplusplus
1626}
1627#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:413
eis_log_priority
eis_log_priority
Definition libeis.h:368
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:370
EIS_LOG_PRIORITY_WARNING
@ EIS_LOG_PRIORITY_WARNING
Definition libeis.h:371
EIS_LOG_PRIORITY_ERROR
@ EIS_LOG_PRIORITY_ERROR
Definition libeis.h:372
EIS_LOG_PRIORITY_DEBUG
@ EIS_LOG_PRIORITY_DEBUG
Definition libeis.h:369
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_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_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)
Release resources associated with this event.
eis_device_type
eis_device_type
The device type determines what the device represents.
Definition libeis.h:202
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:211
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
Definition libeis.h:231
eis_keymap_type
eis_keymap_type
Definition libeis.h:224
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:450
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_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_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_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 sockets.
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:203
EIS_DEVICE_TYPE_PHYSICAL
@ EIS_DEVICE_TYPE_PHYSICAL
Definition libeis.h:204
EIS_DEVICE_CAP_POINTER
@ EIS_DEVICE_CAP_POINTER
Definition libeis.h:212
EIS_DEVICE_CAP_SCROLL
@ EIS_DEVICE_CAP_SCROLL
Definition libeis.h:216
EIS_DEVICE_CAP_TOUCH
@ EIS_DEVICE_CAP_TOUCH
Definition libeis.h:215
EIS_DEVICE_CAP_KEYBOARD
@ EIS_DEVICE_CAP_KEYBOARD
Definition libeis.h:214
EIS_DEVICE_CAP_BUTTON
@ EIS_DEVICE_CAP_BUTTON
Definition libeis.h:217
EIS_DEVICE_CAP_POINTER_ABSOLUTE
@ EIS_DEVICE_CAP_POINTER_ABSOLUTE
Definition libeis.h:213
EIS_EVENT_TOUCH_UP
@ EIS_EVENT_TOUCH_UP
Event for a single touch released from the device's logical surface.
Definition libeis.h:343
EIS_EVENT_SCROLL_STOP
@ EIS_EVENT_SCROLL_STOP
An ongoing scroll sequence stopped.
Definition libeis.h:316
EIS_EVENT_DEVICE_START_EMULATING
@ EIS_EVENT_DEVICE_START_EMULATING
The client is about to send events for a device.
Definition libeis.h:286
EIS_EVENT_BUTTON_BUTTON
@ EIS_EVENT_BUTTON_BUTTON
A button press or release event.
Definition libeis.h:307
EIS_EVENT_CLIENT_DISCONNECT
@ EIS_EVENT_CLIENT_DISCONNECT
The client has disconnected, any pending requests for this client should be discarded.
Definition libeis.h:243
EIS_EVENT_DEVICE_CLOSED
@ EIS_EVENT_DEVICE_CLOSED
The client no longer listens to events from this device.
Definition libeis.h:256
EIS_EVENT_TOUCH_DOWN
@ EIS_EVENT_TOUCH_DOWN
Event for a single touch set down on the device's logical surface.
Definition libeis.h:338
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:298
EIS_EVENT_FRAME
@ EIS_EVENT_FRAME
"Hardware" frame event.
Definition libeis.h:268
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:290
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:312
EIS_EVENT_SCROLL_CANCEL
@ EIS_EVENT_SCROLL_CANCEL
An ongoing scroll sequence was cancelled.
Definition libeis.h:320
EIS_EVENT_TOUCH_MOTION
@ EIS_EVENT_TOUCH_MOTION
Event for a single currently-down touch changing position (or other properties).
Definition libeis.h:348
EIS_EVENT_CLIENT_CONNECT
@ EIS_EVENT_CLIENT_CONNECT
A client has connected.
Definition libeis.h:238
EIS_EVENT_KEYBOARD_KEY
@ EIS_EVENT_KEYBOARD_KEY
A key press or release event.
Definition libeis.h:330
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:325
EIS_EVENT_SEAT_BIND
@ EIS_EVENT_SEAT_BIND
The client wants to bind or unbind a capability on this seat.
Definition libeis.h:250
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:303
EIS_KEYMAP_TYPE_XKB
@ EIS_KEYMAP_TYPE_XKB
Definition libeis.h:225
eis_client
eis_device
eis_event
eis_keymap
eis_region
Regions are only available on devices of type EIS_DEVICE_TYPE_VIRTUAL.
eis_seat
eis_touch
eis