libei: doc/api/libei.h Source File

libei 1.3.0 A library for Emulated Input

libei.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: MIT */
2/*
3 * Copyright © 2020 Red Hat, Inc.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25#pragma once
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31#include <stdbool.h>
32#include <stdint.h>
33#include <stddef.h>
34
137struct ei;
138
150struct ei_device;
151
165struct ei_seat;
166
175struct ei_event;
176
184struct ei_keymap;
185
206struct ei_region;
207
230 enum ei_device_type {
231 EI_DEVICE_TYPE_VIRTUAL = 1,
232 EI_DEVICE_TYPE_PHYSICAL
233};
234
258 enum ei_device_capability {
262 EI_DEVICE_CAP_POINTER = (1 << 0),
266 EI_DEVICE_CAP_POINTER_ABSOLUTE = (1 << 1),
270 EI_DEVICE_CAP_KEYBOARD = (1 << 2),
274 EI_DEVICE_CAP_TOUCH = (1 << 3),
278 EI_DEVICE_CAP_SCROLL = (1 << 4),
282 EI_DEVICE_CAP_BUTTON = (1 << 5),
283};
284
290 enum ei_keymap_type {
294 EI_KEYMAP_TYPE_XKB = 1,
295};
296
297 enum ei_event_type {
306 EI_EVENT_CONNECT = 1,
307
320 EI_EVENT_DISCONNECT,
321
331 EI_EVENT_SEAT_ADDED,
332
343 EI_EVENT_SEAT_REMOVED,
344
354 EI_EVENT_DEVICE_ADDED,
355
366 EI_EVENT_DEVICE_REMOVED,
367
374 EI_EVENT_DEVICE_PAUSED,
378 EI_EVENT_DEVICE_RESUMED,
379
394 EI_EVENT_KEYBOARD_MODIFIERS,
395
404 EI_EVENT_FRAME = 100,
405
420 EI_EVENT_DEVICE_START_EMULATING = 200,
428 EI_EVENT_DEVICE_STOP_EMULATING,
429
437 EI_EVENT_POINTER_MOTION = 300,
438
446 EI_EVENT_POINTER_MOTION_ABSOLUTE = 400,
447
454 EI_EVENT_BUTTON_BUTTON = 500,
455
463 EI_EVENT_SCROLL_DELTA = 600,
470 EI_EVENT_SCROLL_STOP,
477 EI_EVENT_SCROLL_CANCEL,
485 EI_EVENT_SCROLL_DISCRETE,
486
493 EI_EVENT_KEYBOARD_KEY = 700,
494
504 EI_EVENT_TOUCH_DOWN = 800,
512 EI_EVENT_TOUCH_UP,
520 EI_EVENT_TOUCH_MOTION,
521};
522
528const char*
529ei_event_type_to_string(enum ei_event_type);
530
534struct ei *
535ei_new(void *user_data);
536
554struct ei *
555ei_new_sender(void *user_data);
556
574struct ei *
575ei_new_receiver(void *user_data);
576
583struct ei *
584ei_ref(struct ei *ei);
585
593struct ei *
594ei_unref(struct ei *ei);
595
601void
602ei_set_user_data(struct ei *ei, void *user_data);
603
608void *
609ei_get_user_data(struct ei *ei);
610
614bool
615ei_is_sender(struct ei *ei);
616
620 enum ei_log_priority {
621 EI_LOG_PRIORITY_DEBUG = 10,
622 EI_LOG_PRIORITY_INFO = 20,
623 EI_LOG_PRIORITY_WARNING = 30,
624 EI_LOG_PRIORITY_ERROR = 40,
625};
626
627struct ei_log_context;
628
633unsigned int
634ei_log_context_get_line(struct ei_log_context *ctx);
635
640const char *
641ei_log_context_get_file(struct ei_log_context *ctx);
642
647const char *
648ei_log_context_get_func(struct ei_log_context *ctx);
649
667 typedef void (*ei_log_handler)(struct ei *ei,
668 enum ei_log_priority priority,
669 const char *message,
670 struct ei_log_context *context);
681void
682ei_log_set_handler(struct ei *ei, ei_log_handler log_handler);
683
687void
688ei_log_set_priority(struct ei *ei, enum ei_log_priority priority);
689
693enum ei_log_priority
694ei_log_get_priority(const struct ei *ei);
695
704 typedef uint64_t (*ei_clock_now_func)(struct ei *ei);
705
711void
712ei_clock_set_now_func(struct ei *, ei_clock_now_func func);
713
726void
727ei_configure_name(struct ei * ei, const char *name);
728
748int
749ei_setup_backend_socket(struct ei *ei, const char *socketpath);
750
768int
769ei_setup_backend_fd(struct ei *ei, int fd);
770
777int
778ei_get_fd(struct ei *ei);
779
789void
790ei_dispatch(struct ei *ei);
791
797struct ei_event *
798ei_get_event(struct ei *ei);
799
816struct ei_event *
817ei_peek_event(struct ei *ei);
818
826uint64_t
827ei_now(struct ei *ei);
828
836void
837ei_seat_set_user_data(struct ei_seat *seat, void *user_data);
838
845void *
846ei_seat_get_user_data(struct ei_seat *seat);
847
851const char *
852ei_seat_get_name(struct ei_seat *seat);
853
861bool
862ei_seat_has_capability(struct ei_seat *seat,
863 enum ei_device_capability cap);
864
882void
883ei_seat_bind_capabilities(struct ei_seat *seat, ...)
884__attribute__((sentinel));
885
897void
898ei_seat_unbind_capabilities(struct ei_seat *seat, ...)
899__attribute__((sentinel));
900
901
905struct ei_seat *
906ei_seat_ref(struct ei_seat *seat);
907
911struct ei_seat *
912ei_seat_unref(struct ei_seat *seat);
913
919struct ei *
920ei_seat_get_context(struct ei_seat *seat);
921
931struct ei_event *
932ei_event_unref(struct ei_event *event);
933
937enum ei_event_type
938ei_event_get_type(struct ei_event *event);
939
949struct ei_device *
950ei_event_get_device(struct ei_event *event);
951
961uint64_t
962ei_event_get_time(struct ei_event *event);
963
972struct ei_device *
973ei_device_ref(struct ei_device *device);
974
984struct ei_device *
985ei_device_unref(struct ei_device *device);
986
990struct ei_seat *
991ei_device_get_seat(struct ei_device *device);
992
1000void
1001ei_device_set_user_data(struct ei_device *device, void *user_data);
1002
1009void *
1010ei_device_get_user_data(struct ei_device *device);
1011
1018uint32_t
1019ei_device_get_width(struct ei_device *device);
1020
1027uint32_t
1028ei_device_get_height(struct ei_device *device);
1029
1035size_t
1036ei_keymap_get_size(struct ei_keymap *keymap);
1037
1044enum ei_keymap_type
1045ei_keymap_get_type(struct ei_keymap *keymap);
1046
1054int
1055ei_keymap_get_fd(struct ei_keymap *keymap);
1056
1067struct ei_device *
1068ei_keymap_get_device(struct ei_keymap *keymap);
1069
1078struct ei_keymap *
1079ei_keymap_ref(struct ei_keymap *keymap);
1080
1090struct ei_keymap *
1091ei_keymap_unref(struct ei_keymap *keymap);
1092
1096void
1097ei_keymap_set_user_data(struct ei_keymap *keymap, void *user_data);
1098
1102void *
1103ei_keymap_get_user_data(struct ei_keymap *keymap);
1104
1124void
1125ei_device_close(struct ei_device *device);
1126
1132const char *
1133ei_device_get_name(struct ei_device *device);
1134
1140enum ei_device_type
1141ei_device_get_type(struct ei_device *device);
1142
1150bool
1151ei_device_has_capability(struct ei_device *device,
1152 enum ei_device_capability cap);
1153
1154
1176struct ei_region *
1177ei_device_get_region(struct ei_device *device, size_t index);
1178
1187struct ei_region *
1188ei_device_get_region_at(struct ei_device *device, double x, double y);
1189
1193struct ei_region *
1194ei_region_ref(struct ei_region *region);
1195
1199struct ei_region *
1200ei_region_unref(struct ei_region *region);
1201
1205void
1206ei_region_set_user_data(struct ei_region *region, void *user_data);
1207
1211void *
1212ei_region_get_user_data(struct ei_region *region);
1213
1217uint32_t
1218ei_region_get_x(struct ei_region *region);
1219
1223uint32_t
1224ei_region_get_y(struct ei_region *region);
1225
1229uint32_t
1230ei_region_get_width(struct ei_region *region);
1231
1235uint32_t
1236ei_region_get_height(struct ei_region *region);
1237
1265const char *
1266ei_region_get_mapping_id(struct ei_region *region);
1267
1274bool
1275ei_region_contains(struct ei_region *region, double x, double y);
1276
1287bool
1288ei_region_convert_point(struct ei_region *region, double *x, double *y);
1289
1359double
1360ei_region_get_physical_scale(struct ei_region *region);
1361
1376/* FIXME: the current API makes it impossible to know when the keymap has
1377 * been consumed so the file stays open forever.
1378 */
1379struct ei_keymap *
1380ei_device_keyboard_get_keymap(struct ei_device *device);
1381
1387struct ei_device *
1388ei_keymap_get_context(struct ei_keymap *keymap);
1389
1395struct ei *
1396ei_device_get_context(struct ei_device *device);
1397
1427void
1428ei_device_start_emulating(struct ei_device *device, uint32_t sequence);
1429
1438void
1439ei_device_stop_emulating(struct ei_device *device);
1440
1457void
1458ei_device_frame(struct ei_device *device, uint64_t time);
1459
1472void
1473ei_device_pointer_motion(struct ei_device *device, double x, double y);
1474
1490void
1491ei_device_pointer_motion_absolute(struct ei_device *device,
1492 double x, double y);
1493
1508void
1509ei_device_button_button(struct ei_device *device,
1510 uint32_t button, bool is_press);
1511
1530void
1531ei_device_scroll_delta(struct ei_device *device, double x, double y);
1532
1555void
1556ei_device_scroll_discrete(struct ei_device *device, int32_t x, int32_t y);
1557
1587void
1588ei_device_scroll_stop(struct ei_device *device, bool stop_x, bool stop_y);
1589
1618void
1619ei_device_scroll_cancel(struct ei_device *device, bool cancel_x, bool cancel_y);
1620
1641void
1642ei_device_keyboard_key(struct ei_device *device, uint32_t keycode, bool is_press);
1643
1656struct ei_touch *
1657ei_device_touch_new(struct ei_device *device);
1658
1672void
1673ei_touch_down(struct ei_touch *touch, double x, double y);
1674
1680void
1681ei_touch_motion(struct ei_touch *touch, double x, double y);
1682
1690void
1691ei_touch_up(struct ei_touch *touch);
1692
1701struct ei_touch *
1702ei_touch_ref(struct ei_touch *touch);
1703
1713struct ei_touch *
1714ei_touch_unref(struct ei_touch *touch);
1715
1723void
1724ei_touch_set_user_data(struct ei_touch *touch, void *user_data);
1725
1732void *
1733ei_touch_get_user_data(struct ei_touch *touch);
1734
1740struct ei_device *
1741ei_touch_get_device(struct ei_touch *touch);
1742
1752struct ei_seat *
1753ei_event_get_seat(struct ei_event *event);
1754
1763uint32_t
1764ei_event_emulating_get_sequence(struct ei_event *event);
1765
1773uint32_t
1774ei_event_keyboard_get_xkb_mods_depressed(struct ei_event *event);
1775
1783uint32_t
1784ei_event_keyboard_get_xkb_mods_latched(struct ei_event *event);
1785
1793uint32_t
1794ei_event_keyboard_get_xkb_mods_locked(struct ei_event *event);
1795
1803uint32_t
1804ei_event_keyboard_get_xkb_group(struct ei_event *event);
1805
1806
1813double
1814ei_event_pointer_get_dx(struct ei_event *event);
1815
1822double
1823ei_event_pointer_get_dy(struct ei_event *event);
1824
1831double
1832ei_event_pointer_get_absolute_x(struct ei_event *event);
1833
1840double
1841ei_event_pointer_get_absolute_y(struct ei_event *event);
1842
1849uint32_t
1850ei_event_button_get_button(struct ei_event *event);
1851
1858bool
1859ei_event_button_get_is_press(struct ei_event *event);
1860
1867double
1868ei_event_scroll_get_dx(struct ei_event *event);
1869
1876double
1877ei_event_scroll_get_dy(struct ei_event *event);
1878
1885bool
1886ei_event_scroll_get_stop_x(struct ei_event *event);
1887
1894bool
1895ei_event_scroll_get_stop_y(struct ei_event *event);
1896
1903int32_t
1904ei_event_scroll_get_discrete_dx(struct ei_event *event);
1905
1912int32_t
1913ei_event_scroll_get_discrete_dy(struct ei_event *event);
1914
1921uint32_t
1922ei_event_keyboard_get_key(struct ei_event *event);
1923
1930bool
1931ei_event_keyboard_get_key_is_press(struct ei_event *event);
1932
1945uint32_t
1946ei_event_touch_get_id(struct ei_event *event);
1947
1955double
1956ei_event_touch_get_x(struct ei_event *event);
1957
1965double
1966ei_event_touch_get_y(struct ei_event *event);
1967
1972#ifdef __cplusplus
1973}
1974#endif
ei_device_keyboard_get_keymap
struct ei_keymap * ei_device_keyboard_get_keymap(struct ei_device *device)
Return the keymap for this device or NULL.
ei_device_get_width
uint32_t ei_device_get_width(struct ei_device *device)
Return the width of the device in mm if the device is of type EI_DEVICE_TYPE_PHYSICAL,...
ei_device_set_user_data
void ei_device_set_user_data(struct ei_device *device, void *user_data)
Set a custom data pointer for this context.
ei_device_get_type
enum ei_device_type ei_device_get_type(struct ei_device *device)
ei_device_get_region_at
struct ei_region * ei_device_get_region_at(struct ei_device *device, double x, double y)
Return the region that contains the given point x/y (in desktop-wide coordinates) or NULL if the coor...
ei_device_close
void ei_device_close(struct ei_device *device)
Notify the server that the client is no longer interested in this device.
ei_device_unref
struct ei_device * ei_device_unref(struct ei_device *device)
Decrease the refcount of this struct by one.
ei_device_get_context
struct ei * ei_device_get_context(struct ei_device *device)
Return the struct ei context this device is associated with.
ei_device_get_seat
struct ei_seat * ei_device_get_seat(struct ei_device *device)
ei_device_get_name
const char * ei_device_get_name(struct ei_device *device)
ei_device_has_capability
bool ei_device_has_capability(struct ei_device *device, enum ei_device_capability cap)
Return true if the device has the requested capability.
ei_device_get_height
uint32_t ei_device_get_height(struct ei_device *device)
Return the height of the device in mm if the device is of type EI_DEVICE_TYPE_PHYSICAL,...
ei_device_ref
struct ei_device * ei_device_ref(struct ei_device *device)
Increase the refcount of this struct by one.
ei_device_get_user_data
void * ei_device_get_user_data(struct ei_device *device)
Return the custom data pointer for this context.
ei_device_get_region
struct ei_region * ei_device_get_region(struct ei_device *device, size_t index)
Obtain a region from a device of type EI_DEVICE_TYPE_VIRTUAL.
ei_keymap_get_fd
int ei_keymap_get_fd(struct ei_keymap *keymap)
Return a memmap-able file descriptor pointing to the keymap used by the device.
ei_keymap_get_user_data
void * ei_keymap_get_user_data(struct ei_keymap *keymap)
ei_keymap_get_size
size_t ei_keymap_get_size(struct ei_keymap *keymap)
ei_keymap_get_type
enum ei_keymap_type ei_keymap_get_type(struct ei_keymap *keymap)
Returns the type for this keymap.
ei_keymap_ref
struct ei_keymap * ei_keymap_ref(struct ei_keymap *keymap)
Increase the refcount of this struct by one.
ei_keymap_unref
struct ei_keymap * ei_keymap_unref(struct ei_keymap *keymap)
Decrease the refcount of this struct by one.
ei_keymap_set_user_data
void ei_keymap_set_user_data(struct ei_keymap *keymap, void *user_data)
ei_keymap_get_device
struct ei_device * ei_keymap_get_device(struct ei_keymap *keymap)
Return the device this keymap belongs to, or NULL if it has not yet been assigned to a device.
ei_keymap_get_context
struct ei_device * ei_keymap_get_context(struct ei_keymap *keymap)
Return the struct ei_device this keymap is associated with.
ei_log_context_get_func
const char * ei_log_context_get_func(struct ei_log_context *ctx)
ei_log_get_priority
enum ei_log_priority ei_log_get_priority(const struct ei *ei)
ei_log_context_get_line
unsigned int ei_log_context_get_line(struct ei_log_context *ctx)
ei_log_context_get_file
const char * ei_log_context_get_file(struct ei_log_context *ctx)
ei_log_priority
ei_log_priority
Definition libei.h:620
ei_log_handler
void(* ei_log_handler)(struct ei *ei, enum ei_log_priority priority, const char *message, struct ei_log_context *context)
The log handler for library logging.
Definition libei.h:667
ei_log_set_priority
void ei_log_set_priority(struct ei *ei, enum ei_log_priority priority)
ei_log_set_handler
void ei_log_set_handler(struct ei *ei, ei_log_handler log_handler)
Change the log handler for this context.
EI_LOG_PRIORITY_INFO
@ EI_LOG_PRIORITY_INFO
Definition libei.h:622
EI_LOG_PRIORITY_DEBUG
@ EI_LOG_PRIORITY_DEBUG
Definition libei.h:621
EI_LOG_PRIORITY_WARNING
@ EI_LOG_PRIORITY_WARNING
Definition libei.h:623
EI_LOG_PRIORITY_ERROR
@ EI_LOG_PRIORITY_ERROR
Definition libei.h:624
ei_event_touch_get_id
uint32_t ei_event_touch_get_id(struct ei_event *event)
For an event of type EI_EVENT_TOUCH_DOWN, EI_EVENT_TOUCH_MOTION, or EI_EVENT_TOUCH_UP,...
ei_event_emulating_get_sequence
uint32_t ei_event_emulating_get_sequence(struct ei_event *event)
For an event of type EI_EVENT_DEVICE_START_EMULATING, return the sequence number set by the EIS imple...
ei_event_scroll_get_dx
double ei_event_scroll_get_dx(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_DELTA return the x scroll distance in logical pixels or mm,...
ei_event_scroll_get_dy
double ei_event_scroll_get_dy(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_DELTA return the y scroll distance in logical pixels or mm,...
ei_event_pointer_get_absolute_x
double ei_event_pointer_get_absolute_x(struct ei_event *event)
For an event of type EI_EVENT_POINTER_MOTION_ABSOLUTE return the x position in logical pixels or mm,...
ei_event_button_get_is_press
bool ei_event_button_get_is_press(struct ei_event *event)
For an event of type EI_EVENT_BUTTON_BUTTON return true if the event is a button press,...
ei_event_scroll_get_stop_y
bool ei_event_scroll_get_stop_y(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_STOP return whether the y axis has stopped scrolling.
ei_event_keyboard_get_xkb_mods_locked
uint32_t ei_event_keyboard_get_xkb_mods_locked(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_MODIFIERS, get the mask of currently logically locked modifier...
ei_event_scroll_get_discrete_dy
int32_t ei_event_scroll_get_discrete_dy(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_DISCRETE return the y scroll distance in fractions or multiples ...
ei_event_keyboard_get_key
uint32_t ei_event_keyboard_get_key(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_KEY return the key code (as defined in include/linux/input-eve...
ei_event_touch_get_x
double ei_event_touch_get_x(struct ei_event *event)
For an event of type EI_EVENT_TOUCH_DOWN, or EI_EVENT_TOUCH_MOTION, return the x coordinate of the to...
ei_event_keyboard_get_xkb_mods_depressed
uint32_t ei_event_keyboard_get_xkb_mods_depressed(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_MODIFIERS, get the mask of currently logically pressed-down mo...
ei_event_touch_get_y
double ei_event_touch_get_y(struct ei_event *event)
For an event of type EI_EVENT_TOUCH_DOWN, or EI_EVENT_TOUCH_MOTION, return the y coordinate of the to...
ei_event_pointer_get_dy
double ei_event_pointer_get_dy(struct ei_event *event)
For an event of type EI_EVENT_POINTER_MOTION return the relative y movement in logical pixels or mm,...
ei_event_scroll_get_stop_x
bool ei_event_scroll_get_stop_x(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_CANCEL return whether the x axis has cancelled scrolling.
ei_event_keyboard_get_xkb_mods_latched
uint32_t ei_event_keyboard_get_xkb_mods_latched(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_MODIFIERS, get the mask of currently logically latched modifie...
ei_event_scroll_get_discrete_dx
int32_t ei_event_scroll_get_discrete_dx(struct ei_event *event)
For an event of type EI_EVENT_SCROLL_DISCRETE return the x scroll distance in fractions or multiples ...
ei_event_button_get_button
uint32_t ei_event_button_get_button(struct ei_event *event)
For an event of type EI_EVENT_BUTTON_BUTTON return the button code as defined in linux/input-event-co...
ei_event_pointer_get_dx
double ei_event_pointer_get_dx(struct ei_event *event)
For an event of type EI_EVENT_POINTER_MOTION return the relative x movement in logical pixels or mm,...
ei_event_keyboard_get_xkb_group
uint32_t ei_event_keyboard_get_xkb_group(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_MODIFIERS, get the logical group state.
ei_event_pointer_get_absolute_y
double ei_event_pointer_get_absolute_y(struct ei_event *event)
For an event of type EI_EVENT_POINTER_MOTION_ABSOLUTE return the y position in logical pixels or mm,...
ei_event_keyboard_get_key_is_press
bool ei_event_keyboard_get_key_is_press(struct ei_event *event)
For an event of type EI_EVENT_KEYBOARD_KEY return true if the event is a key down,...
ei_region_set_user_data
void ei_region_set_user_data(struct ei_region *region, void *user_data)
ei_region_get_physical_scale
double ei_region_get_physical_scale(struct ei_region *region)
Return the physical scale for this region.
ei_region_get_width
uint32_t ei_region_get_width(struct ei_region *region)
ei_region_get_mapping_id
const char * ei_region_get_mapping_id(struct ei_region *region)
Get the unique identifier (representing an external resource) that is attached to this region,...
ei_region_unref
struct ei_region * ei_region_unref(struct ei_region *region)
ei_region_get_user_data
void * ei_region_get_user_data(struct ei_region *region)
ei_region_get_y
uint32_t ei_region_get_y(struct ei_region *region)
ei_region_contains
bool ei_region_contains(struct ei_region *region, double x, double y)
Return true if the point x/y (in desktop-wide coordinates) is within region.
ei_region_get_x
uint32_t ei_region_get_x(struct ei_region *region)
ei_region_convert_point
bool ei_region_convert_point(struct ei_region *region, double *x, double *y)
Convert the point x/y in a desktop-wide coordinate system into the corresponding point relative to th...
ei_region_ref
struct ei_region * ei_region_ref(struct ei_region *region)
ei_region_get_height
uint32_t ei_region_get_height(struct ei_region *region)
ei_seat_set_user_data
void ei_seat_set_user_data(struct ei_seat *seat, void *user_data)
Set a custom data pointer for this context.
ei_seat_get_context
struct ei * ei_seat_get_context(struct ei_seat *seat)
Return the struct ei context this seat is associated with.
ei_seat_bind_capabilities
void ei_seat_bind_capabilities(struct ei_seat *seat,...) __attribute__((sentinel))
Bind this client to the given seat capabilities, terminated by NULL.
ei_seat_get_name
const char * ei_seat_get_name(struct ei_seat *seat)
ei_seat_get_user_data
void * ei_seat_get_user_data(struct ei_seat *seat)
Return the custom data pointer for this context.
ei_seat_ref
struct ei_seat * ei_seat_ref(struct ei_seat *seat)
ei_seat_has_capability
bool ei_seat_has_capability(struct ei_seat *seat, enum ei_device_capability cap)
Return true if the capabilitiy is available on this seat or false otherwise.
ei_seat_unref
struct ei_seat * ei_seat_unref(struct ei_seat *seat)
ei_seat_unbind_capabilities
void ei_seat_unbind_capabilities(struct ei_seat *seat,...) __attribute__((sentinel))
Unbind a seat's capabilities, terminatd by NULL.
ei_device_stop_emulating
void ei_device_stop_emulating(struct ei_device *device)
Notify the EIS implementation that the given device is no longer sending events.
ei_device_start_emulating
void ei_device_start_emulating(struct ei_device *device, uint32_t sequence)
Notify the EIS implementation that the given device is about to start sending events.
ei_touch_get_device
struct ei_device * ei_touch_get_device(struct ei_touch *touch)
ei_touch_down
void ei_touch_down(struct ei_touch *touch, double x, double y)
This function can only be called once on an ei_touch object.
ei_device_scroll_cancel
void ei_device_scroll_cancel(struct ei_device *device, bool cancel_x, bool cancel_y)
Generate a scroll cancel event on a device with the EI_DEVICE_CAP_SCROLL capability.
ei_device_pointer_motion_absolute
void ei_device_pointer_motion_absolute(struct ei_device *device, double x, double y)
Generate an absolute motion event on a device with the EI_DEVICE_CAP_POINTER_ABSOLUTE capability.
ei_touch_up
void ei_touch_up(struct ei_touch *touch)
Release this touch.
ei_device_scroll_delta
void ei_device_scroll_delta(struct ei_device *device, double x, double y)
Generate a smooth (pixel-precise) scroll event on a device with the EI_DEVICE_CAP_SCROLL capability.
ei_touch_get_user_data
void * ei_touch_get_user_data(struct ei_touch *touch)
Return the custom data pointer for this context.
ei_device_scroll_stop
void ei_device_scroll_stop(struct ei_device *device, bool stop_x, bool stop_y)
Generate a scroll stop event on a device with the EI_DEVICE_CAP_SCROLL capability.
ei_device_button_button
void ei_device_button_button(struct ei_device *device, uint32_t button, bool is_press)
Generate a button event on a device with the EI_DEVICE_CAP_BUTTON capability.
ei_touch_ref
struct ei_touch * ei_touch_ref(struct ei_touch *touch)
Increase the refcount of this struct by one.
ei_touch_motion
void ei_touch_motion(struct ei_touch *touch, double x, double y)
Move this touch to the new coordinates.
ei_device_keyboard_key
void ei_device_keyboard_key(struct ei_device *device, uint32_t keycode, bool is_press)
Generate a key event on a device with the EI_DEVICE_CAP_KEYBOARD capability.
ei_device_frame
void ei_device_frame(struct ei_device *device, uint64_t time)
Generate a frame event to group the current set of events into a logical hardware event.
ei_device_scroll_discrete
void ei_device_scroll_discrete(struct ei_device *device, int32_t x, int32_t y)
Generate a discrete scroll event on a device with the EI_DEVICE_CAP_SCROLL capability.
ei_touch_unref
struct ei_touch * ei_touch_unref(struct ei_touch *touch)
Decrease the refcount of this struct by one.
ei_device_touch_new
struct ei_touch * ei_device_touch_new(struct ei_device *device)
Initiate a new touch on a device with the EI_DEVICE_CAP_TOUCH capability.
ei_device_pointer_motion
void ei_device_pointer_motion(struct ei_device *device, double x, double y)
Generate a relative motion event on a device with the EI_DEVICE_CAP_POINTER capability.
ei_touch_set_user_data
void ei_touch_set_user_data(struct ei_touch *touch, void *user_data)
Set a custom data pointer for this context.
ei_setup_backend_socket
int ei_setup_backend_socket(struct ei *ei, const char *socketpath)
Set this ei context to use the socket backend.
ei_is_sender
bool ei_is_sender(struct ei *ei)
Returns true if the context is was created with ei_new_sender() or false otherwise.
ei_clock_set_now_func
void ei_clock_set_now_func(struct ei *, ei_clock_now_func func)
Override the function that returns the current time ei_now().
ei_new_receiver
struct ei * ei_new_receiver(void *user_data)
Create a new receiver ei context.
ei_dispatch
void ei_dispatch(struct ei *ei)
Main event dispatching function.
ei_get_fd
int ei_get_fd(struct ei *ei)
libei keeps a single file descriptor for all events.
ei_set_user_data
void ei_set_user_data(struct ei *ei, void *user_data)
Set a custom data pointer for this context.
ei_event_get_seat
struct ei_seat * ei_event_get_seat(struct ei_event *event)
Return the seat from this event.
ei_device_type
ei_device_type
The device type determines what the device represents.
Definition libei.h:230
ei_unref
struct ei * ei_unref(struct ei *ei)
Decrease the refcount of this struct by one.
ei_new_sender
struct ei * ei_new_sender(void *user_data)
Create a new sender ei context.
ei_now
uint64_t ei_now(struct ei *ei)
ei_event_get_device
struct ei_device * ei_event_get_device(struct ei_event *event)
Return the device from this event.
ei_peek_event
struct ei_event * ei_peek_event(struct ei *ei)
Returns the next event in the internal event queue (or NULL) without removing that event from the que...
ei_setup_backend_fd
int ei_setup_backend_fd(struct ei *ei, int fd)
Initialize the ei context on the given socket.
ei_keymap_type
ei_keymap_type
The set of supported keymap types for a struct ei_keymap.
Definition libei.h:290
ei_clock_now_func
uint64_t(* ei_clock_now_func)(struct ei *ei)
Optional override function for ei_now().
Definition libei.h:704
ei_event_get_time
uint64_t ei_event_get_time(struct ei_event *event)
Return the time for the event of type EI_EVENT_FRAME in microseconds.
ei_device_capability
ei_device_capability
The set of supported capabilities.
Definition libei.h:258
ei_get_event
struct ei_event * ei_get_event(struct ei *ei)
Return the next event from the event queue, removing it from the queue.
ei_event_unref
struct ei_event * ei_event_unref(struct ei_event *event)
Release resources associated with this event.
ei_event_get_type
enum ei_event_type ei_event_get_type(struct ei_event *event)
ei_event_type
ei_event_type
Definition libei.h:297
ei_configure_name
void ei_configure_name(struct ei *ei, const char *name)
Set the name for this client.
ei_event_type_to_string
const char * ei_event_type_to_string(enum ei_event_type)
This is a debugging helper to return a string of the name of the event type, or NULL if the event typ...
ei_ref
struct ei * ei_ref(struct ei *ei)
Increase the refcount of this struct by one.
ei_new
struct ei * ei_new(void *user_data)
This is an alias for ei_new_sender.
ei_get_user_data
void * ei_get_user_data(struct ei *ei)
Return the custom data pointer for this context.
EI_DEVICE_TYPE_PHYSICAL
@ EI_DEVICE_TYPE_PHYSICAL
Definition libei.h:232
EI_DEVICE_TYPE_VIRTUAL
@ EI_DEVICE_TYPE_VIRTUAL
Definition libei.h:231
EI_KEYMAP_TYPE_XKB
@ EI_KEYMAP_TYPE_XKB
A libxkbcommon-compatible XKB keymap.
Definition libei.h:294
EI_DEVICE_CAP_POINTER
@ EI_DEVICE_CAP_POINTER
The device can send relative motion events.
Definition libei.h:262
EI_DEVICE_CAP_SCROLL
@ EI_DEVICE_CAP_SCROLL
The device can send scroll events.
Definition libei.h:278
EI_DEVICE_CAP_POINTER_ABSOLUTE
@ EI_DEVICE_CAP_POINTER_ABSOLUTE
The device can send absolute motion events.
Definition libei.h:266
EI_DEVICE_CAP_TOUCH
@ EI_DEVICE_CAP_TOUCH
The device can send touch events.
Definition libei.h:274
EI_DEVICE_CAP_BUTTON
@ EI_DEVICE_CAP_BUTTON
The device can send button events.
Definition libei.h:282
EI_DEVICE_CAP_KEYBOARD
@ EI_DEVICE_CAP_KEYBOARD
The device can send keyboard events.
Definition libei.h:270
EI_EVENT_SEAT_REMOVED
@ EI_EVENT_SEAT_REMOVED
The server has removed a seat previously available to this client.
Definition libei.h:343
EI_EVENT_POINTER_MOTION_ABSOLUTE
@ EI_EVENT_POINTER_MOTION_ABSOLUTE
An absolute motion event with absolute position within the device's regions or size,...
Definition libei.h:446
EI_EVENT_POINTER_MOTION
@ EI_EVENT_POINTER_MOTION
A relative motion event with delta coordinates in logical pixels or mm, depending on the device type.
Definition libei.h:437
EI_EVENT_SCROLL_DELTA
@ EI_EVENT_SCROLL_DELTA
A vertical and/or horizontal scroll event with logical-pixels or mm precision, depending on the devic...
Definition libei.h:463
EI_EVENT_DEVICE_START_EMULATING
@ EI_EVENT_DEVICE_START_EMULATING
The server is about to send events for a device.
Definition libei.h:420
EI_EVENT_SCROLL_DISCRETE
@ EI_EVENT_SCROLL_DISCRETE
A vertical and/or horizontal scroll event with a discrete range in logical scroll steps,...
Definition libei.h:485
EI_EVENT_SCROLL_STOP
@ EI_EVENT_SCROLL_STOP
An ongoing scroll sequence stopped.
Definition libei.h:470
EI_EVENT_SEAT_ADDED
@ EI_EVENT_SEAT_ADDED
The server has added a seat available to this client.
Definition libei.h:331
EI_EVENT_FRAME
@ EI_EVENT_FRAME
"Hardware" frame event.
Definition libei.h:404
EI_EVENT_DEVICE_REMOVED
@ EI_EVENT_DEVICE_REMOVED
The server has removed a device belonging to this client.
Definition libei.h:366
EI_EVENT_DEVICE_RESUMED
@ EI_EVENT_DEVICE_RESUMED
The client may send events.
Definition libei.h:378
EI_EVENT_BUTTON_BUTTON
@ EI_EVENT_BUTTON_BUTTON
A button press or release event.
Definition libei.h:454
EI_EVENT_DEVICE_ADDED
@ EI_EVENT_DEVICE_ADDED
The server has added a device for this client.
Definition libei.h:354
EI_EVENT_TOUCH_DOWN
@ EI_EVENT_TOUCH_DOWN
Event for a single touch set down on the device's logical surface.
Definition libei.h:504
EI_EVENT_DEVICE_PAUSED
@ EI_EVENT_DEVICE_PAUSED
Any events sent from this device will be discarded until the next resume.
Definition libei.h:374
EI_EVENT_CONNECT
@ EI_EVENT_CONNECT
The server has approved the connection to this client.
Definition libei.h:306
EI_EVENT_DEVICE_STOP_EMULATING
@ EI_EVENT_DEVICE_STOP_EMULATING
The server stopped emulating events on this device, see EIS_EVENT_DEVICE_START_EMULATING.
Definition libei.h:428
EI_EVENT_TOUCH_UP
@ EI_EVENT_TOUCH_UP
Event for a single touch released from the device's logical surface.
Definition libei.h:512
EI_EVENT_KEYBOARD_KEY
@ EI_EVENT_KEYBOARD_KEY
A key press or release event.
Definition libei.h:493
EI_EVENT_TOUCH_MOTION
@ EI_EVENT_TOUCH_MOTION
Event for a single currently-down touch changing position (or other properties).
Definition libei.h:520
EI_EVENT_DISCONNECT
@ EI_EVENT_DISCONNECT
The server has disconnected this client - all resources left to reference this server are now obsolet...
Definition libei.h:320
EI_EVENT_SCROLL_CANCEL
@ EI_EVENT_SCROLL_CANCEL
An ongoing scroll sequence was cancelled.
Definition libei.h:477
EI_EVENT_KEYBOARD_MODIFIERS
@ EI_EVENT_KEYBOARD_MODIFIERS
The server has changed the modifier state on the device's keymap.
Definition libei.h:394
ei_device
A single device to generate input events from.
ei_event
An event received from the EIS implementation.
ei_keymap
An keymap for a device with the EI_DEVICE_CAP_KEYBOARD capability.
ei_region
A rectangular region, defined by an x/y offset and a width and a height.
ei_seat
A logical seat for a group of devices.
ei
The main context to interact with libei.