$imgui

Build quick debug windows with Dear ImGui.

46 natives. Read-only natives only look things up; the rest change something. Parameter types use the language's names (Types).

begin

read-only

$imgui.begin(name: string, flags: int, pos: vec2, pivot: vec2, size: vec2, force_geometry: bool)

Begin an immediate mode UI.

Parameter	Type	Meaning
name	string	The name of the UI.
flags	int	IMGUI flags.
pos	vec2	Location of the UI.
pivot	vec2	Pivot of the UI.
size	vec2	Size of the UI.
force_geometry	bool	Force the provided in position and size. This can be useful for iterating on the size and position in script but will not allow the user to move the window.

begin_child

read-only

$imgui.begin_child(str_id: string, size: vec2, border: bool, flags: int)

Begin a child region.

Parameter	Type	Meaning
str_id	string	String id for the child region.
size	vec2	Size
border	bool	True if the region should have a border.
flags	int	Flags for the sub region

begin_group

read-only

$imgui.begin_group()

Begin ImGUI group.

begin_tab_bar

read-only

$imgui.begin_tab_bar(text: string, args: list, flags: int) -> bool

ImGUI tab bar widget.

Parameter	Type	Meaning
text	string	The label for the tab bar with {} characters as placeholder for more values.
args	list	List of values to place in the message.
flags	int	ImGuiTreeNodeFlags

Returns bool: Open

begin_tab_item

read-only

$imgui.begin_tab_item(text: string, args: list, flags: int) -> bool

ImGUI tab item widget.

Parameter	Type	Meaning
text	string	The label for the tab item with {} characters as placeholder for more values.
args	list	List of values to place in the message.
flags	int	ImGuiTreeNodeFlags

Returns bool: Open

bullet

read-only

$imgui.bullet(text: string, args: list)

ImGUI bullet

Parameter	Type	Meaning
text	string	The text to draw with {} characters as placeholder for more values.
args	list	List of values to place in the message.

button

read-only

$imgui.button(label: string, size: vec2) -> bool

ImGUI button widget.

Parameter	Type	Meaning
label	string	The label for the button
size	vec2	Dimensions of the button

Returns bool: Clicked

checkbox

read-only

$imgui.checkbox(label: string, value: bool) -> list

ImGUI checkbox widget.

Parameter	Type	Meaning
label	string	The label for the checkbox
value	bool	Current value of the check box.

Returns list: Clicked, Checked

color4_linear_to_srgb

read-only

$imgui.color4_linear_to_srgb(label: string, value: vec4) -> vec4

ImGUI color4 linear RGB to sRGB.

Parameter	Type	Meaning
label	string	Label text.
value	vec4	The color to convert.

Returns vec4: Updated value of the color passed in.

color4_srgb_to_linear

read-only

$imgui.color4_srgb_to_linear(label: string, value: vec4) -> vec4

ImGUI color4 sRGB to linear RGB.

Parameter	Type	Meaning
label	string	Label text.
value	vec4	The color to convert.

Returns vec4: Updated value of the color passed in.

color4_value

read-only

$imgui.color4_value(label: string, value: vec4) -> vec4

ImGUI color4 control.

Parameter	Type	Meaning
label	string	Label text.
value	vec4	The color to display.

Returns vec4: Updated value of the color passed in.

color4_value_srgb_to_linear

read-only

$imgui.color4_value_srgb_to_linear(label: string, value: vec4) -> vec4

ImGUI color4 control converted from SRGB to linear.

Parameter	Type	Meaning
label	string	Label text.
value	vec4	The color to display.

Returns vec4: Updated value of the color passed in.

columns

read-only

$imgui.columns(count: int, id: string, border: bool)

ImGUI Columns

Parameter	Type	Meaning
count	int	Number of columns
id	string	ID for the columns
border	bool	True if a border is desired around the columns

combo

read-only

$imgui.combo(label: string, current_item: int, items: list, max_displayed_item: int) -> list

ImGUI combo widget.

Parameter	Type	Meaning
label	string	The label for the combobox
current_item	int	Current selected item.
items	list	List of items name in combobox
max_displayed_item	int	Max number of items showed in combobox.

Returns list: Selection changed, Current Item

dummy

read-only

$imgui.dummy(size: vec2)

ImGUI dummy window

Parameter	Type	Meaning
size	vec2	Size of the dummy

end_child

read-only

$imgui.end_child()

End a child region.

end_group

read-only

$imgui.end_group()

End ImGUI group.

end_tab_bar

read-only

$imgui.end_tab_bar()

End ImGUI tab bar widget.

end_tab_item

read-only

$imgui.end_tab_item()

End ImGUI tab item widget.

float_slider

read-only

$imgui.float_slider(label: string, value: float, min: float, max: float, format: string) -> list

ImGUI float control.

Parameter	Type	Meaning
label	string	Label text.
value	float	The float value to display.
min	float	Step value for control.
max	float	Fast step value for control.
format	string	Float printf format text.

Returns list: Changed, Value

float_value

read-only

$imgui.float_value(label: string, value: float, step: float, step_fast: float, format: string) -> float

ImGUI float control.

Parameter	Type	Meaning
label	string	Label text.
value	float	The float value to display.
step	float	Step value for control.
step_fast	float	Fast step value for control.
format	string	Float printf format text.

Returns float: Updated value of the float passed in.

get_column_idx

read-only

$imgui.get_column_idx() -> int

ImGUI get column index

Returns int: The index of the column

get_column_width

read-only

$imgui.get_column_width() -> float

ImGUI get column width

Returns float: The width of the column

header

read-only

$imgui.header(text: string, args: list, flags: int) -> bool

ImGUI header widget.

Parameter	Type	Meaning
text	string	The label for the header with {} characters as placeholder for more values.
args	list	List of values to place in the message.
flags	int	ImGuiTreeNodeFlags

Returns bool: Open

histogram

read-only

$imgui.histogram(label: string, values: list, overlay: string, scale_min: float, scale_max: float, graph_size: vec2)

ImGUI histogram

Parameter	Type	Meaning
label	string	Label text.
values	list	list of values to display
overlay	string	text overlay for histogram
scale_min	float	min scale
scale_max	float	max scale
graph_size	vec2	Dimensions of the histogram

imgui_end

read-only

$imgui.imgui_end()

End an immediate mode UI.

indent

read-only

$imgui.indent(indent_width: float)

ImGUI indent

Parameter	Type	Meaning
indent_width	float	Indent width

int_value

read-only

$imgui.int_value(label: string, value: int, step: float, step_fast: float, format: string) -> int

ImGUI float control.

Parameter	Type	Meaning
label	string	Label text.
value	int	The int value to display.
step	float	Step value for control.
step_fast	float	Fast step value for control.
format	string	Float printf format text.

Returns int: Updated value of the int passed in.

is_item_hovered

read-only

$imgui.is_item_hovered() -> bool

ImGUI is item hovered?

Returns bool: Hovered

lock

read-only

$imgui.lock()

Lock ImGUI.

newline

read-only

$imgui.newline()

ImGUI newline

next_column

read-only

$imgui.next_column()

ImGUI next column

pop_id

read-only

$imgui.pop_id()

Pop ImGUI ID

progress_bar

read-only

$imgui.progress_bar(fraction: float, size: vec2, overlay: string)

ImGUI progress bar

Parameter	Type	Meaning
fraction	float	amount of progress
size	vec2	Size of progress bar
overlay	string	text overlay for progress bar.

progressbar

read-only

$imgui.progressbar(progress: float, label: string)

ImGUI progressbar widget.

Parameter	Type	Meaning
progress	float	Position offset in the X direction
label	string	The label for the button

push_id

read-only

$imgui.push_id(int_value: int)

Push ImGUI ID

Parameter	Type	Meaning
int_value	int	id to push

sameline

read-only

$imgui.sameline(pos_x: float, spacing_w: float)

ImGUI same line spacing

Parameter	Type	Meaning
pos_x	float	Position offset in the X direction
spacing_w	float	Spacing for sameline

separator

read-only

$imgui.separator()

ImGUI separator

set_clipboard_text

read-only

$imgui.set_clipboard_text(text: string)

Copy text to system clipboard.

Parameter	Type	Meaning
text	string	The text.

set_column_width

read-only

$imgui.set_column_width(index: int, width: float)

ImGUI set column width

Parameter	Type	Meaning
index	int	Column index
width	float	Width to set to

set_tooltip

read-only

$imgui.set_tooltip(text: string)

ImGUI set tooltip.

Parameter	Type	Meaning
text	string	Tooltip text

spacing

read-only

$imgui.spacing()

ImGUI spacing

text

read-only

$imgui.text(text: string, args: list, color: var)

ImGUI text.

Parameter	Type	Meaning
text	string	The text to draw with {} characters as placeholder for more values.
args	list	List of values to place in the message.
color	var	The text color (vec3 or vec4).

text_value

read-only

$imgui.text_value(label: string, value: string, size_bytes: int) -> string

ImGUI float control.

Parameter	Type	Meaning
label	string	Label text.
value	string	The string value to display.
size_bytes	int	Max size of the string.

Returns string: Updated value of the string passed in.

unindent

read-only

$imgui.unindent(indent_width: float)

ImGUI unindent

Parameter	Type	Meaning
indent_width	float	Indent width

unlock

read-only

$imgui.unlock()

Unlock ImGUI.