# imguigml

# Overview

ImGuiGML is a DLL / GML wrapper of the popular Dear ImGui, library.

It's available on the Windows, macOS, and Ubuntu platforms:

• Windows support includes x86 and x64
• macOS support includes Intel and M1 architectures
• Ubuntu support includes x64 support

ImGui is a UI library designed for fast implementation and iteration, using an 'Immediate Mode GUI' paradigm You will primarily be putting your GUI functions in step events that are called each step, rather than an event / retained based paradigm of only making updates.

Extension by babyjeans (Follow @babyj3ans)
Special Thanks to @net8floz for additional programming and the excellent example screenshots!

Special Special Thanks to JujuAdams for supporting the project!

• Usage
• ImGui and IDs
• Reference
• Changelist
• Unsupported Features

# Usage

• drop the imguigml object into your game, and voila. it begins activated.
• call imguigml_deactivate(); and imguigml_activate() for hiding/showing, which also stops all updates.
• imgui is inaccessible completely when deactivated
• Note: in some cases, its necessary to make sure imguigml_ready() is true right before calling functions using it.
• Note: imguigml is a Persistent object

For most imgui functions, it's a straight wrap! Call whatever you're looking for with: imguigml_<function> as opposed to ImGui::<function> from the C++ analog.

Now, each step that you'd like to show some ImGui, just call all of the functions that make up your UI. See the example provided for details!

# ImGui and IDs

Copy and pasted from the ImGui Documentation from v1.53 of dear ImGui, edited for GML

• Elements that are not clickable, such as Text() items don't need an ID.

• Interactive widgets require state to be carried over multiple frames (most typically Dear ImGui often needs to remember what is the "active" widget). to do so they need a unique ID. unique ID are typically derived from a string label or an integer index.

  imguigml_button("OK"); // Label = "OK", ID = hash of "OK" imguigml_button("Cancel"); // Label = "Cancel", ID = hash of "Cancel"

• ID are uniquely scoped within windows, tree nodes, etc. so no conflict can happen if you have two imguigml_buttons called "OK" in two different windows or in two different locations of a tree.

• If you have a same ID twice in the same location, you'll have a conflict:

  imguigml_button("OK"); imguigml_button("OK"); // ID collision! Both imguigml_buttons will be treated as the same.

  Fear not! this is easy to solve and there are many ways to solve it!

• When passing a label you can optionally specify extra unique ID information within string itself. This helps solving the simpler collision cases. Use "##" to pass a complement to the ID that won't be visible to the end-user:

  imguigml_button("Play"); // Label = "Play", ID = hash of "Play" imguigml_button("Play##foo1"); // Label = "Play", ID = hash of "Play##foo1" (different from above) imguigml_button("Play##foo2"); // Label = "Play", ID = hash of "Play##foo2" (different from above)

• If you want to completely hide the label, but still need an ID:

  Checkbox("##On", &b); // Label = "", ID = hash of "##On" (no label!)

• Occasionally/rarely you might want change a label while preserving a constant ID. This allows you to animate labels. For example you may want to include varying information in a window title bar (and windows are uniquely identified by their ID.. obviously) Use "###" to pass a label that isn't part of ID:

  imguigml_button("Hello###ID"; // Label = "Hello", ID = hash of "ID" imguigml_button("World###ID"; // Label = "World", ID = hash of "ID" (same as above)

• Use imguigml_push_id() / imguigml_pop_id() to create scopes and avoid ID conflicts within the same Window. This is the most convenient way of distinguishing ID if you are iterating and creating many UI elements. You can push a string or an integer value. Remember that ID are formed from the concatenation of everything in the ID stack!

  for (int i = 0; i < 100; i++) { imguigml_push_id(i); imguigml_button("Click"); // Label = "Click", ID = hash of integer + "label" (unique) imguigml_pop_id(); }

  for (int i = 0; i < 100; i++) { var inst_id = Instancse[i]; imguigml_push_id(inst_id); imguigml_button("Click"); // Label = "Click", ID = hash of instance_id + "label" (unique) imguigml_pop_id(); }

  for (int i = 0; i < 100; i++) { var inst = Instances[i]; imguigml_push_id(instance.name); imguigml_button("Click"); // Label = "Click", ID = hash of string + "label" (unique) imguigml_pop_id(); }

• More example showing that you can stack multiple prefixes into the ID stack:

  imguigml_button("Click"); // Label = "Click", ID = hash of "Click" imguigml_push_id("node"); imguigml_button("Click"); // Label = "Click", ID = hash of "node" + "Click" imguigml_push_id(my_ptr); imguigml_button("Click"); // Label = "Click", ID = hash of "node" + ptr + "Click" imguigml_pop_id(); imguigml_pop_id();

• Tree nodes implicitly creates a scope for you by calling imguigml_push_id().

  imguigml_button("Click"); // Label = "Click", ID = hash of "Click" if (imguigml_tree_node("node")) { imguigml_button("Click"); // Label = "Click", ID = hash of "node" + "Click" imguigml_tree_pop(); }

• When working with trees, ID are used to preserve the open/close state of each tree node. Depending on your use cases you may want to use strings or indices as ID. e.g. when displaying a single object that may change over time (dynamic 1-1 relationship), using a static string as ID will preserve your node open/closed state when the targeted object change. e.g. when displaying a list of objects, using indices as ID will preserve the node open/closed state differently. experiment and see what makes more sense!

# Reference

# imguigml_activate

returns: None

imguigml_activate()

helper function to simply activate imguigml again

# imguigml_deactivate

returns: None

imguigml_deactivate()

helper function to simply deactivate imguigml again

# imguigml_ready

returns: {Boolean}

imguigml_ready()

returns true if imguigml is ready for commands to be called

# imguigml_color_convert_gml_to_u32

imguigml_color_convert_gml_to_u32(_color, [_alpha=1.0])

get an ImGui color from a gml color

# imguigml_color_convert_gml_to_float4

imguigml_color_convert_gml_to_float4(_color, [_alpha=1.0]

get an ImGui color4 from a gml color

# imguigml_color_convert_float4_to_gml

imguigml_color_convert_float4_to_gml(_r_or_array4, [_g=undefined], [_b=undefined], [_a=undefined])

get an gml color from a ImGui color4

# imguigml_color_convert_u32_to_gml

imguigml_color_convert_u32_to_gml(_color)

get gml color from an imgui color

# imguigml_toggle_cursor

imguigml_toggle_cursor([_force])

Toggle whether or not ImGui will touch the cursor or not

# imguigml_enable_depth

imguigml_enable_depth([_enabled])

if enabled, setting the depth of the imgui instance will change the z-value imgui renders, otherwise it's at z=1.0

# imguigml_set_display_mode

imguigml_set_display_mode(_display_mode, [_display_view=0])

set the imguigml display mode - this affects how the window is resized / handled. currently there's the 3 display modes:

• GUIAspect - ImGuiGML Draws on the GUI layer, but corrects for aspect ratio according to the viewport of view passed. DEFAULT
• View - ImGuiGML will Draw in a normal Draw call NOT Draw GUI, the mouse will scale to the view given. Use if you want to Draw ImGuiGML during the Draw event (application surface). NOTE: This should be set before or after Begin Step and Draw of the imgui object, it affects both mouse (Begin Step) and rendering (Draw) If you're using EImGui_DisplayMode.View you may want to experiment with imguigml_set_display_scale

# imguigml_get_display_mode

returns: {Real:EImGui_DisplayMode} ImGuIGML'

imguigml_get_display_mode()

returns the current set display mode

# imguigml_get_display_view

returns: {Real:EImGui_DisplayMode} ImGuIGML'

imguigml_get_display_view()

returns the current set display view - the view who's viewport we respect the aspect ratio of with using EImGui_DisplayMode.GUIWindowSize or EImGui_DisplayMode.GUIAspect

# imguigml_set_display_scale

imguigml_set_display_scale([_x], [_y])

set the imguigml display scaling - it will scale the mouse and the vertex buffer ImGui passes ImGuiGML by this much. if you pass no arguments, Scale will no longer be overriden

# imguigml_get_display_scale_width

returns: {Real}

imguigml_get_display_scale_width()

get the scale % we scale the width of

# imguigml_get_display_scale_height

returns: {Real}

imguigml_get_display_scale_height()

get the scale % we scale the height of

# imguigml_set_display_size

imguigml_set_display_size([_width], [_height])

set the display size (how imgui will clamp windows). by default, ImGuiGML automatically sets the display size to the window size each step. using this function disables that behavior. calling this fucntion with NO params, re-enables that functionality.

# imguigml_get_display_size

returns: {Array:[x, y]}

imguigml_get_display_size()

get the display size (how imgui will clamp windows)

# imguigml_drawlist_add_line

imguigml_drawlist_add_line(_x1, _y1, _x2, _y1, _color, [_thickness=1.0])

adds a line to the draw list

# imguigml_drawlist_add_rect

imguigml_drawlist_add_rect(_x1, _y1, _x2, _y2, _col, [_rounding = 0.0], [_rounding_corner_flags = ~0], [_thickness = 1.0])

Adds a rectangle to the drawlist

# imguigml_drawlist_add_rect_filled

imguigml_drawlist_add_rect_filled(_x1, _y1, _x2, _y2, _col, [_rounding = 0.0], [_rounding_corner_flags = ~0])

Adds a filled rectangle to the drawlist

# imguigml_drawlist_add_rect_filled_multicolor

imguigml_drawlist_add_rect_filled_multicolor(_x1, _y1, _x2, _y2, _colUL, _colUR, _colBR, _colBL);

Adds a multicolored filled rectangle to the drawlist

# imguigml_drawlist_add_quad

imguigml_drawlist_add_quad(_x1, _y1, _x2, _y2, _x3, _y3, _x4, _y4, _col, [_thickness = 1.0])

Adds a quad to the drawlist

# imguigml_drawlist_add_quad_filled

imguigml_drawlist_add_quad_filled(_x1, _y1, _x2, _y2, _x3, _y3, _x4, _y4, _col, [_thickness = 1.0])

Adds a filled quad to the draw list

# imguigml_drawlist_add_triangle

imguigml_drawlist_add_triangle(_x1, _y1, _x2, _y2, _x3, _y3, _col, [_thickness=1.0])

Adds a triangle to the draw list

# imguigml_drawlist_add_triangle_filled

imguigml_drawlist_add_triangle_filled(_x1, _y1, _x2, _y2, _x3, _y3, _col)

Adds a filled triangle to the draw list

# imguigml_drawlist_add_circle

imguigml_drawlist_add_circle(_center_x, _center_y, _radius, _col, [_num_segments=12], [_thickness=1.0])

Adds a circle to the drawlist

# imguigml_drawlist_add_circle_filled

imguigml_drawlist_add_circle_filled(_center_x, _center_y, _radius, _col, [_num_segments=12])

Adds a circle to the drawlist

# imguigml_drawlist_add_text

imguigml_drawlist_add_text(_pos_x, _pos_y, _col, _text, _wrap_width)

Adds text to the drawlist

# imguigml_drawlist_add_surface

imguigml_drawlist_add_surface(_surface, _x, _y, [_width=undefined], [_height=undefined], [_u0=0.0], [_v0=0.0], [_u1=1.0], [_v1=1.0], [color=c_white])

# imguigml_drawlist_add_surface_quad

imguigml_drawlist_add_surface_quad(surface, _x1, _y1, _x2, _y2, x3, _y3, _x4, _y4, [_u1=0], [_v1=0], [_u2=1], [_v2=0], [_u3=1], [_v3=1], [_u4=0], [_v4=1], [_col=c_white])

Adds an image quad to the draw list

# imguigml_drawlist_add_sprite

imguigml_drawlist_add_sprite(_sprite_index, _sub_img, _x, _y, [_width=undefined], [_height=undefined], [_col=c_white])

Adds an image to the draw list

# imguigml_drawlist_add_polyline

imguigml_drawlist_add_polyline(_points, _col, [_closed=true], [_thickness=1.0], [_anti_aliased=true])

add a line in a polygonal shape to the draw list

# imguigml_drawlist_add_convex_poly_filled

imguigml_drawlist_add_convex_poly_filled(_points, _col, [_anti_aliased=true])

add filled convex polygonal shape to the draw list

# imguigml_drawlist_add_bezier_curve

imguigml_drawlist_add_bezier_curve(_pos_x1, _pos_y1, _curve_x1, _curve_y1, _curve_x2, _curve_y2, _pos_x2, _pos_y2, _col, _thickness, [_num_segments=0])

Adds a bezier curve to the drawlist

# imguigml_drawlist_path_clear

returns: None

imguigml_drawlist_path_clear()

Clears the current path

# imguigml_drawlist_path_line_to

imguigml_drawlist_path_line_to(_x, _y)

add a line to the current path

# imguigml_drawlist_path_line_to_merge_duplicate

imguigml_drawlist_path_line_to_merge_duplicate(_x, _y)

add a line to the current path, merging any duplicate lines this creates

# imguigml_drawlist_path_fill_convex

imguigml_drawlist_path_fill_convex(_col)

add fill the current convex shape created bhy the path

# imguigml_drawlist_path_stroke

imguigml_drawlist_path_stroke(_col, _closed, [_thickness=1.0])

set the stroke settings for drawing paths

# imguigml_drawlist_path_arc_to

imguigml_drawlist_path_arc_to(_center_x, _center_y, _radius, _min, _max, [_num_segments=10])

Adds an arc to a path

# imguigml_drawlist_path_arc_to_fast

imguigml_drawlist_path_arc_to_fast(_center_x, _center_y, _radius, _min_of_12, _max_of_12)

More performant path_arc

# imguigml_drawlist_path_bezier_curve_to

imguigml_drawlist_path_bezier_curve_to(_x1, _y1, _x2, _y2, _x3, _y3, [_num_segments=0])

Curve path to

# imguigml_drawlist_path_rect

imguigml_drawlist_path_rect(_x1, _x2, _y1, _y2, [_rounding=0.0], [_rounding_corner_flags=-1])

draw a rect on the path

# imguigml_drawlist_channels_split

imguigml_drawlist_channels_split(_channels_count)

merge channels Channels:

• Use to simulate layers. By switching channels to can render out-of-order (e.g. submit foreground primitives before background primitives)
• Use to minimize draw calls (e.g. if going back-and-forth between multiple non-overlapping clipping rectangles, prefer to append into separate channels then merge at the end)

# imguigml_drawlist_channels_merge

returns: None

imguigml_drawlist_channels_merge()

merge channels Channels:

• Use to simulate layers. By switching channels to can render out-of-order (e.g. submit foreground primitives before background primitives)
• Use to minimize draw calls (e.g. if going back-and-forth between multiple non-overlapping clipping rectangles, prefer to append into separate channels then merge at the end)

# imguigml_drawlist_channels_set_current

imguigml_drawlist_channels_set_current(_channel_index)

merge channels Channels:

• Use to simulate layers. By switching channels to can render out-of-order (e.g. submit foreground primitives before background primitives)
• Use to minimize draw calls (e.g. if going back-and-forth between multiple non-overlapping clipping rectangles, prefer to append into separate channels then merge at the end)

# imguigml_drawlist_push_clip_rect

imguigml_drawlist_push_clip_rect(_min_x, _min_y, _max_x, _max_y, [_intersect_with_clip_plane=false])

Render-level scissoring

# imguigml_drawlist_pop_clip_rect

returns: None

imguigml_drawlist_pop_clip_rect()

End Render-level scissoring

# imguigml_drawlist_push_clip_rect_fullscreen

returns: None

imguigml_drawlist_push_clip_rect_fullscreen()

Push the clip rect for the fullscreen

# imguigml_drawlist_get_clip_rect_min

returns: {Array:[ _min_x, _min_y ]

imguigml_drawlist_get_clip_rect_min()

Gets the max pos of clipping rectangle

# imguigml_drawlist_get_clip_rect_max

returns: {Array:[ _max_x, _max_y ]

imguigml_drawlist_get_clip_rect_max()

Gets the max pos of clipping rectangle

# imguigml_drawlist_push_texture_id

imguigml_drawlist_push_texture_id(_tex_id)

Pushes a texture to the drawlist

# imguigml_drawlist_pop_texture_id

returns: None

imguigml_drawlist_pop_texture_id()

Pops texture from drawlist

# imguigml_drawlist_set_flags

imguigml_drawlist_set_flags(_flags)

set the antialising flags [per primitive]

# imguigml_drawlist_get_flags

returns: {Real:EImGui_DrawListFlags}

imguigml_drawlist_get_flags()

get the antialising flags [per primitive]

# imguigml_drawlist_use_overlay

returns: None

imguigml_drawlist_use_overlay()

use imgui's overlay drawlist ontop of the screen

# imguigml_drawlist_use_window

returns: None

imguigml_drawlist_use_window()

use imgui's active window drawlist with drawlist functions

# __imguigml_drawlist_add_image_quad

__imguigml_drawlist_add_image_quad(_texture_id, _x1, _y1, _x2, _y2, x3, _y3, _x4, _y4, [_u1=0], [_v1=0], [_u2=1], [_v2=0], [_u3=1], [_v3=1], [_u4=0], [_v4=1], [_col=c_white])

Adds an image quad to the draw list extensionizer { "docs": false }

# __imguigml_drawlist_add_image

__imguigml_drawlist_add_image(_texture_id, _x1, _y1, _x2, _y2, [_u1=0], [_v1=0], [_u2=1], [_v2=1], [_col=c_white])

Adds an image to the draw list extensionizer { "docs": false }

# imguigml_io_ini_saving_rate

imguigml_io_ini_saving_rate([_time])

Maximum time between saving positions/sizes to .ini file, in seconds.

# imguigml_io_mouse_double_click_time

imguigml_io_mouse_double_click_time([_time])

Time for a double-click, in seconds.

# imguigml_io_mouse_double_click_max_dist

imguigml_io_mouse_double_click_max_dist([_distance])

Distance threshold to stay in to validate a double-click, in pixels.

# imguigml_io_mouse_drag_threshold

imguigml_io_mouse_drag_threshold([_distance])

Distance threshold before considering we are dragging

# imguigml_io_key_repeat_delay

imguigml_io_key_repeat_delay([_time])

When holding a key/button, time before it starts repeating, in seconds (for buttons in Repeat mode, etc.).

# imguigml_io_key_repeat_rate

imguigml_io_key_repeat_rate([_time])

When holding a key/button, rate at which it repeats, in seconds.

# imguigml_io_font_global_scale

imguigml_io_font_global_scale([_scale])

Global scale all fonts

# imguigml_io_font_allow_user_scaling

imguigml_io_font_allow_user_scaling([_boolean])

Allow user scaling text of individual window with CTRL+Wheel.

# imguigml_io_display_framebuffer_scaling

imguigml_io_display_framebuffer_scaling([_x=1.0],[_y=1.0])

NOTE: DOES NOTHING FOR NOW For retina display or other situations where window coordinates are different from framebuffer coordinates. User storage only, presently not used by ImGui.

# imguigml_io_osx_behaviors

imguigml_io_osx_behaviors([_boolean])

OS X style: Text editing cursor movement using Alt instead of Ctrl, Shortcuts using Cmd/Super instead of Ctrl, Line/Text Start and End using Cmd+Arrows instead of Home/End, ouble click selects by word instead of selecting whole text, Multi-selection in lists uses Cmd/Super instead of Ctrl

# imguigml_io_ini_filename

imguigml_io_ini_filename([_path])

Path to .ini file. NULL to disable .ini saving.

# imguigml_io_log_filename

imguigml_io_log_filename([_path])

Path to .log file - default parameter to ImGui::LogToFile when no file is specified. defaults to "imgui_log.txt

# imguigml_io_cursor_blink

imguigml_io_cursor_blink([_enabled])

allow input currsors to blink

# imguigml_mem

imguigml_mem(key, [default_value])

Get a value from the memory map

# imguigml_memset

imguigml_memset(_key, _val)

Sets a value in the memory map

# imguigml_secure_load_mem

imguigml_secure_load_mem(filename)

loads imguigml memory from the filesystem

# imguigml_secure_save_mem

imguigml_secure_save_mem(filename)

saves imguigml memory onto the filesystem

# imguigml_separator

returns: None

imguigml_separator()

separator, generally horizontal. inside a menu bar or in horizontal layout mode, this becomes a vertical separator.

# imguigml_same_line

imguigml_same_line([_pos_x=0.0], [_spacing_w=-1.0])

call between widgets or groups to layout them horizontally

# imguigml_new_line

returns: None

imguigml_new_line()

undo a SameLine()

# imguigml_spacing

returns: None

imguigml_spacing()

add vertical spacing

# imguigml_dummy

imguigml_dummy(_size_x, _size_y)

add a dummy item of given size

# imguigml_indent

imguigml_indent([_index_w=0.0f])

move content position toward the right, by style.IndentSpacing or indent_w if >0

# imguigml_unindent

imguigml_unindent([_index_w=0.0f])

move content position back to the left, by style.IndentSpacing or indent_w if >0

# imguigml_begin_group

returns: None

imguigml_begin_group()

lock horizontal starting position + capture group bounding box into one "item" (so you can use IsItemHovered() or layout primitives such as SameLine() on whole group, etc.)

# imguigml_end_group

returns: None

imguigml_end_group()

end horizontal capture group

# imguigml_get_cursor_pos

returns: {Array:[x,y]}

imguigml_get_cursor_pos()

cursor position is relative to window position

# imguigml_get_cursor_pos_x

returns: {Real}

imguigml_get_cursor_pos_x()

cursor position is relative to window position

# imguigml_get_cursor_pos_y

returns: {Real}

imguigml_get_cursor_pos_y()

cursor position is relative to window position

# imguigml_set_cursor_pos

imguigml_set_cursor_pos(_x, _y)

set the imgui cursor position

# imguigml_set_cursor_pos_x

imguigml_set_cursor_pos_x(_x)

set the imgui cursor position x

# imguigml_set_cursor_pos_y

imguigml_set_cursor_pos_y(_y)

set the imgui cursor position y

# imguigml_get_cursor_start_pos

returns: {Array:[x,y]}

imguigml_get_cursor_start_pos()

initial cursor position

# imguigml_get_cursor_screen_pos

returns: {Array:[x,y]}

imguigml_get_cursor_screen_pos()

cursor position in absolute screen coordinates [0..io.DisplaySize] (useful to work with ImDrawList API)

# imguigml_set_cursor_screen_pos

imguigml_set_cursor_screen_pos(_x, _y)

cursor position in absolute screen coordinates [0..io.DisplaySize]

# imguigml_align_text_to_frame_padding

returns: None

imguigml_align_text_to_frame_padding()

vertically align/lower upcoming text to FramePadding.y so that it will aligns to upcoming widgets (call if you have text on a line before regular widgets)

# imguigml_get_text_line_height

returns: {Real} height of font == GetWindowFontS

imguigml_get_text_line_height()

height of font == GetWindowFontSize()

# imguigml_get_text_line_height_with_spacing

returns: {Real} distance (in pixels) between 2 consecutive lines of text == GetWindowFontSize() + GetStyle().ItemSpac

imguigml_get_text_line_height_with_spacing()

distance (in pixels) between 2 consecutive lines of text == GetWindowFontSize() + GetStyle().ItemSpacing.y

# imguigml_get_frame_height

returns: {Real}

imguigml_get_frame_height()

gets the height of the active frame [~ FontSize + style.FramePadding.y * 2]

# imguigml_get_frame_height_with_spacing

returns: {Real} distance (in pixels) between 2 consecutive lines of standard height widgets == GetWindowFontSize() + GetStyle().FramePadding.y*2 + GetStyle().ItemSpac

imguigml_get_frame_height_with_spacing()

distance (in pixels) between 2 consecutive lines of standard height widgets == GetWindowFontSize() + GetStyle().FramePadding.y*2 + GetStyle().ItemSpacing.y

# imguigml_columns

imguigml_columns([_count=1], [_id=undefined], [_border=true])

You can also use SameLine(pos_x) for simplified columns.

# imguigml_next_column

returns: None

imguigml_next_column()

next column, defaults to current row or next row if the current row is finished

# imguigml_get_column_index

returns: {Real} column_

imguigml_get_column_index()

get current column index

# imguigml_get_column_width

imguigml_get_column_width([_column_index=-1])

get column width (in pixels). pass -1 to use current column

# imguigml_set_column_width

imguigml_set_column_width(_column_index, _width)

set column width (in pixels). pass -1 to use current column

# imguigml_get_column_offset

imguigml_get_column_offset([_column_index=-1])

get position of column line (in pixels, from the left side of the contents region).

# imguigml_set_column_offset

imguigml_set_column_offset(_column_index, _offset_x)

set position of column line (in pixels, from the left side of the contents region).

# imguigml_get_columns_count

returns: {Real} columns

imguigml_get_columns_count()

get amount of columns

# imguigml_begin_drag_drop_source

imguigml_begin_drag_drop_source([_flags=0])

call when the current item is active. If this return true, you can call imguigml_set_drag_drop_payload() + imguigml_end_drag_drop_target()

# imguigml_set_drag_drop_payload

imguigml_set_drag_drop_payload(_type, _payload_id, [_flags=0])

pass an id to use to identify your payload data, or use the imgiugml_generate_payload / imguigml_set_payload_data / imguigml_release_payload_data helper functions

# imguigml_end_drag_drop_source

returns: None

imguigml_end_drag_drop_source()

end the drag drop source

# imguigml_begin_drop_target

returns: {Boolean} true on

imguigml_begin_drop_target()

call after submitting an item that may receive an item. If this returns true, you can call AcceptDragDropPayload() + EndDragDropTarget()

# imguigml_accept_drag_drop_payload

imguigml_accept_drag_drop_payload(_type, [_flags=0])

accept contents of a given type. If ImGuiDragDropFlags_AcceptBeforeDelivery is set you can peek into the payload before the mouse button is released.

# imguigml_end_drag_drop_target

returns: None

imguigml_end_drag_drop_target()

end drag drop target

# imguigml_payload

imguigml_payload([_id], _payload_data)

if an id is passed, use this id when looking up the payload, otherwise, return a generated id. these ids work by clearing each ImGui NewFrame and starting over again. generally, this should function fine, however, if you're having id misses in dragndrop, try just using your own unique id.

# imguigml_payload_get

imguigml_payload_get(_id)

return a payload given a passed _id.

# imguigml_add_font_from_ttf

imguigml_add_font_from_ttf(_file_path, [_font_size=10])

Add font from a TTF file, passing the filepath to it. Returns a font index that can be checked for validity with imguigml_is_font_valid

# imguigml_push_font

returns: None

imguigml_push_font(_font_index)

use undefined as a shortcut to push default font

# imguigml_pop_font

returns: None

imguigml_pop_font()

pop the font

# imguigml_get_font

returns: {Real} _fo

imguigml_get_font()

get current font (not implemented)

# imguigml_get_font_size

returns: {Real} current font

imguigml_get_font_size()

get current font size (= height in pixels) of current font with current scale applied

# imguigml_is_font_valid

returns: {Bool} is the font

imguigml_is_font_valid(_font_index)

returns true if the font given is a valid font

# imguigml_get_font_tex_uv_white_pixel

returns: {Array:[u,v]}

imguigml_get_font_tex_uv_white_pixel()

get UV coordinate for a while pixel, useful to draw custom shapes via the ImDrawList API

# imguigml_push_id

imguigml_push_id(_id, [_end_id])

push identifier into the ID stack. IDs are hash of the entire stack!

# imguigml_pop_id

returns: None

imguigml_pop_id()

pop identifier from ID stack

# imguigml_get_id

imguigml_get_id(_id, [_end_id])

push identifier into the ID stack. IDs are hash of the entire stack!

# imguigml_get_clipboard_text

returns: {String} clipboa

imguigml_get_clipboard_text()

get the clipboard text

# imguigml_set_clipboard_text

returns: None

imguigml_set_clipboard_text(_text)

set the clipboard text

# imguigml_get_key_index

imguigml_get_key_index(_key_index)

get mapped index for imgui_key index, you really don't need this

# imguigml_is_key_down

imguigml_is_key_down(_key_index)

is key being held. == io.KeysDown[user_key_index]. note that imgui doesn't know the semantic of each entry of io.KeyDown[]. Use your own indices/enums according to how your backend/engine stored them into KeyDown[]!

# imguigml_is_key_pressed

imguigml_is_key_pressed(_key_index, [_repeat=true])

was key pressed (went from !Down to Down)

# imguigml_is_key_released

imguigml_is_key_released(_key_index)

is key released

# imguigml_get_key_pressed_amount

imguigml_get_key_pressed_amount(_key_index, _repeat_delay, _rate);

uses provided repeat rate/delay.

# imguigml_is_mouse_down

imguigml_is_mouse_down(_button)

is mouse button held

# imguigml_is_mouse_clicked

imguigml_is_mouse_clicked(_button, [_repeat=false])

did mouse button clicked (went from !Down to Down)

# imguigml_is_mouse_double_clicked

imguigml_is_mouse_double_clicked(_button)

did mouse button double-clicked. a double-click returns false in IsMouseClicked(). uses io.MouseDoubleClickTime.

# imguigml_is_mouse_released

imguigml_is_mouse_released(_button)

did mouse button released (went from Down to !Down)

# imguigml_is_mouse_dragging

imguigml_is_mouse_dragging([_button=0], [_lock_threadhold=-1.0])

is mouse dragging.

# imguigml_is_mouse_hovering_rect

imguigml_is_mouse_hovering_rect(_min_x, _min_y, _max_x, _max_y, [_clip=true])

is mouse hovering given bounding rect (in screen space).

# imguigml_is_mouse_pos_valid

returns: {Boolean}

imguigml_is_mouse_pos_valid()

is the mouse position valid

# imguigml_get_mouse_pos

returns: {Boolean}

imguigml_get_mouse_pos()

shortcut to ImGui::GetIO().MousePos provided by user, to be consistent with other calls

# imguigml_get_mouse_pos_on_opening_current_popup

returns: None

imguigml_get_mouse_pos_on_opening_current_popup()

retrieve backup of mouse positioning at the time of opening popup we have BeginPopup() into

# imguigml_get_mouse_drag_delta

returns: None

imguigml_get_mouse_drag_delta()

retrieve backup of mouse positioning at the time of opening popup we have BeginPopup() into

# imguigml_reset_mouse_drag_delta

imguigml_reset_mouse_drag_delta([_button=0])

reset the drag delta

# imguigml_get_mouse_cursor

returns: {Real:EImGui_MouseCursor}

imguigml_get_mouse_cursor()

get desired cursor type, reset in ImGui::NewFrame(), this is updated during the frame. valid before Render(). If you use software rendering by setting io.MouseDrawCursor ImGui will render those for you

# imguigml_set_mouse_cursor

imguigml_set_mouse_cursor(_type)

set desired cursor type

# imguigml_capture_keyboard_from_app

imguigml_capture_keyboard_from_app([_capture=true])

manually override io.WantCaptureKeyboard flag next frame (said flag is entirely left for your application handle). e.g. force capture keyboard when your widget is being hovered.

# imguigml_capture_mouse_from_app

imguigml_capture_mouse_from_app([_capture=true])

manually override io.WantCaptureMouse flag next frame (said flag is entirely left for your application handle).

# imguigml_log_to_tty

imguigml_log_to_tty([_max_depth=-1])

start logging to tty

# imguigml_log_to_file

imguigml_log_to_file([_max_depth=-1], [_file_name=undefined])

start logging to file

# imguigml_log_to_clipboard

imguigml_log_to_clipboard([_max_depth=-1])

start logging to OS clipboard

# imguigml_log_finish

returns: None

imguigml_log_finish()

stop logging (close file, etc.)

# imguigml_log_buttons

returns: None

imguigml_log_buttons()

helper to display buttons for logging to tty/file/clipboard

# imguigml_log_text

imguigml_log_text(_text)

pass text data straight to log (without being displayed)

# imguigml_begin_main_menu_bar

returns: {Boolean}

imguigml_begin_main_menu_bar()

create and append to a full screen menu-bar. only call EndMainMenuBar() if this returns true!

# imguigml_end_main_menu_bar

returns: None

imguigml_end_main_menu_bar()

end main menu bar

# imguigml_begin_menu_bar

returns: {Boolean}

imguigml_begin_menu_bar()

append to menu-bar of current window (requires ImGuiWindowFlags_MenuBar flag set on parent window). only call EndMenuBar() if this returns true!

# imguigml_end_menu_bar

returns: None

imguigml_end_menu_bar()

end menu bar

# imguigml_begin_menu

imguigml_begin_menu(_label, [_enabled=true]);

create a sub-menu entry. only call EndMenu() if this returns true!

# imguigml_end_menu

returns: None

imguigml_end_menu()

end sub-menu entry

# imguigml_menu_item

imguigml_menu_item(_label, [_shortcut=""], [_selected=false], [_enabled=true]);

show a sub-menu item

# imguigml_open_popup

imguigml_open_popup(_str_id)

call to mark popup as open (don't call every frame!). popups are closed when user click outside, or if CloseCurrentPopup() is called within a BeginPopup()/EndPopup() block. By default, Selectable()/MenuItem() are calling CloseCurrentPopup(). Popup identifiers are relative to the current ID-stack (so OpenPopup and BeginPopup needs to be at the same level).

# imguigml_open_popup_on_item_click

imguigml_open_popup_on_item_click([_str_id=undefined], [_mouse_button=1])

helper to open popup when clicked on last item.

# imguigml_begin_popup

imguigml_begin_popup(_str_id)

begin a pop up - only call EndPopup() if BeginPopup() returned true!

# imguigml_begin_popup_modal

imguigml_begin_popup_modal(_name, [_open=undefined], [_extra_flags=0])

modal dialog (block interactions behind the modal window, can't close the modal window by clicking outside)

# imguigml_begin_popup_context_item

imguigml_begin_popup_context_item([_str_id=undefined], [_mouse_button=1])

helper to open and begin popup when clicked on last item. if you can pass a NULL str_id only if the previous item had an id. If you want to use that on a non-interactive item such as Text() you need to pass in an explicit ID here. read comments in .cpp!

# imguigml_begin_popup_context_window

imguigml_begin_popup_context_window([_str_id=undefined], [_mouse_button=1], [_also_over_items=true])

helper to open and begin popup when clicked on current window.

# imguigml_begin_popup_context_void

imguigml_begin_popup_context_void([_str_id=undefined], [_mouse_button=1])

helper to open and begin popup when clicked in void (where there are no imgui windows).

# imguigml_end_popup

returns: None

imguigml_end_popup()

end the current pop up

# imguigml_is_popup_open

imguigml_is_popup_open(_str_id)

return true if the popup is open

# imguigml_close_current_popup

returns: None

imguigml_close_current_popup()

close the popup we have begin-ed into. clicking on a MenuItem or Selectable automatically close the current popup.

# imguigml_push_style_color

imguigml_push_style_color(_idx, _colOrR, [_g], [_b], [_a])

# imguigml_pop_style_color

imguigml_pop_style_color([_count=1])

pop style colors

# imguigml_push_style_var

imguigml_push_style_var()

push a style var on the param stack

# imguigml_pop_style_var

imguigml_pop_style_var([_count=1])

pop style colors

# imguigml_get_style_color_vec4

imguigml_get_style_color_vec4(_idx)

retrieve style color as stored in ImGuiStyle structure. use to feed back into PushStyleColor(), otherwhise use GetColorU32() to get style color + style alpha.

# imguigml_get_color_u32

imguigml_get_color_u32(_colOrR, [_g], [_b], [_a])

retrieve given style color with style alpha applied and optional extra alpha multiplier

# imguigml_get_color_u32_from_idx

imguigml_get_color_u32_from_idx(_idx, [_alpha_mul=1.0])

retrieve given style color with style alpha applied and optional extra alpha multiplier

# imguigml_push_item_width

imguigml_push_item_width(_item_width)

width of items for the common item+label case, pixels.

# imguigml_pop_item_width

returns: None

imguigml_pop_item_width()

pop item width

# imguigml_calc_item_width

returns: {Real}

imguigml_calc_item_width()

width of item given pushed settings and current cursor position

# imguigml_push_text_wrap_pos

imguigml_push_text_wrap_pos([_wrap_pos_x=0.0])

word-wrapping for Text*() commands.

# imguigml_pop_text_wrap_pos

returns: None

imguigml_pop_text_wrap_pos()

pop text wrap pos

# imguigml_push_allow_keyboard_focus

imguigml_push_allow_keyboard_focus(_allow_keyboard_focus)

allow focusing using TAB/Shift-TAB, enabled by default but you can disable it for certain widgets

# imguigml_pop_allow_keyboard_focus

returns: None

imguigml_pop_allow_keyboard_focus()

pop allow keyboard focus

# imguigml_push_button_repeat

imguigml_push_button_repeat(_repeat)

in 'repeat' mode, Button*() functions return repeated true in a typematic manner (using io.KeyRepeatDelay/io.KeyRepeatRate setting). Note that you can call IsItemActive() after any Button() to tell if the button is held in the current frame.

# imguigml_pop_button_repeat

returns: None

imguigml_pop_button_repeat()

pop repeat mode

# imguigml_selectable

imguigml_selectable(_label, [_selected=false], [_selectable_flags=0], [_size_x=0], [_size_y=0])

selectable element

# imguigml_list_box

imguigml_list_box(_label, _current_item, _item_array, [_height_in_items=-1])

create a list box

# imguigml_list_box_header

imguigml_list_box_header(_label, _size_x, _size_y)

use if you want to reimplement ListBox() will custom data or interactions. make sure to call ListBoxFooter() afterwards.

# imguigml_list_box_header_items

imguigml_list_box_header_items(_label, _items_count,  [_height_in_items=-1]);

use if you want to reimplement ListBox() will custom data or interactions. make sure to call ListBoxFooter() afterwards.

# imguigml_list_box_footer

returns: None

imguigml_list_box_footer()

terminate the scrolling region

# imguigml_show_style_editor

returns: None

imguigml_show_style_editor()

add style editor block (not a window). you can pass in a reference ImGuiStyle structure to compare to, revert to and save to (else it uses the default style)

# imguigml_style_colors_classic

returns: None

imguigml_style_colors_classic()

use classic colors

# imguigml_style_colors_dark

returns: None

imguigml_style_colors_dark()

use dark colors

# imguigml_style_colors_light

returns: None

imguigml_style_colors_light()

use light colors

# imguigml_show_style_selector

imguigml_show_style_selector(_label)

show the style selector widget

# imguigml_begin_tab_bar

imguigml_begin_tab_bar(_std_id, [_flags=0])

start a tab bar

# imguigml_end_tab_bar

returns: None

imguigml_end_tab_bar()

finish a tab bar

# imguigml_begin_tab_item

imguigml_begin_tab_item(_name, [_open=undefined], [_flags=0])

create a tab item

# imguigml_end_tab_item

returns: None

imguigml_end_tab_item()

end a tab item

# imguigml_set_tab_item_closed

imguigml_set_tab_item_closed(_name)

set a tab item as closed

# imguigml_set_tab_item_selected

imguigml_set_tab_item_selected(_name)

set a tab item as selected

# imguigml_texteditor_create

returns: None

imguigml_texteditor_create()

create a new texteditor

# imguigml_texteditor_destroy

imguigml_texteditor_destroy(_editor)

destroy a texteditor

# imguigml_texteditor_set_language_definition

imguigml_texteditor_set_language_definition(_editor_index)

Sets the current text editor language definition

# imguigml_texteditor_get_language_definition

imguigml_texteditor_get_language_definition(_editor_index)

Gets the current text editor language definition

# imguigml_texteditor_get_palette

imguigml_texteditor_get_palette(_editor_index)

Gets the palette of the current text editor

# imguigml_texteditor_set_palette

imguigml_texteditor_set_palette(_editor_index, _palette)

Sets the palette of the current text editor

# imguigml_texteditor_render

imguigml_texteditor_render(_editor_index, _label, [_size_x=0], [_size_y=0], [_border=false])

Renders the text editor

# imguigml_texteditor_set_text

imguigml_texteditor_set_text(_editor_index, _text)

Sets the text of the current editor

# imguigml_texteditor_get_text

imguigml_texteditor_get_text(_editor_index)

Gets the text from the current editor

# imguigml_texteditor_get_selected_text

imguigml_texteditor_get_selected_text(_editor_index)

Gets the selected text of the current editor

# imguigml_texteditor_get_total_lines

imguigml_texteditor_get_total_lines(_editor_index)

Gets the total lines from the current text editor

# imguigml_texteditor_is_overwrite

imguigml_texteditor_is_overwrite(_editor_index)

Checks if current text editor is in overwrite mode

# imguigml_texteditor_set_readonly

imguigml_texteditor_set_readonly(_editor_index, _value)

Sets the text editor to read only

# imguigml_texteditor_is_readonly

imguigml_texteditor_is_readonly(_editor_index)

Checks if the current editor is read only

# imguigml_texteditor_set_cursor_position

imguigml_texteditor_set_cursor_position(_editor_index, _line, _col)

Sets the cursor position using line and column

# imguigml_texteditor_get_cursor_position

imguigml_texteditor_get_cursor_position(_editor_index)

Gets the line and column from the current text editor

# imguigml_texteditor_insert_text

imguigml_texteditor_insert_text(_editor_index, _text)

Inserts text at position in the current text editor

# imguigml_texteditor_move_up

imguigml_texteditor_move_up(_editor_index, _amount, [_select = false])

Moves up lines in the text editor

# imguigml_texteditor_move_down

imguigml_texteditor_move_down(_editor_index, _amount, [_select = false])

Moves down lines in the text editor

# imguigml_texteditor_move_left

imguigml_texteditor_move_left(_editor_index, _amount, [_select = false])

Moves left lines in the text editor

# imguigml_texteditor_move_right

imguigml_texteditor_move_right(_editor_index, _amount, [_select = false])

Moves right lines in the text editor

# imguigml_texteditor_move_top

imguigml_texteditor_move_top(_editor_index, [_select = false])

Skips to top of current editor

# imguigml_texteditor_move_bottom

imguigml_texteditor_move_bottom(_editor_index, [_select = false])

Skips to bottom of current editor

# imguigml_texteditor_move_home

imguigml_texteditor_move_home(_editor_index, [_select = false])

Moves to the home position of the current editor

# imguigml_texteditor_move_end

imguigml_texteditor_move_end(_editor_index, [_select = false])

Moves to the end position of the current editor

# imguigml_texteditor_set_selection_start

imguigml_texteditor_set_selection_start(_editor_index, _line, _col)

Sets the start select position in the current editor

# imguigml_texteditor_set_selection_end

imguigml_texteditor_set_selection_end(_editor_index, _line, _col)

Sets the end select position in the current editor

# imguigml_texteditor_set_selection

imguigml_texteditor_set_selection(_editor_index, _line1, _col1, _line2, _col2, [word_mode = false])

Sets selection value in current editor

# imguigml_texteditor_select_word_under_cursor

imguigml_texteditor_select_word_under_cursor(_editor_index)

Selects the word under the mouse cursor in the current editor

# imguigml_texteditor_has_selection

imguigml_texteditor_has_selection(_editor_index)

Checks if current editor has selected text

# imguigml_texteditor_copy

imguigml_texteditor_copy(_editor_index)

Copies the selected tex

# imguigml_texteditor_cut

imguigml_texteditor_cut(_editor_index)

Cuts the selected text

# imguigml_texteditor_paste

imguigml_texteditor_paste(_editor_index)

pastes the selected text

# imguigml_texteditor_delete

imguigml_texteditor_delete(_editor_index)

deletes the selected text

# imguigml_texteditor_can_undo

imguigml_texteditor_can_undo(_editor_index)

Check if there is undo history

# imguigml_texteditor_can_redo

imguigml_texteditor_can_redo(_editor_index)

Check if there is redo history

# imguigml_texteditor_get_dark_palette

imguigml_texteditor_get_dark_palette(_editor_index)

Gets the dark palette that may be used with editor

# imguigml_texteditor_get_light_palette

imguigml_texteditor_get_light_palette(_editor_index)

Gets the light palette that may be used with editor

# imguigml_set_tooltip

imguigml_set_tooltip(_tooltip_text)

set text tooltip under mouse-cursor, typically use with ImGui::IsItemHovered(). overidde any previous call to SetTooltip().

# imguigml_begin_tooltip

returns: None

imguigml_begin_tooltip()

begin/append a tooltip window. to create full-featured tooltip (with any kind of contents).

# imguigml_end_tooltip

returns: None

imguigml_end_tooltip()

end a tooltip window

# imguigml_value

imguigml_value(_label, _val_type, _val, [_float_format])

Output single value in "name: value" format (tip: freely declare more in your code to handle your types. you can add functions to the ImGui namespace)

# imguigml_color_convert_u32_to_float4

imguigml_color_convert_u32_to_float4(_color)

convert a u32 color to a float 4

# imguigml_color_convert_float4_to_u32

imguigml_color_convert_float4_to_u32(_r_or_array4, [_g=undefined], [_b=undefined], [_a=undefined])

convert a float4 color to a u32

# imguigml_color_convert_rgb_to_hsv

imguigml_color_convert_rgb_to_hsv(_r, _g, _b)

convert rgb to hsv

# imguigml_color_convert_hsv_to_rgb

imguigml_color_convert_hsv_to_rgb(_h, _s, _v)

convert rgb to hsv

# imguigml_is_item_hovered

imguigml_is_item_hovered([_flags=0])

is the last item hovered by mouse (and usable)?

# imguigml_is_item_active

returns: {Boolean}

imguigml_is_item_active()

is the last item active? (e.g. button being held, text field being edited- items that don't interact will always return false)

# imguigml_is_item_clicked

imguigml_is_item_clicked([_button=0])

is the last item clicked? (e.g. button/node just clicked on)

# imguigml_is_item_visible

returns: {Boolean}

imguigml_is_item_visible()

is the last item visible? (aka not out of sight due to clipping/scrolling.)

# imguigml_is_any_item_hovered

returns: {Boolean}

imguigml_is_any_item_hovered()

are any items hovered

# imguigml_is_any_item_active

returns: {Boolean}

imguigml_is_any_item_active()

are any items active

# imguigml_get_item_rect_min

returns: {Array:[x,y]}

imguigml_get_item_rect_min()

get bounding rect of last item in screen space

# imguigml_get_item_rect_max

returns: {Array:[x,y]}

imguigml_get_item_rect_max()

get bounding rect of last item in screen space

# imguigml_get_item_rect_size

returns: {Array:[x,y]}

imguigml_get_item_rect_size()

get bounding rect of last item in screen space

# imguigml_set_item_allow_overlap

returns: None

imguigml_set_item_allow_overlap()

allow last item to be overlapped by a subsequent item. sometimes useful with invisible buttons, selectables, etc. to catch unused area.

# imguigml_is_window_focused

imguigml_is_window_focused([_flags=0])

is current Begin()-ed window focused?

# imguigml_is_window_hovered

imguigml_is_window_hovered([_flags=0])

is current Begin()-ed window hovered (and typically: not blocked by a popup/modal)?

# imguigml_is_rect_visible

imguigml_is_rect_visible(_sizeOrMin, [_max])

test if a rectangle is visible / not clipped

# imguigml_get_time

returns: None

imguigml_get_time()

get the time

# imguigml_get_frame_count

returns: None

imguigml_get_frame_count()

get the time

# imguigml_get_style_color_name

imguigml_get_style_color_name(_idx)

get the style color's name

# imguigml_calc_text_size

imguigml_calc_text_size(_text, [_text_end=undefined], [_hide_text_after_double_hash=false], [_wrap_width=-1.0f]);

Calculate text size. Text can be multi-line. Optionally ignore text after a ## marker.

# imguigml_calc_list_clipping

imguigml_calc_list_clipping(_items_count, _items_height)

calculate coarse clipping for large list of evenly sized items. Prefer using the ImGuiListClipper higher-level helper if you can.

# imguigml_push_clip_rect

imguigml_push_clip_rect(_min_x, _min_y, _max_x, _max_y, _intersect_with_current_clip_rect)

# imguigml_pop_clip_rect

returns: None

imguigml_pop_clip_rect()

pop the clip rect

# imguigml_begin

imguigml_begin(_name, [_open=undefined], [_flags=0])

Push a new ImGui window to add widgets to.

# imguigml_end

returns: None

imguigml_end()

ImGui::End()

# imguigml_begin_child

imguigml_begin_child(_id, [_size_x=0], [_size_y=0], [_border=false], [_extra_flags=0])

begin a scrolling region. each axis can use a different mode, e.g. ImVec2(0,400).

# imguigml_end_child

returns: None

imguigml_end_child()

end a scrolling region

# imguigml_get_content_region_max

returns: {Array:EPos2D}

imguigml_get_content_region_max()

current content boundaries (typically window boundaries including scrolling, or current column boundaries), in windows coordinates

# imguigml_get_content_region_avail

returns: {Array:EPos2D}

imguigml_get_content_region_avail()

== GetContentRegionMax() - GetCursorPos()

# imguigml_get_content_region_avail_width

returns: {Real}

imguigml_get_content_region_avail_width()

get available width

# imguigml_get_window_content_region_min

returns: {Array:EPos2D}

imguigml_get_window_content_region_min()

content boundaries min (roughly (0,0)-Scroll), in window coordinates

# imguigml_get_window_content_region_max

returns: {Array:EPos2D}

imguigml_get_window_content_region_max()

content boundaries max (roughly (0,0)+Size-Scroll) where Size can be override with SetNextWindowContentSize(), in window coordinates

# imguigml_get_window_content_region_width

returns: {Real} content

imguigml_get_window_content_region_width()

content width in windows coordinates

# imguigml_get_window_pos

returns: {Array:EPos2D}

imguigml_get_window_pos()

get current window position in screen space (useful if you want to do your own drawing via the DrawList api)

# imguigml_get_window_size

returns: {Array:E2D}

imguigml_get_window_size()

get current window size

# imguigml_get_window_width

returns: {Real}

imguigml_get_window_width()

get current window width

# imguigml_get_window_height

returns: {Real} h

imguigml_get_window_height()

get current window height

# imguigml_is_window_collapsed

returns: {Boolean} is current window c

imguigml_is_window_collapsed()

is current window collapsed

# imguigml_is_window_appearing

returns: {Boolean} is current window a

imguigml_is_window_appearing()

is current window appearing

# imguigml_set_window_font_scale

imguigml_set_window_font_scale(_scale)

per-window font scale. Adjust IO.FontGlobalScale if you want to scale all windows

# imguigml_set_next_window_pos

imguigml_set_next_window_pos(_pos_x, _pos_y, [_cond=0], [_pivot_x=0], [_pivot_y=0])

set next window position. call before Begin(). use pivot=(0.5f,0.5f) to center on given point, etc.

# imguigml_set_next_window_size

imguigml_set_next_window_size(_size_x, _size_y, [_cond=0])

set next window size. set axis to 0.0f to force an auto-fit on this axis. call before Begin()

# imguigml_set_next_window_size_constraints

imguigml_set_next_window_size_constraints(_min_size_x, _min_size_y, _max_size_x, _max_size_y)

set next window size limits. use -1,-1 on either X/Y axis to preserve the current size.

# imguigml_set_next_window_content_size

imguigml_set_next_window_content_size(_size_x, _size_y)

set next window content size (enforce the range of scrollbars). set axis to 0.0f to leave it automatic. call before Begin()

# imguigml_set_next_window_collapsed

imguigml_set_next_window_collapsed(_collapsed, [_cond=0])

set next window collapsed state. call before Begin()

# imguigml_set_next_window_focus

returns: None

imguigml_set_next_window_focus()

set next window to be focused / front-most. call before Begin()

# imguigml_set_window_pos

imguigml_set_window_pos(_name, _pos_x, _pos_y, [_cond=0])

set named window position.

# imguigml_set_window_size

imguigml_set_window_size(_name, _size_x, _size_y, [_cond=0])

set named window size. set axis to 0.0f to force an auto-fit on this axis.

# imguigml_set_window_collapsed

imguigml_set_window_collapsed(_name, _collapsed, [_cond=0])

set named window collapsed state

# imguigml_set_window_focus

imguigml_set_window_focus(_name)

set named window to be focused / front-most. use NULL to remove focus.

# imguigml_get_scroll_x

returns: {Real} [0..GetScrollMa

imguigml_get_scroll_x()

get scrolling amount [0..GetScrollMaxX()]

# imguigml_get_scroll_y

returns: {Real} [0..GetScrollMa

imguigml_get_scroll_y()

get scrolling amount [0..GetScrollMaxY()]

# imguigml_get_scroll_max_x

returns: {Real} scrolling amount ~~ ContentSize.X - WindowS

imguigml_get_scroll_max_x()

get maximum scrolling amount ~~ ContentSize.X - WindowSize.X

# imguigml_get_scroll_max_y

returns: {Real} scrolling amount ~~ ContentSize.Y - WindowS

imguigml_get_scroll_max_y()

get maximum scrolling amount ~~ ContentSize.Y - WindowSize.Y

# imguigml_set_scroll_x

imguigml_set_scroll_x(_scroll_x)

set scrolling amount [0..GetScrollMaxX()]

# imguigml_set_scroll_y

imguigml_set_scroll_y(_scroll_y)

set scrolling amount [0..GetScrollMaxY()]

# imguigml_set_scroll_here_x

returns: None

imguigml_set_scroll_here_x()

adjust scrolling amount to make current cursor position visible.

# imguigml_set_scroll_here_y

returns: None

imguigml_set_scroll_here_y()

adjust scrolling amount to make current cursor position visible.

# imguigml_set_scroll_from_pos_y

imguigml_set_scroll_from_pos_y(_pos_y, [_center_y_ratio=0.5])

adjust scrolling amount to make given position valid. use GetCursorPos() or GetCursorStartPos()+offset to get valid positions.

# imguigml_set_keyboard_focus_here

imguigml_set_keyboard_focus_here([_offset=0])

focus keyboard on the next widget.

# imguigml_set_state_storage

imguigml_set_state_storage(_tree)

replace tree state storage with our own (if you want to manipulate it yourself, typically clear subsection of it)

# imguigml_get_state_storage

imguigml_get_state_storage(_tree)

replace tree state storage with our own (if you want to manipulate it yourself, typically clear subsection of it)

# imguigml_begin_child_frame

imguigml_begin_child_frame(_guiID, [_size_x], [_size_y], [_extra_flags=0])

helper to create a child window / scrolling region that looks like a normal widget frame

# imguigml_end_child_frame

imguigml_end_child_frame()

helper to create a child window / scrolling region that looks like a normal widget frame

# imguigml_show_metrics_window

imguigml_show_metrics_window([_open=undefined])

create metrics window. display ImGui internals: draw commands (with individual draw calls and vertices), window list, basic internal state, etc.

# imguigml_show_user_guide

returns: None

imguigml_show_user_guide()

add basic help/info block (not a window): how to manipulate ImGui as a end-user (mouse/keyboard controls).

# imguigml_show_demo_window

imguigml_show_demo_window([_open=undefined])

create demo/test window (previously called ShowTestWindow). demonstrate most ImGui features. call this to learn about the library! try to make it always available in your application!

# imguigml_show_font_selector

imguigml_show_font_selector(_label)

show a font selector NOTE: Functionality is limited at this time until ImGuiGML has better font support

# imguigml_button

imguigml_button(_label, [_size_x=0], [_size_y=0])

ImGui::Button()

# imguigml_small_button

imguigml_small_button(_label)

button with FramePadding=(0,0) to easily embed within text

# imguigml_invisible_button

imguigml_invisible_button(_str_id, [_size_x=0], [_size_y=0])

ImGui::InvisibleButton()

# imguigml_image

imguigml_image(_texture_id, _size_x, _size_y, [_u0=0.0], [_v0=0.0], [_u1=1.0], [_v1=1.0], [_tint_r=1.0], [_tint_g=1.0], [_tint_b=1.0], [_tint_a=1.0], [_border_r=0.0], [_border_g=0.0], [_border_b=0.0], [_border_a=0.0])

ImGui::Image()

# imguigml_surface

imguigml_surface(_surface, [width=undefined], [height=undefined], [_u0=0.0], [_v0=0.0], [_u1=1.0], [_v1=1.0], [_tint_r=1.0], [_tint_g=1.0], [_tint_b=1.0], [_tint_a=1.0], [_border_r=0.0], [_border_g=0.0], [_border_b=0.0], [_border_a=0.0])

ImGui::Image()

# imguigml_sprite

imguigml_sprite(_sprite_index, _sub_img, [_width=undefined], [_height=undefiend], [_tint_r=1.0], [_tint_g=1.0], [_tint_b=1.0], [_tint_a=1.0], [_border_r=0.0], [_border_g=0.0], [_border_b=0.0], [_border_a=0.0])

ImGui::Image()

# imguigml_image_button

imguigml_image_button(_texture_id, _size_x, _size_y, [_u0=0.0], [_v0=0.0], [_u1=1.0], [_v1=1.0], [_bg_r=0.0], [_bg_g=0.0], [_bg_b=0.0], [_bg_a=0.0], [_tint_r=1.0], [_tint_g=1.0], [_tint_b=1.0], [_tint_a=1.0])

ImGui::ImageButton()

# imguigml_surface_button

imguigml_surface_button(_surface, _size_x, _size_y, [_u0=0.0], [_v0=0.0], [_u1=1.0], [_v1=1.0], [_bg_r=0.0], [_bg_g=0.0], [_bg_b=0.0], [_bg_a=0.0], [_tint_r=1.0], [_tint_g=1.0], [_tint_b=1.0], [_tint_a=1.0])

Add an ImGui button that uses a surface for its appearance

# imguigml_sprite_button

imguigml_sprite_button(_sprite_index, _sub_img, [_width=undefined], [_height=undefiend], [_bg_r=0.0], [_bg_g=0.0], [_bg_b=0.0], [_bg_a=0.0], [_tint_r=1.0], [_tint_g=1.0], [_tint_b=1.0], [_tint_a=1.0])

ImGui::ImageButton()

# imguigml_checkbox

imguigml_checkbox(_label, _val)

ImGui::Checkbox()

# imguigml_checkbox_flags

imguigml_checkbox_flags(_label, _flags, _flag_val)

Show a checkbox with multiple flags

# imguigml_radio_button

imguigml_radio_button(_label, _active, [_current_val])

Show a radio button (multiple choice, single answer)

# imguigml_plot_lines

imguigml_plot_lines(_label, _values, [_values_offset=0], [_overlay=undefined], [_scale_min=undefined], [_scale_max=undefined], [_graph_size_x=0], [_graph_size_y=0], [_stride=sizeof(float)]

Plots a line graph, index as x axis values for y

# imguigml_plot_histogram

imguigml_plot_histogram(_label, _values, [_values_offset=0], [_overlay=undefined], [_scale_min=undefined], [_scale_max=undefined], [_graph_size_x=0], [_graph_size_y=0], [_stride=sizeof(float)]

Plots a histogram.

# imguigml_progress_bar

imguigml_progress_bar(_fraction, [_size_x=-1.0], [_size_y=0.0], [_overlay])

# __imguigml_image

__imguigml_image(_texture_id, _size_x, _size_y, [_u0=0.0], [_v0=0.0], [_u1=1.0], [_v1=1.0], [_tint_r=1.0], [_tint_g=1.0], [_tint_b=1.0], [_tint_a=1.0], [_border_r=0.0], [_border_g=0.0], [_border_b=0.0], [_border_a=0.0])

internal imguigml call to draw an image using the _texture_id texture extensionizer { "docs": false }

# __imguigml_image_button

__imguigml_image_button(_texture_id, _size_x, _size_y, [_u0=0.0], [_v0=0.0], [_u1=1.0], [_v1=1.0], [_tint_r=1.0], [_tint_g=1.0], [_tint_b=1.0], [_tint_a=1.0], [_border_r=0.0], [_border_g=0.0], [_border_b=0.0], [_border_a=0.0])

Add a button using the texture stored at _texture_id for the appearance extensionizer { "docs": false }

# imguigml_color_edit3

imguigml_color_edit3(_label, _r_or_array3, [_g=undefined], [_b=undefined], [_flags=0])

show a color edit field

# imguigml_color_edit4

imguigml_color_edit4(_label, _r_or_array4, [_g=undefined], [_b=undefined], [_a=undefined], [_flags=0])

show a color edit field

# imguigml_color_picker3

imguigml_color_picker3(_label, _r_or_array4, [_g=undefined], [_b=undefined], [_flags=0])

show a color edit field

# imguigml_color_picker4

imguigml_color_picker4(_label, _r_or_array4, [_g=undefined], [_b=undefined], [_a=undefined], [_flags=0])

show a color edit field

# imguigml_color_button

imguigml_color_button(_desc_id, _r, _g, _b, _a, [_flags=0], [_size_x=0], [_size_y=0])

display a colored square/button, hover for details, return true when pressed.

# imguigml_set_color_edit_options

returns: None

imguigml_set_color_edit_options()

initialize current options (generally on application startup) if you want to select a default format, picker type, etc. User will be able to change many settings, unless you pass the _NoOptions flag to your calls.

# imguigml_combo

imguigml_combo(_label, _current_item, _items, [_height_in_items = -1]);

# imguigml_begin_combo

imguigml_begin_combo(_label, _preview_value, [_flags=0])

begin a combo widget

# imguigml_end_combo

returns: None

imguigml_end_combo()

end a combo widget

# imguigml_set_item_default_focus

returns: None

imguigml_set_item_default_focus()

set the default item focus (temp function until nav update)

# imguigml_drag_float

imguigml_drag_float(_label, _v, [_v_speed=1.0], [_v_min=0.0], [_v_max=0.0], [_display_format="%.3f"], [_flags=EImGui_SliderFlags.None]);

If v_min >= v_max we have no bound

# imguigml_drag_float2