378 struct eis_log_context;
416 struct eis_log_context *ctx);
1310 double x,
double y);
1319 uint32_t button,
bool is_press);
void eis_touch_up(struct eis_touch *touch)
see ei_touch_up
An ongoing scroll sequence was cancelled.
Definition: libeis.h:320
A relative motion event with delta coordinates in logical pixels or mm, depending on the device type...
Definition: libeis.h:298
The client is about to send events for a device.
Definition: libeis.h:286
void * eis_region_get_user_data(struct eis_region *region)
struct eis_event * eis_get_event(struct eis *eis)
Returns the next event in the internal event queue (or NULL) and removes it from the queue...
double eis_event_pointer_get_dx(struct eis_event *event)
For an event of type EIS_EVENT_POINTER_MOTION return the relative x movement in logical pixels or mm...
struct eis_keymap * eis_keymap_ref(struct eis_keymap *keymap)
int32_t eis_event_scroll_get_discrete_dy(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_DISCRETE return the y scroll distance in fractions or multiples...
bool eis_event_keyboard_get_key_is_press(struct eis_event *event)
For an event of type EIS_EVENT_KEYBOARD_KEY return true if the event is a key down, false for a release.
double eis_event_scroll_get_dx(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_DELTA return the x scroll distance in logical pixels or mm...
uint32_t eis_device_get_width(struct eis_device *device)
Return the width in mm of a device of type EIS_DEVICE_TYPE_PHYSICAL, or zero otherwise.
void eis_device_configure_type(struct eis_device *device, enum eis_device_type type)
Set the device type for this device.
void eis_device_keyboard_key(struct eis_device *device, uint32_t keycode, bool is_press)
see ei_device_keyboard_key
void eis_touch_down(struct eis_touch *touch, double x, double y)
see ei_touch_down
struct eis_touch * eis_touch_unref(struct eis_touch *touch)
see ei_touch_unref
void eis_device_scroll_cancel(struct eis_device *device, bool cancel_x, bool cancel_y)
see ei_device_scroll_cancel
struct eis * eis_seat_get_context(struct eis_seat *seat)
enum eis_device_type eis_device_get_type(struct eis_device *device)
void eis_client_connect(struct eis_client *client)
Allow connection from the client.
eis_keymap_type
Definition: libeis.h:224
The client wants to bind or unbind a capability on this seat.
Definition: libeis.h:250
void eis_seat_configure_capability(struct eis_seat *seat, enum eis_device_capability cap)
Allow a capability on the seat.
void eis_device_scroll_stop(struct eis_device *device, bool stop_x, bool stop_y)
see ei_device_scroll_stop
bool eis_event_scroll_get_stop_x(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_STOP return whether the x axis has stopped scrolling.
struct eis_client * eis_client_ref(struct eis_client *client)
double eis_event_touch_get_x(struct eis_event *event)
For an event of type EIS_EVENT_TOUCH_DOWN, or EIS_EVENT_TOUCH_MOTION, return the x coordinate of the ...
void eis_keymap_set_user_data(struct eis_keymap *eis_keymap, void *user_data)
struct eis_seat * eis_seat_ref(struct eis_seat *seat)
bool eis_client_is_sender(struct eis_client *client)
Returns true if the client is a sender, false otherwise.
struct eis_seat * eis_client_new_seat(struct eis_client *client, const char *name)
Create a new logical seat with a given name.
int eis_backend_fd_add_client(struct eis *ctx)
Add a new client to a context set up with eis_setup_backend_fd().
void eis_log_set_handler(struct eis *eis, eis_log_handler log_handler)
Change the log handler for this context.
struct eis * eis_new(void *user_data)
Create a new libeis context with a refcount of 1.
bool eis_seat_has_capability(struct eis_seat *seat, enum eis_device_capability cap)
void eis_device_frame(struct eis_device *device, uint64_t time)
see ei_device_frame
struct eis_region * eis_device_get_region(struct eis_device *device, size_t index)
Obtain a region from the device.
struct eis_device * eis_device_ref(struct eis_device *device)
void(* eis_log_handler)(struct eis *eis, enum eis_log_priority priority, const char *message, struct eis_log_context *ctx)
The log handler for library logging.
Definition: libeis.h:413
void eis_region_set_mapping_id(struct eis_region *region, const char *mapping_id)
Attach a unique identifier representing an external resource to this region.
struct eis_region * eis_region_ref(struct eis_region *region)
struct eis_touch * eis_device_touch_new(struct eis_device *device)
see ei_device_touch_new
struct eis_device * eis_event_get_device(struct eis_event *event)
Return the device from this event.
bool eis_event_button_get_is_press(struct eis_event *event)
For an event of type EIS_EVENT_BUTTON_BUTTON return true if the event is a button press...
struct eis_seat * eis_device_get_seat(struct eis_device *device)
void eis_region_set_user_data(struct eis_region *region, void *user_data)
void * eis_keymap_get_user_data(struct eis_keymap *eis_keymap)
void eis_device_configure_size(struct eis_device *device, uint32_t width, uint32_t height)
Configure the size in mm of a device of type EIS_DEVICE_TYPE_PHYSICAL.
struct eis * eis_unref(struct eis *eis)
const char * eis_seat_get_name(struct eis_seat *eis_seat)
void eis_device_button_button(struct eis_device *device, uint32_t button, bool is_press)
see ei_device_button_button
uint32_t eis_event_emulating_get_sequence(struct eis_event *event)
For an event of type EIS_EVENT_DEVICE_START_EMULATING, return the sequence number set by the ei clien...
void eis_device_configure_capability(struct eis_device *device, enum eis_device_capability cap)
Event for a single touch set down on the device's logical surface.
Definition: libeis.h:338
struct eis_event * eis_peek_event(struct eis *eis)
Returns the next event in the internal event queue (or NULL) without removing that event from the que...
Event for a single currently-down touch changing position (or other properties).
Definition: libeis.h:348
void eis_device_scroll_discrete(struct eis_device *device, int32_t x, int32_t y)
see ei_device_scroll_discrete
enum eis_keymap_type eis_keymap_get_type(struct eis_keymap *keymap)
Returns the type for this keymap.
void eis_device_configure_name(struct eis_device *device, const char *name)
struct eis_device * eis_device_unref(struct eis_device *device)
void eis_clock_set_now_func(struct eis *, eis_clock_now_func func)
Override the function that returns the current time eis_now().
struct eis * eis_device_get_context(struct eis_device *device)
A vertical and/or horizontal scroll event with a discrete range in logical scroll steps...
Definition: libeis.h:325
struct eis_event * eis_event_unref(struct eis_event *event)
Release resources associated with this event.
enum eis_log_priority eis_log_get_priority(const struct eis *eis)
void eis_device_remove(struct eis_device *device)
Remove the device.
uint64_t eis_event_get_time(struct eis_event *event)
Return the time for the event of type EIS_EVENT_FRAME in microseconds.
void eis_region_set_physical_scale(struct eis_region *region, double scale)
Set the physical scale for this region.
double eis_event_pointer_get_absolute_x(struct eis_event *event)
For an event of type EIS_EVENT_POINTER_MOTION_ABSOLUTE return the x position in logical pixels or mm...
void eis_device_start_emulating(struct eis_device *device, uint32_t sequence)
see ei_device_start_emulating
void eis_seat_add(struct eis_seat *seat)
Add this seat to its client and notify the client of the seat's availability.
A vertical and/or horizontal scroll event with logical-pixels or mm precision, depending on the devic...
Definition: libeis.h:312
double eis_event_pointer_get_dy(struct eis_event *event)
For an event of type EIS_EVENT_POINTER_MOTION return the relative y movement in logical pixels or mm...
struct eis_touch * eis_touch_ref(struct eis_touch *touch)
see ei_touch_ref
void eis_device_pause(struct eis_device *device)
Notify the client that the device is paused and that no events from the client will be processed...
eis_device_capability
Definition: libeis.h:211
An ongoing scroll sequence stopped.
Definition: libeis.h:316
int eis_setup_backend_fd(struct eis *ctx)
Initialize the context that can take pre-configured sockets.
void eis_device_set_user_data(struct eis_device *eis_device, void *user_data)
uint32_t eis_event_keyboard_get_key(struct eis_event *event)
For an event of type EIS_EVENT_KEYBOARD_KEY return the key code (as defined in include/linux/input-ev...
double eis_event_scroll_get_dy(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_DELTA return the y scroll distance in logical pixels or mm...
struct eis_region * eis_device_get_region_at(struct eis_device *device, double x, double y)
Return the region that contains the given point x/y (in desktop-wide coordinates) or NULL if the coor...
A button press or release event.
Definition: libeis.h:307
enum eis_event_type eis_event_get_type(struct eis_event *event)
double eis_event_touch_get_y(struct eis_event *event)
For an event of type EIS_EVENT_TOUCH_DOWN, or EIS_EVENT_TOUCH_MOTION, return the y coordinate of the ...
struct eis * eis_client_get_context(struct eis_client *client)
struct eis_device * eis_keymap_get_device(struct eis_keymap *keymap)
Return the device this keymap belongs to.
bool eis_device_has_capability(struct eis_device *device, enum eis_device_capability cap)
struct eis_device * eis_touch_get_device(struct eis_touch *touch)
see ei_touch_get_device
void eis_device_pointer_motion_absolute(struct eis_device *device, double x, double y)
see ei_device_pointer_motion_absolute
struct eis * eis_ref(struct eis *eis)
struct eis_device * eis_seat_new_device(struct eis_seat *seat)
Create a new device on the seat.
int eis_keymap_get_fd(struct eis_keymap *keymap)
Return a memmap-able file descriptor pointing to the keymap used by the device.
void * eis_get_user_data(struct eis *eis)
unsigned int eis_log_context_get_line(struct eis_log_context *ctx)
void eis_region_set_size(struct eis_region *region, uint32_t w, uint32_t h)
This call has no effect if called after eis_region_add()
void eis_device_resume(struct eis_device *device)
Notify the client that the capabilities are resumed and that events from the device will be processed...
void eis_region_set_offset(struct eis_region *region, uint32_t x, uint32_t y)
This call has no effect if called after eis_region_add()
void eis_device_pointer_motion(struct eis_device *device, double x, double y)
see ei_device_pointer_motion
bool eis_region_contains(struct eis_region *region, double x, double y)
const char * eis_event_type_to_string(enum eis_event_type)
This is a debugging helper to return a string of the name of the event type, or NULL if the event typ...
bool eis_event_scroll_get_stop_y(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_STOP return whether the y axis has stopped scrolling.
void eis_device_stop_emulating(struct eis_device *device)
see ei_device_stop_emulating
struct eis_client * eis_device_get_client(struct eis_device *device)
uint32_t eis_event_button_get_button(struct eis_event *event)
For an event of type EIS_EVENT_BUTTON_BUTTON return the button code as defined in linux/input-event-c...
eis_device_type
The device type determines what the device represents.
Definition: libeis.h:202
void eis_device_keyboard_send_xkb_modifiers(struct eis_device *device, uint32_t depressed, uint32_t latched, uint32_t locked, uint32_t group)
Notify the client of the current XKB modifier state.
struct eis_region * eis_region_unref(struct eis_region *region)
void eis_set_user_data(struct eis *eis, void *user_data)
void eis_device_scroll_delta(struct eis_device *device, double x, double y)
see ei_device_scroll_delta
struct eis_client * eis_client_unref(struct eis_client *client)
Regions are only available on devices of type EIS_DEVICE_TYPE_VIRTUAL.
Definition: libeis.h:148
uint32_t eis_event_touch_get_id(struct eis_event *event)
For an event of type EIS_EVENT_TOUCH_DOWN, EIS_EVENT_TOUCH_MOTION, or EIS_EVENT_TOUCH_UP, return the tracking ID of the touch.
void eis_seat_set_user_data(struct eis_seat *eis_seat, void *user_data)
The client no longer listens to events from this device.
Definition: libeis.h:256
void * eis_device_get_user_data(struct eis_device *eis_device)
void * eis_client_get_user_data(struct eis_client *eis_client)
struct eis_keymap * eis_device_keyboard_get_keymap(struct eis_device *device)
Return the keymap assigned to this device.
void eis_touch_set_user_data(struct eis_touch *touch, void *user_data)
see ei_touch_set_user_data
void * eis_seat_get_user_data(struct eis_seat *eis_seat)
struct eis_keymap * eis_device_new_keymap(struct eis_device *device, enum eis_keymap_type type, int fd, size_t size)
Create a new keymap of the given type.
uint64_t(* eis_clock_now_func)(struct eis *eis)
Optional override function for eis_now().
Definition: libeis.h:450
void * eis_touch_get_user_data(struct eis_touch *touch)
see ei_touch_get_user_data
A client has connected.
Definition: libeis.h:238
uint64_t eis_now(struct eis *eis)
uint32_t eis_device_get_height(struct eis_device *device)
Return the height in mm of a device of type EIS_DEVICE_TYPE_PHYSICAL, or zero otherwise.
void eis_dispatch(struct eis *eis)
Main event dispatching function.
size_t eis_keymap_get_size(struct eis_keymap *keymap)
Event for a single touch released from the device's logical surface.
Definition: libeis.h:343
int eis_get_fd(struct eis *eis)
libeis keeps a single file descriptor for all events.
Stop emulating events on this device, see EIS_EVENT_DEVICE_START_EMULATING.
Definition: libeis.h:290
struct eis_seat * eis_event_get_seat(struct eis_event *event)
bool eis_event_seat_has_capability(struct eis_event *event, enum eis_device_capability cap)
For an event of type EIS_EVENT_SEAT_BIND, return the capabilities requested by the client...
uint32_t eis_region_get_height(struct eis_region *region)
eis_log_priority
Definition: libeis.h:368
int eis_setup_backend_socket(struct eis *ctx, const char *path)
Initialize the context with a UNIX socket name.
struct eis_region * eis_device_new_region(struct eis_device *device)
Create a new region on the device of type EIS_DEVICE_TYPE_VIRTUAL with an initial refcount of 1...
void eis_seat_remove(struct eis_seat *seat)
Remove this seat and all its remaining devices.
struct eis_keymap * eis_keymap_unref(struct eis_keymap *keymap)
const char * eis_log_context_get_func(struct eis_log_context *ctx)
const char * eis_device_get_name(struct eis_device *device)
Return the name of the device.
uint32_t eis_region_get_width(struct eis_region *region)
void eis_touch_motion(struct eis_touch *touch, double x, double y)
see ei_touch_motion
struct eis_client * eis_seat_get_client(struct eis_seat *eis_seat)
"Hardware" frame event.
Definition: libeis.h:268
void eis_client_set_user_data(struct eis_client *eis_client, void *user_data)
double eis_region_get_physical_scale(struct eis_region *region)
int32_t eis_event_scroll_get_discrete_dx(struct eis_event *event)
For an event of type EIS_EVENT_SCROLL_DISCRETE return the x scroll distance in fractions or multiples...
A key press or release event.
Definition: libeis.h:330
void eis_log_set_priority(struct eis *eis, enum eis_log_priority priority)
The client has disconnected, any pending requests for this client should be discarded.
Definition: libeis.h:243
double eis_event_pointer_get_absolute_y(struct eis_event *event)
For an event of type EIS_EVENT_POINTER_MOTION_ABSOLUTE return the y position in logical pixels or mm...
uint32_t eis_region_get_y(struct eis_region *region)
void eis_region_add(struct eis_region *region)
Add the given region to its device.
void eis_device_add(struct eis_device *device)
Add this device to its seat and notify the client of the device's availability.
struct eis_seat * eis_seat_unref(struct eis_seat *seat)
const char * eis_client_get_name(struct eis_client *client)
Return the name set by this client.
uint32_t eis_region_get_x(struct eis_region *region)
const char * eis_log_context_get_file(struct eis_log_context *ctx)
struct eis_client * eis_event_get_client(struct eis_event *event)
const char * eis_region_get_mapping_id(struct eis_region *region)
Get the unique ID for this region previously set by this caller, if any, or NULL if the client does n...
void eis_keymap_add(struct eis_keymap *keymap)
Set the keymap on the device.
eis_event_type
Definition: libeis.h:231
void eis_client_disconnect(struct eis_client *client)
Disconnect this client.
An absolute motion event with absolute position within the device's regions or size, depending on the device type.
Definition: libeis.h:303