mirror of
https://gitlab.freedesktop.org/libinput/libinput.git
synced 2026-03-24 09:00:35 +01:00
doc: Document basic event accessor functions
Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
This commit is contained in:
parent
67455487f8
commit
0c43efb9bd
1 changed files with 20 additions and 0 deletions
|
|
@ -177,9 +177,29 @@ struct libinput_event_touch_touch;
|
|||
void
|
||||
libinput_event_destroy(struct libinput_event *event);
|
||||
|
||||
/**
|
||||
* @ingroup event
|
||||
*
|
||||
* Get the type of the event.
|
||||
*
|
||||
* @param event An event retrieved by libinput_get_event().
|
||||
*/
|
||||
enum libinput_event_type
|
||||
libinput_event_get_type(struct libinput_event *event);
|
||||
|
||||
/**
|
||||
* @ingroup event
|
||||
*
|
||||
* Get get the target union of the event.
|
||||
*
|
||||
* The valid union member depends on the event type. For global events not
|
||||
* related to some seat or device, the target is a libinput struct pointer.
|
||||
* For events associated with a seat, the target is a libinput_seat pointer
|
||||
* and for events associated with a device, the target is a libinput_device
|
||||
* pointer.
|
||||
*
|
||||
* @param event An event retrieved by libinput_get_event().
|
||||
*/
|
||||
union libinput_event_target
|
||||
libinput_event_get_target(struct libinput_event *event);
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue