xkbcommon 1.14.0-beta2
Reference library implementing the XKB specification for parsing keyboard descriptions and handling keyboard state
Loading...
Searching...
No Matches
Ownership Reference
Struct xkb_context
_Shared_ ownership using reference counting. Heap-allocated by xkb_context_new(), which creates the first reference. Take additional references with xkb_context_ref() and release each of them with exactly one xkb_context_unref() call. The object is destroyed once its last reference has been released.
Struct xkb_event
_Exclusive_ ownership. Heap-allocated and owned by xkb_events. An event is valid only inside a frame.
Struct xkb_events

_Exclusive_ ownership. Heap-allocated by xkb_events_new() and freed exclusively by calling exactly once xkb_events_destroy().

Owns a reference to the xkb_context passed during initialization, kept for the entire lifetime of the xkb_events instance and released when calling xkb_events_destroy().

Struct xkb_keymap

_Shared_ ownership using reference counting. Heap-allocated by xkb_keymap_new(), which creates the first reference. Take additional references with xkb_keymap_ref() and release each of them with exactly one xkb_keymap_unref() call. The object is destroyed once its last reference has been released.

Owns a reference to the xkb_context passed during initialization, kept for the entire lifetime of the xkb_keymap instance and released when calling xkb_keymap_unref().

Struct xkb_keymap_key_iterator

_Exclusive_ ownership. Instances are allocated and managed by the caller (typically on the stack) and must be initialized using xkb_keymap_key_iterator_init(). No explicit destruction is required by xkbcommon.

Borrows the xkb_keymap passed during initialization.

Struct xkb_machine

_Shared_ ownership using reference counting. Heap-allocated by xkb_machine_new(), which creates the first reference. Take additional references with xkb_machine_ref() and release each of them with exactly one xkb_machine_unref() call. The object is destroyed once its last reference has been released.

Owns a reference to the xkb_keymap passed during initialization, kept for the entire lifetime of the xkb_machine instance and released when calling xkb_machine_unref().

Struct xkb_machine_builder

_Shared_ ownership using reference counting. Heap-allocated by xkb_machine_builder_new(), which creates the first reference. Take additional references with xkb_machine_builder_ref() and release each of them with exactly one xkb_machine_builder_unref() call. The object is destroyed once its last reference has been released.

Owns a reference to the xkb_keymap passed during initialization, kept for the entire lifetime of the xkb_machine_builder instance and released when calling xkb_machine_builder_unref().

Struct xkb_rmlvo_builder

_Shared_ ownership using reference counting. Heap-allocated by xkb_rmlvo_builder_new(), which creates the first reference. Take additional references with xkb_rmlvo_builder_ref() and release each of them with exactly one xkb_rmlvo_builder_unref() call. The object is destroyed once its last reference has been released.

Owns a reference to the xkb_context passed during initialization, kept for the entire lifetime of the xkb_rmlvo_builder instance and released when calling xkb_rmlvo_builder_unref().

Struct xkb_state

_Shared_ ownership using reference counting. Heap-allocated by xkb_state_new(), which creates the first reference. Take additional references with xkb_state_ref() and release each of them with exactly one xkb_state_unref() call. The object is destroyed once its last reference has been released.

Owns a reference to the xkb_keymap passed during initialization, kept for the entire lifetime of the xkb_state instance and released when calling xkb_state_unref().