xref: /third_party/libinput/src/libinput.h

43  * @struct libinput
45  * A handle for accessing libinput. This struct is refcounted, use
48 struct libinput;
54  * A base handle for accessing libinput devices. This struct is
63  * A base handle for accessing libinput device groups. This struct is
73  * The base handle for accessing libinput seats. This struct is
242  * depending on the device. libinput provides some scroll direction locking
282 	 * @deprecated This axis source is deprecated as of libinput 1.16.
283 	 * It was never used by any device before libinput 1.16. All wheel
400  * pad devices. See the libinput documentation for more details.
415  * 24HD). libinput guarantees that at least one mode group is always
447  * the next call to libinput. Use libinput_tablet_pad_mode_group_ref() and
493  * libinput guarantees that at least one mode is available. A device without
629  * Set caller-specific data associated with this mode group. libinput does
664  * off position. If a switch is logically on during initialization, libinput
754 	 * This event is deprecated as of libinput 1.19. Use
760 	 * source of a scroll event. For libinput versions 1.19 and later,
768 	 * libinput makes no guarantee about the relation between
790 	 * See the libinput documentation for details.
804 	 * See the libinput documentation for details.
819 	 * See the libinput documentation for details.
870 	 * libinput guarantees that both x and y are set in the proximity
1021  * Get the libinput context from the event.
1023  * @param event The libinput event
1024  * @return The libinput context for this event.
1026 struct libinput *
1092  * down or libinput decides that the gesture begins. For @ref
1179  * @note Timestamps may not always increase. See the libinput documentation
1190  * @note Timestamps may not always increase. See the libinput documentation
1248  * @note Timestamps may not always increase. See the libinput documentation
1259  * @note Timestamps may not always increase. See the libinput documentation
1278  * standardized mouse. See the libinput documentation for more details.
1299  * standardized mouse. See the libinput documentation for more details.
1319  * X resolution of the touchpad. See the libinput documentation for more
1344  * X resolution of the touchpad. See the libinput documentation for more
1408  * @param event The libinput pointer event
1430  * @param event The libinput pointer event
1548  * If the source is @ref LIBINPUT_POINTER_AXIS_SOURCE_FINGER, libinput
1564  * If the source is @ref LIBINPUT_POINTER_AXIS_SOURCE_CONTINUOUS, libinput
1570  * deprecated as of libinput 1.16. No device has ever sent this source.
1578  * @note This function is superfluous as of libinput 1.19. The event
1596  * should be considered deprecated as of libinput 1.19. Callers should use
1629  * If the event is @ref LIBINPUT_EVENT_POINTER_SCROLL_FINGER, libinput
1645  * If the event is @ref LIBINPUT_EVENT_POINTER_SCROLL_CONTINUOUS, libinput
1727  * @note Timestamps may not always increase. See the libinput documentation
1738  * @note Timestamps may not always increase. See the libinput documentation
1804  * @param event The libinput touch event
1824  * @param event The libinput touch event
1843  * @param event The libinput touch event
1864  * @param event The libinput touch event
1891  * See the libinput documentation for details on gesture handling.
1897  * @note Timestamps may not always increase. See the libinput documentation
1908  * @note Timestamps may not always increase. See the libinput documentation
1933  * libinput will end the three-finger gesture and, if applicable, start a
1970  * 1000dpi resolution. See the libinput documentation for more details.
1988  * 1000dpi resolution. See the libinput documentation for more details.
2004  * device with 1000dpi resolution. See the libinput documentation for more
2026  * device with 1000dpi resolution. See the libinput documentation for more
2133  * @param event The libinput tablet tool event
2156  * @param event The libinput tablet tool event
2179  * @param event The libinput tablet tool event
2204  * @param event The libinput tablet tool event
2227  * @param event The libinput tablet tool event
2250  * @param event The libinput tablet tool event
2272  * @param event The libinput tablet tool event
2294  * @param event The libinput tablet tool event
2317  * @param event The libinput tablet tool event
2338  * @param event The libinput tablet tool event
2359  * @param event The libinput tablet tool event
2377  * width of the device. See the libinput documentation for more details.
2379  * @param event The libinput tablet tool event
2396  * width of the device. See the libinput documentation for more details.
2398  * @param event The libinput tablet tool event
2415  * See the libinput documentation for more details.
2417  * @param event The libinput tablet event
2434  * See the libinput documentation for more details.
2436  * @param event The libinput tablet event
2452  * @param event The libinput tablet tool event
2468  * @param event The libinput tablet tool event
2488  * @param event The libinput tablet tool event
2508  * @param event The libinput tablet tool event
2530  * @param event The libinput tablet tool event
2548  * @param event The libinput tablet tool event
2568  * @param event The libinput tablet tool event
2586  * @param event The libinput tablet tool event
2597  * @param event The libinput tablet tool event
2611  * @param event The libinput tablet tool event
2630  * libinput always includes all device axes in the event.
2633  * width of the device. See the libinput documentation for more details.
2635  * @param event The libinput tablet tool event
2653  * libinput always includes all device axes in the event.
2656  * width of the device. See the libinput documentation for more details.
2658  * @param event The libinput tablet tool event
2674  * the next call to libinput. Use libinput_tablet_tool_ref() and
2682  * libinput creates one tool per type per tablet. See
2685  * @param event The libinput tablet tool event
2711  * tool may not be lifted out of physical proximity. For such tools, libinput
2714  * @param event The libinput tablet tool event
2730  * @param event The libinput tablet tool event
2747  * @param event The libinput tablet tool event
2763  * @param event The libinput tablet tool event
2781  * @param event The libinput tablet tool event
2792  * @note Timestamps may not always increase. See the libinput documentation
2795  * @param event The libinput tablet tool event
2806  * @note Timestamps may not always increase. See the libinput documentation
2809  * @param event The libinput tablet tool event
2833  * @param tool The libinput tool
2855  * @param tool The libinput tool
2968  * libinput emulates the other axis as a circular contact, i.e. major ==
3011  * libinput, or nonzero otherwise. If a tool can be uniquely identified,
3032  * Some tools provide hardware information that enables libinput to uniquely
3035  * identifiable through a serial number. libinput does not specify how a
3039  * libinput creates a struct @ref libinput_tablet_tool on the first
3043  * libinput re-uses this struct whenever that same physical tool comes into
3045  * recognized by libinput. It is possible to attach tool-specific virtual
3051  * If the tool does not have a unique identifier, libinput creates a single
3055  * @param tool The libinput tool
3068  * Return the user data associated with a tool object. libinput does
3072  * @param tool The libinput tool
3085  * @param tool The libinput tool
3121  * libinput sends a terminating event with a ring value of -1 when the
3129  * @param event The libinput tablet pad event
3149  * @param event The libinput tablet pad event
3161  * @ref LIBINPUT_TABLET_PAD_RING_SOURCE_FINGER, libinput sends a ring
3168  * @param event The libinput tablet pad event
3184  * libinput sends a terminating event with a ring value of -1 when the
3192  * @param event The libinput tablet pad event
3212  * @param event The libinput tablet pad event
3224  * @ref LIBINPUT_TABLET_PAD_STRIP_SOURCE_FINGER, libinput sends a strip
3231  * @param event The libinput tablet pad event
3248  * See the libinput documentation for more details.
3254  * @param event The libinput tablet pad event
3271  * @param event The libinput tablet pad event
3292  * @param event The libinput tablet pad event
3309  * @param event The libinput tablet pad event
3330  * Mode switching is controlled by libinput and more than one mode may exist
3341  * @param event The libinput tablet pad event
3364  * the next call to libinput. Use libinput_tablet_pad_mode_group_ref() and
3368  * @param event The libinput tablet pad event
3381  * @note Timestamps may not always increase. See the libinput documentation
3384  * @param event The libinput tablet pad event
3395  * @note Timestamps may not always increase. See the libinput documentation
3398  * @param event The libinput tablet pad event
3422  * @param event The libinput switch event
3440  * @param event The libinput switch event
3461  * @note Timestamps may not always increase. See the libinput documentation
3464  * @param event The libinput switch event
3475  * @note Timestamps may not always increase. See the libinput documentation
3478  * @param event The libinput switch event
3487  * @defgroup base Initialization and manipulation of libinput contexts
3494  * libinput does not open file descriptors to devices directly, instead
3527  * Create a new libinput context from udev. This context is inactive until
3535  * @return An initialized, but inactive libinput context or NULL on error
3537 struct libinput *
3545  * Assign a seat to this libinput context. New devices or the removal of
3557  * @param libinput A libinput context initialized with
3564 libinput_udev_assign_seat(struct libinput *libinput,
3570  * Create a new libinput context that requires the caller to manually add or
3584  * @return An initialized, empty libinput context.
3586 struct libinput *
3593  * Add a device to a libinput context initialized with
3603  * @param libinput A previously initialized libinput context
3607  * @note It is an application bug to call this function on a libinput
3611 libinput_path_add_device(struct libinput *libinput,
3617  * Remove a device from a libinput context initialized with
3627  * @param device A libinput device
3629  * @note It is an application bug to call this function on a libinput
3638  * libinput keeps a single file descriptor for all events. Call into
3644 libinput_get_fd(struct libinput *libinput);
3653  * Dispatching does not necessarily queue libinput events. This function
3655  * descriptor returned by libinput_get_fd(). libinput has a number of
3659  * @param libinput A previously initialized libinput context
3664 libinput_dispatch(struct libinput *libinput);
3669  * Retrieve the next event from libinput's internal event queue.
3674  * @param libinput A previously initialized libinput context
3678 libinput_get_event(struct libinput *libinput);
3687  * @param libinput A previously initialized libinput context
3692 libinput_next_event_type(struct libinput *libinput);
3697  * Set caller-specific data associated with this context. libinput does
3701  * @param libinput A previously initialized libinput context
3706 libinput_set_user_data(struct libinput *libinput,
3714  * @param libinput A previously initialized libinput context
3720 libinput_get_user_data(struct libinput *libinput);
3725  * Resume a suspended libinput context. This re-enables device
3728  * @param libinput A previously initialized libinput context
3734 libinput_resume(struct libinput *libinput);
3740  * This all but terminates libinput but does keep the context
3743  * @param libinput A previously initialized libinput context
3746 libinput_suspend(struct libinput *libinput);
3754  * @param libinput A previously initialized valid libinput context
3755  * @return The passed libinput context
3757 struct libinput *
3758 libinput_ref(struct libinput *libinput);
3763  * Dereference the libinput context. After this, the context may have been
3788  * @param libinput A previously initialized libinput context
3791 struct libinput *
3792 libinput_unref(struct libinput *libinput);
3797  * Set the log priority for the libinput context. Messages with priorities
3803  * @param libinput A previously initialized libinput context
3810 libinput_log_set_priority(struct libinput *libinput,
3821  * @param libinput A previously initialized libinput context
3828 libinput_log_get_priority(const struct libinput *libinput);
3835  * @param libinput The libinput context
3844 typedef void (*libinput_log_handler)(struct libinput *libinput,
3858  * @param libinput A previously initialized libinput context
3865 libinput_log_set_handler(struct libinput *libinput,
3875  * See the libinput documentation for more information on seats.
3909  * Set caller-specific data associated with this seat. libinput does
3935  * Get the libinput context from the seat.
3938  * @return The libinput context for this seat.
3940 struct libinput *
3946  * Return the physical name of the seat. For libinput contexts created from
4009  * Set caller-specific data associated with this input device. libinput does
4035  * Get the libinput context from the device.
4038  * @return The libinput context for this device.
4040 struct libinput *
4050  * libinput assigns these devices to the same @ref libinput_device_group
4094  * the next call to libinput. Use libinput_device_group_ref() and
4099  * property, see the libinput documentation for more details.
4191  * the next call to libinput. Use libinput_seat_ref() and
4195  * See the libinput documentation for more information on seats.
4210  * re-plugging it as a member of the new seat. libinput will generate a
4235  * Return a udev handle to the device that is this libinput device, if any.
4369  * libinput documentation for details.
4466  * Set caller-specific data associated with this device group. libinput does
4495  * all features, libinput assigns a default based on the hardware
4500  * supported on all devices. For all configuration options, libinput
4762  * on finger up. See the libinput documentation for more details.
4831  * tap-and-drag will immediately stop the drag. See the libinput
4988  * that property's value becomes the default matrix, see the libinput
5015 	 * mode only, any device detected by libinput can be enabled. Do not
5097  * subsets of another mode libinput may drop the bits that are subsets. In
5131  * Check if a device uses libinput-internal pointer-acceleration.
5152  * range. libinput picks the semantically closest acceleration step if the
5258  * In this version of libinput, this pointer acceleration configuration
5277  * Note that in this version of libinput, only the
5773  * See the libinput documentation for more details.
6141  * touchpad while typing. See the libinput documentation for details.
6159  * the libinput documentation for details.
6232  * touchpad while using the trackpoint. See the libinput documentation for
6253  * after. See the libinput documentation for details.

Indexes created Thu Nov 07 10:32:03 CST 2024