ui.h

#include <modkit/ui.h>83 functions · 16 structs · 15 enums · 33 typedefs · 12 macros

Optional immediate-mode application UI built on Clay and text layout.

Include this header explicitly. The UI package is intentionally not exposed by modkit/modkit.h because its scoped layout helpers are opt-in syntax.

Functions

`mk_ui_begin`function

bool mk_ui_begin(mk_ui_t ui, const mk_ui_frame_desc_t *frame)

Begin one immediate-mode UI frame and process queued input.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`frame`	`const mk_ui_frame_desc_t *`	Frame dimensions and timing.

Returns True when declaration may proceed.

`mk_ui_box_begin`function

bool mk_ui_box_begin(mk_ui_t ui, mk_ui_id_t id, const mk_ui_box_desc_t *desc)

Begin a general-purpose layout box.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable element ID.
`desc`	`const mk_ui_box_desc_t *`	Box properties.

Returns True when the scope opened.

`mk_ui_box_desc_init`function

void mk_ui_box_desc_init(mk_ui_box_desc_t *desc)

Initialize a box descriptor.

Parameter	Type	Description
`desc`	`mk_ui_box_desc_t *`	Descriptor to initialize.

`mk_ui_box_end`function

void mk_ui_box_end(mk_ui_t ui)

End the innermost box, row, column, or scroll scope.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

`mk_ui_button`function

bool mk_ui_button(mk_ui_t ui, mk_ui_id_t id, const char *label)

Declare a push button.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable widget ID.
`label`	`const char *`	UTF-8 label.

Returns True when activated this frame.

`mk_ui_checkbox`function

bool mk_ui_checkbox(mk_ui_t ui, mk_ui_id_t id, const char *label, bool *value)

Declare a binary checkbox.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable widget ID.
`label`	`const char *`	UTF-8 label.
`value`	`bool *`	Value read and toggled on activation.

Returns True when value changed.

`mk_ui_clear_focus`function

void mk_ui_clear_focus(mk_ui_t ui)

Clear keyboard focus.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

`mk_ui_column_begin`function

bool mk_ui_column_begin(mk_ui_t ui, mk_ui_id_t id, const mk_ui_box_desc_t *desc)

Begin a vertical layout box.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable element ID.
`desc`	`const mk_ui_box_desc_t *`	Box properties.

Returns True when the scope opened.

`mk_ui_create`function

mk_result mk_ui_create(const mk_ui_desc_t *desc, mk_ui_t *ui)

Create a UI context.

Parameter	Type	Description
`desc`	`const mk_ui_desc_t *`	Context configuration.
`ui`	`mk_ui_t *`	Receives the created handle.

Returns MK_SUCCESS or an error result.

`mk_ui_desc_init`function

void mk_ui_desc_init(mk_ui_desc_t *desc)

Initialize a UI context descriptor with documented defaults.

Parameter	Type	Description
`desc`	`mk_ui_desc_t *`	Descriptor to initialize.

`mk_ui_destroy`function

void mk_ui_destroy(mk_ui_t ui)

Destroy a UI context and its retained state.

Parameter	Type	Description
`ui`	`mk_ui_t`	Context to destroy.

`mk_ui_end`function

bool mk_ui_end(mk_ui_t ui)

Resolve layout and finish the current UI frame.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when the command stream is renderable.

`mk_ui_feed_navigation`function

void mk_ui_feed_navigation(mk_ui_t ui, const mk_ui_navigation_t *navigation)

Feed application-mapped navigation state.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`navigation`	`const mk_ui_navigation_t *`	Directional axes and actions.

`mk_ui_fit`function

mk_ui_size_t mk_ui_fit(float min, float max)

Construct a content-fitting size constraint.

Parameter	Type	Description
`min`	`float`	Minimum size.
`max`	`float`	Maximum size.

Returns The size constraint.

`mk_ui_fixed`function

mk_ui_size_t mk_ui_fixed(float value)

Construct a fixed logical-pixel size constraint.

Parameter	Type	Description
`value`	`float`	Fixed size.

Returns The size constraint.

`mk_ui_focused`function

mk_ui_id_t mk_ui_focused(mk_ui_t ui)

Get the currently focused element.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns Focused ID, or MK_UI_ID_INVALID.

`mk_ui_frame_desc_init`function

void mk_ui_frame_desc_init(mk_ui_frame_desc_t *desc)

Initialize a per-frame descriptor.

Parameter	Type	Description
`desc`	`mk_ui_frame_desc_t *`	Descriptor to initialize.

`mk_ui_get_frame_stats`function

bool mk_ui_get_frame_stats(mk_ui_t ui, mk_ui_frame_stats_t *stats)

Read diagnostics for the most recently completed frame.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`stats`	`mk_ui_frame_stats_t *`	Receives frame counters.

Returns True when statistics were available.

`mk_ui_get_motion`function

bool mk_ui_get_motion(mk_ui_t ui, mk_ui_motion_t *motion)

Read a context's transition settings.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`motion`	`mk_ui_motion_t *`	Receives the settings.

Returns True on success.

`mk_ui_get_theme`function

bool mk_ui_get_theme(mk_ui_t ui, mk_ui_theme_t *theme)

Read a context's active theme.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`theme`	`mk_ui_theme_t *`	Receives the theme.

Returns True on success.

`mk_ui_grow`function

mk_ui_size_t mk_ui_grow(float min, float max)

Construct an available-space-growing size constraint.

Parameter	Type	Description
`min`	`float`	Minimum size.
`max`	`float`	Maximum size.

Returns The size constraint.

`mk_ui_handle_event`function

bool mk_ui_handle_event(mk_ui_t ui, const mk_event_t *event)

Feed one platform event to a manual-mode UI context.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`event`	`const mk_event_t *`	Event to process.

Returns True when the UI consumed the event.

`mk_ui_id_str`function

mk_ui_id_t mk_ui_id_str(mk_ui_t ui, const char *text)

Hash a null-terminated UTF-8 string into the current ID scope.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`text`	`const char *`	Stable identifier text.

Returns The scoped UI ID.

`mk_ui_id_str_n`function

mk_ui_id_t mk_ui_id_str_n(mk_ui_t ui, const char *text, size_t text_len)

Hash a UTF-8 byte span into the current ID scope.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`text`	`const char *`	Identifier bytes.
`text_len`	`size_t`	Byte length.

Returns The scoped UI ID.

`mk_ui_id_u64`function

mk_ui_id_t mk_ui_id_u64(mk_ui_t ui, uint64_t value)

Hash an integer into the current ID scope.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`value`	`uint64_t`	Caller-stable value.

Returns The scoped UI ID.

`mk_ui_image`function

void mk_ui_image(mk_ui_t ui, mk_ui_id_t id, mk_texture_t texture, mk_rectf uv, uint32_t tint, float width, float height)

Draw a textured image element.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable element ID.
`texture`	`mk_texture_t`	Source texture.
`uv`	`mk_rectf`	Normalized source rectangle.
`tint`	`uint32_t`	Packed tint color.
`width`	`float`	Logical width.
`height`	`float`	Logical height.

`mk_ui_item_active`function

bool mk_ui_item_active(mk_ui_t ui)

Test whether the last declared item owns an active interaction.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when active.

`mk_ui_item_enabled`function

bool mk_ui_item_enabled(mk_ui_t ui)

Test whether the last declared item accepts interaction.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when enabled.

`mk_ui_item_focused`function

bool mk_ui_item_focused(mk_ui_t ui)

Test whether the last declared item has keyboard focus.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when focused.

`mk_ui_item_hovered`function

bool mk_ui_item_hovered(mk_ui_t ui)

Test whether the last declared item is hovered.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when hovered.

`mk_ui_item_pressed`function

bool mk_ui_item_pressed(mk_ui_t ui)

Test whether the last declared item is held by a pointer press.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when pressed.

`mk_ui_item_visible`function

bool mk_ui_item_visible(mk_ui_t ui)

Test whether the last declared item intersects its active clips.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when visible.

`mk_ui_motion_init`function

void mk_ui_motion_init(mk_ui_motion_t *motion)

Initialize UI transition settings.

Parameter	Type	Description
`motion`	`mk_ui_motion_t *`	Settings to initialize.

`mk_ui_number_float`function

bool mk_ui_number_float(mk_ui_t ui, mk_ui_id_t id, const char *label, float *value, float min, float max, float step, mk_ui_range_flags_t flags)

Declare a draggable and editable floating-point field.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable widget ID.
`label`	`const char *`	UTF-8 label.
`value`	`float *`	Value read and updated.
`min`	`float`	Minimum value.
`max`	`float`	Maximum value.
`step`	`float`	Drag and keyboard increment.
`flags`	`mk_ui_range_flags_t`	Presentation flags.

Returns True when value changed.

`mk_ui_number_int`function

bool mk_ui_number_int(mk_ui_t ui, mk_ui_id_t id, const char *label, int32_t *value, int32_t min, int32_t max, int32_t step, mk_ui_range_flags_t flags)

Declare a draggable and editable integer field.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable widget ID.
`label`	`const char *`	UTF-8 label.
`value`	`int32_t *`	Value read and updated.
`min`	`int32_t`	Minimum value.
`max`	`int32_t`	Maximum value.
`step`	`int32_t`	Drag and keyboard increment.
`flags`	`mk_ui_range_flags_t`	Presentation flags.

Returns True when value changed.

`mk_ui_percent`function

mk_ui_size_t mk_ui_percent(float value)

Construct a parent-relative size constraint.

Parameter	Type	Description
`value`	`float`	Fraction of the parent dimension.

Returns The size constraint.

`mk_ui_pop_id`function

void mk_ui_pop_id(mk_ui_t ui)

Pop the innermost ID component.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

`mk_ui_pop_style`function

void mk_ui_pop_style(mk_ui_t ui, uint32_t count)

Pop entries from the typed style stack.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`count`	`uint32_t`	Number of entries to pop.

`mk_ui_presence_begin`function

bool mk_ui_presence_begin(mk_ui_t ui, mk_ui_id_t id, bool visible, const mk_ui_presence_desc_t *desc)

Begin content that animates while entering or leaving declaration.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable presence ID.
`visible`	`bool`	Desired visibility.
`desc`	`const mk_ui_presence_desc_t *`	Transition options.

Returns True while the content must still be declared.

`mk_ui_presence_desc_init`function

void mk_ui_presence_desc_init(mk_ui_presence_desc_t *desc)

Initialize a conditional-presence descriptor.

Parameter	Type	Description
`desc`	`mk_ui_presence_desc_t *`	Descriptor to initialize.

`mk_ui_presence_end`function

void mk_ui_presence_end(mk_ui_t ui)

End the innermost presence scope.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

`mk_ui_progress`function

void mk_ui_progress(mk_ui_t ui, mk_ui_id_t id, const char *label, float value, float min, float max)

Draw a read-only progress range.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable element ID.
`label`	`const char *`	UTF-8 label.
`value`	`float`	Current value.
`min`	`float`	Minimum value.
`max`	`float`	Maximum value.

`mk_ui_push_color`function

bool mk_ui_push_color(mk_ui_t ui, mk_ui_color_role_t role, uint32_t color)

Push a theme-color override.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`role`	`mk_ui_color_role_t`	Color slot.
`color`	`uint32_t`	Packed replacement color.

Returns True on success.

`mk_ui_push_float`function

bool mk_ui_push_float(mk_ui_t ui, mk_ui_float_role_t role, float value)

Push a theme-scalar override.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`role`	`mk_ui_float_role_t`	Scalar slot.
`value`	`float`	Replacement value.

Returns True on success.

`mk_ui_push_font`function

bool mk_ui_push_font(mk_ui_t ui, mk_ui_font_role_t role, mk_font_family_t family)

Push a font-family override.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`role`	`mk_ui_font_role_t`	Font slot.
`family`	`mk_font_family_t`	Replacement font family.

Returns True on success.

`mk_ui_push_id_str`function

bool mk_ui_push_id_str(mk_ui_t ui, const char *text)

Push a string ID component.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`text`	`const char *`	Caller-stable identifier text.

Returns True on success.

`mk_ui_push_id_u64`function

bool mk_ui_push_id_u64(mk_ui_t ui, uint64_t value)

Push an integer ID component.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`value`	`uint64_t`	Caller-stable value.

Returns True on success.

`mk_ui_radio`function

bool mk_ui_radio(mk_ui_t ui, mk_ui_id_t id, const char *label, int32_t option, int32_t *selected)

Declare one option in a radio group.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable widget ID.
`label`	`const char *`	UTF-8 label.
`option`	`int32_t`	Value represented by this option.
`selected`	`int32_t *`	Selected value read and updated.

Returns True when selection changed.

`mk_ui_render`function

bool mk_ui_render(mk_ui_t ui)

Render the most recently completed UI frame.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when rendering was submitted.

`mk_ui_request_focus`function

bool mk_ui_request_focus(mk_ui_t ui, mk_ui_id_t id)

Request focus for a stable element ID.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Element ID.

Returns True when the request was accepted.

`mk_ui_row_begin`function

bool mk_ui_row_begin(mk_ui_t ui, mk_ui_id_t id, const mk_ui_box_desc_t *desc)

Begin a horizontal layout box.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable element ID.
`desc`	`const mk_ui_box_desc_t *`	Box properties.

Returns True when the scope opened.

`mk_ui_scroll_begin`function

bool mk_ui_scroll_begin(mk_ui_t ui, mk_ui_id_t id, const mk_ui_box_desc_t *desc)

Begin a scrollable layout box.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable element ID.
`desc`	`const mk_ui_box_desc_t *`	Box properties and scroll axes.

Returns True when the scope opened.

`mk_ui_semantics_init`function

void mk_ui_semantics_init(mk_ui_semantics_t *semantics)

Initialize accessibility metadata.

Parameter	Type	Description
`semantics`	`mk_ui_semantics_t *`	Metadata to initialize.

`mk_ui_separator`function

void mk_ui_separator(mk_ui_t ui, uint32_t color, float thickness)

Draw a separator occupying layout space.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`color`	`uint32_t`	Packed separator color.
`thickness`	`float`	Separator thickness.

`mk_ui_set_motion`function

bool mk_ui_set_motion(mk_ui_t ui, const mk_ui_motion_t *motion)

Replace a context's transition settings.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`motion`	`const mk_ui_motion_t *`	Settings to copy.

Returns True on success.

`mk_ui_set_next_semantics`function

void mk_ui_set_next_semantics(mk_ui_t ui, const mk_ui_semantics_t *semantics)

Apply custom accessibility metadata to the next element.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`semantics`	`const mk_ui_semantics_t *`	Metadata copied for the next declaration.

`mk_ui_set_theme`function

bool mk_ui_set_theme(mk_ui_t ui, const mk_ui_theme_t *theme)

Replace a context's active theme.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`theme`	`const mk_ui_theme_t *`	Theme to copy.

Returns True on success.

`mk_ui_slider_float`function

bool mk_ui_slider_float(mk_ui_t ui, mk_ui_id_t id, const char *label, float *value, float min, float max, float step, mk_ui_range_flags_t flags)

Declare a floating-point slider.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable widget ID.
`label`	`const char *`	UTF-8 label.
`value`	`float *`	Value read and updated.
`min`	`float`	Minimum value.
`max`	`float`	Maximum value.
`step`	`float`	Keyboard and navigation increment.
`flags`	`mk_ui_range_flags_t`	Presentation flags.

Returns True when value changed.

`mk_ui_slider_int`function

bool mk_ui_slider_int(mk_ui_t ui, mk_ui_id_t id, const char *label, int32_t *value, int32_t min, int32_t max, int32_t step, mk_ui_range_flags_t flags)

Declare an integer slider.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable widget ID.
`label`	`const char *`	UTF-8 label.
`value`	`int32_t *`	Value read and updated.
`min`	`int32_t`	Minimum value.
`max`	`int32_t`	Maximum value.
`step`	`int32_t`	Keyboard and navigation increment.
`flags`	`mk_ui_range_flags_t`	Presentation flags.

Returns True when value changed.

`mk_ui_spacer`function

void mk_ui_spacer(mk_ui_t ui, float width, float height)

Declare empty layout space.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`width`	`float`	Spacer width.
`height`	`float`	Spacer height.

`mk_ui_tab`function

bool mk_ui_tab(mk_ui_t ui, mk_ui_id_t id, const char *label, int32_t option, int32_t *selected)

Declare one tab selector.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable tab ID.
`label`	`const char *`	UTF-8 label.
`option`	`int32_t`	Value represented by this tab.
`selected`	`int32_t *`	Selected value read and updated.

Returns True when selection changed.

`mk_ui_tab_list_begin`function

bool mk_ui_tab_list_begin(mk_ui_t ui, mk_ui_id_t id, const mk_ui_box_desc_t *desc)

Begin a tab-list container.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable list ID.
`desc`	`const mk_ui_box_desc_t *`	Layout properties.

Returns True when the scope opened.

`mk_ui_tab_list_end`function

void mk_ui_tab_list_end(mk_ui_t ui)

End the innermost tab-list scope.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

`mk_ui_tab_panel_begin`function

bool mk_ui_tab_panel_begin(mk_ui_t ui, mk_ui_id_t id, bool active, const mk_ui_box_desc_t *desc)

Begin a conditionally active tab panel.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable panel ID.
`active`	`bool`	Whether the panel is selected.
`desc`	`const mk_ui_box_desc_t *`	Layout properties.

Returns True when panel content should be declared.

`mk_ui_tab_panel_end`function

void mk_ui_tab_panel_end(mk_ui_t ui)

End the innermost active tab-panel scope.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

`mk_ui_text`function

void mk_ui_text(mk_ui_t ui, mk_ui_id_t id, const mk_ui_text_desc_t *desc)

Lay out and draw shaped UTF-8 text.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable element ID.
`desc`	`const mk_ui_text_desc_t *`	Text content and style.

`mk_ui_text_desc_init`function

void mk_ui_text_desc_init(mk_ui_text_desc_t *desc)

Initialize a shaped-text descriptor.

Parameter	Type	Description
`desc`	`mk_ui_text_desc_t *`	Descriptor to initialize.

`mk_ui_text_edit`function

uint32_t mk_ui_text_edit(mk_ui_t ui, mk_ui_id_t id, const mk_ui_text_edit_desc_t *desc, mk_ui_text_buffer_t *buffer)

Declare an editable UTF-8 text field.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable widget ID.
`desc`	`const mk_ui_text_edit_desc_t *`	Editing and presentation options.
`buffer`	`mk_ui_text_buffer_t *`	Mutable text storage.

Returns ORed mk_ui_edit_result_t bits.

`mk_ui_text_edit_desc_init`function

void mk_ui_text_edit_desc_init(mk_ui_text_edit_desc_t *desc)

Initialize a text-edit descriptor.

Parameter	Type	Description
`desc`	`mk_ui_text_edit_desc_t *`	Descriptor to initialize.

`mk_ui_text_get_selection`function

bool mk_ui_text_get_selection(mk_ui_t ui, mk_ui_id_t id, uint32_t *byte_start, uint32_t *byte_end)

Read the current selectable-text byte range.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Text element ID.
`byte_start`	`uint32_t *`	Receives the first selected byte.
`byte_end`	`uint32_t *`	Receives one past the last selected byte.

Returns True when the element has a selection.

`mk_ui_theme_dark`function

mk_ui_theme_t mk_ui_theme_dark(void)

Construct the built-in dark theme.

Returns A complete dark theme.

`mk_ui_theme_high_contrast`function

mk_ui_theme_t mk_ui_theme_high_contrast(void)

Construct the built-in high-contrast theme.

Returns A complete high-contrast theme.

`mk_ui_theme_light`function

mk_ui_theme_t mk_ui_theme_light(void)

Construct the built-in light theme.

Returns A complete light theme.

`mk_ui_toggle`function

bool mk_ui_toggle(mk_ui_t ui, mk_ui_id_t id, const char *label, bool *value)

Declare a binary switch.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable widget ID.
`label`	`const char *`	UTF-8 label.
`value`	`bool *`	Value read and toggled on activation.

Returns True when value changed.

`mk_ui_virtual_list_begin`function

bool mk_ui_virtual_list_begin(mk_ui_t ui, mk_ui_id_t id, const mk_ui_virtual_list_desc_t *desc, mk_ui_virtual_range_t *range)

Begin a fixed-row virtualized scroll list.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`id`	`mk_ui_id_t`	Stable list ID.
`desc`	`const mk_ui_virtual_list_desc_t *`	List dimensions and row count.
`range`	`mk_ui_virtual_range_t *`	Receives the half-open row range to declare.

Returns True when the scope opened.

`mk_ui_virtual_list_desc_init`function

void mk_ui_virtual_list_desc_init(mk_ui_virtual_list_desc_t *desc)

Initialize a virtual-list descriptor.

Parameter	Type	Description
`desc`	`mk_ui_virtual_list_desc_t *`	Descriptor to initialize.

`mk_ui_virtual_list_end`function

void mk_ui_virtual_list_end(mk_ui_t ui)

End the current virtual list.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

`mk_ui_virtual_list_item_begin`function

bool mk_ui_virtual_list_item_begin(mk_ui_t ui, uint32_t index)

Begin one row in the current virtual list.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`index`	`uint32_t`	Logical row index.

Returns True when the row scope opened.

`mk_ui_virtual_list_item_end`function

void mk_ui_virtual_list_item_end(mk_ui_t ui)

End the current virtual-list row.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

`mk_ui_virtual_list_scroll_to`function

bool mk_ui_virtual_list_scroll_to(mk_ui_t ui, mk_ui_id_t list_id, uint32_t index, mk_ui_scroll_align_t align)

Request that a virtual-list row be brought into view.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.
`list_id`	`mk_ui_id_t`	Stable list ID.
`index`	`uint32_t`	Logical row index.
`align`	`mk_ui_scroll_align_t`	Desired viewport alignment.

Returns True when the request was accepted.

`mk_ui_want_capture_keyboard`function

bool mk_ui_want_capture_keyboard(mk_ui_t ui)

Query whether gameplay should yield keyboard input to the UI.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when keyboard input is captured.

`mk_ui_want_capture_pointer`function

bool mk_ui_want_capture_pointer(mk_ui_t ui)

Query whether gameplay should yield pointer input to the UI.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when pointer input is captured.

`mk_ui_want_capture_text`function

bool mk_ui_want_capture_text(mk_ui_t ui)

Query whether text input is active in the UI.

Parameter	Type	Description
`ui`	`mk_ui_t`	UI context.

Returns True when text input is captured.

Structs

`mk_ui_box_desc`struct

Layout and presentation properties for a UI box.

Field	Type	Description
`struct_size`	`uint32_t`	Structure size in bytes.
`struct_version`	`uint32_t`	MK_UI_BOX_DESC_VERSION.
`width`	`mk_ui_size_t`	Horizontal size constraint.
`height`	`mk_ui_size_t`	Vertical size constraint.
`padding`	`mk_ui_insets_t`	Insets between border and children.
`gap`	`float`	Spacing between adjacent children.
`direction`	`mk_ui_direction_t`	Child layout direction.
`align_x`	`mk_ui_align_t`	Horizontal child alignment.
`align_y`	`mk_ui_align_t`	Vertical child alignment.
`background_color`	`uint32_t`	Packed background color.
`border_color`	`uint32_t`	Packed border color.
`border_width`	`float`	Border thickness in logical pixels.
`corner_radius`	`float`	Corner radius in logical pixels.
`flags`	`uint32_t`	ORed mk_ui_box_flags_t values.

`mk_ui_desc`struct

Capacity, input, typography, theme, and navigation options for a UI context.

Field	Type	Description
`struct_size`	`uint32_t`	Structure size in bytes.
`struct_version`	`uint32_t`	MK_UI_DESC_VERSION.
`window`	`mk_window_t`	Window associated with automatic events and text input.
`manual_window_id`	`uint32_t`	Window ID accepted in manual mode.
`event_mode`	`mk_ui_event_mode_t`	Event integration mode.
`event_priority`	`int32_t`	Automatic event-listener priority.
`fonts`	`mk_font_family_t`	Font family for each semantic role.
`theme`	`mk_ui_theme_t`	Initial widget theme.
`follow_flags`	`uint32_t`	ORed mk_ui_follow_flags_t values.
`max_elements`	`uint32_t`	Maximum declarations in one frame.
`max_events`	`uint32_t`	Maximum queued input events.
`max_cached_text_layouts`	`uint32_t`	Text-layout cache capacity.
`text_cache_ttl_frames`	`uint32_t`	Frames an unused text layout remains cached.
`undo_capacity_bytes`	`uint32_t`	Per-editor undo storage budget.
`undo_max_operations`	`uint32_t`	Maximum retained undo operations.
`navigation_deadzone`	`float`	Directional navigation analog deadzone.
`navigation_repeat_delay`	`float`	Delay before held navigation repeats.
`navigation_repeat_rate`	`float`	Interval between repeated navigation actions.
`motion`	`mk_ui_motion_t`	Built-in transition settings.

`mk_ui_frame_desc`struct

Per-frame viewport, scale, and timing inputs.

Field	Type	Description
`struct_size`	`uint32_t`	Structure size in bytes.
`struct_version`	`uint32_t`	MK_UI_FRAME_DESC_VERSION.
`width`	`float`	Available logical width.
`height`	`float`	Available logical height.
`scale`	`float`	Logical-to-physical pixel scale.
`delta_time`	`float`	Wall-clock frame duration in seconds.

`mk_ui_frame_stats`struct

Diagnostics collected while building and rendering the last frame.

Field	Type	Description
`declarations`	`uint32_t`	Elements declared in the frame.
`draw_commands`	`uint32_t`	Renderer commands produced.
`duplicate_ids`	`uint32_t`	Duplicate stable IDs encountered.
`unbalanced_scopes`	`uint32_t`	Unterminated or over-popped scopes.
`clay_capacity_exhaustions`	`uint32_t`	Clay arena or element-capacity failures.
`dropped_events`	`uint32_t`	Input events dropped for capacity.
`state_evictions`	`uint32_t`	Retained widget-state entries evicted.
`text_layout_evictions`	`uint32_t`	Cached text layouts evicted.
`text_layout_failures`	`uint32_t`	Text layouts that could not be created.
`text_buffer_exhaustions`	`uint32_t`	Text edits rejected for buffer capacity.
`nested_clip_overflows`	`uint32_t`	Clip scopes beyond renderer capacity.
`text_cache_hits`	`uint32_t`	Reused cached text layouts.
`text_cache_misses`	`uint32_t`	Newly built text layouts.

`mk_ui_insets`struct

Logical inset values for the four sides of a box.

Field	Type	Description
`left`	`float`	Left inset.
`top`	`float`	Top inset.
`right`	`float`	Right inset.
`bottom`	`float`	Bottom inset.

`mk_ui_motion`struct

Durations and easing for built-in UI state transitions.

Field	Type	Description
`struct_size`	`uint32_t`	Structure size in bytes.
`struct_version`	`uint32_t`	MK_UI_MOTION_VERSION.
`hover_duration`	`float`	Hover transition duration in seconds.
`press_duration`	`float`	Press transition duration in seconds.
`focus_duration`	`float`	Focus transition duration in seconds.
`enter_duration`	`float`	Default appearance duration in seconds.
`exit_duration`	`float`	Default disappearance duration in seconds.
`ease`	`mk_ease_type`	Easing curve for transitions.

`mk_ui_navigation`struct

Directional and discrete navigation state for one feed operation.

Field	Type	Description
`x`	`float`	Horizontal navigation axis in the range -1 to 1.
`y`	`float`	Vertical navigation axis in the range -1 to 1.
`flags`	`uint32_t`	ORed mk_ui_navigation_flags_t values.

`mk_ui_presence_desc`struct

Enter and exit transition settings for conditionally present content.

Field	Type	Description
`struct_size`	`uint32_t`	Structure size in bytes.
`struct_version`	`uint32_t`	MK_UI_PRESENCE_DESC_VERSION.
`enter_duration`	`float`	Appearance duration in seconds.
`exit_duration`	`float`	Disappearance duration in seconds.
`ease`	`mk_ease_type`	Transition easing curve.
`block_input_on_exit`	`bool`	Keep exiting content modal until removed.

`mk_ui_semantics`struct

Accessibility metadata applied to the next declared element.

Field	Type	Description
`struct_size`	`uint32_t`	Structure size in bytes.
`struct_version`	`uint32_t`	MK_UI_SEMANTICS_VERSION.
`role`	`mk_accessibility_role_t`	Semantic role.
`label`	`const char *`	Accessible UTF-8 label.
`description`	`const char *`	Optional accessible description.
`value`	`const char *`	Optional textual value.
`states`	`uint32_t`	ORed accessibility-state bits.
`actions`	`uint32_t`	ORed supported accessibility actions.
`range_min`	`double`	Minimum numeric value.
`range_max`	`double`	Maximum numeric value.
`range_value`	`double`	Current numeric value.
`selection_start`	`int32_t`	Selected UTF-8 byte start, or a negative sentinel.
`selection_end`	`int32_t`	Selected UTF-8 byte end, or a negative sentinel.
`collection_index`	`uint32_t`	Zero-based index within a collection.
`collection_count`	`uint32_t`	Number of items in the collection.
`live`	`mk_accessibility_live_t`	Live-region announcement behavior.

`mk_ui_size`struct

Size constraint for one UI box dimension.

Field	Type	Description
`kind`	`mk_ui_size_kind_t`	Constraint model.
`value`	`float`	Fixed size or parent fraction, depending on kind.
`min`	`float`	Minimum resolved size.
`max`	`float`	Maximum resolved size.

`mk_ui_text_buffer`struct

Mutable UTF-8 storage used by text-edit widgets.

Field	Type	Description
`data`	`char *`	Writable UTF-8 bytes.
`length`	`size_t`	Current length in bytes, excluding any terminator.
`capacity`	`size_t`	Writable buffer capacity.
`grow`	`bool(*)`	Optional callback that grows data to at least required bytes.
`user_data`	`void *`	Caller context passed to grow.

`mk_ui_text_desc`struct

Shaped-text content, style, wrapping, and selection options.

Field	Type	Description
`struct_size`	`uint32_t`	Structure size in bytes.
`struct_version`	`uint32_t`	MK_UI_TEXT_DESC_VERSION.
`text`	`const char *`	UTF-8 content.
`text_len`	`size_t`	Content length in bytes.
`font_role`	`mk_ui_font_role_t`	Base font-family role.
`size_px`	`float`	Font size in logical pixels.
`line_height`	`float`	Line-height multiplier or zero for default.
`color`	`uint32_t`	Packed foreground color.
`background_color`	`uint32_t`	Packed selection/background color.
`wrap`	`mk_text_wrap_t`	Line-wrapping policy.
`overflow`	`mk_text_overflow_t`	Overflow policy.
`align`	`mk_text_paragraph_align_t`	Paragraph alignment.
`direction`	`mk_text_direction_t`	Base text direction.
`locale`	`const char *`	Optional BCP 47 locale.
`max_lines`	`uint32_t`	Maximum lines, or zero for unlimited.
`grow_width`	`bool`	Prefer unwrapped width when space permits.
`spans`	`const mk_text_style_span_t *`	Optional inline style spans.
`span_count`	`uint32_t`	Number of entries in spans.
`flags`	`uint32_t`	ORed mk_ui_text_flags_t values.

`mk_ui_text_edit_desc`struct

Presentation and input-mode options for an editable text field.

Field	Type	Description
`struct_size`	`uint32_t`	Structure size in bytes.
`struct_version`	`uint32_t`	MK_UI_TEXT_EDIT_DESC_VERSION.
`placeholder`	`const char *`	UTF-8 placeholder shown for an empty buffer.
`font_role`	`mk_ui_font_role_t`	Font-family role.
`size_px`	`float`	Font size in logical pixels.
`flags`	`uint32_t`	ORed mk_ui_text_edit_flags_t values.
`input_type`	`mk_text_input_type`	Platform keyboard/input hint.

`mk_ui_theme`struct

Complete color and size palette for built-in widgets.

Field	Type	Description
`background`	`uint32_t`	Root background color.
`surface`	`uint32_t`	Default surface color.
`surface_hovered`	`uint32_t`	Hovered surface color.
`surface_pressed`	`uint32_t`	Pressed surface color.
`text`	`uint32_t`	Primary text color.
`text_muted`	`uint32_t`	Secondary text color.
`accent`	`uint32_t`	Accent color.
`border`	`uint32_t`	Border color.
`danger`	`uint32_t`	Error and destructive-action color.
`body_size`	`float`	Body font size in logical pixels.
`display_size`	`float`	Display font size in logical pixels.
`mono_size`	`float`	Monospaced font size in logical pixels.
`control_height`	`float`	Default control height.
`spacing`	`float`	Default spacing unit.
`corner_radius`	`float`	Default control corner radius.

`mk_ui_virtual_list_desc`struct

Fixed-row virtual-list layout and capacity options.

Field	Type	Description
`struct_size`	`uint32_t`	Structure size in bytes.
`struct_version`	`uint32_t`	MK_UI_VIRTUAL_LIST_DESC_VERSION.
`box`	`mk_ui_box_desc_t`	Scroll-container layout and presentation.
`item_count`	`uint32_t`	Total logical row count.
`item_height`	`float`	Fixed row height in logical pixels.
`item_gap`	`float`	Spacing between rows.
`overscan`	`uint32_t`	Extra rows declared beyond each viewport edge.

`mk_ui_virtual_range`struct

Half-open range of virtual-list rows that should be declared.

Field	Type	Description
`first`	`uint32_t`	First visible or overscanned row index.
`last`	`uint32_t`	One past the last row index.

Enums

`mk_ui_align`enum

Alignment within a UI container axis.

Value	Description
`MK_UI_ALIGN_START`	Align to the logical start.
`MK_UI_ALIGN_CENTER`	Center within available space.
`MK_UI_ALIGN_END`	Align to the logical end.

`mk_ui_box_flags`enum

Clipping, scrolling, and modal behavior for a box.

Value	Description
`MK_UI_BOX_NONE`	No optional box behavior.
`MK_UI_BOX_CLIP_X`	Clip horizontally to the content bounds.
`MK_UI_BOX_CLIP_Y`	Clip vertically to the content bounds.
`MK_UI_BOX_SCROLL_X`	Allow horizontal scrolling.
`MK_UI_BOX_SCROLL_Y`	Allow vertical scrolling.
`MK_UI_BOX_MODAL`	Give this layer modal input priority.

`mk_ui_color_role`enum

Theme color slots addressable by the style stack.

Value	Description
`MK_UI_COLOR_BACKGROUND`	Root background.
`MK_UI_COLOR_SURFACE`	Default control and panel surface.
`MK_UI_COLOR_SURFACE_HOVERED`	Hovered surface.
`MK_UI_COLOR_SURFACE_PRESSED`	Pressed surface.
`MK_UI_COLOR_TEXT`	Primary text.
`MK_UI_COLOR_TEXT_MUTED`	Secondary text.
`MK_UI_COLOR_ACCENT`	Accent and focus indication.
`MK_UI_COLOR_BORDER`	Control and panel borders.
`MK_UI_COLOR_DANGER`	Destructive or error indication.

`mk_ui_direction`enum

Main-axis direction for child layout.

Value	Description
`MK_UI_TOP_TO_BOTTOM`	Lay out children vertically.
`MK_UI_LEFT_TO_RIGHT`	Lay out children horizontally.

`mk_ui_edit_result`enum

Bitmask returned by mk_ui_text_edit.

Value	Description
`MK_UI_EDIT_NONE`	No edit event occurred.
`MK_UI_EDIT_CHANGED`	Buffer content changed.
`MK_UI_EDIT_SUBMITTED`	The user submitted a single-line field.
`MK_UI_EDIT_ACTIVATED`	The editor gained active input.
`MK_UI_EDIT_DEACTIVATED`	The editor lost active input.

`mk_ui_event_mode`enum

Selects automatic event subscription or manual event feeding.

Value	Description
`MK_UI_EVENTS_AUTOMATIC`	Subscribe to window events during context lifetime.
`MK_UI_EVENTS_MANUAL`	Accept events only through mk_ui_handle_event.

`mk_ui_float_role`enum

Theme scalar slots addressable by the style stack.

Value	Description
`MK_UI_FLOAT_BODY_SIZE`	Body font size.
`MK_UI_FLOAT_DISPLAY_SIZE`	Display font size.
`MK_UI_FLOAT_MONO_SIZE`	Monospaced font size.
`MK_UI_FLOAT_CONTROL_HEIGHT`	Default interactive-control height.
`MK_UI_FLOAT_SPACING`	Default layout spacing.
`MK_UI_FLOAT_CORNER_RADIUS`	Default corner radius.

`mk_ui_follow_flags`enum

System preferences a UI context follows dynamically.

Value	Description
`MK_UI_FOLLOW_THEME`	Follow the platform light/dark theme.
`MK_UI_FOLLOW_TEXT_SCALE`	Follow the platform text scale.
`MK_UI_FOLLOW_HIGH_CONTRAST`	Follow the high-contrast preference.
`MK_UI_FOLLOW_REDUCED_MOTION`	Disable transitions when requested.
`MK_UI_FOLLOW_SAFE_AREA`	Inset content by platform safe areas.
`MK_UI_FOLLOW_ALL`	Follow every supported preference.

`mk_ui_font_role`enum

Semantic font-family roles used by UI text.

Value	Description
`MK_UI_FONT_BODY`	Default interface copy and labels.
`MK_UI_FONT_DISPLAY`	Headings and display text.
`MK_UI_FONT_MONO`	Monospaced values and code.
`MK_UI_FONT_ROLE_COUNT`	Number of font roles.

`mk_ui_navigation_flags`enum

Discrete navigation actions supplied to a UI context.

Value	Description
`MK_UI_NAV_NONE`	No discrete action.
`MK_UI_NAV_NEXT`	Move to the next declaration-order item.
`MK_UI_NAV_PREVIOUS`	Move to the previous declaration-order item.
`MK_UI_NAV_ACTIVATE`	Activate the focused item.
`MK_UI_NAV_CANCEL`	Cancel the current interaction or modal.

`mk_ui_range_flags`enum

Presentation options for range and numeric widgets.

Value	Description
`MK_UI_RANGE_NONE`	Draw no value fill.
`MK_UI_RANGE_FILL`	Fill the control background to the current value.

`mk_ui_scroll_align`enum

Alignment used when scrolling a virtual-list item into view.

Value	Description
`MK_UI_SCROLL_NEAREST`	Move only enough to reveal the item.
`MK_UI_SCROLL_START`	Align the item with the viewport start.
`MK_UI_SCROLL_CENTER`	Center the item in the viewport.
`MK_UI_SCROLL_END`	Align the item with the viewport end.

`mk_ui_size_kind`enum

Constraint model for one box dimension.

Value	Description
`MK_UI_SIZE_FIT`	Fit the content within optional limits.
`MK_UI_SIZE_GROW`	Consume available space within optional limits.
`MK_UI_SIZE_FIXED`	Use a fixed logical-pixel size.
`MK_UI_SIZE_PERCENT`	Use a fraction of the parent dimension.

`mk_ui_text_edit_flags`enum

Behavior flags for an editable text field.

Value	Description
`MK_UI_TEXT_EDIT_NONE`	Standard single-line editing.
`MK_UI_TEXT_EDIT_MULTILINE`	Accept and lay out newline characters.
`MK_UI_TEXT_EDIT_READ_ONLY`	Allow selection without mutation.
`MK_UI_TEXT_EDIT_PASSWORD`	Mask displayed content.

`mk_ui_text_flags`enum

Optional behavior for static text.

Value	Description
`MK_UI_TEXT_NONE`	Non-interactive static text.
`MK_UI_TEXT_SELECTABLE`	Allow pointer and keyboard selection.

Typedefs

`mk_ui_align_t`typedef

typedef enum mk_ui_align mk_ui_align_t

Alignment within a UI container axis.

`mk_ui_box_desc_t`typedef

typedef struct mk_ui_box_desc mk_ui_box_desc_t

Layout and presentation properties for a UI box.

`mk_ui_box_flags_t`typedef

typedef enum mk_ui_box_flags mk_ui_box_flags_t

Clipping, scrolling, and modal behavior for a box.

`mk_ui_color_role_t`typedef

typedef enum mk_ui_color_role mk_ui_color_role_t

Theme color slots addressable by the style stack.

`mk_ui_desc_t`typedef

typedef struct mk_ui_desc mk_ui_desc_t

Capacity, input, typography, theme, and navigation options for a UI context.

`mk_ui_direction_t`typedef

typedef enum mk_ui_direction mk_ui_direction_t

Main-axis direction for child layout.

`mk_ui_edit_result_t`typedef

typedef enum mk_ui_edit_result mk_ui_edit_result_t

Bitmask returned by mk_ui_text_edit.

`mk_ui_event_mode_t`typedef

typedef enum mk_ui_event_mode mk_ui_event_mode_t

Selects automatic event subscription or manual event feeding.

`mk_ui_float_role_t`typedef

typedef enum mk_ui_float_role mk_ui_float_role_t

Theme scalar slots addressable by the style stack.

`mk_ui_follow_flags_t`typedef

typedef enum mk_ui_follow_flags mk_ui_follow_flags_t

System preferences a UI context follows dynamically.

`mk_ui_font_role_t`typedef

typedef enum mk_ui_font_role mk_ui_font_role_t

Semantic font-family roles used by UI text.

`mk_ui_frame_desc_t`typedef

typedef struct mk_ui_frame_desc mk_ui_frame_desc_t

Per-frame viewport, scale, and timing inputs.

`mk_ui_frame_stats_t`typedef

typedef struct mk_ui_frame_stats mk_ui_frame_stats_t

Diagnostics collected while building and rendering the last frame.

`mk_ui_id_t`typedef

typedef uint64_t mk_ui_id_t

Stable identifier for a UI element within its ID scope.

`mk_ui_insets_t`typedef

typedef struct mk_ui_insets mk_ui_insets_t

Logical inset values for the four sides of a box.

`mk_ui_motion_t`typedef

typedef struct mk_ui_motion mk_ui_motion_t

Durations and easing for built-in UI state transitions.

`mk_ui_navigation_flags_t`typedef

typedef enum mk_ui_navigation_flags mk_ui_navigation_flags_t

Discrete navigation actions supplied to a UI context.

`mk_ui_navigation_t`typedef

typedef struct mk_ui_navigation mk_ui_navigation_t

Directional and discrete navigation state for one feed operation.

`mk_ui_presence_desc_t`typedef

typedef struct mk_ui_presence_desc mk_ui_presence_desc_t

Enter and exit transition settings for conditionally present content.

`mk_ui_range_flags_t`typedef

typedef enum mk_ui_range_flags mk_ui_range_flags_t

Presentation options for range and numeric widgets.

`mk_ui_scroll_align_t`typedef

typedef enum mk_ui_scroll_align mk_ui_scroll_align_t

Alignment used when scrolling a virtual-list item into view.

`mk_ui_semantics_t`typedef

typedef struct mk_ui_semantics mk_ui_semantics_t

Accessibility metadata applied to the next declared element.

`mk_ui_size_kind_t`typedef

typedef enum mk_ui_size_kind mk_ui_size_kind_t

Constraint model for one box dimension.

`mk_ui_size_t`typedef

typedef struct mk_ui_size mk_ui_size_t

Size constraint for one UI box dimension.

`mk_ui_t`typedef

typedef struct mk_ui* mk_ui_t

Opaque immediate-mode UI context handle.

`mk_ui_text_buffer_t`typedef

typedef struct mk_ui_text_buffer mk_ui_text_buffer_t

Mutable UTF-8 storage used by text-edit widgets.

`mk_ui_text_desc_t`typedef

typedef struct mk_ui_text_desc mk_ui_text_desc_t

Shaped-text content, style, wrapping, and selection options.

`mk_ui_text_edit_desc_t`typedef

typedef struct mk_ui_text_edit_desc mk_ui_text_edit_desc_t

Presentation and input-mode options for an editable text field.

`mk_ui_text_edit_flags_t`typedef

typedef enum mk_ui_text_edit_flags mk_ui_text_edit_flags_t

Behavior flags for an editable text field.

`mk_ui_text_flags_t`typedef

typedef enum mk_ui_text_flags mk_ui_text_flags_t

Optional behavior for static text.

`mk_ui_theme_t`typedef

typedef struct mk_ui_theme mk_ui_theme_t

Complete color and size palette for built-in widgets.

`mk_ui_virtual_list_desc_t`typedef

typedef struct mk_ui_virtual_list_desc mk_ui_virtual_list_desc_t

Fixed-row virtual-list layout and capacity options.

`mk_ui_virtual_range_t`typedef

typedef struct mk_ui_virtual_range mk_ui_virtual_range_t

Half-open range of virtual-list rows that should be declared.

Macros

`MK_UI_BOX_DESC_VERSION`define

MK_UI_BOX_DESC_VERSION

ABI version for mk_ui_box_desc_t.

`MK_UI_DESC_VERSION`define

MK_UI_DESC_VERSION

ABI version for mk_ui_desc_t.

`MK_UI_EVENT_PRIORITY_DEFAULT`define

MK_UI_EVENT_PRIORITY_DEFAULT

Default event-listener priority used by automatic UI input.

`MK_UI_FRAME_DESC_VERSION`define

MK_UI_FRAME_DESC_VERSION

ABI version for mk_ui_frame_desc_t.

`MK_UI_ID_INVALID`define

MK_UI_ID_INVALID

Invalid UI element identifier.

`MK_UI_INVALID`define

MK_UI_INVALID

Invalid UI context handle.

`MK_UI_MOTION_VERSION`define

MK_UI_MOTION_VERSION

ABI version for mk_ui_motion_t.

`MK_UI_PRESENCE_DESC_VERSION`define

MK_UI_PRESENCE_DESC_VERSION

ABI version for mk_ui_presence_desc_t.

`MK_UI_SEMANTICS_VERSION`define

MK_UI_SEMANTICS_VERSION

ABI version for mk_ui_semantics_t.

`MK_UI_TEXT_DESC_VERSION`define

MK_UI_TEXT_DESC_VERSION

ABI version for mk_ui_text_desc_t.

`MK_UI_TEXT_EDIT_DESC_VERSION`define

MK_UI_TEXT_EDIT_DESC_VERSION

ABI version for mk_ui_text_edit_desc_t.

`MK_UI_VIRTUAL_LIST_DESC_VERSION`define

MK_UI_VIRTUAL_LIST_DESC_VERSION

ABI version for mk_ui_virtual_list_desc_t.

ui.h

Functions

mk_ui_beginfunction

mk_ui_box_beginfunction

mk_ui_box_desc_initfunction

mk_ui_box_endfunction

mk_ui_buttonfunction

mk_ui_checkboxfunction

mk_ui_clear_focusfunction

mk_ui_column_beginfunction

mk_ui_createfunction

mk_ui_desc_initfunction

mk_ui_destroyfunction

mk_ui_endfunction

mk_ui_feed_navigationfunction

mk_ui_fitfunction

mk_ui_fixedfunction

mk_ui_focusedfunction

mk_ui_frame_desc_initfunction

mk_ui_get_frame_statsfunction

mk_ui_get_motionfunction

mk_ui_get_themefunction

mk_ui_growfunction

mk_ui_handle_eventfunction

mk_ui_id_strfunction

mk_ui_id_str_nfunction

mk_ui_id_u64function

mk_ui_imagefunction

mk_ui_item_activefunction

mk_ui_item_enabledfunction

mk_ui_item_focusedfunction

mk_ui_item_hoveredfunction

mk_ui_item_pressedfunction

mk_ui_item_visiblefunction

mk_ui_motion_initfunction

mk_ui_number_floatfunction

mk_ui_number_intfunction

mk_ui_percentfunction

mk_ui_pop_idfunction

mk_ui_pop_stylefunction

mk_ui_presence_beginfunction

mk_ui_presence_desc_initfunction

mk_ui_presence_endfunction

mk_ui_progressfunction

mk_ui_push_colorfunction

mk_ui_push_floatfunction

mk_ui_push_fontfunction

mk_ui_push_id_strfunction

mk_ui_push_id_u64function

mk_ui_radiofunction

mk_ui_renderfunction

mk_ui_request_focusfunction

mk_ui_row_beginfunction

mk_ui_scroll_beginfunction

mk_ui_semantics_initfunction

mk_ui_separatorfunction

mk_ui_set_motionfunction

mk_ui_set_next_semanticsfunction

mk_ui_set_themefunction

mk_ui_slider_floatfunction

mk_ui_slider_intfunction

mk_ui_spacerfunction

mk_ui_tabfunction

mk_ui_tab_list_beginfunction

mk_ui_tab_list_endfunction

mk_ui_tab_panel_beginfunction

mk_ui_tab_panel_endfunction

mk_ui_textfunction

mk_ui_text_desc_initfunction

mk_ui_text_editfunction

mk_ui_text_edit_desc_initfunction

mk_ui_text_get_selectionfunction

mk_ui_theme_darkfunction

mk_ui_theme_high_contrastfunction

mk_ui_theme_lightfunction

mk_ui_togglefunction

mk_ui_virtual_list_beginfunction

mk_ui_virtual_list_desc_initfunction

mk_ui_virtual_list_endfunction

mk_ui_virtual_list_item_beginfunction

`mk_ui_begin`function

`mk_ui_box_begin`function

`mk_ui_box_desc_init`function

`mk_ui_box_end`function

`mk_ui_button`function

`mk_ui_checkbox`function

`mk_ui_clear_focus`function

`mk_ui_column_begin`function

`mk_ui_create`function

`mk_ui_desc_init`function

`mk_ui_destroy`function

`mk_ui_end`function

`mk_ui_feed_navigation`function

`mk_ui_fit`function

`mk_ui_fixed`function

`mk_ui_focused`function

`mk_ui_frame_desc_init`function

`mk_ui_get_frame_stats`function

`mk_ui_get_motion`function

`mk_ui_get_theme`function

`mk_ui_grow`function

`mk_ui_handle_event`function

`mk_ui_id_str`function

`mk_ui_id_str_n`function

`mk_ui_id_u64`function

`mk_ui_image`function

`mk_ui_item_active`function

`mk_ui_item_enabled`function

`mk_ui_item_focused`function

`mk_ui_item_hovered`function

`mk_ui_item_pressed`function

`mk_ui_item_visible`function

`mk_ui_motion_init`function

`mk_ui_number_float`function

`mk_ui_number_int`function

`mk_ui_percent`function

`mk_ui_pop_id`function

`mk_ui_pop_style`function

`mk_ui_presence_begin`function

`mk_ui_presence_desc_init`function

`mk_ui_presence_end`function

`mk_ui_progress`function

`mk_ui_push_color`function

`mk_ui_push_float`function

`mk_ui_push_font`function

`mk_ui_push_id_str`function

`mk_ui_push_id_u64`function

`mk_ui_radio`function

`mk_ui_render`function

`mk_ui_request_focus`function

`mk_ui_row_begin`function

`mk_ui_scroll_begin`function

`mk_ui_semantics_init`function

`mk_ui_separator`function

`mk_ui_set_motion`function

`mk_ui_set_next_semantics`function

`mk_ui_set_theme`function

`mk_ui_slider_float`function

`mk_ui_slider_int`function

`mk_ui_spacer`function

`mk_ui_tab`function

`mk_ui_tab_list_begin`function

`mk_ui_tab_list_end`function

`mk_ui_tab_panel_begin`function

`mk_ui_tab_panel_end`function

`mk_ui_text`function

`mk_ui_text_desc_init`function

`mk_ui_text_edit`function

`mk_ui_text_edit_desc_init`function

`mk_ui_text_get_selection`function

`mk_ui_theme_dark`function

`mk_ui_theme_high_contrast`function

`mk_ui_theme_light`function

`mk_ui_toggle`function

`mk_ui_virtual_list_begin`function

`mk_ui_virtual_list_desc_init`function

`mk_ui_virtual_list_end`function

`mk_ui_virtual_list_item_begin`function

`mk_ui_virtual_list_item_end`function

`mk_ui_virtual_list_scroll_to`function