hid_types/id/usage/
haptics.rs

1//! Well-known Usage ID values from the Haptics Usage Page.
2
3use num_enum::{IntoPrimitive, TryFromPrimitive};
4
5use crate::Ident;
6
7/// Well-known Usage ID values from the Haptics Usage Page.
8///
9/// See [HID Usage Tables for Universal Serial Bus](https://www.usb.org/document-library/hid-usage-tables-17),
10/// section 17.
11#[expect(missing_docs)]
12#[derive(Clone, Copy, Debug, Eq, PartialEq, TryFromPrimitive, IntoPrimitive)]
13#[repr(u16)]
14pub enum KnownUsage {
15    Undefined = 0x00,
16    SimpleHapticController = 0x01,
17    // 0x02-0x0F reserved
18    WaveformList = 0x10,
19    DurationList = 0x11,
20    // 0x12-0x1F reserved
21    AutoTrigger = 0x20,
22    ManualTrigger = 0x21,
23    AutoTriggerAssociatedControl = 0x22,
24    Intensity = 0x23,
25    RepeatCount = 0x24,
26    RetriggerPeriod = 0x25,
27    WaveformVendorPage = 0x26,
28    WaveformVendorId = 0x27,
29    WaveformCutoffTime = 0x28,
30    // 0x29-0x1000 reserved
31    WaveformNone = 0x1001,
32    WaveformStop = 0x1002,
33    WaveformClick = 0x1003,
34    WaveformBuzzContinuous = 0x1004,
35    WaveformRumbleContinuous = 0x1005,
36    WaveformPress = 0x1006,
37    WaveformRelease = 0x1007,
38    WaveformHover = 0x1008,
39    WaveformSuccess = 0x1009,
40    WaveformError = 0x100A,
41    WaveformInkContinuous = 0x100B,
42    WaveformPencilContinuous = 0x100C,
43    WaveformMarkerContinuous = 0x100D,
44    WaveformChiselMarkerContinuous = 0x100E,
45    WaveformBrushContinuous = 0x100F,
46    WaveformEraserContinuous = 0x1010,
47    WaveformSparkleContinuous = 0x1011,
48    // 0x1012-0x2000 reserved
49    // 0x2001-0x2FFF reserved for vendor waveforms
50    // 0x3000-0xFFFF reserved
51}
52
53/// A __Usage ID__ value.
54pub type Usage = Ident<KnownUsage, u16>;
hid_types/id/usage/haptics.rs

hid_types/id/usage/
haptics.rs
