imgui - REFramework

Bindings for ImGui. Can be used in the re.on_draw_ui callback.

Some methods can be used in re.on_frame if begin_window/end_window is used.

Example:

local thing = 1
local things = { "hi", "hello", "howdy", "hola", "aloha" }

re.on_draw_ui(function()
    if imgui.button("Whats up") then 
        thing = 1
    end

    local changed, new_thing = imgui.combo("Greeting", thing, things) 
    if changed then thing = new_thing end
end)

Methods

`imgui.begin_window(name, open, flags)`

Creates a new window with the title of name.

open is a bool. Can be nil. If not nil, a close button will be shown in the top right of the window.

flags - ImGuiWindowFlags.

begin_window must have a corresponding end_window call.

This function may only be called in on_frame, not on_draw_ui.

Returns a bool. Returns false if the user wants to close the window.

`imgui.end_window()`

Ends the last begin_window call. Required.

`imgui.begin_child_window(size, border, flags)`

size - Vector2f

border - bool

flags - ImGuiWindowFlags

`imgui.end_rect(additional_size, rounding)`

These two methods draw a rectangle around the elements between begin_rect and end_rect

`imgui.begin_disabled(disabled=true)`

`imgui.end_disabled()`

These two methods will disable and darken elements in between it.

`imgui.button(label, size)`

Draws a button with label text, and optional size.

size is a Vector2f or a size 2 array.

Returns true when the user presses the button.

`imgui.invisible_button(id, size, flags)`

size is a Vector2f or a size 2 array.

`imgui.text_colored(text, color)`

Draws text with color.

color is an integer color in the form ARGB.

`imgui.checkbox(label, value)`

Returns a tuple of changed, value

`imgui.drag_float(label, value, speed, min, max, display_format (optional))`

Returns a tuple of changed, value

`imgui.drag_float2(label, value (Vector2f), speed, min, max, display_format (optional))`

Returns a tuple of changed, value

`imgui.drag_float3(label, value (Vector3f), speed, min, max, display_format (optional))`

Returns a tuple of changed, value

`imgui.drag_float4(label, value (Vector4f), speed, min, max, display_format (optional))`

Returns a tuple of changed, value

`imgui.drag_int(label, value, speed, min, max, display_format (optional))`

Returns a tuple of changed, value

`imgui.slider_float(label, value, min, max, display_format (optional))`

Returns a tuple of changed, value

`imgui.slider_int(label, value, min, max, display_format (optional))`

Returns a tuple of changed, value

`imgui.input_text(label, value, flags (optional))`

Returns a tuple of changed, value, selection_start, selection_end

`imgui.input_text_multiline(label, value, size, flags (optional))`

Returns a tuple of changed, value, selection_start, selection_end

`imgui.combo(label, selection, values)`

Returns a tuple of changed, value.

changed = true when selection changes.

value is the selection index within values (a table)

values can be a table with any type of keys, as long as the values are strings.

`imgui.color_picker(label, color, flags)`

Returns a tuple of changed, value. color is an integer color in the form ABGR which imgui and draw APIs expect.

`imgui.color_picker_argb(label, color, flags)`

Returns a tuple of changed, value. color is an integer color in the form ARGB.

`imgui.color_picker3(label, color (Vector3f), flags)`

Returns a tuple of changed, value

`imgui.color_picker4(label, color (Vector4f), flags)`

Returns a tuple of changed, value

`imgui.color_edit(label, color, flags)`

Returns a tuple of changed, value. color is an integer color in the form ABGR which imgui and draw APIs expect.

`imgui.color_edit_argb(label, color, flags)`

Returns a tuple of changed, value. color is an integer color in the form ARGB.

`imgui.color_edit3(label, color (Vector3f), flags)`

Returns a tuple of changed, value

`imgui.color_edit4(label, color (Vector4f), flags)`

Returns a tuple of changed, value

flags for color_picker/edit APIs: ImGuiColorEditFlags

`imgui.tree_node_ptr_id(id, label)`

`imgui.tree_node_str_id(id, label)`

`imgui.tree_pop()`

All of the above tree functions must have a corresponding tree_pop!

`imgui.is_item_hovered(flags)`

`imgui.collapsing_header(name)`

`imgui.load_font(filepath, size, [ranges])`

Loads a font file from the reframework/fonts subdirectory at the specified size with optional Unicode ranges (an array of start, end pairs ending with 0). Returns a handle for use with imgui.push_font(). If filepath is nil, it will load the default font at the specified size.

`imgui.push_font(font)`

Sets the font to be used for the next set of ImGui widgets/draw commands until imgui.pop_font is called.

`imgui.pop_font()`

Unsets the previously pushed font.

`imgui.get_default_font_size()`

Returns size of the default font for REFramework's UI.

`imgui.set_next_window_pos(pos (Vector2f or table), condition, pivot (Vector2f or table))`

condition is the ImGuiCond enum.

enum ImGuiCond_
{
    ImGuiCond_None          = 0,        // No condition (always set the variable), same as _Always
    ImGuiCond_Always        = 1 << 0,   // No condition (always set the variable)
    ImGuiCond_Once          = 1 << 1,   // Set the variable once per runtime session (only the first call will succeed)
    ImGuiCond_FirstUseEver  = 1 << 2,   // Set the variable if the object/window has no persistently saved data (no entry in .ini file)
    ImGuiCond_Appearing     = 1 << 3    // Set the variable if the object/window is appearing after being hidden/inactive (or the first time)
};

`imgui.set_next_window_size(size (Vector2f or table), condition)`

condition is the ImGuiCond enum.

`imgui.push_id(id)`

id can be an int, const char*, or void*.

`imgui.pop_id()`

`imgui.get_id()`

`imgui.get_mouse()`

Returns a Vector2f corresponding to the user's mouse position in window space.

`imgui.progress_bar(progress, size, overlay)`

progress is a float between 0 and 1.

size is a Vector2f or a size 2 array.

overlay is a string on top of the progress bar.

local progress = 0.0

re.on_frame(function()
    progress = progress + 0.001
    if progress > 1.0 then 
        progress = 0.0
    end
end)

re.on_draw_ui(function()
    imgui.progress_bar(progress, Vector2f.new(200, 20), string.format("Progress: %.1f%%", progress * 100))
end)

`imgui.item_size(pos, size)`

`imgui.item_add(pos, size)`

Adds an item with the specified position and size to the current window.

`imgui.draw_list_path_clear()`

Clears the current window's draw list path.

`imgui.draw_list_path_line_to(pos)`

Adds a line to the current window's draw list path given the specified pos

pos is a Vector2f or a size 2 array.

`imgui.draw_list_path_stroke(color, closed, thickness)`

Strokes the current window's draw list path with the specified color, closed state, and thickness.

color is an integer color in the form ARGB.
closed is a bool.
thickness is a float.

`imgui.get_key_index(imgui_key)`

Returns the index of the specified imgui_key.

`imgui.is_key_down(key)`

Returns true if the specified key is currently being held down.

`imgui.is_key_pressed(key)`

Returns true if the specified key was pressed during the current frame.

`imgui.is_key_released(key)`

Returns true if the specified key was released during the current frame.

`imgui.is_mouse_down(button)`

Returns true if the specified mouse button is currently being held down.

`imgui.is_mouse_clicked(button)`

Returns true if the specified mouse button was clicked during the current frame.

`imgui.is_mouse_released(button)`

Returns true if the specified mouse button was released during the current frame.

`imgui.is_mouse_double_clicked(button)`

Returns true if the specified mouse button was double-clicked during the current frame.

`imgui.indent(indent_width)`

Indents the current line by indent_width pixels.

`imgui.unindent(indent_width)`

Unindents the current line by indent_width pixels.

Starts a tooltip window that will be drawn at the current cursor position.

Ends the current tooltip window.

`imgui.set_tooltip(text)`

Sets the text for the current tooltip window.

`imgui.open_popup(str_id, flags)`

Opens a popup with the specified str_id and flags.

`imgui.begin_popup(str_id, flags)`

Begins a new popup with the specified str_id and flags.

`imgui.begin_popup_context_item(str_id, flags)`

Begins a new popup with the specified str_id and flags, anchored to the last item.

`imgui.end_popup()`

Ends the current popup window.

`imgui.close_current_popup()`

Closes the current popup window.

`imgui.is_popup_open(str_id)`

Returns true if the popup with the specified str_id is open.

`imgui.calc_text_size(text)`

Calculates and returns the size of the specified text as a Vector2f.

`imgui.get_window_size()`

Returns the size of the current window as a Vector2f.

`imgui.get_window_pos()`

Returns the position of the current window as a Vector2f.

`imgui.set_next_item_open(is_open, condition)`

Sets the open state of the next collapsing header or tree node to is_open based on the specified condition.

`imgui.begin_list_box(label, size)`

Begins a new list box with the specified label and size.

`imgui.end_list_box()`

Ends the current list box.

`imgui.begin_menu_bar()`

Begins a new menu bar.

`imgui.end_menu_bar()`

Ends the current menu bar.

`imgui.begin_main_menu_bar()`

Begins the main menu bar.

`imgui.end_main_menu_bar()`

Ends the main menu bar.

`imgui.begin_menu(label, enabled)`

Begins a new menu with the specified label. The menu will be disabled if enabled is false.

`imgui.end_menu()`

Ends the current menu.

`imgui.menu_item(label, shortcut, selected, enabled)`

Adds a menu item with the specified label, shortcut, selected state, and enabled state.

`imgui.get_display_size()`

Returns the size of the display as a Vector2f.

`imgui.push_item_width(item_width)`

Pushes the width of the next item to item_width pixels.

`imgui.pop_item_width()`

Pops the last item width off the stack.

`imgui.set_next_item_width(item_width)`

Sets the width of the next item to item_width pixels.

`imgui.calc_item_width()`

Calculates and returns the current item width.

`imgui.push_style_color(style_color, color)`

Pushes a new style color onto the style stack.

`imgui.pop_style_color(count)`

Pops count style colors off the style stack.

`imgui.push_style_var(idx, value)`

Pushes a new style variable onto the style stack.

`imgui.pop_style_var(count)`

Pops count style variables off the style stack.

`imgui.get_cursor_pos()`

Returns the current cursor position as a Vector2f.

`imgui.set_cursor_pos(pos)`

Sets the current cursor position to pos.

`imgui.get_cursor_start_pos()`

Returns the initial cursor position as a Vector2f.

`imgui.get_cursor_screen_pos()`

Returns the current cursor position in screen coordinates as a Vector2f.

`imgui.set_cursor_screen_pos(pos)`

Sets the current cursor position in screen coordinates to pos.

`imgui.set_item_default_focus()`

Sets the default focus to the next widget.

Scroll APIs

`imgui.get_scroll_x()`

Returns the horizontal scroll position.

`imgui.get_scroll_y()`

Returns the vertical scroll position.

`imgui.set_scroll_x(scroll_x)`

Sets the horizontal scroll position to scroll_x.

`imgui.set_scroll_y(scroll_y)`

Sets the vertical scroll position to scroll_y.

`imgui.get_scroll_max_x()`

Returns the maximum horizontal scroll position.

`imgui.get_scroll_max_y()`

Returns the maximum vertical scroll position.

`imgui.set_scroll_here_x(center_x_ratio)`

Centers the horizontal scroll position.

`imgui.set_scroll_here_y(center_y_ratio)`

Centers the vertical scroll position.

`imgui.set_scroll_from_pos_x(local_x, center_x_ratio)`

Sets the horizontal scroll position from the specified local_x and center_x_ratio.

`imgui.set_scroll_from_pos_y(local_y, center_y_ratio)`

Sets the vertical scroll position from the specified local_y and center_y_ratio.

Table API

`imgui.begin_table(str_id, column, flags, outer_size, inner_width)`

Begins a new table with the specified str_id, column count, flags, outer_size, and inner_width.

str_id is a string.
column is an integer.
flags is an optional ImGuiTableFlags enum.
outer_size is a Vector2f or a size 2 array.
inner_width is an optional float.

`imgui.end_table()`

Ends the current table.

`imgui.table_next_row(row_flags, min_row_height)`

Begins a new row in the current table with the specified row_flags and min_row_height.

row_flags is an optional ImGuiTableRowFlags enum.
min_row_height is an optional float.