Crate input [−] [src]
Libinput bindings for rust
These bindings closely follow libinput's concepts and it's original API. Please refer to the libinput documentation to understand the general structure and concepts.
Differences to the C-Library:
- Refcounting does not need to be done manually. Just call
clone
when you need an additional reference. - Libinput logging cannot (currently) not be customized.
Userdata handling
Multiple types in the libinput library allow to attach a pointer of an arbitrary type, so called userdata
.
Using this data is unsafe as there is no way to find out what type is stored in the libinput struct.
Additionally multiple references to the same libinput object may exist and userdata may be shared mutably.
This is why using and setting userdata is an unsafe operation (except when creating an object).
If you heavily rely on userdata, you should always stored them wrapped in a Mutex
and use the same
type for every userdata access to further simplify usage.
You need to be especially cautious when initializing libinput types from raw pointers, you obtained from other libraries which may set their own userdata. If accessing their userdata make sure no shared mutable access may happen and don't store something else instead, if the library does not explicitly allow this.
Generally usage of this api is error-prone and discouraged if not needed.
Getting started
To get started check out the Libinput
struct.
Reexports
pub use event::Event; |
Modules
event |
Libinput Events |
ffi |
Unsafe c-api. |
Structs
Device |
Representation of a single input device as seen by the kernel. |
DeviceGroup |
Device group |
Libinput |
Libinput context |
Seat |
A seat has two identifiers, the physical name and the logical name. |
Enums
AccelProfile |
Pointer Acceleration Profile |
ClickMethod |
The click method defines when to generate software-emulated buttons, usually on a device that does not have a specific physical button available. |
DeviceCapability |
Capabilities on a device. |
DeviceConfigError |
Errors returned when applying configuration settings. |
Led |
Mask reflecting LEDs on a device. |
ScrollMethod |
The scroll method of a device selects when to generate scroll axis events instead of pointer motion events. |
SendEventsMode |
The send-event mode of a device defines when a device may generate events and pass those events to the caller. |
TapButtonMap |
Map 1/2/3 finger tips to buttons |
Traits
AsRaw |
Trait for types that allow to optain the underlying raw libinput pointer. |
FromRaw |
Trait for types that allow to be initialized from a raw pointer |
Userdata |
Trait to deal with userdata attached to this struct. |
Type Definitions
DeviceConfigResult |
Result returned when applying configuration settings. |
LibinputInterface |
libinput does not open file descriptors to devices directly,
instead |