2 * Copyright © 2013 Jonas Ådahl
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.
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.
34 #define LIBINPUT_ATTRIBUTE_PRINTF(_format, _args) \
35 __attribute__ ((format (printf, _format, _args)))
36 #define LIBINPUT_ATTRIBUTE_DEPRECATED __attribute__ ((deprecated))
40 * libinput is a generic input device handling library. It abstracts
41 * commonly-used concepts such as keyboard, pointer and touchpad handling
46 * @page tpbuttons Touchpad button behavior
48 * For touchpad devices without physical buttons, libinput enables an
49 * emulated right button area through either of two methods.
51 * Software button areas
52 * =====================
53 * On most touchpads, the bottom area of the touchpad is split into a left
54 * and a right-button area. Pressing the touchpad down with a finger in
55 * those areas will generate clicks as shown in the diagram below:
58 +------------------------+
64 +------------------------+
66 +------------------------+
69 * Generally, the touchpad will emulate a right-button click if the finger
70 * was set down in the right button area and did not leave the
71 * right button area before clicking, even if another finger was already
72 * down on the touchpad in another area.
73 * A middle click is generated by clicking the touchpad when one finger is
74 * in the bottom left button area, and one finger is in the botton right
76 * The exact behavior of the touchpad is implementation-dependent.
78 * Top software button area
79 * ========================
80 * On selected touchpads, the top area of the touchpad is a separate set of
81 * software buttons split into a left, middle and right button area.
82 * Pressing the touchpad down with a finger in those areas will generate
83 * clicks as shown in the diagram below:
86 +------------------------+
87 | LEFT | MIDDLE | RIGHT |
88 +------------------------+
92 +------------------------+
94 +------------------------+
96 * This behavior is enabled on the Lenovo *40 series (T440, T540, T240...)
97 * and the Lenovo Helix, Yoga S1 and Carbon X1 2nd.
101 * On Apple touchpads, no button areas are provided. Instead, use a
102 * two-finger click for a right button click, and a three-finger click for a
103 * middle button click.
107 * Log priority for internal logging messages.
109 enum libinput_log_priority {
110 LIBINPUT_LOG_PRIORITY_DEBUG = 10,
111 LIBINPUT_LOG_PRIORITY_INFO = 20,
112 LIBINPUT_LOG_PRIORITY_ERROR = 30,
118 * Capabilities on a device. A device may have one or more capabilities
119 * at a time, and capabilities may appear or disappear during the
120 * lifetime of the device.
122 enum libinput_device_capability {
123 LIBINPUT_DEVICE_CAP_KEYBOARD = 0,
124 LIBINPUT_DEVICE_CAP_POINTER = 1,
125 LIBINPUT_DEVICE_CAP_TOUCH = 2
131 * Logical state of a key. Note that the logical state may not represent
132 * the physical state of the key.
134 enum libinput_key_state {
135 LIBINPUT_KEY_STATE_RELEASED = 0,
136 LIBINPUT_KEY_STATE_PRESSED = 1
142 * Mask reflecting LEDs on a device.
145 LIBINPUT_LED_NUM_LOCK = (1 << 0),
146 LIBINPUT_LED_CAPS_LOCK = (1 << 1),
147 LIBINPUT_LED_SCROLL_LOCK = (1 << 2)
153 * Logical state of a physical button. Note that the logical state may not
154 * represent the physical state of the button.
156 enum libinput_button_state {
157 LIBINPUT_BUTTON_STATE_RELEASED = 0,
158 LIBINPUT_BUTTON_STATE_PRESSED = 1
165 * Axes on a device that are not x or y coordinates.
167 enum libinput_pointer_axis {
168 LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL = 0,
169 LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL = 1,
175 * Event type for events returned by libinput_get_event().
177 enum libinput_event_type {
179 * This is not a real event type, and is only used to tell the user that
180 * no new event is available in the queue. See
181 * libinput_next_event_type().
183 LIBINPUT_EVENT_NONE = 0,
186 * Signals that a device has been added to the context. The device will
187 * not be read until the next time the user calls libinput_dispatch()
188 * and data is available.
190 * This allows setting up initial device configuration before any events
193 LIBINPUT_EVENT_DEVICE_ADDED,
196 * Signals that a device has been removed. No more events from the
197 * associated device will be in the queue or be queued after this event.
199 LIBINPUT_EVENT_DEVICE_REMOVED,
201 LIBINPUT_EVENT_KEYBOARD_KEY = 300,
203 LIBINPUT_EVENT_POINTER_MOTION = 400,
204 LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE,
205 LIBINPUT_EVENT_POINTER_BUTTON,
206 LIBINPUT_EVENT_POINTER_AXIS,
208 LIBINPUT_EVENT_TOUCH_DOWN = 500,
209 LIBINPUT_EVENT_TOUCH_UP,
210 LIBINPUT_EVENT_TOUCH_MOTION,
211 LIBINPUT_EVENT_TOUCH_CANCEL,
213 * Signals the end of a set of touchpoints at one device sample
214 * time. This event has no coordinate information attached.
216 LIBINPUT_EVENT_TOUCH_FRAME
220 struct libinput_device;
221 struct libinput_seat;
223 struct libinput_event;
224 struct libinput_event_device_notify;
225 struct libinput_event_keyboard;
226 struct libinput_event_pointer;
229 * @ingroup event_touch
230 * @struct libinput_event_touch
232 * Touch event representing a touch down, move or up, as well as a touch
233 * cancel and touch frame events. Valid event types for this event are @ref
234 * LIBINPUT_EVENT_TOUCH_DOWN, @ref LIBINPUT_EVENT_TOUCH_MOTION, @ref
235 * LIBINPUT_EVENT_TOUCH_UP, @ref LIBINPUT_EVENT_TOUCH_CANCEL and @ref
236 * LIBINPUT_EVENT_TOUCH_FRAME.
238 struct libinput_event_touch;
241 * @defgroup event Accessing and destruction of events
249 * @param event An event retrieved by libinput_get_event().
252 libinput_event_destroy(struct libinput_event *event);
257 * Get the type of the event.
259 * @param event An event retrieved by libinput_get_event().
261 enum libinput_event_type
262 libinput_event_get_type(struct libinput_event *event);
267 * Get the libinput context from the event.
269 * @param event The libinput event
270 * @return The libinput context for this event.
273 libinput_event_get_context(struct libinput_event *event);
278 * Return the device associated with this event, if applicable. For device
279 * added/removed events this is the device added or removed. For all other
280 * device events, this is the device that generated the event.
282 * This device is not refcounted and its lifetime is that of the event. Use
283 * libinput_device_ref() before using the device outside of this scope.
285 * @return The device associated with this event
288 struct libinput_device *
289 libinput_event_get_device(struct libinput_event *event);
294 * Return the pointer event that is this input event. If the event type does
295 * not match the pointer event types, this function returns NULL.
297 * The inverse of this function is libinput_event_pointer_get_base_event().
299 * @return A pointer event, or NULL for other events
301 struct libinput_event_pointer *
302 libinput_event_get_pointer_event(struct libinput_event *event);
307 * Return the keyboard event that is this input event. If the event type does
308 * not match the keyboard event types, this function returns NULL.
310 * The inverse of this function is libinput_event_keyboard_get_base_event().
312 * @return A keyboard event, or NULL for other events
314 struct libinput_event_keyboard *
315 libinput_event_get_keyboard_event(struct libinput_event *event);
320 * Return the touch event that is this input event. If the event type does
321 * not match the touch event types, this function returns NULL.
323 * The inverse of this function is libinput_event_touch_get_base_event().
325 * @return A touch event, or NULL for other events
327 struct libinput_event_touch *
328 libinput_event_get_touch_event(struct libinput_event *event);
333 * Return the device event that is this input event. If the event type does
334 * not match the device event types, this function returns NULL.
336 * The inverse of this function is
337 * libinput_event_device_notify_get_base_event().
339 * @return A device event, or NULL for other events
341 struct libinput_event_device_notify *
342 libinput_event_get_device_notify_event(struct libinput_event *event);
347 * @return The generic libinput_event of this event
349 struct libinput_event *
350 libinput_event_device_notify_get_base_event(struct libinput_event_device_notify *event);
353 * @defgroup event_keyboard Keyboard events
355 * Key events are generated when a key changes its logical state, usually by
356 * being pressed or released.
360 * @ingroup event_keyboard
362 * @return The event time for this event
365 libinput_event_keyboard_get_time(struct libinput_event_keyboard *event);
368 * @ingroup event_keyboard
370 * @return The keycode that triggered this key event
373 libinput_event_keyboard_get_key(struct libinput_event_keyboard *event);
376 * @ingroup event_keyboard
378 * @return The state change of the key
380 enum libinput_key_state
381 libinput_event_keyboard_get_key_state(struct libinput_event_keyboard *event);
385 * @ingroup event_keyboard
387 * @return The generic libinput_event of this event
389 struct libinput_event *
390 libinput_event_keyboard_get_base_event(struct libinput_event_keyboard *event);
393 * @ingroup event_keyboard
395 * For the key of a LIBINPUT_EVENT_KEYBOARD_KEY event, return the total number
396 * of keys pressed on all devices on the associated seat after the event was
399 " @note It is an application bug to call this function for events other than
400 * LIBINPUT_EVENT_KEYBOARD_KEY. For other events, this function returns 0.
402 * @return the seat wide pressed key count for the key of this event
405 libinput_event_keyboard_get_seat_key_count(
406 struct libinput_event_keyboard *event);
409 * @defgroup event_pointer Pointer events
411 * Pointer events reflect motion, button and scroll events, as well as
412 * events from other axes.
416 * @ingroup event_pointer
418 * @return The event time for this event
421 libinput_event_pointer_get_time(struct libinput_event_pointer *event);
424 * @ingroup event_pointer
426 * Return the delta between the last event and the current event. For pointer
427 * events that are not of type LIBINPUT_EVENT_POINTER_MOTION, this function
430 * If a device employs pointer acceleration, the delta returned by this
431 * function is the accelerated delta.
433 * @note It is an application bug to call this function for events other than
434 * LIBINPUT_EVENT_POINTER_MOTION.
436 * @return the relative x movement since the last event
439 libinput_event_pointer_get_dx(struct libinput_event_pointer *event);
442 * @ingroup event_pointer
444 * Return the delta between the last event and the current event. For pointer
445 * events that are not of type LIBINPUT_EVENT_POINTER_MOTION, this function
448 * If a device employs pointer acceleration, the delta returned by this
449 * function is the accelerated delta.
451 * @note It is an application bug to call this function for events other than
452 * LIBINPUT_EVENT_POINTER_MOTION.
454 * @return the relative y movement since the last event
457 libinput_event_pointer_get_dy(struct libinput_event_pointer *event);
460 * @ingroup event_pointer
462 * Return the current absolute x coordinate of the pointer event, in mm from
463 * the top left corner of the device. To get the corresponding output screen
464 * coordinate, use libinput_event_pointer_get_absolute_x_transformed().
466 * For pointer events that are not of type
467 * LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE, this function returns 0.
469 * @note It is an application bug to call this function for events other than
470 * LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE.
472 * @return the current absolute x coordinate
475 libinput_event_pointer_get_absolute_x(struct libinput_event_pointer *event);
478 * @ingroup event_pointer
480 * Return the current absolute y coordinate of the pointer event, in mm from
481 * the top left corner of the device. To get the corresponding output screen
482 * coordinate, use libinput_event_pointer_get_absolute_y_transformed().
484 * For pointer events that are not of type
485 * LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE, this function returns 0.
487 * @note It is an application bug to call this function for events other than
488 * LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE.
490 * @return the current absolute y coordinate
493 libinput_event_pointer_get_absolute_y(struct libinput_event_pointer *event);
496 * @ingroup event_pointer
498 * Return the current absolute x coordinate of the pointer event, transformed to
499 * screen coordinates.
501 * For pointer events that are not of type
502 * LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE, the return value of this function is
505 * @note It is an application bug to call this function for events other than
506 * LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE.
508 * @param event The libinput pointer event
509 * @param width The current output screen width
510 * @return the current absolute x coordinate transformed to a screen coordinate
513 libinput_event_pointer_get_absolute_x_transformed(
514 struct libinput_event_pointer *event,
518 * @ingroup event_pointer
520 * Return the current absolute y coordinate of the pointer event, transformed to
521 * screen coordinates.
523 * For pointer events that are not of type
524 * LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE, the return value of this function is
527 * @note It is an application bug to call this function for events other than
528 * LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE.
530 * @param event The libinput pointer event
531 * @param height The current output screen height
532 * @return the current absolute y coordinate transformed to a screen coordinate
535 libinput_event_pointer_get_absolute_y_transformed(
536 struct libinput_event_pointer *event,
540 * @ingroup event_pointer
542 * Return the button that triggered this event.
543 * For pointer events that are not of type LIBINPUT_EVENT_POINTER_BUTTON,
544 * this function returns 0.
546 * @note It is an application bug to call this function for events other than
547 * LIBINPUT_EVENT_POINTER_BUTTON.
549 * @return the button triggering this event
552 libinput_event_pointer_get_button(struct libinput_event_pointer *event);
555 * @ingroup event_pointer
557 * Return the button state that triggered this event.
558 * For pointer events that are not of type LIBINPUT_EVENT_POINTER_BUTTON,
559 * this function returns 0.
561 * @note It is an application bug to call this function for events other than
562 * LIBINPUT_EVENT_POINTER_BUTTON.
564 * @return the button state triggering this event
566 enum libinput_button_state
567 libinput_event_pointer_get_button_state(struct libinput_event_pointer *event);
570 * @ingroup event_pointer
572 * For the button of a LIBINPUT_EVENT_POINTER_BUTTON event, return the total
573 * number of buttons pressed on all devices on the associated seat after the
574 * the event was triggered.
576 " @note It is an application bug to call this function for events other than
577 * LIBINPUT_EVENT_POINTER_BUTTON. For other events, this function returns 0.
579 * @return the seat wide pressed button count for the key of this event
582 libinput_event_pointer_get_seat_button_count(
583 struct libinput_event_pointer *event);
586 * @ingroup event_pointer
588 * Return the axis that triggered this event.
589 * For pointer events that are not of type LIBINPUT_EVENT_POINTER_AXIS,
590 * this function returns 0.
592 * @note It is an application bug to call this function for events other than
593 * LIBINPUT_EVENT_POINTER_AXIS.
595 * @return the axis triggering this event
597 enum libinput_pointer_axis
598 libinput_event_pointer_get_axis(struct libinput_event_pointer *event);
601 * @ingroup event_pointer
603 * Return the axis value of the given axis. The interpretation of the value
604 * is dependent on the axis. For the two scrolling axes
605 * LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL and
606 * LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL, the value of the event is in
607 * relative scroll units, with the positive direction being down or right,
608 * respectively. The dimension of a scroll unit is equal to one unit of
609 * motion in the respective axis, where applicable (e.g. touchpad two-finger
612 * For pointer events that are not of type LIBINPUT_EVENT_POINTER_AXIS,
613 * this function returns 0.
615 * @note It is an application bug to call this function for events other than
616 * LIBINPUT_EVENT_POINTER_AXIS.
618 * @return the axis value of this event
621 libinput_event_pointer_get_axis_value(struct libinput_event_pointer *event);
624 * @ingroup event_pointer
626 * @return The generic libinput_event of this event
628 struct libinput_event *
629 libinput_event_pointer_get_base_event(struct libinput_event_pointer *event);
633 * @defgroup event_touch Touch events
635 * Events from absolute touch devices.
639 * @ingroup event_touch
641 * @return The event time for this event
644 libinput_event_touch_get_time(struct libinput_event_touch *event);
647 * @ingroup event_touch
649 * Get the slot of this touch event. See the kernel's multitouch
650 * protocol B documentation for more information.
652 * If the touch event has no assigned slot, for example if it is from a
653 * single touch device, this function returns -1.
655 * @note this function should not be called for LIBINPUT_EVENT_TOUCH_CANCEL or
656 * LIBINPUT_EVENT_TOUCH_FRAME.
658 * @return The slot of this touch event
661 libinput_event_touch_get_slot(struct libinput_event_touch *event);
664 * @ingroup event_touch
666 * Get the seat slot of the touch event. A seat slot is a non-negative seat
667 * wide unique identifier of an active touch point.
669 * Events from single touch devices will be represented as one individual
670 * touch point per device.
672 * @note this function should not be called for LIBINPUT_EVENT_TOUCH_CANCEL or
673 * LIBINPUT_EVENT_TOUCH_FRAME.
675 * @return The seat slot of the touch event
678 libinput_event_touch_get_seat_slot(struct libinput_event_touch *event);
681 * @ingroup event_touch
683 * Return the current absolute x coordinate of the touch event, in mm from
684 * the top left corner of the device. To get the corresponding output screen
685 * coordinate, use libinput_event_touch_get_x_transformed().
687 * @note this function should only be called for LIBINPUT_EVENT_TOUCH_DOWN and
688 * LIBINPUT_EVENT_TOUCH_MOTION.
690 * @param event The libinput touch event
691 * @return the current absolute x coordinate
694 libinput_event_touch_get_x(struct libinput_event_touch *event);
697 * @ingroup event_touch
699 * Return the current absolute y coordinate of the touch event, in mm from
700 * the top left corner of the device. To get the corresponding output screen
701 * coordinate, use libinput_event_touch_get_y_transformed().
703 * For LIBINPUT_EVENT_TOUCH_UP 0 is returned.
705 * @note this function should only be called for LIBINPUT_EVENT_TOUCH_DOWN and
706 * LIBINPUT_EVENT_TOUCH_MOTION.
708 * @param event The libinput touch event
709 * @return the current absolute y coordinate
712 libinput_event_touch_get_y(struct libinput_event_touch *event);
715 * @ingroup event_touch
717 * Return the current absolute x coordinate of the touch event, transformed to
718 * screen coordinates.
720 * @note this function should only be called for LIBINPUT_EVENT_TOUCH_DOWN and
721 * LIBINPUT_EVENT_TOUCH_MOTION.
723 * @param event The libinput touch event
724 * @param width The current output screen width
725 * @return the current absolute x coordinate transformed to a screen coordinate
728 libinput_event_touch_get_x_transformed(struct libinput_event_touch *event,
732 * @ingroup event_touch
734 * Return the current absolute y coordinate of the touch event, transformed to
735 * screen coordinates.
737 * @note this function should only be called for LIBINPUT_EVENT_TOUCH_DOWN and
738 * LIBINPUT_EVENT_TOUCH_MOTION.
740 * @param event The libinput touch event
741 * @param height The current output screen height
742 * @return the current absolute y coordinate transformed to a screen coordinate
745 libinput_event_touch_get_y_transformed(struct libinput_event_touch *event,
749 * @ingroup event_touch
751 * @return The generic libinput_event of this event
753 struct libinput_event *
754 libinput_event_touch_get_base_event(struct libinput_event_touch *event);
757 * @defgroup base Initialization and manipulation of libinput contexts
760 struct libinput_interface {
762 * Open the device at the given path with the flags provided and
765 * @param path The device path to open
766 * @param flags Flags as defined by open(2)
767 * @param user_data The user_data provided in
768 * libinput_udev_create_context()
770 * @return the file descriptor, or a negative errno on failure.
772 int (*open_restricted)(const char *path, int flags, void *user_data);
774 * Close the file descriptor.
776 * @param fd The file descriptor to close
777 * @param user_data The user_data provided in
778 * libinput_udev_create_context()
780 void (*close_restricted)(int fd, void *user_data);
786 * Create a new libinput context from udev. This context is inactive until
787 * assigned a seat ID with libinput_udev_assign_seat().
789 * @param interface The callback interface
790 * @param user_data Caller-specific data passed to the various callback
792 * @param udev An already initialized udev context
794 * @return An initialized, but inactive libinput context or NULL on error
797 libinput_udev_create_context(const struct libinput_interface *interface,
804 * Assign a seat to this libinput context. New devices or the removal of
805 * existing devices will appear as events during libinput_dispatch().
807 * libinput_udev_assign_seat() succeeds even if no input devices are currently
808 * available on this seat, or if devices are available but fail to open in
809 * @ref libinput_interface::open_restricted. Devices that do not have the
810 * minimum capabilities to be recognized as pointer, keyboard or touch
811 * device are ignored. Such devices and those that failed to open
812 * ignored until the next call to libinput_resume().
814 * This function may only be called once per context.
816 * @param libinput A libinput context initialized with
817 * libinput_udev_create_context()
818 * @param seat_id A seat identifier. This string must not be NULL.
820 * @return 0 on success or -1 on failure.
823 libinput_udev_assign_seat(struct libinput *libinput,
824 const char *seat_id);
829 * Create a new libinput context that requires the caller to manually add or
830 * remove devices with libinput_path_add_device() and
831 * libinput_path_remove_device().
833 * The context is fully initialized but will not generate events until at
834 * least one device has been added.
836 * The reference count of the context is initialized to 1. See @ref
839 * @param interface The callback interface
840 * @param user_data Caller-specific data passed to the various callback
843 * @return An initialized, empty libinput context.
846 libinput_path_create_context(const struct libinput_interface *interface,
852 * Add a device to a libinput context initialized with
853 * libinput_path_create_context(). If successful, the device will be
854 * added to the internal list and re-opened on libinput_resume(). The device
855 * can be removed with libinput_path_remove_device().
857 * If the device was successfully initialized, it is returned in the device
858 * argument. The lifetime of the returned device pointer is limited until
859 * the next libinput_dispatch(), use libinput_device_ref() to keep a permanent
862 * @param libinput A previously initialized libinput context
863 * @param path Path to an input device
864 * @return The newly initiated device on success, or NULL on failure.
866 * @note It is an application bug to call this function on a libinput
867 * context initialized with libinput_udev_create_context().
869 struct libinput_device *
870 libinput_path_add_device(struct libinput *libinput,
876 * Remove a device from a libinput context initialized with
877 * libinput_path_create_context() or added to such a context with
878 * libinput_path_add_device().
880 * Events already processed from this input device are kept in the queue,
881 * the LIBINPUT_EVENT_DEVICE_REMOVED event marks the end of events for this
884 * If no matching device exists, this function does nothing.
886 * @param device A libinput device
888 * @note It is an application bug to call this function on a libinput
889 * context initialized with libinput_udev_create_context().
892 libinput_path_remove_device(struct libinput_device *device);
897 * libinput keeps a single file descriptor for all events. Call into
898 * libinput_dispatch() if any events become available on this fd.
900 * @return the file descriptor used to notify of pending events.
903 libinput_get_fd(struct libinput *libinput);
908 * Main event dispatchment function. Reads events of the file descriptors
909 * and processes them internally. Use libinput_get_event() to retrieve the
912 * Dispatching does not necessarily queue libinput events.
914 * @param libinput A previously initialized libinput context
916 * @return 0 on success, or a negative errno on failure
919 libinput_dispatch(struct libinput *libinput);
924 * Retrieve the next event from libinput's internal event queue.
926 * After handling the retrieved event, the caller must destroy it using
927 * libinput_event_destroy().
929 * @param libinput A previously initialized libinput context
930 * @return The next available event, or NULL if no event is available.
932 struct libinput_event *
933 libinput_get_event(struct libinput *libinput);
938 * Return the type of the next event in the internal queue. This function
939 * does not pop the event off the queue and the next call to
940 * libinput_get_event() returns that event.
942 * @param libinput A previously initialized libinput context
943 * @return The event type of the next available event or LIBINPUT_EVENT_NONE
944 * if no event is availble.
946 enum libinput_event_type
947 libinput_next_event_type(struct libinput *libinput);
952 * @param libinput A previously initialized libinput context
953 * @return the caller-specific data previously assigned in
954 * libinput_create_udev().
957 libinput_get_user_data(struct libinput *libinput);
962 * Resume a suspended libinput context. This re-enables device
963 * monitoring and adds existing devices.
965 * @param libinput A previously initialized libinput context
966 * @see libinput_suspend
968 * @return 0 on success or -1 on failure
971 libinput_resume(struct libinput *libinput);
976 * Suspend monitoring for new devices and close existing devices.
977 * This all but terminates libinput but does keep the context
978 * valid to be resumed with libinput_resume().
980 * @param libinput A previously initialized libinput context
983 libinput_suspend(struct libinput *libinput);
988 * Add a reference to the context. A context is destroyed whenever the
989 * reference count reaches 0. See @ref libinput_unref.
991 * @param libinput A previously initialized valid libinput context
992 * @return The passed libinput context
995 libinput_ref(struct libinput *libinput);
1000 * Dereference the libinput context. After this, the context may have been
1001 * destroyed, if the last reference was dereferenced. If so, the context is
1002 * invalid and may not be interacted with.
1004 * @param libinput A previously initialized libinput context
1005 * @return NULL if context was destroyed otherwise the passed context
1008 libinput_unref(struct libinput *libinput);
1013 * Set the global log priority. Messages with priorities equal to or
1014 * higher than the argument will be printed to the current log handler.
1016 * The default log priority is LIBINPUT_LOG_PRIORITY_ERROR.
1018 * @param libinput A previously initialized libinput context
1019 * @param priority The minimum priority of log messages to print.
1021 * @see libinput_log_set_handler
1022 * @see libinput_log_get_priority
1025 libinput_log_set_priority(struct libinput *libinput,
1026 enum libinput_log_priority priority);
1031 * Get the global log priority. Messages with priorities equal to or
1032 * higher than the argument will be printed to the current log handler.
1034 * The default log priority is LIBINPUT_LOG_PRIORITY_ERROR.
1036 * @param libinput A previously initialized libinput context
1037 * @return The minimum priority of log messages to print.
1039 * @see libinput_log_set_handler
1040 * @see libinput_log_set_priority
1042 enum libinput_log_priority
1043 libinput_log_get_priority(const struct libinput *libinput);
1048 * Log handler type for custom logging.
1050 * @param libinput The libinput context
1051 * @param priority The priority of the current message
1052 * @param format Message format in printf-style
1053 * @param args Message arguments
1055 * @see libinput_set_log_priority
1056 * @see libinput_log_set_handler
1058 typedef void (*libinput_log_handler)(struct libinput *libinput,
1059 enum libinput_log_priority priority,
1060 const char *format, va_list args)
1061 LIBINPUT_ATTRIBUTE_PRINTF(3, 0);
1066 * Set the global log handler. Messages with priorities equal to or higher
1067 * than the current log priority will be passed to the given
1070 * The default log handler prints to stderr.
1072 * @param libinput A previously initialized libinput context
1073 * @param log_handler The log handler for library messages.
1074 * @param user_data Caller-specific data pointer, passed into the log
1077 * @see libinput_log_set_handler
1080 libinput_log_set_handler(struct libinput *libinput,
1081 libinput_log_handler log_handler);
1084 * @defgroup seat Initialization and manipulation of seats
1086 * A seat has two identifiers, the physical name and the logical name. The
1087 * physical name is summarized as the list of devices a process on the same
1088 * physical seat has access to.
1090 * The logical seat name is the seat name for a logical group of devices. A
1091 * compositor may use that to create additonal seats as independent device
1092 * sets. Alternatively, a compositor may limit itself to a single logical
1093 * seat, leaving a second compositor to manage devices on the other logical
1097 * +---+--------+------------+------------------------+------------+
1098 * | | event0 | | | log seat A |
1099 * | K +--------+ | +------------+
1100 * | e | event1 | phys seat0 | libinput context 1 | |
1101 * | r +--------+ | | log seat B |
1102 * | n | event2 | | | |
1103 * | e +--------+------------+------------------------+------------+
1104 * | l | event3 | phys seat1 | libinput context 2 | log seat C |
1105 * +---+--------+------------+------------------------+------------+
1112 * Increase the refcount of the seat. A seat will be freed whenever the
1113 * refcount reaches 0. This may happen during dispatch if the
1114 * seat was removed from the system. A caller must ensure to reference
1115 * the seat correctly to avoid dangling pointers.
1117 * @param seat A previously obtained seat
1118 * @return The passed seat
1120 struct libinput_seat *
1121 libinput_seat_ref(struct libinput_seat *seat);
1126 * Decrease the refcount of the seat. A seat will be freed whenever the
1127 * refcount reaches 0. This may happen during dispatch if the
1128 * seat was removed from the system. A caller must ensure to reference
1129 * the seat correctly to avoid dangling pointers.
1131 * @param seat A previously obtained seat
1132 * @return NULL if seat was destroyed, otherwise the passed seat
1134 struct libinput_seat *
1135 libinput_seat_unref(struct libinput_seat *seat);
1140 * Set caller-specific data associated with this seat. libinput does
1141 * not manage, look at, or modify this data. The caller must ensure the
1144 * @param seat A previously obtained seat
1145 * @param user_data Caller-specific data pointer
1146 * @see libinput_seat_get_user_data
1149 libinput_seat_set_user_data(struct libinput_seat *seat, void *user_data);
1154 * Get the caller-specific data associated with this seat, if any.
1156 * @param seat A previously obtained seat
1157 * @return Caller-specific data pointer or NULL if none was set
1158 * @see libinput_seat_set_user_data
1161 libinput_seat_get_user_data(struct libinput_seat *seat);
1166 * Return the physical name of the seat. For libinput contexts created from
1167 * udev, this is always the same value as passed into
1168 * libinput_udev_assign_seat() and all seats from that context will have
1169 * the same physical name.
1171 * The physical name of the seat is one that is usually set by the system or
1172 * lower levels of the stack. In most cases, this is the base filter for
1173 * devices - devices assigned to seats outside the current seat will not
1174 * be available to the caller.
1176 * @param seat A previously obtained seat
1177 * @return the physical name of this seat
1180 libinput_seat_get_physical_name(struct libinput_seat *seat);
1185 * Return the logical name of the seat. This is an identifier to group sets
1186 * of devices within the compositor.
1188 * @param seat A previously obtained seat
1189 * @return the logical name of this seat
1192 libinput_seat_get_logical_name(struct libinput_seat *seat);
1195 * @defgroup device Initialization and manipulation of input devices
1201 * Increase the refcount of the input device. An input device will be freed
1202 * whenever the refcount reaches 0. This may happen during dispatch if the
1203 * device was removed from the system. A caller must ensure to reference
1204 * the device correctly to avoid dangling pointers.
1206 * @param device A previously obtained device
1207 * @return The passed device
1209 struct libinput_device *
1210 libinput_device_ref(struct libinput_device *device);
1215 * Decrease the refcount of the input device. An input device will be freed
1216 * whenever the refcount reaches 0. This may happen during dispatch if the
1217 * device was removed from the system. A caller must ensure to reference
1218 * the device correctly to avoid dangling pointers.
1220 * @param device A previously obtained device
1221 * @return NULL if device was destroyed, otherwise the passed device
1223 struct libinput_device *
1224 libinput_device_unref(struct libinput_device *device);
1229 * Set caller-specific data associated with this input device. libinput does
1230 * not manage, look at, or modify this data. The caller must ensure the
1233 * @param device A previously obtained device
1234 * @param user_data Caller-specific data pointer
1235 * @see libinput_device_get_user_data
1238 libinput_device_set_user_data(struct libinput_device *device, void *user_data);
1243 * Get the caller-specific data associated with this input device, if any.
1245 * @param device A previously obtained device
1246 * @return Caller-specific data pointer or NULL if none was set
1247 * @see libinput_device_set_user_data
1250 libinput_device_get_user_data(struct libinput_device *device);
1255 * Get the system name of the device.
1257 * To get the descriptive device name, use libinput_device_get_name().
1259 * @param device A previously obtained device
1260 * @return System name of the device
1264 libinput_device_get_sysname(struct libinput_device *device);
1269 * The descriptive device name as advertised by the kernel and/or the
1270 * hardware itself. To get the sysname for this device, use
1271 * libinput_device_get_sysname().
1273 * The lifetime of the returned string is tied to the struct
1274 * libinput_device. The string may be the empty string but is never NULL.
1276 * @param device A previously obtained device
1277 * @return The device name
1280 libinput_device_get_name(struct libinput_device *device);
1285 * Get the product ID for this device.
1287 * @param device A previously obtained device
1288 * @return The product ID of this device
1291 libinput_device_get_id_product(struct libinput_device *device);
1296 * Get the vendor ID for this device.
1298 * @param device A previously obtained device
1299 * @return The vendor ID of this device
1302 libinput_device_get_id_vendor(struct libinput_device *device);
1307 * A device may be mapped to a single output, or all available outputs. If a
1308 * device is mapped to a single output only, a relative device may not move
1309 * beyond the boundaries of this output. An absolute device has its input
1310 * coordinates mapped to the extents of this output.
1312 * @return the name of the output this device is mapped to, or NULL if no
1316 libinput_device_get_output_name(struct libinput_device *device);
1321 * Get the seat associated with this input device.
1323 * A seat can be uniquely identified by the physical and logical seat name.
1324 * There will ever be only one seat instance with a given physical and logical
1325 * seat name pair at any given time, but if no external reference is kept, it
1326 * may be destroyed if no device belonging to it is left.
1328 * @param device A previously obtained device
1329 * @return The seat this input device belongs to
1331 struct libinput_seat *
1332 libinput_device_get_seat(struct libinput_device *device);
1337 * Update the LEDs on the device, if any. If the device does not have
1338 * LEDs, or does not have one or more of the LEDs given in the mask, this
1339 * function does nothing.
1341 * @param device A previously obtained device
1342 * @param leds A mask of the LEDs to set, or unset.
1345 libinput_device_led_update(struct libinput_device *device,
1346 enum libinput_led leds);
1351 * Set the bitmask in keys to the bitmask of the keys present on the device
1352 * (see linux/input.h), up to size characters.
1354 * @param device A current input device
1355 * @param keys An array filled with the bitmask for the keys
1356 * @param size Size of the keys array
1358 * @return The number of valid bytes in keys, or a negative errno on failure
1361 libinput_device_get_keys(struct libinput_device *device,
1362 char *keys, size_t size);
1367 * Apply the 3x3 transformation matrix to absolute device coordinates. This
1368 * matrix has no effect on relative events.
1370 * Given a 6-element array [a, b, c, d, e, f], the matrix is applied as
1378 libinput_device_calibrate(struct libinput_device *device,
1379 float calibration[6]);
1384 * Check if the given device has the specified capability
1386 * @return 1 if the given device has the capability or 0 if not
1389 libinput_device_has_capability(struct libinput_device *device,
1390 enum libinput_device_capability capability);
1395 * Get the physical size of a device in mm, where meaningful. This function
1396 * only succeeds on devices with the required data, i.e. tablets, touchpads
1399 * If this function returns nonzero, width and height are unmodified.
1401 * @param device The device
1402 * @param width Set to the width of the device
1403 * @param height Set to the height of the device
1404 * @return 0 on success, or nonzero otherwise
1407 libinput_device_get_size(struct libinput_device *device,
1413 * @defgroup config Device configuration
1415 * Enable, disable, change and/or check for device-specific features. For
1416 * all features, libinput assigns a default based on the hardware
1417 * configuration. This default can be obtained with the respective
1420 * Some configuration option may be dependent on or mutually exclusive with
1421 * with other options. The behavior in those cases is
1422 * implementation-defined, the caller must ensure that the options are set
1423 * in the right order.
1429 * Status codes returned when applying configuration settings.
1431 enum libinput_config_status {
1432 LIBINPUT_CONFIG_STATUS_SUCCESS = 0, /**< Config applied successfully */
1433 LIBINPUT_CONFIG_STATUS_UNSUPPORTED, /**< Configuration not available on
1435 LIBINPUT_CONFIG_STATUS_INVALID, /**< Invalid parameter range */
1441 * Return a string describing the error.
1443 * @param status The status to translate to a string
1444 * @return A human-readable string representing the error or NULL for an
1448 libinput_config_status_to_str(enum libinput_config_status status);
1453 enum libinput_config_tap_state {
1454 LIBINPUT_CONFIG_TAP_DISABLED, /**< Tapping is to be disabled, or is
1455 currently disabled */
1456 LIBINPUT_CONFIG_TAP_ENABLED, /**< Tapping is to be enabled, or is
1457 currently enabled */
1463 * Check if the device supports tap-to-click. See
1464 * libinput_device_config_tap_set_enabled() for more information.
1466 * @param device The device to configure
1467 * @return The number of fingers that can generate a tap event, or 0 if the
1468 * device does not support tapping.
1470 * @see libinput_device_config_tap_set_enabled
1471 * @see libinput_device_config_tap_get_enabled
1472 * @see libinput_device_config_tap_set_enabled_get_default
1475 libinput_device_config_tap_get_finger_count(struct libinput_device *device);
1480 * Enable or disable tap-to-click on this device, with a default mapping of
1481 * 1, 2, 3 finger tap mapping to left, right, middle click, respectively.
1482 * Tapping is limited by the number of simultaneous touches
1483 * supported by the device, see
1484 * libinput_device_config_tap_get_finger_count().
1486 * @param device The device to configure
1487 * @param enable @ref LIBINPUT_CONFIG_TAP_ENABLED to enable tapping or @ref
1488 * LIBINPUT_CONFIG_TAP_DISABLED to disable tapping
1490 * @return A config status code. Disabling tapping on a device that does not
1491 * support tapping always succeeds.
1493 * @see libinput_device_config_tap_get_finger_count
1494 * @see libinput_device_config_tap_get_enabled
1495 * @see libinput_device_config_tap_get_default_enabled
1497 enum libinput_config_status
1498 libinput_device_config_tap_set_enabled(struct libinput_device *device,
1499 enum libinput_config_tap_state enable);
1504 * Check if tap-to-click is enabled on this device. If the device does not
1505 * support tapping, this function always returns 0.
1507 * @param device The device to configure
1509 * @return @ref LIBINPUT_CONFIG_TAP_ENABLED if tapping is currently enabled,
1510 * or @ref LIBINPUT_CONFIG_TAP_DISABLED is currently disabled
1512 * @see libinput_device_config_tap_get_finger_count
1513 * @see libinput_device_config_tap_set_enabled
1514 * @see libinput_device_config_tap_get_default_enabled
1516 enum libinput_config_tap_state
1517 libinput_device_config_tap_get_enabled(struct libinput_device *device);
1522 * Return the default setting for whether tapping is enabled on this device.
1524 * @param device The device to configure
1525 * @return @ref LIBINPUT_CONFIG_TAP_ENABLED if tapping is enabled by default,
1526 * or @ref LIBINPUT_CONFIG_TAP_DISABLED is disabled by default
1528 * @see libinput_device_config_tap_get_finger_count
1529 * @see libinput_device_config_tap_set_enabled
1530 * @see libinput_device_config_tap_get_enabled
1532 enum libinput_config_tap_state
1533 libinput_device_config_tap_get_default_enabled(struct libinput_device *device);
1538 #endif /* LIBINPUT_H */