libinput  0.5.0
A wrapper library for input devices
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
libinput.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Jonas Ådahl
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and
5  * its documentation for any purpose is hereby granted without fee, provided
6  * that the above copyright notice appear in all copies and that both that
7  * copyright notice and this permission notice appear in supporting
8  * documentation, and that the name of the copyright holders not be used in
9  * advertising or publicity pertaining to distribution of the software
10  * without specific, written prior permission. The copyright holders make
11  * no representations about the suitability of this software for any
12  * purpose. It is provided "as is" without express or implied warranty.
13  *
14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
15  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
16  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
17  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
18  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
19  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
20  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21  */
22 
23 #ifndef LIBINPUT_H
24 #define LIBINPUT_H
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 #include <stdlib.h>
31 #include <stdint.h>
32 #include <libudev.h>
33 
34 #define LIBINPUT_ATTRIBUTE_PRINTF(_format, _args) \
35  __attribute__ ((format (printf, _format, _args)))
36 #define LIBINPUT_ATTRIBUTE_DEPRECATED __attribute__ ((deprecated))
37 
113 };
114 
126 };
127 
137 };
138 
148 };
149 
159 };
160 
161 
170 };
171 
184 
194 
200 
202 
207 
217 };
218 
219 struct libinput;
220 struct libinput_device;
221 struct libinput_seat;
222 
223 struct libinput_event;
224 struct libinput_event_device_notify;
225 struct libinput_event_keyboard;
226 struct libinput_event_pointer;
227 
238 struct libinput_event_touch;
239 
251 void
252 libinput_event_destroy(struct libinput_event *event);
253 
262 libinput_event_get_type(struct libinput_event *event);
263 
272 struct libinput *
273 libinput_event_get_context(struct libinput_event *event);
274 
288 struct libinput_device *
289 libinput_event_get_device(struct libinput_event *event);
290 
301 struct libinput_event_pointer *
302 libinput_event_get_pointer_event(struct libinput_event *event);
303 
314 struct libinput_event_keyboard *
315 libinput_event_get_keyboard_event(struct libinput_event *event);
316 
327 struct libinput_event_touch *
328 libinput_event_get_touch_event(struct libinput_event *event);
329 
341 struct libinput_event_device_notify *
342 libinput_event_get_device_notify_event(struct libinput_event *event);
343 
349 struct libinput_event *
350 libinput_event_device_notify_get_base_event(struct libinput_event_device_notify *event);
351 
364 uint32_t
365 libinput_event_keyboard_get_time(struct libinput_event_keyboard *event);
366 
372 uint32_t
373 libinput_event_keyboard_get_key(struct libinput_event_keyboard *event);
374 
381 libinput_event_keyboard_get_key_state(struct libinput_event_keyboard *event);
382 
383 
389 struct libinput_event *
390 libinput_event_keyboard_get_base_event(struct libinput_event_keyboard *event);
391 
404 uint32_t
406  struct libinput_event_keyboard *event);
407 
420 uint32_t
421 libinput_event_pointer_get_time(struct libinput_event_pointer *event);
422 
435 double
436 libinput_event_pointer_get_dx(struct libinput_event_pointer *event);
437 
450 double
451 libinput_event_pointer_get_dy(struct libinput_event_pointer *event);
452 
468 double
469 libinput_event_pointer_get_absolute_x(struct libinput_event_pointer *event);
470 
486 double
487 libinput_event_pointer_get_absolute_y(struct libinput_event_pointer *event);
488 
506 double
508  struct libinput_event_pointer *event,
509  uint32_t width);
510 
528 double
530  struct libinput_event_pointer *event,
531  uint32_t height);
532 
545 uint32_t
546 libinput_event_pointer_get_button(struct libinput_event_pointer *event);
547 
561 libinput_event_pointer_get_button_state(struct libinput_event_pointer *event);
562 
575 uint32_t
577  struct libinput_event_pointer *event);
578 
592 libinput_event_pointer_get_axis(struct libinput_event_pointer *event);
593 
614 double
615 libinput_event_pointer_get_axis_value(struct libinput_event_pointer *event);
616 
622 struct libinput_event *
623 libinput_event_pointer_get_base_event(struct libinput_event_pointer *event);
624 
625 
637 uint32_t
639 
654 int32_t
656 
671 int32_t
673 
687 double
689 
705 double
707 
721 double
723  uint32_t width);
724 
738 double
740  uint32_t height);
741 
747 struct libinput_event *
749 
766  int (*open_restricted)(const char *path, int flags, void *user_data);
774  void (*close_restricted)(int fd, void *user_data);
775 };
776 
790 struct libinput *
791 libinput_udev_create_context(const struct libinput_interface *interface,
792  void *user_data,
793  struct udev *udev);
794 
816 int
817 libinput_udev_assign_seat(struct libinput *libinput,
818  const char *seat_id);
819 
839 struct libinput *
840 libinput_path_create_context(const struct libinput_interface *interface,
841  void *user_data);
842 
863 struct libinput_device *
864 libinput_path_add_device(struct libinput *libinput,
865  const char *path);
866 
885 void
886 libinput_path_remove_device(struct libinput_device *device);
887 
896 int
897 libinput_get_fd(struct libinput *libinput);
898 
912 int
913 libinput_dispatch(struct libinput *libinput);
914 
926 struct libinput_event *
927 libinput_get_event(struct libinput *libinput);
928 
941 libinput_next_event_type(struct libinput *libinput);
942 
950 void *
951 libinput_get_user_data(struct libinput *libinput);
952 
964 int
965 libinput_resume(struct libinput *libinput);
966 
976 void
977 libinput_suspend(struct libinput *libinput);
978 
988 struct libinput *
989 libinput_ref(struct libinput *libinput);
990 
1001 struct libinput *
1002 libinput_unref(struct libinput *libinput);
1003 
1018 void
1019 libinput_log_set_priority(struct libinput *libinput,
1020  enum libinput_log_priority priority);
1021 
1037 libinput_log_get_priority(const struct libinput *libinput);
1038 
1052 typedef void (*libinput_log_handler)(struct libinput *libinput,
1053  enum libinput_log_priority priority,
1054  const char *format, va_list args)
1056 
1073 void
1074 libinput_log_set_handler(struct libinput *libinput,
1075  libinput_log_handler log_handler);
1076 
1114 struct libinput_seat *
1115 libinput_seat_ref(struct libinput_seat *seat);
1116 
1128 struct libinput_seat *
1129 libinput_seat_unref(struct libinput_seat *seat);
1130 
1142 void
1143 libinput_seat_set_user_data(struct libinput_seat *seat, void *user_data);
1144 
1154 void *
1155 libinput_seat_get_user_data(struct libinput_seat *seat);
1156 
1173 const char *
1174 libinput_seat_get_physical_name(struct libinput_seat *seat);
1175 
1185 const char *
1186 libinput_seat_get_logical_name(struct libinput_seat *seat);
1187 
1203 struct libinput_device *
1204 libinput_device_ref(struct libinput_device *device);
1205 
1217 struct libinput_device *
1218 libinput_device_unref(struct libinput_device *device);
1219 
1231 void
1232 libinput_device_set_user_data(struct libinput_device *device, void *user_data);
1233 
1243 void *
1244 libinput_device_get_user_data(struct libinput_device *device);
1245 
1257 const char *
1258 libinput_device_get_sysname(struct libinput_device *device);
1259 
1273 const char *
1274 libinput_device_get_name(struct libinput_device *device);
1275 
1284 unsigned int
1285 libinput_device_get_id_product(struct libinput_device *device);
1286 
1295 unsigned int
1296 libinput_device_get_id_vendor(struct libinput_device *device);
1297 
1309 const char *
1310 libinput_device_get_output_name(struct libinput_device *device);
1311 
1325 struct libinput_seat *
1326 libinput_device_get_seat(struct libinput_device *device);
1327 
1338 void
1339 libinput_device_led_update(struct libinput_device *device,
1340  enum libinput_led leds);
1341 
1354 int
1355 libinput_device_get_keys(struct libinput_device *device,
1356  char *keys, size_t size);
1357 
1371 void
1372 libinput_device_calibrate(struct libinput_device *device,
1373  float calibration[6]);
1374 
1382 int
1383 libinput_device_has_capability(struct libinput_device *device,
1384  enum libinput_device_capability capability);
1385 
1400 int
1401 libinput_device_get_size(struct libinput_device *device,
1402  double *width,
1403  double *height);
1404 
1405 
1430 };
1431 
1441 const char *
1443 
1452 };
1453 
1468 int
1469 libinput_device_config_tap_get_finger_count(struct libinput_device *device);
1470 
1492 libinput_device_config_tap_set_enabled(struct libinput_device *device,
1493  enum libinput_config_tap_state enable);
1494 
1511 libinput_device_config_tap_get_enabled(struct libinput_device *device);
1512 
1527 libinput_device_config_tap_get_default_enabled(struct libinput_device *device);
1528 
1529 #ifdef __cplusplus
1530 }
1531 #endif
1532 #endif /* LIBINPUT_H */
const char * libinput_seat_get_physical_name(struct libinput_seat *seat)
Return the physical name of the seat.
libinput_log_priority
Log priority for internal logging messages.
Definition: libinput.h:109
void(*) voi libinput_log_set_handler)(struct libinput *libinput, libinput_log_handler log_handler)
Set the global log handler.
Definition: libinput.h:1074
unsigned int libinput_device_get_id_product(struct libinput_device *device)
Get the product ID for this device.
Definition: libinput.h:125
uint32_t libinput_event_pointer_get_button(struct libinput_event_pointer *event)
Return the button that triggered this event.
void(* close_restricted)(int fd, void *user_data)
Close the file descriptor.
Definition: libinput.h:774
Definition: libinput.h:210
int libinput_dispatch(struct libinput *libinput)
Main event dispatchment function.
struct libinput * libinput_ref(struct libinput *libinput)
Add a reference to the context.
Definition: libinput.h:754
Definition: libinput.h:206
Definition: libinput.h:158
libinput_led
Mask reflecting LEDs on a device.
Definition: libinput.h:144
Touch event representing a touch down, move or up, as well as a touch cancel and touch frame events...
Definition: libinput.h:226
Definition: libinput.h:208
int32_t libinput_event_touch_get_slot(struct libinput_event_touch *event)
Get the slot of this touch event.
void * libinput_device_get_user_data(struct libinput_device *device)
Get the caller-specific data associated with this input device, if any.
struct libinput_seat * libinput_seat_ref(struct libinput_seat *seat)
Increase the refcount of the seat.
Definition: libinput.h:169
Signals the end of a set of touchpoints at one device sample time.
Definition: libinput.h:216
Config applied successfully.
Definition: libinput.h:1426
const char * libinput_device_get_name(struct libinput_device *device)
The descriptive device name as advertised by the kernel and/or the hardware itself.
Definition: libinput.h:147
uint32_t libinput_event_keyboard_get_seat_key_count(struct libinput_event_keyboard *event)
For the key of a LIBINPUT_EVENT_KEYBOARD_KEY event, return the total number of keys pressed on all de...
void * libinput_seat_get_user_data(struct libinput_seat *seat)
Get the caller-specific data associated with this seat, if any.
Tapping is to be enabled, or is currently enabled.
Definition: libinput.h:1450
struct libinput_event * libinput_event_device_notify_get_base_event(struct libinput_event_device_notify *event)
Definition: libinput.h:201
Signals that a device has been added to the context.
Definition: libinput.h:193
Configuration not available on this device.
Definition: libinput.h:1427
Definition: libinput.h:203
double libinput_event_pointer_get_dy(struct libinput_event_pointer *event)
Return the delta between the last event and the current event.
void libinput_path_remove_device(struct libinput_device *device)
Remove a device from a libinput context initialized with libinput_path_create_context() or added to s...
Signals that a device has been removed.
Definition: libinput.h:199
void libinput_log_set_priority(struct libinput *libinput, enum libinput_log_priority priority)
Set the global log priority.
void libinput_device_calibrate(struct libinput_device *device, float calibration[6])
Apply the 3x3 transformation matrix to absolute device coordinates.
libinput_button_state
Logical state of a physical button.
Definition: libinput.h:156
const char * libinput_config_status_to_str(enum libinput_config_status status)
Return a string describing the error.
enum libinput_config_tap_state libinput_device_config_tap_get_enabled(struct libinput_device *device)
Check if tap-to-click is enabled on this device.
struct libinput_device * libinput_device_ref(struct libinput_device *device)
Increase the refcount of the input device.
uint32_t libinput_event_touch_get_time(struct libinput_event_touch *event)
double libinput_event_touch_get_x(struct libinput_event_touch *event)
Return the current absolute x coordinate of the touch event, in mm from the top left corner of the de...
uint32_t libinput_event_pointer_get_seat_button_count(struct libinput_event_pointer *event)
For the button of a LIBINPUT_EVENT_POINTER_BUTTON event, return the total number of buttons pressed o...
Definition: libinput.h:205
Definition: libinput.h:111
enum libinput_key_state libinput_event_keyboard_get_key_state(struct libinput_event_keyboard *event)
double libinput_event_pointer_get_dx(struct libinput_event_pointer *event)
Return the delta between the last event and the current event.
double libinput_event_pointer_get_absolute_y_transformed(struct libinput_event_pointer *event, uint32_t height)
Return the current absolute y coordinate of the pointer event, transformed to screen coordinates...
double libinput_event_pointer_get_absolute_x(struct libinput_event_pointer *event)
Return the current absolute x coordinate of the pointer event, in mm from the top left corner of the ...
struct libinput_event_device_notify * libinput_event_get_device_notify_event(struct libinput_event *event)
Return the device event that is this input event.
libinput_pointer_axis
Axes on a device that are not x or y coordinates.
Definition: libinput.h:167
libinput_config_tap_state
Definition: libinput.h:1447
int(* open_restricted)(const char *path, int flags, void *user_data)
Open the device at the given path with the flags provided and return the fd.
Definition: libinput.h:766
Definition: libinput.h:123
void(* libinput_log_handler)(struct libinput *libinput, enum libinput_log_priority priority, const char *format, va_list args) LIBINPUT_ATTRIBUTE_PRINTF(3
Log handler type for custom logging.
Definition: libinput.h:1052
enum libinput_config_status libinput_device_config_tap_set_enabled(struct libinput_device *device, enum libinput_config_tap_state enable)
Enable or disable tap-to-click on this device, with a default mapping of 1, 2, 3 finger tap mapping t...
Definition: libinput.h:135
libinput_device_capability
Capabilities on a device.
Definition: libinput.h:122
Definition: libinput.h:209
libinput_config_status
Status codes returned when applying configuration settings.
Definition: libinput.h:1425
Definition: libinput.h:136
double libinput_event_touch_get_y(struct libinput_event_touch *event)
Return the current absolute y coordinate of the touch event, in mm from the top left corner of the de...
int32_t libinput_event_touch_get_seat_slot(struct libinput_event_touch *event)
Get the seat slot of the touch event.
double libinput_event_pointer_get_absolute_y(struct libinput_event_pointer *event)
Return the current absolute y coordinate of the pointer event, in mm from the top left corner of the ...
void libinput_device_led_update(struct libinput_device *device, enum libinput_led leds)
Update the LEDs on the device, if any.
struct libinput_device * libinput_path_add_device(struct libinput *libinput, const char *path)
Add a device to a libinput context initialized with libinput_path_create_context().
double libinput_event_touch_get_x_transformed(struct libinput_event_touch *event, uint32_t width)
Return the current absolute x coordinate of the touch event, transformed to screen coordinates...
Definition: libinput.h:110
struct libinput * libinput_event_get_context(struct libinput_event *event)
Get the libinput context from the event.
Definition: libinput.h:211
#define LIBINPUT_ATTRIBUTE_PRINTF(_format, _args)
Definition: libinput.h:34
struct libinput * libinput_path_create_context(const struct libinput_interface *interface, void *user_data)
Create a new libinput context that requires the caller to manually add or remove devices with libinpu...
struct libinput_seat * libinput_seat_unref(struct libinput_seat *seat)
Decrease the refcount of the seat.
int libinput_device_config_tap_get_finger_count(struct libinput_device *device)
Check if the device supports tap-to-click.
Invalid parameter range.
Definition: libinput.h:1429
unsigned int libinput_device_get_id_vendor(struct libinput_device *device)
Get the vendor ID for this device.
enum libinput_event_type libinput_event_get_type(struct libinput_event *event)
Get the type of the event.
double libinput_event_pointer_get_axis_value(struct libinput_event_pointer *event)
Return the axis value of the given axis.
struct libinput_device * libinput_event_get_device(struct libinput_event *event)
Return the device associated with this event, if applicable.
void * libinput_get_user_data(struct libinput *libinput)
Definition: libinput.h:124
void libinput_event_destroy(struct libinput_event *event)
Destroy the event.
Definition: libinput.h:204
void libinput_suspend(struct libinput *libinput)
Suspend monitoring for new devices and close existing devices.
Definition: libinput.h:145
uint32_t libinput_event_keyboard_get_key(struct libinput_event_keyboard *event)
Tapping is to be disabled, or is currently disabled.
Definition: libinput.h:1448
Definition: libinput.h:157
int libinput_get_fd(struct libinput *libinput)
libinput keeps a single file descriptor for all events.
int libinput_resume(struct libinput *libinput)
Resume a suspended libinput context.
int libinput_device_get_keys(struct libinput_device *device, char *keys, size_t size)
Set the bitmask in keys to the bitmask of the keys present on the device (see linux/input.h), up to size characters.
struct libinput * libinput_udev_create_context(const struct libinput_interface *interface, void *user_data, struct udev *udev)
Create a new libinput context from udev.
libinput_event_type
Event type for events returned by libinput_get_event().
Definition: libinput.h:177
struct libinput_event * libinput_get_event(struct libinput *libinput)
Retrieve the next event from libinput&#39;s internal event queue.
enum libinput_event_type libinput_next_event_type(struct libinput *libinput)
Return the type of the next event in the internal queue.
int libinput_device_has_capability(struct libinput_device *device, enum libinput_device_capability capability)
Check if the given device has the specified capability.
double libinput_event_pointer_get_absolute_x_transformed(struct libinput_event_pointer *event, uint32_t width)
Return the current absolute x coordinate of the pointer event, transformed to screen coordinates...
uint32_t libinput_event_keyboard_get_time(struct libinput_event_keyboard *event)
struct libinput_event_keyboard * libinput_event_get_keyboard_event(struct libinput_event *event)
Return the keyboard event that is this input event.
Definition: libinput.h:146
struct libinput_seat * libinput_device_get_seat(struct libinput_device *device)
Get the seat associated with this input device.
enum libinput_button_state libinput_event_pointer_get_button_state(struct libinput_event_pointer *event)
Return the button state that triggered this event.
Definition: libinput.h:168
struct libinput * libinput_unref(struct libinput *libinput)
Dereference the libinput context.
enum libinput_log_priority libinput_log_get_priority(const struct libinput *libinput)
Get the global log priority.
const char * libinput_device_get_sysname(struct libinput_device *device)
Get the system name of the device.
struct libinput_device * libinput_device_unref(struct libinput_device *device)
Decrease the refcount of the input device.
int libinput_device_get_size(struct libinput_device *device, double *width, double *height)
Get the physical size of a device in mm, where meaningful.
void libinput_seat_set_user_data(struct libinput_seat *seat, void *user_data)
Set caller-specific data associated with this seat.
const char * libinput_seat_get_logical_name(struct libinput_seat *seat)
Return the logical name of the seat.
int libinput_udev_assign_seat(struct libinput *libinput, const char *seat_id)
Assign a seat to this libinput context.
double libinput_event_touch_get_y_transformed(struct libinput_event_touch *event, uint32_t height)
Return the current absolute y coordinate of the touch event, transformed to screen coordinates...
enum libinput_pointer_axis libinput_event_pointer_get_axis(struct libinput_event_pointer *event)
Return the axis that triggered this event.
enum libinput_config_tap_state libinput_device_config_tap_get_default_enabled(struct libinput_device *device)
Return the default setting for whether tapping is enabled on this device.
struct libinput_event * libinput_event_keyboard_get_base_event(struct libinput_event_keyboard *event)
const char * libinput_device_get_output_name(struct libinput_device *device)
A device may be mapped to a single output, or all available outputs.
uint32_t libinput_event_pointer_get_time(struct libinput_event_pointer *event)
struct libinput_event * libinput_event_touch_get_base_event(struct libinput_event_touch *event)
libinput_key_state
Logical state of a key.
Definition: libinput.h:134
This is not a real event type, and is only used to tell the user that no new event is available in th...
Definition: libinput.h:183
void libinput_device_set_user_data(struct libinput_device *device, void *user_data)
Set caller-specific data associated with this input device.
struct libinput_event * libinput_event_pointer_get_base_event(struct libinput_event_pointer *event)
struct libinput_event_pointer * libinput_event_get_pointer_event(struct libinput_event *event)
Return the pointer event that is this input event.
Definition: libinput.h:112
struct libinput_event_touch * libinput_event_get_touch_event(struct libinput_event *event)
Return the touch event that is this input event.