libinput.h File Reference

#include <stdlib.h>
#include <stdint.h>
#include <libudev.h>

Go to the source code of this file.

Data Structures
struct	libinput_interface

Typedefs
typedef int32_t	li_fixed_t
	libinput 24.8 fixed point real number. More...
typedef void(*	libinput_log_handler )(enum libinput_log_priority priority, void *user_data, const char *format, va_list args)
	Log handler type for custom logging. More...

Enumerations
enum	libinput_log_priority { LIBINPUT_LOG_PRIORITY_DEBUG, LIBINPUT_LOG_PRIORITY_INFO, LIBINPUT_LOG_PRIORITY_ERROR }
	Log priority for internal logging messages. More...
enum	libinput_device_capability { LIBINPUT_DEVICE_CAP_KEYBOARD, LIBINPUT_DEVICE_CAP_POINTER, LIBINPUT_DEVICE_CAP_TOUCH }
	Capabilities on a device. More...
enum	libinput_keyboard_key_state { LIBINPUT_KEYBOARD_KEY_STATE_RELEASED, LIBINPUT_KEYBOARD_KEY_STATE_PRESSED }
	Logical state of a key. More...
enum	libinput_led { LIBINPUT_LED_NUM_LOCK, LIBINPUT_LED_CAPS_LOCK, LIBINPUT_LED_SCROLL_LOCK }
	Mask reflecting LEDs on a device. More...
enum	libinput_pointer_button_state { LIBINPUT_POINTER_BUTTON_STATE_RELEASED, LIBINPUT_POINTER_BUTTON_STATE_PRESSED }
	Logical state of a physical button. More...
enum	libinput_pointer_axis { LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL, LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL }
	Axes on a device that are not x or y coordinates. More...
enum	libinput_event_type {   LIBINPUT_EVENT_NONE, LIBINPUT_EVENT_DEVICE_ADDED, LIBINPUT_EVENT_DEVICE_REMOVED, LIBINPUT_EVENT_KEYBOARD_KEY,   LIBINPUT_EVENT_POINTER_MOTION, LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE, LIBINPUT_EVENT_POINTER_BUTTON, LIBINPUT_EVENT_POINTER_AXIS,   LIBINPUT_EVENT_TOUCH_DOWN, LIBINPUT_EVENT_TOUCH_UP, LIBINPUT_EVENT_TOUCH_MOTION, LIBINPUT_EVENT_TOUCH_CANCEL,   LIBINPUT_EVENT_TOUCH_FRAME }
	Event type for events returned by libinput_get_event(). More...

Functions
static double	li_fixed_to_double (li_fixed_t f)
	Convert li_fixed_t to a double. More...
static int	li_fixed_to_int (li_fixed_t f)
	Convert li_fixed_t to a int. More...
void	libinput_event_destroy (struct libinput_event *event)
	Destroy the event. More...
enum libinput_event_type	libinput_event_get_type (struct libinput_event *event)
	Get the type of the event. More...
struct libinput *	libinput_event_get_context (struct libinput_event *event)
	Get the libinput context from the event. More...
struct libinput_device *	libinput_event_get_device (struct libinput_event *event)
	Return the device associated with this event, if applicable. More...
struct libinput_event_pointer *	libinput_event_get_pointer_event (struct libinput_event *event)
	Return the pointer event that is this input event. More...
struct libinput_event_keyboard *	libinput_event_get_keyboard_event (struct libinput_event *event)
	Return the keyboard event that is this input event. More...
struct libinput_event_touch *	libinput_event_get_touch_event (struct libinput_event *event)
	Return the touch event that is this input event. More...
struct libinput_event_device_notify *	libinput_event_get_device_notify_event (struct libinput_event *event)
	Return the device event that is this input event. More...
struct libinput_event *	libinput_event_device_notify_get_base_event (struct libinput_event_device_notify *event)
uint32_t	libinput_event_keyboard_get_time (struct libinput_event_keyboard *event)
uint32_t	libinput_event_keyboard_get_key (struct libinput_event_keyboard *event)
enum libinput_keyboard_key_state	libinput_event_keyboard_get_key_state (struct libinput_event_keyboard *event)
struct libinput_event *	libinput_event_keyboard_get_base_event (struct libinput_event_keyboard *event)
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 devices on the associated seat after the event was triggered. More...
uint32_t	libinput_event_pointer_get_time (struct libinput_event_pointer *event)
li_fixed_t	libinput_event_pointer_get_dx (struct libinput_event_pointer *event)
	Return the delta between the last event and the current event. More...
li_fixed_t	libinput_event_pointer_get_dy (struct libinput_event_pointer *event)
	Return the delta between the last event and the current event. More...
li_fixed_t	libinput_event_pointer_get_absolute_x (struct libinput_event_pointer *event)
	Return the current absolute x coordinate of the pointer event. More...
li_fixed_t	libinput_event_pointer_get_absolute_y (struct libinput_event_pointer *event)
	Return the current absolute y coordinate of the pointer event. More...
li_fixed_t	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. More...
li_fixed_t	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. More...
uint32_t	libinput_event_pointer_get_button (struct libinput_event_pointer *event)
	Return the button that triggered this event. More...
enum libinput_pointer_button_state	libinput_event_pointer_get_button_state (struct libinput_event_pointer *event)
	Return the button state that triggered this event. More...
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 on all devices on the associated seat after the the event was triggered. More...
enum libinput_pointer_axis	libinput_event_pointer_get_axis (struct libinput_event_pointer *event)
	Return the axis that triggered this event. More...
li_fixed_t	libinput_event_pointer_get_axis_value (struct libinput_event_pointer *event)
	Return the axis value of the given axis. More...
struct libinput_event *	libinput_event_pointer_get_base_event (struct libinput_event_pointer *event)
uint32_t	libinput_event_touch_get_time (struct libinput_event_touch *event)
int32_t	libinput_event_touch_get_slot (struct libinput_event_touch *event)
	Get the slot of this touch event. More...
int32_t	libinput_event_touch_get_seat_slot (struct libinput_event_touch *event)
	Get the seat slot of the touch event. More...
li_fixed_t	libinput_event_touch_get_x (struct libinput_event_touch *event)
	Return the current absolute x coordinate of the touch event. More...
li_fixed_t	libinput_event_touch_get_y (struct libinput_event_touch *event)
	Return the current absolute y coordinate of the touch event. More...
li_fixed_t	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. More...
li_fixed_t	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. More...
struct libinput_event *	libinput_event_touch_get_base_event (struct libinput_event_touch *event)
struct libinput *	libinput_udev_create_for_seat (const struct libinput_interface *interface, void *user_data, struct udev *udev, const char *seat_id)
	Create a new libinput context from udev, for input devices matching the given seat ID. More...
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 libinput_path_add_device() and libinput_path_remove_device(). More...
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(). More...
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 such a context with libinput_path_add_device(). More...
int	libinput_get_fd (struct libinput *libinput)
	libinput keeps a single file descriptor for all events. More...
int	libinput_dispatch (struct libinput *libinput)
	Main event dispatchment function. More...
struct libinput_event *	libinput_get_event (struct libinput *libinput)
	Retrieve the next event from libinput's internal event queue. More...
enum libinput_event_type	libinput_next_event_type (struct libinput *libinput)
	Return the type of the next event in the internal queue. More...
void *	libinput_get_user_data (struct libinput *libinput)
int	libinput_resume (struct libinput *libinput)
	Resume a suspended libinput context. More...
void	libinput_suspend (struct libinput *libinput)
	Suspend monitoring for new devices and close existing devices. More...
void	libinput_destroy (struct libinput *libinput)
	Destroy the libinput context. More...
void	libinput_log_set_priority (enum libinput_log_priority priority)
	Set the global log priority. More...
enum libinput_log_priority	libinput_log_get_priority (void)
	Get the global log priority. More...
void	libinput_log_set_handler (libinput_log_handler log_handler, void *user_data)
	Set the global log handler. More...
void	libinput_seat_ref (struct libinput_seat *seat)
	Increase the refcount of the seat. More...
void	libinput_seat_unref (struct libinput_seat *seat)
	Decrease the refcount of the seat. More...
void	libinput_seat_set_user_data (struct libinput_seat *seat, void *user_data)
	Set caller-specific data associated with this seat. More...
void *	libinput_seat_get_user_data (struct libinput_seat *seat)
	Get the caller-specific data associated with this seat, if any. More...
const char *	libinput_seat_get_physical_name (struct libinput_seat *seat)
	Return the physical name of the seat. More...
const char *	libinput_seat_get_logical_name (struct libinput_seat *seat)
	Return the logical name of the seat. More...
void	libinput_device_ref (struct libinput_device *device)
	Increase the refcount of the input device. More...
void	libinput_device_unref (struct libinput_device *device)
	Decrease the refcount of the input device. More...
void	libinput_device_set_user_data (struct libinput_device *device, void *user_data)
	Set caller-specific data associated with this input device. More...
void *	libinput_device_get_user_data (struct libinput_device *device)
	Get the caller-specific data associated with this input device, if any. More...
const char *	libinput_device_get_sysname (struct libinput_device *device)
	Get the system name of the device. More...
const char *	libinput_device_get_output_name (struct libinput_device *device)
	A device may be mapped to a single output, or all available outputs. More...
struct libinput_seat *	libinput_device_get_seat (struct libinput_device *device)
	Get the seat associated with this input device. More...
void	libinput_device_led_update (struct libinput_device *device, enum libinput_led leds)
	Update the LEDs on the device, if any. More...
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. More...
void	libinput_device_calibrate (struct libinput_device *device, float calibration[6])
	Apply the 3x3 transformation matrix to absolute device coordinates. More...
int	libinput_device_has_capability (struct libinput_device *device, enum libinput_device_capability capability)
	Check if the given device has the specified capability. More...

Enumeration Type Documentation

enum libinput_log_priority

Log priority for internal logging messages.

Enumerator
LIBINPUT_LOG_PRIORITY_DEBUG
LIBINPUT_LOG_PRIORITY_INFO
LIBINPUT_LOG_PRIORITY_ERROR