input::ffi

Function libinput_event_pointer_has_axis

pub unsafe extern "C" fn libinput_event_pointer_has_axis(
    event: *mut libinput_event_pointer,
    axis: u32,
) -> i32
Expand description

@ingroup event_pointer

Check if the event has a valid value for the given axis.

If this function returns non-zero for an axis and libinput_event_pointer_get_axis_value() returns a value of 0, the event is a scroll stop event.

For pointer events that are not of type @ref LIBINPUT_EVENT_POINTER_AXIS, @ref LIBINPUT_EVENT_POINTER_SCROLL_WHEEL, @ref LIBINPUT_EVENT_POINTER_SCROLL_FINGER, or @ref LIBINPUT_EVENT_POINTER_SCROLL_CONTINUOUS this function returns 0.

@note It is an application bug to call this function for events other than @ref LIBINPUT_EVENT_POINTER_AXIS, @ref LIBINPUT_EVENT_POINTER_SCROLL_WHEEL, @ref LIBINPUT_EVENT_POINTER_SCROLL_FINGER, or @ref LIBINPUT_EVENT_POINTER_SCROLL_CONTINUOUS.

@return Non-zero if this event contains a value for this axis