#include <xkbcommon.h>

Collaboration diagram for xkb_state_update:

Data Fields
uint32_t	size

const struct xkb_state_components_update *	components

const struct xkb_layout_policy_update *	layout_policy

Detailed Description

Request to process an out-of-band atomic update through an xkb_machine or xkb_state.

A NULL pointer means “not set / no change”.

Note

This struct uses a size-based versioning scheme to allow forward and backward compatibility between callers and the library:

Older callers (smaller struct): Trailing fields unknown to the caller default to zero in the library.
Newer callers (larger struct): Accepted only if all trailing bytes unknown to the library are zero.

Precondition: The struct MUST be initialized with memset() before setting any fields:
struct xkb_state_update update;

memset(&update, 0, sizeof(update));

update.size = sizeof(update);

update.components = …;

xkb_state_update
Request to process an out-of-band atomic update through an xkb_machine or xkb_state.
Definition xkbcommon.h:3778

Invariant: size MUST be explicitly set to sizeof(struct xkb_state_update).; All bytes of the struct, including padding, MUST remain zero except for explicitly assigned fields.

See also: xkb_state::xkb_state_update_synthetic(); xkb_machine::xkb_machine_process_synthetic(); xkb_state_components_update; xkb_layout_policy_update

Field Documentation

uint32_t xkb_state_update::size

Size of this structure in bytes.

uint32_t xkb_state_update::reserved0

private

Reserved for future extensions.

const struct xkb_state_components_update* xkb_state_update::components

Components updates, or NULL for no change.

const struct xkb_layout_policy_update* xkb_state_update::layout_policy

Out-of-range layout policy update, or NULL for no change.

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