On this page

ui.h

The element api in namespace ui. Each frame you declare a tree of boxes, the layout engine sizes it and the engine paints it.

#include "isolenui/ui/ui.h". The guide starts at How widgets work.

Pinch and zoom

Explained in Pinch zoom.

ui::take_pinchui::pinch_taken_atui::fit_box_atui::set_zoomui::zoom_of

Hit regions

Explained in Transparent windows.

ui::solid_at

Context and frame

Explained in How widgets work.

ui::ctxui::ctx_createui::ctx_destroyui::beginui::endui::theme_ofui::input_ofui::dtui::clockui::busyui::frame_ofui::bind_deviceui::art_size_fnui::bind_sizesui::font_ofui::font_handle

Elements, ids and keys

Explained in How widgets work.

ui::openui::open_gridui::closeui_boxui_gridui_catui_cat_ui_box_at_ui_grid_at_ui::keyui::next_idui::last_idui::rect_ofui::layout_ofui::last_node

Boxes and styles

Explained in Styles.

ui::styleui::rowui::colui::stackui::style::bgui::style::opacityui::style::inertui::style::dimui::style::mutedui::style::gradientui::style::borderui::style::roundui::style::glassyui::style::breatheui::style::on_layer

ui::style layout chain

Explained in Flexbox.

ui::style::widthui::style::heightui::style::sizeui::style::growui::style::shrinkui::style::padui::style::gapui::style::wrapui::style::reverseui::style::justifyui::style::itemsui::style::centreui::style::selfui::style::placeui::style::columnui::style::rowui::style::spanui::style::area

Views and overflow

Explained in Overflow and views.

ui::viewui::style::overflowui::style::scrollbarui::style::clips

Floating and offset

Explained in Floating and shift.

ui::style::floatsui::style::offset

Colours

Explained in Colours.

ui::colorui::rgbui::rgbaui::with_alphaui::operator""_rgb

Themes

Explained in Themes.

ui::themeui::theme_hud

Cursors

Explained in Cursors.

ui::cursor_shapeui::cursor_arrowui::cursor_textui::cursor_handui::cursor_resize_xui::cursor_resize_yui::cursor_moveui::cursor_crosshairui::cursor_not_allowedui::cursor_countui::cursorui::cursor_of

Shadows and elevation

Explained in Shadows and elevation.

ui::shadow_layerui::elevationui::elevui::elev_noneui::elev_smui::elev_mdui::elev_lgui::elev_countui::theme::liftui::theme_liftui::dropui::style::lift

Text styles

Explained in Text styles.

ui::text_styleui::bodyui::captionui::headui::dimui::monoui::text_style::sizeui::text_style::inui::text_style::inkui::text_style::trackedui::text_style::alignedui::text_style::wraps

Input and keys

Explained in Keyboard and input.

ui::inputui::input::right_downui::input::pinchui::input::wheel_points_yui::input::wheel_phaseui::padui::pad::fingersui::pad::liftedui::pad::momentumui::pad::momentum_endUI_INPUT_QUEUEui::vkui::vk::backui::vk::tabui::vk::enterui::vk::escapeui::vk::spaceui::vk::page_upui::vk::page_downui::vk::endui::vk::homeui::vk::leftui::vk::upui::vk::rightui::vk::downui::vk::insertui::vk::delui::vk::f1

Content and spacing

Explained in Content and spacing.

ui::textui::textfui::spacerui::gapui::ruleui::imageui::svgui::fitui::fit_containui::fit_coverui::fit_stretch

Interaction

Explained in Interaction.

ui::hitui::interactui::focusui::focusedui::easeui::canvasui::paint_fnui::shield

Theme swaps and direction

Explained in Themes.

ui::set_themeui::theme_looksui::theme::looksui::theme::own_looksui::theme::directionui::theme::chart

Direction

Explained in Direction and bidi.

ui::dirui::dir_inheritui::dir_ltrui::dir_rtlui::directionui::dir_ofui::style::ltrui::style::rtlui::style::pad_inline

States and looks

Explained in States and looks.

ui::stateui::state_hoveredui::state_pressedui::state_focusedui::state_focus_visibleui::state_checkedui::state_openui::state_disabledui::state_countui::look_fieldui::look_fillui::look_strokeui::look_inkui::look_widthui::look_opacityui::look_stepui::lookui::roleui::role_noneui::role_linkui::role_countui::shadeui::style::asui::style::skinnedui::style::partui::style::disableui::text_style::asui::state_ofui::set_stateui::mirrorui::shade_of_lastui::resolve

Portals and popovers

Explained in Portals and popovers.

ui::portalui_portalui::popoverui_popoverui::paint_on_topui::set_overlay_areaui::overlay_areaui::anchorui::anchor_specui::anchor_spec::onui::anchor_spec::gapui::anchor_spec::alongui::anchor_spec::withinui::anchor_spec::withui::anchor_spec::withoutui::sideui::side_bottomui::side_topui::side_rightui::side_leftui::side_startui::side_endui::anchor_flagui::anchor_flipui::anchor_shiftui::anchor_match_widthui::anchor_min_widthui::anchor_fitui::anchor_keepui::placement

Focus and tab order

Explained in Focus, scopes and modals.

ui::focus_idui::focus_visibleui::focusableui::autofocusui::keep_tabui::keep_focusui::captured

Scopes and modals

Explained in Focus, scopes and modals.

ui::scope_beginui::scope_endui::scope_topui::scope_flagui::scope_trapui::scope_blockui::scope_escapeui::scope_outsideui::scope_modalui::scope_eventsui::modal_beginui::modal_endui_modal

State store

Explained in State store.

ui::storeui::drop_fnui::store_statsui::store_stats_of

Redraw and wake ups

Explained in Redraw and wake ups.

ui::redrawui::redraw_afterui::redraw_inui::text_inputui::text_input_ofui::post_charsui::post_key

Scrolling from code

Explained in Overflow and views.

ui::scroll_toui::scroll_ofui::scroll_posui::snapui::bar_lookui::take_wheel

Input fields

Explained in Keyboard and input.

ui::input::context_pressedui::input::key_modsui::input::nowui::input::commitui::input::commit_lenui::input::preeditui::input::preedit_lenui::input::preedit_caret

Virtual lists

Explained in Virtual lists.

ui::list_beginui::list_endui::list_openui::list_pinui::pin_flagui::pin_firstui::pin_last

Example

widgets_overview.cpp
#include "isolenui/ui/ui.h"
#include "isolenui/kit/kit.h"

// every element gets an id from its position among its siblings, a loop body
// keys each row so a row keeps its state when rows are added above it
static void track_list(ui::ctx* u, const char* const* titles, const bool* live,
                       uint32_t count)
{
    ui_box(u, ui::col().gap(4.0f))
    {
        for (uint32_t i = 0; i < count; ++i) {
            ui::key(u, titles[i]);
            ui_box(u, ui::row().gap(8.0f).items(lay_align_centre))
            {
                ui::dot(u, live[i] ? 0xff6ec864u : 0xff555555u, live[i]);
                ui::text(u, titles[i], ui::body(u));
            }
        }
    }
}

// rect_of answers from last frame's solve, so a box can size a sibling to
// what it measured, the first frame an id exists it is empty
static void measured_header(ui::ctx* u)
{
    ui::key(u, "title");
    const uint64_t title_id = ui::next_id(u);
    ui_box(u, ui::row()) { ui::text(u, "a title of any width", ui::head(u)); }

    const lay_box r = ui::rect_of(u, title_id);
    ui_box(u, ui::col().width(r.w > 0.0f ? r.w : 1.0f).height(2.0f).bg(0xffe5648au)) {}

    ui::textf(u, ui::caption(u), "frame %u, %s", ui::frame_of(u),
              ui::busy(u) ? "animating" : "idle");
}

// a host that drives the ui itself, what isolen_run does for you
static void host_frame(ui::ctx* u, const ui::input* in, gfx_list* out,
                       float w, float h, float dt, float time)
{
    ui::begin(u, in, w, h, dt, time);
    ui_box(u, ui::view().width(w).height(h).pad(24.0f))
    {
        ui::text(u, "declared, solved and painted by end", ui::body(u));
    }
    ui::end(u, out);
}

Last updated 23 October 2026