defold/extension-imgui/imgui
Functions and constants for interacting with Dear ImGUI
- GitHub: defold/extension-imgui — pinned to
2.14.0(released while Defold 1.12.4 was current)- Pick a release from defold/extension-imgui releases and add its Source code (zip) URL (or a packaged
.zipasset, if the library ships one) togame.projectunder[project]dependencies, then Fetch Libraries in the Defold editor. - Run
bunx @defold-typescript/cli resolveto materialize its types. - Import it under a namespace alias of your choice:
import * as imgui from "imgui"
- Pick a release from defold/extension-imgui releases and add its Source code (zip) URL (or a packaged
Functions
imgui.image_b64_decode(data: string, length: number): stringimgui.image_load_data(filename: string, data: string, data_length: number): LuaMultiReturn<[number, number, number]>imgui.image_load(filename: string): LuaMultiReturn<[number, number, number]>imgui.image_get(texture_id: number): LuaMultiReturn<[number, number, height]>imgui.image_add(texture_id: number, width: number, height: number, uv0x?: number, uv0y?: number, uv1x?: number, uv2x?: number)imgui.add_line(x1: number, y1: number, x2: number, y2: number, r: number, g: number, b: number, a: number, thickness?: number)imgui.add_rect(x1: number, y1: number, x2: number, y2: number, r: number, g: number, b: number, a: number, thickness?: number)imgui.set_display_size(w: number, h: number)imgui.set_mouse_input(x: number, y: number, down1: number, down2: number, down3: number, wheel: number)imgui.set_mouse_pos(x: number, y: number)imgui.set_mouse_button(index: number, down: number)imgui.set_mouse_wheel(wheel: number)imgui.set_key_down(key: number, down: boolean)imgui.set_key_modifier_ctrl(down: boolean)imgui.set_key_modifier_shift(down: boolean)imgui.set_key_modifier_alt(down: boolean)imgui.set_key_modifier_super(down: boolean)imgui.add_input_character(character: string)imgui.add_input_characters(characters: string)imgui.tree_node(text: string, flags: number)imgui.tree_pop()imgui.collapsing_header(label: string, visible: boolean, flags: number): boolimgui.push_id(text: string)imgui.pop_id()imgui.begin_window(title: string, is_open: boolean, flags: number): LuaMultiReturn<[bool, bool]>imgui.end_window()imgui.set_next_window_size(width: number, height: number, cond: number)imgui.set_next_window_pos(x: number, y: number, cond: number, pivot_x: number, pivot_y: number)imgui.set_next_window_collapsed(collapsed: boolean, cond: number)imgui.get_window_size(): LuaMultiReturn<[number, number]>imgui.get_window_pos(): LuaMultiReturn<[number, number]>imgui.is_window_focused(flags: number): booleanimgui.is_window_hovered(): boolimgui.is_window_appearing(): boolimgui.get_content_region_avail(): LuaMultiReturn<[number, number]>imgui.get_window_content_region_max(): LuaMultiReturn<[number, number]>imgui.begin_child(title: string, width: number, border: number, flags: number): boolimgui.end_child()imgui.begin_popup_context_item(id: string): booleanimgui.begin_popup(id: string, flags: number): booleanimgui.begin_popup_modal(id: string, flags: number): booleanimgui.open_popup(id: string, flags: number): booleanimgui.close_current_popup()imgui.end_popup()imgui.begin_drag_drop_source(flags: number): booleanimgui.end_drag_drop_source()imgui.begin_drag_drop_target(): booleanimgui.end_drag_drop_target()imgui.set_drag_drop_payload(type: string, payload: string): booleanimgui.accept_drag_drop_payload(type: string, flags: number): stringimgui.begin_combo(label: string, preview: string): booleanimgui.end_combo()imgui.combo(label: string, current: number, items: table): LuaMultiReturn<[boolean, number]>imgui.begin_table(id: string, column: number, flags?: number, x?: number, y?: number): booleanimgui.end_table()imgui.table_headers_row()imgui.table_setup_column(label: string, flags?: number, weight?: number)imgui.table_set_column_index(column_index: number)imgui.table_next_column()imgui.table_next_row()imgui.table_setup_scroll_freeze(freeze_cols: number, freeze_rows: number)imgui.begin_tooltip()imgui.end_tooltip()imgui.begin_tab_bar()imgui.end_tab_bar()imgui.begin_tab_item()imgui.end_tab_item()imgui.text(text: string, wrapped?: number)imgui.text_get_size(text: string, font_size: number, fontid?: number): LuaMultiReturn<[number, number]>imgui.text_colored(text: string, r: number, g: number, b: number, a: number)imgui.input_text(label: string, text: string, flags?: number): LuaMultiReturn<[boolean, string]>imgui.input_int(label: string, value: number, flags?: number): LuaMultiReturn<[boolean, number]>imgui.input_float(label: string, value: number, step: number, step_fast: number, precision_count: number, flags?: number): LuaMultiReturn<[boolean, number]>imgui.input_double(label: string, value: number, step: number, step_fast: number, precision_count: number, flags?: number): LuaMultiReturn<[boolean, number]>imgui.input_int4(label: string, v1: number, v2: number, v3: number, v4: number): LuaMultiReturn<[number, number, number, number]>imgui.input_int2(label: string, v1: number, v2: number): LuaMultiReturn<[number, number]>imgui.input_float3(label: string, v1: number, v2: number, v3: number): LuaMultiReturn<[number, number, number]>imgui.input_float4(label: string, v1: number, v2: number, v3: number, v4: number): LuaMultiReturn<[number, number, number, number]>imgui.drag_float(label: string, value: number, speed: number, min: number, max: number, precision: number): numberimgui.slider_float(label: string, value: number, min: number, max: number, precision: number): numberimgui.slider_float3(label: string, value1: number, value2: number, value3: number, min: number, max: number, precision: number): LuaMultiReturn<[number, number, number]>imgui.slider_float4(label: string, value1: number, value2: number, value3: number, value4: number, min: number, max: number, precision: number): LuaMultiReturn<[number, number, number, number]>imgui.color_edit4(label: string, color: vec4, flags: number)imgui.selectable(text: string, selected: boolean, flags?: number): LuaMultiReturn<[boolean, boolean]>imgui.button(text: string, width?: number, height?: number): booleanimgui.small_button(text: string): booleanimgui.button_image(texture_id: number, width?: number, height?: number): booleanimgui.button_arrow(label: string, direction: number): boolimgui.checkbox(text: string, checked: boolean): LuaMultiReturn<[boolean, boolean]>imgui.radio_button(text: string, checked: boolean): LuaMultiReturn<[boolean, boolean]>imgui.begin_menu_bar(): booleanimgui.end_menu_bar()imgui.begin_main_menu_bar(): booleanimgui.end_main_menu_bar()imgui.begin_menu(label: string, enabled?: boolean): booleanimgui.end_menu()imgui.menu_item(label: string, shortcut: string, selected: boolean, enabled?: boolean): LuaMultiReturn<[boolean, boolean]>imgui.same_line(offset?: number)imgui.new_line()imgui.bullet()imgui.indent()imgui.unindent()imgui.spacing()imgui.separator()imgui.get_cursor_screen_pos(): LuaMultiReturn<[number, number]>imgui.get_cursor_pos(): LuaMultiReturn<[number, number]>imgui.plot_lines(label: string, offset: number, width: number, height: number, values: number[])imgui.plot_histogram(label: string, offset: number, width: number, height: number, values: table)imgui.demo()imgui.is_mouse_double_clicked(button: number): booleanimgui.is_mouse_clicked(button: number): booleanimgui.is_item_active(): booleanimgui.is_item_focused(): booleanimgui.is_item_clicked(): booleanimgui.is_item_double_clicked(): booleanimgui.is_item_hovered(): booleanimgui.get_item_rect_max(): LuaMultiReturn<[number, number]>imgui.set_keyboard_focus_here(offset: number)imgui.get_style(): tableimgui.set_style(style: table)imgui.set_style_color(color_index: number, r: number, g: number, b: number, a: number)imgui.push_style_color(color_index: number, r: number, g: number, b: number, a: number)imgui.pop_style_color(count: number)imgui.push_style_var(style_var: number, value: None)imgui.pop_style_var(count: number)imgui.set_window_font_scale(scale: number)imgui.set_global_font_scale(scale: number)imgui.scale_all_sizes(scale: number)imgui.set_cursor_pos(x: number, y: number)imgui.push_item_width(width: number)imgui.pop_item_width()imgui.set_next_item_width(width: number)imgui.calc_item_width(): numberimgui.set_item_default_focus()imgui.set_scroll_here_y(center_y_ratio: number)imgui.font_add_ttf_file(filename: string, font_size: number, glyph_ranges: string): numberimgui.font_add_ttf_data(ttf_data: string, font_size: number, font_pixels: number, glyph_ranges: string): numberimgui.font_push(font_index: number)imgui.font_pop()imgui.font_scale(font_id: number, font_scale: number): numberimgui.get_font_size(): numberimgui.get_frame_height()imgui.draw_line(x1: number, y1: number, x2: number, y2: number, color: number)imgui.draw_rect(x: number, y: number, width: number, height: number, color: number)imgui.draw_rect_filled(x: number, y: number, width: number, height: number, color: number)imgui.draw_progress_bar(progress: number, xsize: number, ysize: number)imgui.set_rendering_enabled(enabled: boolean)imgui.want_capture_mouse()imgui.want_capture_keyboard()imgui.want_capture_text()imgui.set_defaults()imgui.set_ini_filename(filename?: string)
imgui.image_b64_decode(data: string, length: number): string
ImageB64Decode.
Parameters
data:stringlength:number
Returns
decoded:string— Data
imgui.image_load_data(filename: string, data: string, data_length: number): LuaMultiReturn<[number, number, number]>
ImageLoadData.
Parameters
filename:stringdata:stringdata_length:number
Returns
texture_id:numberwidth:numberheight:number
imgui.image_load(filename: string): LuaMultiReturn<[number, number, number]>
ImageLoad.
Parameters
filename:string
Returns
texture_id:numberwidth:numberheight:number
imgui.image_get(texture_id: number): LuaMultiReturn<[number, number, height]>
ImageGet.
Parameters
texture_id:number— Texture id
Returns
texture_id:number— Texture idwidth:number— Image widthImage:height— Height
imgui.image_add(texture_id: number, width: number, height: number, uv0x?: number, uv0y?: number, uv1x?: number, uv2x?: number)
ImageAdd.
Parameters
texture_id:number— Texture idwidth:number— Image widthheight:number— Image heightuv0x?:numberuv0y?:numberuv1x?:numberuv2x?:number
imgui.add_line(x1: number, y1: number, x2: number, y2: number, r: number, g: number, b: number, a: number, thickness?: number)
DrawListAddLine.
Parameters
x1:numbery1:numberx2:numbery2:numberr:numberg:numberb:numbera:numberthickness?:number
imgui.add_rect(x1: number, y1: number, x2: number, y2: number, r: number, g: number, b: number, a: number, thickness?: number)
DrawListAddRect.
Parameters
x1:numbery1:numberx2:numbery2:numberr:numberg:numberb:numbera:numberthickness?:number
imgui.set_display_size(w: number, h: number)
SetDisplaySize.
Parameters
w:numberh:number
imgui.set_mouse_input(x: number, y: number, down1: number, down2: number, down3: number, wheel: number)
SetMouseInput.
Parameters
x:numbery:numberdown1:numberdown2:numberdown3:numberwheel:number
imgui.set_mouse_pos(x: number, y: number)
SetMousePos.
Parameters
x:numbery:number
imgui.set_mouse_button(index: number, down: number)
SetMouseButton.
Parameters
index:number— 0️⃣ 0-based; passed toimguiunchanged.down:number
imgui.set_mouse_wheel(wheel: number)
SetMouseWheel.
Parameters
wheel:number
imgui.set_key_down(key: number, down: boolean)
SetKeyDown.
Parameters
key:numberdown:boolean
imgui.set_key_modifier_ctrl(down: boolean)
SetKeyModifierCtrl.
Parameters
down:boolean
imgui.set_key_modifier_shift(down: boolean)
SetKeyModifierShift.
Parameters
down:boolean
imgui.set_key_modifier_alt(down: boolean)
SetKeyModifierAlt.
Parameters
down:boolean
imgui.set_key_modifier_super(down: boolean)
SetKeyModifierSuper.
Parameters
down:boolean
imgui.add_input_character(character: string)
AddInputCharacter.
Parameters
character:string
imgui.add_input_characters(characters: string)
AddInputCharacters.
Parameters
characters:string
imgui.tree_node(text: string, flags: number)
TreeNode.
Parameters
text:stringflags:number
imgui.tree_pop()
TreePop.
imgui.collapsing_header(label: string, visible: boolean, flags: number): bool
CollapsingHeader.
Parameters
label:stringvisible:boolean— Optional; if omitted or nil, no close button is shown.flags:number— Optional.
Returns
open:bool
imgui.push_id(text: string)
PushId.
Parameters
text:string
imgui.pop_id()
PopId.
imgui.begin_window(title: string, is_open: boolean, flags: number): LuaMultiReturn<[bool, bool]>
Begin.
Parameters
title:stringis_open:booleanflags:number
Returns
result:boolis_open:bool
imgui.end_window()
End.
imgui.set_next_window_size(width: number, height: number, cond: number)
SetNextWindowSize.
Parameters
width:numberheight:numbercond:number
imgui.set_next_window_pos(x: number, y: number, cond: number, pivot_x: number, pivot_y: number)
SetNextWindowPos.
Parameters
x:numbery:numbercond:numberpivot_x:numberpivot_y:number
imgui.set_next_window_collapsed(collapsed: boolean, cond: number)
SetNextWindowCollapsed.
Parameters
collapsed:booleancond:number
imgui.get_window_size(): LuaMultiReturn<[number, number]>
GetWindowSize.
Returns
width:numberheight:number
imgui.get_window_pos(): LuaMultiReturn<[number, number]>
GetWindowPos.
Returns
x:numbery:number
imgui.is_window_focused(flags: number): boolean
IsWindowFocused.
Parameters
flags:number
Returns
focused:boolean
imgui.is_window_hovered(): bool
IsWindowHovered.
Returns
result:bool
imgui.is_window_appearing(): bool
IsWindowAppearing.
Returns
result:bool
imgui.get_content_region_avail(): LuaMultiReturn<[number, number]>
GetContentRegionAvail.
Returns
x:numbery:number
imgui.get_window_content_region_max(): LuaMultiReturn<[number, number]>
GetWindowContentRegionMax.
Returns
x:numbery:number
imgui.begin_child(title: string, width: number, border: number, flags: number): bool
BeginChild.
Parameters
title:stringwidth:numberborder:numberflags:number
Returns
result:bool
imgui.end_child()
EndChild.
imgui.begin_popup_context_item(id: string): boolean
BeginPopupContextItem. If id is omitted, uses the last item ID (same as ImGui helper behavior). Lua - call with no arguments to use the last item; passing nil is not accepted.
Parameters
id:string— Optional; if omitted, uses the last item ID.
Returns
result:boolean
imgui.begin_popup(id: string, flags: number): boolean
BeginPopup.
Parameters
id:stringflags:number
Returns
result:boolean
imgui.begin_popup_modal(id: string, flags: number): boolean
BeginPopupModal.
Parameters
id:stringflags:number
Returns
result:boolean
imgui.open_popup(id: string, flags: number): boolean
OpenPopup.
Parameters
id:stringflags:number
Returns
result:boolean
imgui.close_current_popup()
CloseCurrentPopup.
imgui.end_popup()
EndPopup.
imgui.begin_drag_drop_source(flags: number): boolean
BeginDragDropSource.
Parameters
flags:number
Returns
result:boolean
imgui.end_drag_drop_source()
EndDragDropSource.
imgui.begin_drag_drop_target(): boolean
BeginDragDropTarget.
Returns
result:boolean
imgui.end_drag_drop_target()
EndDragDropTarget.
imgui.set_drag_drop_payload(type: string, payload: string): boolean
SetDragDropPayload.
Parameters
type:stringpayload:string
Returns
result:boolean
imgui.accept_drag_drop_payload(type: string, flags: number): string
AcceptDragDropPayload.
Parameters
type:stringflags:number
Returns
payload:string
imgui.begin_combo(label: string, preview: string): boolean
BeginCombo.
Parameters
label:stringpreview:string
Returns
result:boolean
imgui.end_combo()
EndCombo.
imgui.combo(label: string, current: number, items: table): LuaMultiReturn<[boolean, number]>
Combo.
Parameters
label:stringcurrent:numberitems:table
Returns
result:booleancurrent:number
imgui.begin_table(id: string, column: number, flags?: number, x?: number, y?: number): boolean
BeginTable.
Parameters
id:stringcolumn:numberflags?:numberx?:numbery?:number
Returns
result:boolean
imgui.end_table()
EndTable.
imgui.table_headers_row()
TableHeadersRow.
imgui.table_setup_column(label: string, flags?: number, weight?: number)
TableSetupColumn.
Parameters
label:stringflags?:numberweight?:number
imgui.table_set_column_index(column_index: number)
TableSetColumnIndex.
Parameters
column_index:number— 0️⃣ 0-based; passed toimguiunchanged.
imgui.table_next_column()
TableNextColumn.
imgui.table_next_row()
TableNextRow.
imgui.table_setup_scroll_freeze(freeze_cols: number, freeze_rows: number)
TableSetupScrollFreeze.
Parameters
freeze_cols:numberfreeze_rows:number
imgui.begin_tooltip()
BeginTooltip.
imgui.end_tooltip()
EndTooltip.
imgui.begin_tab_bar()
BeginTabBar.
imgui.end_tab_bar()
EndTabBar.
imgui.begin_tab_item()
BeginTabItem.
imgui.end_tab_item()
EndTabItem.
imgui.text(text: string, wrapped?: number)
Text.
Parameters
text:stringwrapped?:number
imgui.text_get_size(text: string, font_size: number, fontid?: number): LuaMultiReturn<[number, number]>
TextGetSize.
Parameters
text:stringfont_size:numberfontid?:number
Returns
width:numberheight:number
imgui.text_colored(text: string, r: number, g: number, b: number, a: number)
TextColored.
Parameters
text:stringr:numberg:numberb:numbera:number
imgui.input_text(label: string, text: string, flags?: number): LuaMultiReturn<[boolean, string]>
InputText.
Parameters
label:stringtext:stringflags?:number
Returns
changed:booleantext:string
imgui.input_int(label: string, value: number, flags?: number): LuaMultiReturn<[boolean, number]>
InputInt.
Parameters
label:stringvalue:numberflags?:number
Returns
changed:booleanvalue:number
imgui.input_float(label: string, value: number, step: number, step_fast: number, precision_count: number, flags?: number): LuaMultiReturn<[boolean, number]>
InputFloat.
Parameters
label:stringvalue:numberstep:numberstep_fast:numberprecision_count:numberflags?:number
Returns
changed:booleanvalue:number
imgui.input_double(label: string, value: number, step: number, step_fast: number, precision_count: number, flags?: number): LuaMultiReturn<[boolean, number]>
InputDouble.
Parameters
label:stringvalue:numberstep:numberstep_fast:numberprecision_count:numberflags?:number
Returns
changed:booleanvalue:number
imgui.input_int4(label: string, v1: number, v2: number, v3: number, v4: number): LuaMultiReturn<[number, number, number, number]>
InputInt4.
Parameters
label:stringv1:numberv2:numberv3:numberv4:number
Returns
v1:numberv2:numberv3:numberv4:number
imgui.input_int2(label: string, v1: number, v2: number): LuaMultiReturn<[number, number]>
InputInt2.
Parameters
label:stringv1:numberv2:number
Returns
v1:numberv2:number
imgui.input_float3(label: string, v1: number, v2: number, v3: number): LuaMultiReturn<[number, number, number]>
InputFloat3.
Parameters
label:stringv1:numberv2:numberv3:number
Returns
v1:numberv2:numberv3:number
imgui.input_float4(label: string, v1: number, v2: number, v3: number, v4: number): LuaMultiReturn<[number, number, number, number]>
InputFloat4.
Parameters
label:stringv1:numberv2:numberv3:numberv4:number
Returns
v1:numberv2:numberv3:numberv4:number
imgui.drag_float(label: string, value: number, speed: number, min: number, max: number, precision: number): number
DragFloat.
Parameters
label:stringvalue:numberspeed:numbermin:numbermax:numberprecision:number
Returns
value:number
imgui.slider_float(label: string, value: number, min: number, max: number, precision: number): number
SliderFloat.
Parameters
label:stringvalue:numbermin:numbermax:numberprecision:number
Returns
value:number
imgui.slider_float3(label: string, value1: number, value2: number, value3: number, min: number, max: number, precision: number): LuaMultiReturn<[number, number, number]>
SliderFloat3.
Parameters
label:stringvalue1:numbervalue2:numbervalue3:numbermin:numbermax:numberprecision:number
Returns
value1:numbervalue2:numbervalue3:number
imgui.slider_float4(label: string, value1: number, value2: number, value3: number, value4: number, min: number, max: number, precision: number): LuaMultiReturn<[number, number, number, number]>
SliderFloat4.
Parameters
label:stringvalue1:numbervalue2:numbervalue3:numbervalue4:numbermin:numbermax:numberprecision:number
Returns
value1:numbervalue2:numbervalue3:numbervalue4:number
imgui.color_edit4(label: string, color: vec4, flags: number)
ColorEdit4.
Parameters
label:stringcolor:vec4flags:number
imgui.selectable(text: string, selected: boolean, flags?: number): LuaMultiReturn<[boolean, boolean]>
Selectable.
Parameters
text:stringselected:booleanflags?:number
Returns
selected:booleanpushed:boolean
imgui.button(text: string, width?: number, height?: number): boolean
Button.
Parameters
text:stringwidth?:numberheight?:number
Returns
pushed:boolean
imgui.small_button(text: string): boolean
SmallButton.
Parameters
text:string
Returns
pushed:boolean
imgui.button_image(texture_id: number, width?: number, height?: number): boolean
ButtonImage.
Parameters
texture_id:numberwidth?:numberheight?:number
Returns
pushed:boolean
imgui.button_arrow(label: string, direction: number): bool
ButtonArrow.
Parameters
label:stringdirection:number
Returns
pushed:bool
imgui.checkbox(text: string, checked: boolean): LuaMultiReturn<[boolean, boolean]>
Checkbox.
Parameters
text:stringchecked:boolean
Returns
changed:booleanchecked:boolean
imgui.radio_button(text: string, checked: boolean): LuaMultiReturn<[boolean, boolean]>
RadioButton.
Parameters
text:stringchecked:boolean
Returns
changed:booleanclicked:boolean
imgui.begin_menu_bar(): boolean
BeginMenuBar.
Returns
result:boolean
imgui.end_menu_bar()
EndMenuBar.
imgui.begin_main_menu_bar(): boolean
BeginMainMenuBar.
Returns
result:boolean
imgui.end_main_menu_bar()
EndMainMenuBar.
imgui.begin_menu(label: string, enabled?: boolean): boolean
BeginMenu.
Parameters
label:stringenabled?:boolean
Returns
result:boolean
imgui.end_menu()
EndMenu.
imgui.menu_item(label: string, shortcut: string, selected: boolean, enabled?: boolean): LuaMultiReturn<[boolean, boolean]>
MenuItem.
Parameters
label:stringshortcut:stringselected:booleanenabled?:boolean
Returns
result:booleanselected:boolean
imgui.same_line(offset?: number)
SameLine.
Parameters
offset?:number
imgui.new_line()
NewLine.
imgui.bullet()
Bullet.
imgui.indent()
Indent.
imgui.unindent()
Unindent.
imgui.spacing()
Spacing.
imgui.separator()
Separator.
imgui.get_cursor_screen_pos(): LuaMultiReturn<[number, number]>
GetCursorScreenPos.
Returns
x:number— Cursor screen x positiony:number— Cursor screen y position
imgui.get_cursor_pos(): LuaMultiReturn<[number, number]>
GetCursorPos.
Returns
x:number— Cursor x positiony:number— Cursor y position
imgui.plot_lines(label: string, offset: number, width: number, height: number, values: number[])
PlotLines.
Parameters
label:stringoffset:numberwidth:numberheight:numbervalues:number[]
imgui.plot_histogram(label: string, offset: number, width: number, height: number, values: table)
PlotHistogram.
Parameters
label:stringoffset:numberwidth:numberheight:numbervalues:table
imgui.demo()
Demo.
imgui.is_mouse_double_clicked(button: number): boolean
IsMouseDoubleClicked.
Parameters
button:number
Returns
double_clicked:boolean
imgui.is_mouse_clicked(button: number): boolean
IsMouseClicked.
Parameters
button:number
Returns
clicked:boolean
imgui.is_item_active(): boolean
IsItemActive.
Returns
active:boolean
imgui.is_item_focused(): boolean
IsItemFocused.
Returns
focused:boolean
imgui.is_item_clicked(): boolean
IsItemClicked.
Returns
clicked:boolean
imgui.is_item_double_clicked(): boolean
IsItemDoubleClicked.
Returns
double_clicked:boolean
imgui.is_item_hovered(): boolean
IsItemHovered.
Returns
hovered:boolean
imgui.get_item_rect_max(): LuaMultiReturn<[number, number]>
GetItemRectMax.
Returns
x:numbery:number
imgui.set_keyboard_focus_here(offset: number)
SetKeyboardFocusHere.
Parameters
offset:number
imgui.get_style(): table
GetStyle.
Returns
style:table
imgui.set_style(style: table)
SetStyle.
Parameters
style:table
imgui.set_style_color(color_index: number, r: number, g: number, b: number, a: number)
SetStyleColor.
Parameters
color_index:numberr:numberg:numberb:numbera:number
imgui.push_style_color(color_index: number, r: number, g: number, b: number, a: number)
PushStyleColor.
Parameters
color_index:numberr:numberg:numberb:numbera:number
imgui.pop_style_color(count: number)
PopStyleColor.
Parameters
count:number
imgui.push_style_var(style_var: number, value: None)
PushStyleVar.
Parameters
style_var:number— Enum for the style to be pushedvalue:None— Number or vmath.vector3 specifying the value of the style var
imgui.pop_style_var(count: number)
PopStyleVar.
Parameters
count:number— Number of style vars to pop; optional, defaults to 1
imgui.set_window_font_scale(scale: number)
SetWindowFontScale.
Parameters
scale:number
imgui.set_global_font_scale(scale: number)
SetGlobalFontScale.
Parameters
scale:number
imgui.scale_all_sizes(scale: number)
ScaleAllSizes.
Parameters
scale:number
imgui.set_cursor_pos(x: number, y: number)
SetCursorPos.
Parameters
x:numbery:number
imgui.push_item_width(width: number)
PushItemWidth.
Parameters
width:number
imgui.pop_item_width()
PopItemWidth.
imgui.set_next_item_width(width: number)
SetNextItemWidth.
Parameters
width:number
imgui.calc_item_width(): number
CalcItemWidth.
Returns
width:number
imgui.set_item_default_focus()
SetItemDefaultFocus.
imgui.set_scroll_here_y(center_y_ratio: number)
SetScrollHereY.
Parameters
center_y_ratio:number
imgui.font_add_ttf_file(filename: string, font_size: number, glyph_ranges: string): number
FontAddTTFFile.
Parameters
filename:stringfont_size:numberglyph_ranges:string
Returns
font_index:number— 0️⃣ 0-based; passed toimguiunchanged.
imgui.font_add_ttf_data(ttf_data: string, font_size: number, font_pixels: number, glyph_ranges: string): number
FontAddTTFData.
Parameters
ttf_data:stringfont_size:numberfont_pixels:numberglyph_ranges:string
Returns
font_index:number— 0️⃣ 0-based; passed toimguiunchanged.
imgui.font_push(font_index: number)
FontPush.
Parameters
font_index:number— 0️⃣ 0-based; passed toimguiunchanged.
imgui.font_pop()
FontPop.
imgui.font_scale(font_id: number, font_scale: number): number
FontScale.
Parameters
font_id:numberfont_scale:number
Returns
old_scale:number
imgui.get_font_size(): number
GetFontSize.
Returns
font_size:number
imgui.get_frame_height()
GetFrameHeight.
imgui.draw_line(x1: number, y1: number, x2: number, y2: number, color: number)
DrawLine.
Parameters
x1:numbery1:numberx2:numbery2:numbercolor:number
imgui.draw_rect(x: number, y: number, width: number, height: number, color: number)
DrawRect.
Parameters
x:numbery:numberwidth:numberheight:numbercolor:number
imgui.draw_rect_filled(x: number, y: number, width: number, height: number, color: number)
DrawRectFilled.
Parameters
x:numbery:numberwidth:numberheight:numbercolor:number
imgui.draw_progress_bar(progress: number, xsize: number, ysize: number)
DrawProgressBar.
Parameters
progress:numberxsize:numberysize:number
imgui.set_rendering_enabled(enabled: boolean)
SetRenderingEnabled.
Parameters
enabled:boolean
imgui.want_capture_mouse()
WantCaptureMouse.
imgui.want_capture_keyboard()
WantCaptureKeyboard.
imgui.want_capture_text()
WantCaptureText.
imgui.set_defaults()
SetDefaults.
imgui.set_ini_filename(filename?: string)
SetIniFilename.
Parameters
filename?:string
Constants
imgui.MOUSEBUTTON_LEFT
MOUSEBUTTON_LEFT
imgui.MOUSEBUTTON_RIGHT
MOUSEBUTTON_RIGHT
imgui.MOUSEBUTTON_MIDDLE
MOUSEBUTTON_MIDDLE
imgui.SELECTABLE_DONT_CLOSE_POPUPS
SELECTABLE_DONT_CLOSE_POPUPS
imgui.SELECTABLE_SPAN_ALL_COLUMNS
SELECTABLE_SPAN_ALL_COLUMNS
imgui.SELECTABLE_ALLOW_DOUBLE_CLICK
SELECTABLE_ALLOW_DOUBLE_CLICK
imgui.SELECTABLE_DISABLED
SELECTABLE_DISABLED
imgui.SELECTABLE_ALLOW_ITEM_OVERLAP
SELECTABLE_ALLOW_ITEM_OVERLAP
imgui.TABITEM_UNSAVED_DOCUMENT
TABITEM_UNSAVED_DOCUMENT
imgui.TABITEM_SET_SELECTED
TABITEM_SET_SELECTED
imgui.TABITEM_NO_CLOSE_WITH_MIDDLE_MOUSE_BUTTON
TABITEM_NO_CLOSE_WITH_MIDDLE_MOUSE_BUTTON
imgui.TABITEM_NO_PUSH_ID
TABITEM_NO_PUSH_ID
imgui.TABITEM_NO_TOOLTIP
TABITEM_NO_TOOLTIP
imgui.TABITEM_NO_REORDER
TABITEM_NO_REORDER
imgui.TABITEM_LEADING
TABITEM_LEADING
imgui.TABITEM_TRAILING
TABITEM_TRAILING
imgui.FOCUSED_CHILD_WINDOWS
FOCUSED_CHILD_WINDOWS
imgui.FOCUSED_ROOT_WINDOW
FOCUSED_ROOT_WINDOW
imgui.FOCUSED_ANY_WINDOW
FOCUSED_ANY_WINDOW
imgui.FOCUSED_ROOT_AND_CHILD_WINDOWS
FOCUSED_ROOT_AND_CHILD_WINDOWS
imgui.TREENODE_SELECTED
TREENODE_SELECTED
imgui.TREENODE_FRAMED
TREENODE_FRAMED
imgui.TREENODE_ALLOW_ITEM_OVERLAP
TREENODE_ALLOW_ITEM_OVERLAP
imgui.TREENODE_NO_TREE_PUSH_ON_OPEN
TREENODE_NO_TREE_PUSH_ON_OPEN
imgui.TREENODE_NO_AUTO_OPEN_ON_LOG
TREENODE_NO_AUTO_OPEN_ON_LOG
imgui.TREENODE_DEFAULT_OPEN
TREENODE_DEFAULT_OPEN
imgui.TREENODE_OPEN_ON_DOUBLE_CLICK
TREENODE_OPEN_ON_DOUBLE_CLICK
imgui.TREENODE_OPEN_ON_ARROW
TREENODE_OPEN_ON_ARROW
imgui.TREENODE_LEAF
TREENODE_LEAF
imgui.TREENODE_BULLET
TREENODE_BULLET
imgui.TREENODE_FRAME_PADDING
TREENODE_FRAME_PADDING
imgui.TREENODE_SPAN_AVAILABLE_WIDTH
TREENODE_SPAN_AVAILABLE_WIDTH
imgui.TREENODE_SPAN_FULL_WIDTH
TREENODE_SPAN_FULL_WIDTH
imgui.TREENODE_NAV_LEFT_JUMPS_BACK_HERE
TREENODE_NAV_LEFT_JUMPS_BACK_HERE
imgui.KEY_TAB
KEY_TAB
imgui.KEY_LEFTARROW
KEY_LEFTARROW
imgui.KEY_RIGHTARROW
KEY_RIGHTARROW
imgui.KEY_UPARROW
KEY_UPARROW
imgui.KEY_DOWNARROW
KEY_DOWNARROW
imgui.KEY_PAGEUP
KEY_PAGEUP
imgui.KEY_PAGEDOWN
KEY_PAGEDOWN
imgui.KEY_HOME
KEY_HOME
imgui.KEY_END
KEY_END
imgui.KEY_INSERT
KEY_INSERT
imgui.KEY_DELETE
KEY_DELETE
imgui.KEY_BACKSPACE
KEY_BACKSPACE
imgui.KEY_SPACE
KEY_SPACE
imgui.KEY_ENTER
KEY_ENTER
imgui.KEY_ESCAPE
KEY_ESCAPE
imgui.KEY_KEYPADENTER
KEY_KEYPADENTER
imgui.KEY_A
KEY_A
imgui.KEY_C
KEY_C
imgui.KEY_V
KEY_V
imgui.KEY_X
KEY_X
imgui.KEY_Y
KEY_Y
imgui.KEY_Z
KEY_Z
imgui.ImGuiCol_Text
ImGuiCol_Text
imgui.ImGuiCol_TextDisabled
ImGuiCol_TextDisabled
imgui.ImGuiCol_WindowBg
ImGuiCol_WindowBg
imgui.ImGuiCol_ChildBg
ImGuiCol_ChildBg
imgui.ImGuiCol_PopupBg
ImGuiCol_PopupBg
imgui.ImGuiCol_Border
ImGuiCol_Border
imgui.ImGuiCol_BorderShadow
ImGuiCol_BorderShadow
imgui.ImGuiCol_FrameBg
ImGuiCol_FrameBg
imgui.ImGuiCol_FrameBgHovered
ImGuiCol_FrameBgHovered
imgui.ImGuiCol_FrameBgActive
ImGuiCol_FrameBgActive
imgui.ImGuiCol_TitleBg
ImGuiCol_TitleBg
imgui.ImGuiCol_TitleBgActive
ImGuiCol_TitleBgActive
imgui.ImGuiCol_TitleBgCollapsed
ImGuiCol_TitleBgCollapsed
imgui.ImGuiCol_MenuBarBg
ImGuiCol_MenuBarBg
imgui.ImGuiCol_ScrollbarBg
ImGuiCol_ScrollbarBg
imgui.ImGuiCol_ScrollbarGrab
ImGuiCol_ScrollbarGrab
imgui.ImGuiCol_ScrollbarGrabHovered
ImGuiCol_ScrollbarGrabHovered
imgui.ImGuiCol_ScrollbarGrabActive
ImGuiCol_ScrollbarGrabActive
imgui.ImGuiCol_CheckMark
ImGuiCol_CheckMark
imgui.ImGuiCol_SliderGrab
ImGuiCol_SliderGrab
imgui.ImGuiCol_SliderGrabActive
ImGuiCol_SliderGrabActive
imgui.ImGuiCol_Button
ImGuiCol_Button
imgui.ImGuiCol_ButtonHovered
ImGuiCol_ButtonHovered
imgui.ImGuiCol_ButtonActive
ImGuiCol_ButtonActive
imgui.ImGuiCol_Header
ImGuiCol_Header
imgui.ImGuiCol_HeaderHovered
ImGuiCol_HeaderHovered
imgui.ImGuiCol_HeaderActive
ImGuiCol_HeaderActive
imgui.ImGuiCol_Separator
ImGuiCol_Separator
imgui.ImGuiCol_SeparatorHovered
ImGuiCol_SeparatorHovered
imgui.ImGuiCol_SeparatorActive
ImGuiCol_SeparatorActive
imgui.ImGuiCol_ResizeGrip
ImGuiCol_ResizeGrip
imgui.ImGuiCol_ResizeGripHovered
ImGuiCol_ResizeGripHovered
imgui.ImGuiCol_ResizeGripActive
ImGuiCol_ResizeGripActive
imgui.ImGuiCol_Tab
ImGuiCol_Tab
imgui.ImGuiCol_TabHovered
ImGuiCol_TabHovered
imgui.ImGuiCol_TabActive
ImGuiCol_TabActive
imgui.ImGuiCol_TabUnfocused
ImGuiCol_TabUnfocused
imgui.ImGuiCol_TabUnfocusedActive
ImGuiCol_TabUnfocusedActive
imgui.ImGuiCol_PlotLines
ImGuiCol_PlotLines
imgui.ImGuiCol_PlotLinesHovered
ImGuiCol_PlotLinesHovered
imgui.ImGuiCol_PlotHistogram
ImGuiCol_PlotHistogram
imgui.ImGuiCol_PlotHistogramHovered
ImGuiCol_PlotHistogramHovered
imgui.ImGuiCol_TableHeaderBg
ImGuiCol_TableHeaderBg
imgui.ImGuiCol_TableBorderStrong
ImGuiCol_TableBorderStrong
imgui.ImGuiCol_TableBorderLight
ImGuiCol_TableBorderLight
imgui.ImGuiCol_TableRowBg
ImGuiCol_TableRowBg
imgui.ImGuiCol_TableRowBgAlt
ImGuiCol_TableRowBgAlt
imgui.ImGuiCol_TextSelectedBg
ImGuiCol_TextSelectedBg
imgui.ImGuiCol_DragDropTarget
ImGuiCol_DragDropTarget
imgui.ImGuiCol_NavHighlight
ImGuiCol_NavHighlight
imgui.ImGuiCol_NavWindowingHighlight
ImGuiCol_NavWindowingHighlight
imgui.ImGuiCol_NavWindowingDimBg
ImGuiCol_NavWindowingDimBg
imgui.ImGuiCol_ModalWindowDimBg
ImGuiCol_ModalWindowDimBg
imgui.TABLECOLUMN_NONE
TABLECOLUMN_NONE
imgui.TABLECOLUMN_DEFAULTHIDE
TABLECOLUMN_DEFAULTHIDE Default as a hidden/disabled column.
imgui.TABLECOLUMN_DEFAULTSORT
TABLECOLUMN_DEFAULTSORT Default as a sorting column.
imgui.TABLECOLUMN_WIDTHSTRETCH
TABLECOLUMN_WIDTHSTRETCH Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp).
imgui.TABLECOLUMN_WIDTHFIXED
TABLECOLUMN_WIDTHFIXED Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable).
imgui.TABLECOLUMN_NORESIZE
TABLECOLUMN_NORESIZE Disable manual resizing.
imgui.TABLECOLUMN_NOREORDER
TABLECOLUMN_NOREORDER Disable manual reordering this column, this will also prevent other columns from crossing over this column.
imgui.TABLECOLUMN_NOHIDE
TABLECOLUMN_NOHIDE Disable ability to hide/disable this column.
imgui.TABLECOLUMN_NOCLIP
TABLECOLUMN_NOCLIP Disable clipping for this column (all NoClip columns will render in a same draw command).
imgui.TABLECOLUMN_NOSORT
TABLECOLUMN_NOSORT Disable ability to sort on this field (even if ImGuiTableFlags_Sortable is set on the table).
imgui.TABLECOLUMN_NOSORTASCENDING
TABLECOLUMN_NOSORTASCENDING Disable ability to sort in the ascending direction.
imgui.TABLECOLUMN_NOSORTDESCENDING
TABLECOLUMN_NOSORTDESCENDING Disable ability to sort in the descending direction.
imgui.TABLECOLUMN_NOHEADERWIDTH
TABLECOLUMN_NOHEADERWIDTH Disable header text width contribution to automatic column width.
imgui.TABLECOLUMN_PREFERSORTASCENDING
TABLECOLUMN_PREFERSORTASCENDING Make the initial sort direction Ascending when first sorting on this column (default).
imgui.TABLECOLUMN_PREFERSORTDESCENDING
TABLECOLUMN_PREFERSORTDESCENDING Make the initial sort direction Descending when first sorting on this column.
imgui.TABLECOLUMN_INDENTENABLE
TABLECOLUMN_INDENTENABLE Use current Indent value when entering cell (default for column 0).
imgui.TABLECOLUMN_INDENTDISABLE
TABLECOLUMN_INDENTDISABLE Ignore current Indent value when entering cell (default for columns > 0). Indentation changes within the cell will still be honored.
imgui.TABLE_NONE
TABLE_NONE
imgui.TABLE_RESIZABLE
TABLE_RESIZABLE Enable resizing columns.
imgui.TABLE_REORDERABLE
TABLE_REORDERABLE Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers)
imgui.TABLE_HIDEABLE
TABLE_HIDEABLE Enable hiding/disabling columns in context menu.
imgui.TABLE_SORTABLE
TABLE_SORTABLE Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate.
imgui.TABLE_NOSAVEDSETTINGS
TABLE_NOSAVEDSETTINGS Disable persisting columns order, width and sort settings in the .ini file.
imgui.TABLE_CONTEXTMENUINBODY
TABLE_CONTEXTMENUINBODY Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow().
imgui.TABLE_ROWBG
TABLE_ROWBG Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually)
imgui.TABLE_BORDERSINNERH
TABLE_BORDERSINNERH Draw horizontal borders between rows.
imgui.TABLE_BORDERSOUTERH
TABLE_BORDERSOUTERH Draw horizontal borders at the top and bottom.
imgui.TABLE_BORDERSINNERV
TABLE_BORDERSINNERV Draw vertical borders between columns.
imgui.TABLE_BORDERSOUTERV
TABLE_BORDERSOUTERV Draw vertical borders on the left and right sides.
imgui.TABLE_BORDERSH
TABLE_BORDERSH Draw horizontal borders.
imgui.TABLE_BORDERSV
TABLE_BORDERSV Draw vertical borders.
imgui.TABLE_BORDERSINNER
TABLE_BORDERSINNER Draw inner borders.
imgui.TABLE_BORDERSOUTER
TABLE_BORDERSOUTER Draw outer borders.
imgui.TABLE_BORDERS
TABLE_BORDERS Draw all borders.
imgui.TABLE_NOBORDERSINBODY
TABLE_NOBORDERSINBODY [ALPHA] Disable vertical borders in columns Body (borders will always appears in Headers). -> May move to style
imgui.TABLE_NOBORDERSINBODYUNTILRESIZE
TABLE_NOBORDERSINBODYUNTILRESIZE [ALPHA] Disable vertical borders in columns Body until hovered for resize (borders will always appears in Headers). -> May move to style
imgui.TABLE_SIZINGFIXEDFIT
TABLE_SIZINGFIXEDFIT Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width.
imgui.TABLE_SIZINGFIXEDSAME
TABLE_SIZINGFIXEDSAME Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching the maximum contents width of all columns. Implicitly enable ImGuiTableFlags_NoKeepColumnsVisible.
imgui.TABLE_SIZINGSTRETCHPROP
TABLE_SIZINGSTRETCHPROP Columns default to _WidthStretch with default weights proportional to each columns contents widths.
imgui.TABLE_SIZINGSTRETCHSAME
TABLE_SIZINGSTRETCHSAME Columns default to _WidthStretch with default weights all equal, unless overriden by TableSetupColumn().
imgui.TABLE_NOHOSTEXTENDX
TABLE_NOHOSTEXTENDX Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used.
imgui.TABLE_NOHOSTEXTENDY
TABLE_NOHOSTEXTENDY Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible.
imgui.TABLE_NOKEEPCOLUMNSVISIBLE
TABLE_NOKEEPCOLUMNSVISIBLE Disable keeping column always minimally visible when ScrollX is off and table gets too small. Not recommended if columns are resizable.
imgui.TABLE_PRECISEWIDTHS
TABLE_PRECISEWIDTHS Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth.
imgui.TABLE_NOCLIP
TABLE_NOCLIP Disable clipping rectangle for every individual columns (reduce draw command count, items will be able to overflow into other columns). Generally incompatible with TableSetupScrollFreeze().
imgui.TABLE_PADOUTERX
TABLE_PADOUTERX Default if BordersOuterV is on. Enable outer-most padding. Generally desirable if you have headers.
imgui.TABLE_NOPADOUTERX
TABLE_NOPADOUTERX Default if BordersOuterV is off. Disable outer-most padding.
imgui.TABLE_NOPADINNERX
TABLE_NOPADINNERX Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off).
imgui.TABLE_SCROLLX
TABLE_SCROLLX Enable horizontal scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this create a child window, ScrollY is currently generally recommended when using ScrollX.
imgui.TABLE_SCROLLY
TABLE_SCROLLY Enable vertical scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size.
imgui.TABLE_SORTMULTI
TABLE_SORTMULTI Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1).
imgui.TABLE_SORTTRISTATE
TABLE_SORTTRISTATE Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0).
imgui.WINDOWFLAGS_NONE
WINDOWFLAGS_NONE
imgui.WINDOWFLAGS_NOTITLEBAR
WINDOWFLAGS_NOTITLEBAR Disable title-bar
imgui.WINDOWFLAGS_NORESIZE
WINDOWFLAGS_NORESIZE Disable user resizing with the lower-right grip
imgui.WINDOWFLAGS_NOMOVE
WINDOWFLAGS_NOMOVE Disable user moving the window
imgui.WINDOWFLAGS_NOSCROLLBAR
WINDOWFLAGS_NOSCROLLBAR Disable scrollbars (window can still scroll with mouse or programmatically)
imgui.WINDOWFLAGS_NOSCROLLWITHMOUSE
WINDOWFLAGS_NOSCROLLWITHMOUSE Disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set.
imgui.WINDOWFLAGS_NOCOLLAPSE
WINDOWFLAGS_NOCOLLAPSE Disable user collapsing window by double-clicking on it
imgui.WINDOWFLAGS_ALWAYSAUTORESIZE
WINDOWFLAGS_ALWAYSAUTORESIZE Resize every window to its content every frame
imgui.WINDOWFLAGS_NOBACKGROUND
WINDOWFLAGS_NOBACKGROUND Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).
imgui.WINDOWFLAGS_NOSAVEDSETTINGS
WINDOWFLAGS_NOSAVEDSETTINGS Never load/save settings in .ini file
imgui.WINDOWFLAGS_NOMOUSEINPUTS
WINDOWFLAGS_NOMOUSEINPUTS Disable catching mouse, hovering test with pass through.
imgui.WINDOWFLAGS_MENUBAR
WINDOWFLAGS_MENUBAR Has a menu-bar
imgui.WINDOWFLAGS_HORIZONTALSCROLLBAR
WINDOWFLAGS_HORIZONTALSCROLLBAR prior to calling Begin() to specify width. Read code in imgui_demo in the "Horizontal Scrolling" section.
imgui.WINDOWFLAGS_NOFOCUSONAPPEARING
WINDOWFLAGS_NOFOCUSONAPPEARING Disable taking focus when transitioning from hidden to visible state
imgui.WINDOWFLAGS_NOBRINGTOFRONTONFOCUS
WINDOWFLAGS_NOBRINGTOFRONTONFOCUS Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)
imgui.WINDOWFLAGS_ALWAYSVERTICALSCROLLBAR
WINDOWFLAGS_ALWAYSVERTICALSCROLLBAR Always show vertical scrollbar (even if ContentSize.y < Size.y)
imgui.WINDOWFLAGS_ALWAYSHORIZONTALSCROLLBAR
WINDOWFLAGS_ALWAYSHORIZONTALSCROLLBAR Always show horizontal scrollbar (even if ContentSize.x < Size.x)
imgui.WINDOWFLAGS_ALWAYSUSEWINDOWPADDING
WINDOWFLAGS_ALWAYSUSEWINDOWPADDING Ensure child windows without border uses style.WindowPadding (ignored by default for non-bordered child windows, because more convenient)
imgui.WINDOWFLAGS_NONAVINPUTS
WINDOWFLAGS_NONAVINPUTS No gamepad/keyboard navigation within the window
imgui.WINDOWFLAGS_NONAVFOCUS
WINDOWFLAGS_NONAVFOCUS No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)
imgui.WINDOWFLAGS_UNSAVEDDOCUMENT
WINDOWFLAGS_UNSAVEDDOCUMENT Append '*' to title without affecting the ID, as a convenience to avoid using the ### operator. When used in a tab/docking context, tab is selected on closure and closure is deferred by one frame to allow code to cancel the closure (with a confirmation popup, etc.) without flicker.
imgui.WINDOWFLAGS_NONAV
WINDOWFLAGS_NONAV ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus,
imgui.WINDOWFLAGS_NODECORATION
WINDOWFLAGS_NODECORATION ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoCollapse,
imgui.WINDOWFLAGS_NOINPUTS
WINDOWFLAGS_NOINPUTS ImGuiWindowFlags_NoMouseInputs | ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus,
imgui.POPUPFLAGS_NONE
POPUPFLAGS_NONE
imgui.POPUPFLAGS_MOUSEBUTTONLEFT
POPUPFLAGS_MOUSEBUTTONLEFT // For BeginPopupContext*(): open on Left Mouse release. Guaranteed to always be == 0 (same as ImGuiMouseButton_Left)
imgui.POPUPFLAGS_MOUSEBUTTONRIGHT
POPUPFLAGS_MOUSEBUTTONRIGHT // For BeginPopupContext*(): open on Right Mouse release. Guaranteed to always be == 1 (same as ImGuiMouseButton_Right)
imgui.POPUPFLAGS_MOUSEBUTTONMIDDLE
POPUPFLAGS_MOUSEBUTTONMIDDLE // For BeginPopupContext*(): open on Middle Mouse release. Guaranteed to always be == 2 (same as ImGuiMouseButton_Middle)
imgui.POPUPFLAGS_MOUSEBUTTONMASK
POPUPFLAGS_MOUSEBUTTONMASK
imgui.POPUPFLAGS_MOUSEBUTTONDEFAULT
POPUPFLAGS_MOUSEBUTTONDEFAULT
imgui.POPUPFLAGS_NOOPENOVEREXISTINGPOPUP
POPUPFLAGS_NOOPENOVEREXISTINGPOPUP For OpenPopup*(), BeginPopupContext*(): don't open if there's already a popup at the same level of the popup stack
imgui.POPUPFLAGS_NOOPENOVERITEMS
POPUPFLAGS_NOOPENOVERITEMS For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space
imgui.POPUPFLAGS_ANYPOPUPID
POPUPFLAGS_ANYPOPUPID For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup.
imgui.POPUPFLAGS_ANYPOPUPLEVEL
POPUPFLAGS_ANYPOPUPLEVEL For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level)
imgui.POPUPFLAGS_ANYPOPUP
POPUPFLAGS_ANYPOPUP
imgui.DROPFLAGS_NONE
DROPFLAGS_NONE
imgui.DROPFLAGS_SOURCENOPREVIEWTOOLTIP
DROPFLAGS_SOURCENOPREVIEWTOOLTIP By default, a successful call to BeginDragDropSource opens a tooltip so you can display a preview or description of the source contents. This flag disable this behavior.
imgui.DROPFLAGS_SOURCENODISABLEHOVER
DROPFLAGS_SOURCENODISABLEHOVER By default, when dragging we clear data so that IsItemHovered() will return false, to avoid subsequent user code submitting tooltips. This flag disable this behavior so you can still call IsItemHovered() on the source item.
imgui.DROPFLAGS_SOURCENOHOLDTOOPENOTHERS
DROPFLAGS_SOURCENOHOLDTOOPENOTHERS Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item.
imgui.DROPFLAGS_SOURCEALLOWNULLID
DROPFLAGS_SOURCEALLOWNULLID Allow items such as Text(), Image() that have no unique identifier to be used as drag source, by manufacturing a temporary identifier based on their window-relative position. This is extremely unusual within the dear imgui ecosystem and so we made it explicit.
imgui.DROPFLAGS_SOURCEEXTERN
DROPFLAGS_SOURCEEXTERN External source (from outside of dear imgui), won't attempt to read current item/window info. Will always return true. Only one Extern source can be active simultaneously.
imgui.DROPFLAGS_SOURCEAUTOEXPIREPAYLOAD
DROPFLAGS_SOURCEAUTOEXPIREPAYLOAD Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged)
imgui.DROPFLAGS_ACCEPTBEFOREDELIVERY
DROPFLAGS_ACCEPTBEFOREDELIVERY AcceptDragDropPayload() will returns true even before the mouse button is released. You can then call IsDelivery() to test if the payload needs to be delivered.
imgui.DROPFLAGS_ACCEPTNODRAWDEFAULTRECT
DROPFLAGS_ACCEPTNODRAWDEFAULTRECT Do not draw the default highlight rectangle when hovering over target.
imgui.DROPFLAGS_ACCEPTNOPREVIEWTOOLTIP
DROPFLAGS_ACCEPTNOPREVIEWTOOLTIP Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.
imgui.DROPFLAGS_ACCEPTPEEKONLY
DROPFLAGS_ACCEPTPEEKONLY For peeking ahead and inspecting the payload before delivery.
imgui.INPUTFLAGS_NONE
INPUTFLAGS_NONE
imgui.INPUTFLAGS_CHARSDECIMAL
INPUTFLAGS_CHARSDECIMAL
imgui.INPUTFLAGS_CHARSHEXADECIMAL
INPUTFLAGS_CHARSHEXADECIMAL
imgui.INPUTFLAGS_CHARSUPPERCASE
INPUTFLAGS_CHARSUPPERCASE Turn a..z into A..Z
imgui.INPUTFLAGS_CHARSNOBLANK
INPUTFLAGS_CHARSNOBLANK Filter out spaces, tabs
imgui.INPUTFLAGS_AUTOSELECTALL
INPUTFLAGS_AUTOSELECTALL Select entire text when first taking mouse focus
imgui.INPUTFLAGS_ENTERRETURNSTRUE
INPUTFLAGS_ENTERRETURNSTRUE Return 'true' when Enter is pressed (as opposed to every time the value was modified). Consider looking at the IsItemDeactivatedAfterEdit() function.
imgui.INPUTFLAGS_CALLBACKCOMPLETION
INPUTFLAGS_CALLBACKCOMPLETION Callback on pressing TAB (for completion handling)
imgui.INPUTFLAGS_CALLBACKHISTORY
INPUTFLAGS_CALLBACKHISTORY Callback on pressing Up/Down arrows (for history handling)
imgui.INPUTFLAGS_CALLBACKALWAYS
INPUTFLAGS_CALLBACKALWAYS Callback on each iteration. User code may query cursor position, modify text buffer.
imgui.INPUTFLAGS_CALLBACKCHARFILTER
INPUTFLAGS_CALLBACKCHARFILTER Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard.
imgui.INPUTFLAGS_ALLOWTABINPUT
INPUTFLAGS_ALLOWTABINPUT Pressing TAB input a '\t' character into the text field
imgui.INPUTFLAGS_CTRLENTERFORNEWLINE
INPUTFLAGS_CTRLENTERFORNEWLINE In multi-line mode, unfocus with Enter, add new line with Ctrl+Enter (default is opposite: unfocus with Ctrl+Enter, add line with Enter).
imgui.INPUTFLAGS_NOHORIZONTALSCROLL
INPUTFLAGS_NOHORIZONTALSCROLL Disable following the cursor horizontally
imgui.INPUTFLAGS_ALWAYSOVERWRITE
INPUTFLAGS_ALWAYSOVERWRITE Insert mode
imgui.INPUTFLAGS_READONLY
INPUTFLAGS_READONLY Read-only mode
imgui.INPUTFLAGS_PASSWORD
INPUTFLAGS_PASSWORD Password mode, display all characters as '*'
imgui.INPUTFLAGS_NOUNDOREDO
INPUTFLAGS_NOUNDOREDO Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call ClearActiveID().
imgui.INPUTFLAGS_CHARSSCIENTIFIC
INPUTFLAGS_CHARSSCIENTIFIC Allow 0123456789.+-*/eE (Scientific notation input)
imgui.INPUTFLAGS_CALLBACKRESIZE
INPUTFLAGS_CALLBACKRESIZE Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow. Notify when the string wants to be resized (for string types which hold a cache of their Size). You will be provided a new BufSize in the callback and NEED to honor it. (see misc/cpp/imgui_stdlib.h for an example of using this)
imgui.INPUTFLAGS_CALLBACKEDIT
INPUTFLAGS_CALLBACKEDIT Callback on any edit (note that InputText() already returns true on edit, the callback is useful mainly to manipulate the underlying buffer while focus is active)
imgui.INPUTFLAGS_ESCAPECLEARSALL
INPUTFLAGS_ESCAPECLEARSALL Callback on any edit (note that InputText() already returns true on edit, the callback is useful mainly to manipulate the underlying buffer while focus is active)
imgui.COLOREDITFLAGS_NONE
COLOREDITFLAGS_NONE
imgui.COLOREDITFLAGS_NOALPHA
COLOREDITFLAGS_NOALPHA // ColorEdit, ColorPicker, ColorButton: ignore Alpha component (will only read 3 components from the input pointer).
imgui.COLOREDITFLAGS_NOPICKER
COLOREDITFLAGS_NOPICKER // ColorEdit: disable picker when clicking on color square.
imgui.COLOREDITFLAGS_NOOPTIONS
COLOREDITFLAGS_NOOPTIONS // ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.
imgui.COLOREDITFLAGS_NOSMALLPREVIEW
COLOREDITFLAGS_NOSMALLPREVIEW // ColorEdit, ColorPicker: disable color square preview next to the inputs. (e.g. to show only the inputs)
imgui.COLOREDITFLAGS_NOINPUTS
COLOREDITFLAGS_NOINPUTS // ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview color square).
imgui.COLOREDITFLAGS_NOTOOLTIP
COLOREDITFLAGS_NOTOOLTIP // ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.
imgui.COLOREDITFLAGS_NOLABEL
COLOREDITFLAGS_NOLABEL // ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker).
imgui.COLOREDITFLAGS_NOSIDEPREVIEW
COLOREDITFLAGS_NOSIDEPREVIEW // ColorPicker: disable bigger color preview on right side of the picker, use small color square preview instead.
imgui.COLOREDITFLAGS_NODRAGDROP
COLOREDITFLAGS_NODRAGDROP // ColorEdit: disable drag and drop target. ColorButton: disable drag and drop source.
imgui.COLOREDITFLAGS_NOBORDER
COLOREDITFLAGS_NOBORDER // ColorButton: disable border (which is enforced by default)
imgui.COLOREDITFLAGS_ALPHABAR
COLOREDITFLAGS_ALPHABAR // ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.
imgui.COLOREDITFLAGS_ALPHAPREVIEW
COLOREDITFLAGS_ALPHAPREVIEW // ColorEdit, ColorPicker, ColorButton: display preview as a transparent color over a checkerboard, instead of opaque.
imgui.COLOREDITFLAGS_ALPHAPREVIEWHALF
COLOREDITFLAGS_ALPHAPREVIEWHALF // ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard, instead of opaque.
imgui.COLOREDITFLAGS_HDR
COLOREDITFLAGS_HDR // (WIP) ColorEdit: Currently only disable 0.0f..1.0f limits in RGBA edition (note: you probably want to use ImGuiColorEditFlags_Float flag as well).
imgui.COLOREDITFLAGS_DISPLAYRGB
COLOREDITFLAGS_DISPLAYRGB [Display] // ColorEdit: override display type among RGB/HSV/Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex.
imgui.COLOREDITFLAGS_DISPLAYHSV
COLOREDITFLAGS_DISPLAYHSV [Display] // "
imgui.COLOREDITFLAGS_DISPLAYHEX
COLOREDITFLAGS_DISPLAYHEX [Display] // "
imgui.COLOREDITFLAGS_UINT8
COLOREDITFLAGS_UINT8 [DataType] // ColorEdit, ColorPicker, ColorButton: display values formatted as 0..255.
imgui.COLOREDITFLAGS_FLOAT
COLOREDITFLAGS_FLOAT [DataType] // ColorEdit, ColorPicker, ColorButton: display values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers.
imgui.COLOREDITFLAGS_PICKERHUEBAR
COLOREDITFLAGS_PICKERHUEBAR [Picker] // ColorPicker: bar for Hue, rectangle for Sat/Value.
imgui.COLOREDITFLAGS_PICKERHUEWHEEL
COLOREDITFLAGS_PICKERHUEWHEEL [Picker] // ColorPicker: wheel for Hue, triangle for Sat/Value.
imgui.COLOREDITFLAGS_INPUTRGB
COLOREDITFLAGS_INPUTRGB [Input] // ColorEdit, ColorPicker: input and output data in RGB format.
imgui.COLOREDITFLAGS_INPUTHSV
COLOREDITFLAGS_INPUTHSV [Input] // ColorEdit, ColorPicker: input and output data in HSV format.
imgui.COND_NONE
COND_NONE No condition (always set the variable), same as _Always
imgui.COND_ALWAYS
COND_ALWAYS No condition (always set the variable)
imgui.COND_ONCE
COND_ONCE Set the variable once per runtime session (only the first call will succeed)
imgui.COND_FIRSTUSEEVER
COND_FIRSTUSEEVER Set the variable if the object/window has no persistently saved data (no entry in .ini file)
imgui.COND_APPEARING
COND_APPEARING Set the variable if the object/window is appearing after being hidden/inactive (or the first time)
imgui.DIR_NONE
DIR_NONE
imgui.DIR_LEFT
DIR_LEFT
imgui.DIR_RIGHT
DIR_RIGHT
imgui.DIR_UP
DIR_UP
imgui.DIR_DOWN
DIR_DOWN
imgui.GLYPH_RANGES_DEFAULT
GLYPH_RANGES_DEFAULT // Basic Latin, Extended Latin
imgui.GLYPH_RANGES_GREEK
GLYPH_RANGES_GREEK // Default + Greek and Coptic
imgui.GLYPH_RANGES_KOREAN
GLYPH_RANGES_KOREAN // Default + Korean characters
imgui.GLYPH_RANGES_JAPANESE
GLYPH_RANGES_JAPANESE // Default + Hiragana, Katakana, Half-Width, Selection of 2999 Ideographs
imgui.GLYPH_RANGES_CHINESEFULL
GLYPH_RANGES_CHINESEFULL // Default + Half-Width + Japanese Hiragana/Katakana + full set of about 21000 CJK Unified Ideographs
imgui.GLYPH_RANGES_CHINESESIMPLIFIEDCOMMON
GLYPH_RANGES_CHINESESIMPLIFIEDCOMMON // Default + Half-Width + Japanese Hiragana/Katakana + set of 2500 CJK Unified Ideographs for common simplified Chinese
imgui.GLYPH_RANGES_CYRILLIC
GLYPH_RANGES_CYRILLIC // Default + about 400 Cyrillic characters
imgui.GLYPH_RANGES_THAI
GLYPH_RANGES_THAI // Default + Thai characters
imgui.GLYPH_RANGES_VIETNAMESE
GLYPH_RANGES_VIETNAMESE // Default + Vietnamese characters
imgui.STYLEVAR_ALPHA
STYLEVAR_ALPHA // float Alpha
imgui.STYLEVAR_DISABLEDALPHA
STYLEVAR_DISABLEDALPHA float DisabledAlpha
imgui.STYLEVAR_WINDOWPADDING
STYLEVAR_WINDOWPADDING ImVec2 WindowPadding
imgui.STYLEVAR_WINDOWROUNDING
STYLEVAR_WINDOWROUNDING // float WindowRounding
imgui.STYLEVAR_WINDOWBORDERSIZE
STYLEVAR_WINDOWBORDERSIZE // float WindowBorderSize
imgui.STYLEVAR_WINDOWMINSIZE
STYLEVAR_WINDOWMINSIZE ImVec2 WindowMinSize
imgui.STYLEVAR_WINDOWTITLEALIGN
STYLEVAR_WINDOWTITLEALIGN // ImVec2 WindowTitleAlign
imgui.STYLEVAR_CHILDROUNDING
STYLEVAR_CHILDROUNDING float ChildRounding
imgui.STYLEVAR_CHILDBORDERSIZE
STYLEVAR_CHILDBORDERSIZE // float ChildBorderSize
imgui.STYLEVAR_POPUPROUNDING
STYLEVAR_POPUPROUNDING float PopupRounding
imgui.STYLEVAR_POPUPBORDERSIZE
STYLEVAR_POPUPBORDERSIZE // float PopupBorderSize
imgui.STYLEVAR_FRAMEPADDING
STYLEVAR_FRAMEPADDING // ImVec2 FramePadding
imgui.STYLEVAR_FRAMEROUNDING
STYLEVAR_FRAMEROUNDING float FrameRounding
imgui.STYLEVAR_FRAMEBORDERSIZE
STYLEVAR_FRAMEBORDERSIZE // float FrameBorderSize
imgui.STYLEVAR_ITEMSPACING
STYLEVAR_ITEMSPACING // ImVec2 ItemSpacing
imgui.STYLEVAR_ITEMINNERSPACING
STYLEVAR_ITEMINNERSPACING // ImVec2 ItemInnerSpacing
imgui.STYLEVAR_INDENTSPACING
STYLEVAR_INDENTSPACING float IndentSpacing
imgui.STYLEVAR_CELLPADDING
STYLEVAR_CELLPADDING // ImVec2 CellPadding
imgui.STYLEVAR_SCROLLBARSIZE
STYLEVAR_SCROLLBARSIZE float ScrollbarSize
imgui.STYLEVAR_SCROLLBARROUNDING
STYLEVAR_SCROLLBARROUNDING // float ScrollbarRounding
imgui.STYLEVAR_GRABMINSIZE
STYLEVAR_GRABMINSIZE // float GrabMinSize
imgui.STYLEVAR_GRABROUNDING
STYLEVAR_GRABROUNDING // float GrabRounding
imgui.STYLEVAR_TABROUNDING
STYLEVAR_TABROUNDING // float TabRounding
imgui.STYLEVAR_TABBORDERSIZE
STYLEVAR_TABBORDERSIZE float TabBorderSize
imgui.STYLEVAR_TABBARBORDERSIZE
STYLEVAR_TABBARBORDERSIZE // float TabBarBorderSize
imgui.STYLEVAR_TABLEANGLEDHEADERSANGLE
STYLEVAR_TABLEANGLEDHEADERSANGLE // float TableAngledHeadersAngle
imgui.STYLEVAR_TABLEANGLEDHEADERSTEXTALIGN
STYLEVAR_TABLEANGLEDHEADERSTEXTALIGN ImVec2 TableAngledHeadersTextAlign
imgui.STYLEVAR_BUTTONTEXTALIGN
STYLEVAR_BUTTONTEXTALIGN // ImVec2 ButtonTextAlign
imgui.STYLEVAR_SELECTABLETEXTALIGN
STYLEVAR_SELECTABLETEXTALIGN // ImVec2 SelectableTextAlign
imgui.STYLEVAR_SEPARATORTEXTBORDERSIZE
STYLEVAR_SEPARATORTEXTBORDERSIZE // float SeparatorTextBorderSize
imgui.STYLEVAR_SEPARATORTEXTALIGN
STYLEVAR_SEPARATORTEXTALIGN // ImVec2 SeparatorTextAlign
imgui.STYLEVAR_SEPARATORTEXTPADDING
STYLEVAR_SEPARATORTEXTPADDING // ImVec2 SeparatorTextPadding