xkb_event Struct Reference

#include <xkbcommon.h>

Public Member Functions
XKB_EXPORT enum xkb_event_type	xkb_event_get_type (const struct xkb_event *event)
XKB_EXPORT xkb_keycode_t	xkb_event_get_keycode (const struct xkb_event *event)
XKB_EXPORT enum xkb_state_component	xkb_event_get_changed_components (const struct xkb_event *event)
XKB_EXPORT enum xkb_keyboard_control_flags	xkb_event_serialize_enabled_controls (const struct xkb_event *event, enum xkb_state_component components)
XKB_EXPORT xkb_mod_mask_t	xkb_event_serialize_mods (const struct xkb_event *event, enum xkb_state_component components)
XKB_EXPORT xkb_layout_index_t	xkb_event_serialize_layout (const struct xkb_event *event, enum xkb_state_component components)

Detailed Description

Opaque keyboard state event object.

Events are produced by xkb_machine::xkb_machine_process_key() and xkb_machine::xkb_machine_process_synthetic() and collected into an xkb_events batch. Each event represents one atomic state change or key action within a frame.

Inspect the event type with xkb_event::xkb_event_get_type(), then extract data with the appropriate xkb_event::xkb_event_get_*() or xkb_event::xkb_event_serialize_*() functions.

Warning

Event pointers are only valid until the next call to xkb_machine::xkb_machine_process_key() or xkb_machine::xkb_machine_process_synthetic() on the same state machine. Do not store them beyond that point.

Since

1.14.0

See also

xkb_event_type

xkb_events

---

The documentation for this struct was generated from the following file:

• include/xkbcommon/xkbcommon.h