diff options
| author | Simon Ser <contact@emersion.fr> | 2022-12-14 17:09:48 +0100 |
|---|---|---|
| committer | Simon Zeni <simon@bl4ckb0ne.ca> | 2022-12-15 19:49:45 +0000 |
| commit | 70816878431fd934e4e0fb213a58b2239c970c52 (patch) | |
| tree | d2a6b5539ff6efe57743bb901fcc22cefe8ae6eb /include/wlr | |
| parent | 8b8921d57b9dfb733757d338c354014f41e86d59 (diff) | |
keyboard: improve documentation
Diffstat (limited to 'include/wlr')
| -rw-r--r-- | include/wlr/types/wlr_keyboard.h | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/include/wlr/types/wlr_keyboard.h b/include/wlr/types/wlr_keyboard.h index b1e01c4d..abc4edf6 100644 --- a/include/wlr/types/wlr_keyboard.h +++ b/include/wlr/types/wlr_keyboard.h @@ -116,12 +116,27 @@ bool wlr_keyboard_set_keymap(struct wlr_keyboard *kb, bool wlr_keyboard_keymaps_match(struct xkb_keymap *km1, struct xkb_keymap *km2); /** - * Sets the keyboard repeat info. `rate` is in key repeats/second and delay is - * in milliseconds. + * Set the keyboard repeat info. + * + * rate is in key repeats/second and delay is in milliseconds. + */ +void wlr_keyboard_set_repeat_info(struct wlr_keyboard *kb, int32_t rate_hz, + int32_t delay_ms); + +/** + * Update the LEDs on the device, if any. + * + * leds is a bitmask of enum wlr_keyboard_led. + * + * If the device doesn't have the provided LEDs, this function is a no-op. */ -void wlr_keyboard_set_repeat_info(struct wlr_keyboard *kb, int32_t rate, - int32_t delay); void wlr_keyboard_led_update(struct wlr_keyboard *keyboard, uint32_t leds); + +/** + * Get the set of currently depressed or latched modifiers. + * + * A bitmask of enum wlr_keyboard_modifier is returned. + */ uint32_t wlr_keyboard_get_modifiers(struct wlr_keyboard *keyboard); #endif |