Skip to content

UI API (hyperion.ui.*)

Text and layout

Function Return Throws Description
hyperion.ui.text(text) void No Render text.
hyperion.ui.textColored(r, g, b, a, text) void No Render colored text (0-255).
hyperion.ui.textDisabled(text) void No Render disabled text.
hyperion.ui.separator() void No Horizontal separator.
hyperion.ui.spacing() void No Vertical spacing.
hyperion.ui.sameLine(offset?) void No Place next item on same line.
hyperion.ui.newLine() void No Start a new line.
hyperion.ui.dummy(w, h) void No Invisible spacer.

Inputs

Most inputs return { value = <newValue>, changed = <bool> }.

Function Return Throws Description
hyperion.ui.checkbox(label, value) { value, changed } No Checkbox.
hyperion.ui.sliderFloat(label, value, min, max) { value, changed } No Float slider.
hyperion.ui.sliderInt(label, value, min, max) { value, changed } No Integer slider.
hyperion.ui.inputText(label, text, maxLen?) { value, changed } No Text input.
hyperion.ui.button(label) bool No Button.
hyperion.ui.smallButton(label) bool No Small button.
hyperion.ui.combo(label, currentItem, items) { value, changed } No Combo box.

Collapsing sections

Function Return Throws Description
hyperion.ui.collapsingHeader(label) bool No Collapsing header.
hyperion.ui.treeNode(label) bool No Tree node.
hyperion.ui.treePop() void No Close tree node.

Layout helpers

Function Return Throws Description
hyperion.ui.beginGroup() void No Begin group.
hyperion.ui.endGroup() void No End group.
hyperion.ui.indent(w?) void No Indent (default width).
hyperion.ui.unindent(w?) void No Unindent (default width).