Dear ImGui API: Difference between revisions

From GiderosMobile
mNo edit summary
 
(48 intermediate revisions by the same user not shown)
Line 2: Line 2:
'''Dear ImGui LUA binding for Gideros Mobile'''
'''Dear ImGui LUA binding for Gideros Mobile'''


(copied from @'''rrraptor''''s GitHub '''https://github.com/MultiPain/Gideros_ImGui''')
GitHub '''https://github.com/MultiPain/Gideros_ImGui'''


== Constructor ==
== Constructor ==
Line 13: Line 13:
</syntaxhighlight>
</syntaxhighlight>


== EXPERIMENTAL ==
== IO Functions ==
'''GetIO'''() access the IO structure (mouse/keyboard/gamepad inputs, time, various configuration options/flags)
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
p_open = ImGui:showLog(title, p_open [, ImGui.WindowFlags = 0]) -- draw log window
local IO = ImGui:getIO()
ImGui:writeLog(text)
</syntaxhighlight>
</syntaxhighlight>


Gestures (touch only, turned OFF by default) ''WIP'':
'''Functions''':
* tap gesture (Left Mouse Button)
Settings/.Ini Utilities
* hold gesture (Right Mouse Button)
* The disk functions are automatically called if io.IniFilename != NULL (default is "imgui.ini").
<syntaxhighlight lang="lua">
* Set io.IniFilename to NULL to load/save manually. Read io.WantSaveIniSettings description about handling .ini saving manually.
ImGui:setTouchGesturesEnabled(bool)
bool = ImGui:isTouchGesturesEnabled()
</syntaxhighlight>


== FONTS ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
IO = imgui:getIO()
IO:setFontDefault(font)
FontAtlas = IO:getFonts()
ImGuiConfigFlag = IO:getConfigFlags()
 
IO:setConfigFlags(ImGui.ConfigFlag)
Font = FontAtlas:addFont(ttf_font_path, font_size [, options])
IO:addConfigFlags(ImGui.ConfigFlag)
 
ImGuiBackendFlag = IO:getBackendFlags()
-- options (table): all parameters are optional
IO:setBackendFlags(ImGui.BackendFlag)
--     fontDataOwnedByAtlas - bool
number = IO:getIniSavingRate()
--     pixelSnapH - bool
IO:setIniSavingRate(number)
--     mergeMode - bool
string = IO:getIniFilename()
--     fontNo - number
IO:setIniFilename(string)
--     oversampleH - number
IO:saveIniSettings([path]) -- if path is not defined the it uses default path, which is set by IO:setIniFilename()
--     oversampleV - number
IO:loadIniSettings([path])
--     glyphExtraSpacingX - number
string = IO:getLogFilename()
--     glyphExtraSpacingY - number
IO:setLogFilename(string)
--     glyphOffsetX - number
number = IO:getMouseDoubleClickTime()
--     glyphOffsetY - number
IO:setMouseDoubleClickTime(number)
--     glyphMinAdvanceX - number
number = IO:getMouseDragThreshold()
--     glyphMaxAdvanceX - number
IO:setMouseDragThreshold(number)
--     rasterizerFlags - number
flag = IO:getMouseDrawCursor()
--     rasterizerMultiply - number
IO:setMouseDrawCursor(flag)
--
number = IO:getMouseDoubleClickMaxDist()
--     glyphs - table:
IO:setMouseDoubleClickMaxDist(number)
--     text(string): represents available chars
number = IO:getKeyRepeatDelay()
--     chars(table): list of specific char code (example: {0x7262, ...})
IO:setKeyRepeatDelay(number)
--     ranges(table): predefined glyph ranges (example: {ImGui.GlyphRanges_Default, ImGui.GlyphRanges_Japanese, ...})
number = IO:getKeyRepeatRate()
FontAtlas:addFonts(fontsDescription)
IO:setKeyRepeatRate(number)
-- fontsDescriptions(table):
number = IO:getFontGlobalScale()
--      description(table):
IO:setFontGlobalScale(number)
--          ttf_font_path(string): path to a font
bool = IO:getFontAllowUserScaling()
--          font_size(number): font size
IO:setFontAllowUserScaling(bool)
--          options(table): see description above
number, number = IO:getDisplayFramebufferScale()
-- example:
IO:setDisplayFramebufferScale(number, number)
-- FontAtlas:addFonts{ {"fonts/DroidSans.ttf", 16}, {"fonts/ProggyTiny.ttf", 16} }
bool = IO:getConfigMacOSXBehaviors()
 
IO:setConfigMacOSXBehaviors(bool)
Font = FontAtlas:getFont([index]) -- get font by index (if index is 0 or nil you will get default font instance)
bool = IO:getConfigInputTextCursorBlink()
FontAtlas:build() -- call after multiple FontAtlas:addFont(...) calls to update ImGui font atlas
IO:setConfigInputTextCursorBlink(bool)
FontAtlas:clearInputData()
bool = IO:getConfigWindowsResizeFromEdges()
FontAtlas:clearTexData()
IO:setConfigWindowsResizeFromEdges(bool)
FontAtlas:clearFonts()
bool = IO:getConfigWindowsMoveFromTitleBarOnly()
FontAtlas:clear()
IO:setConfigWindowsMoveFromTitleBarOnly(bool)
table = FontAtlas:getFonts() -- returns a table with all fonts (included default)
number = IO:getConfigWindowsMemoryCompactTimer()
flag = FontAtlas:isBuilt()
IO:setConfigWindowsMemoryCompactTimer(number)
number = FontAtlas:addCustomRectRegular(width, height)
string = IO:getBackendPlatformName()
number = FontAtlas:addCustomRectFontGlyph(font, id, width, height, advance_x [, offset_x, offset_y])
string = IO:getBackendRendererName()
w, h, x, y, glyph_id, offset_x, offset_y, font, is_packed_flag = FontAtlas:getCustomRectByIndex(index)
bool = IO:IsMouseDown(button)
 
number = IO:getMouseWheel()
ImGui:pushFont(font) -- font (table): object returned by FontAtlas:addFont(...) or FontAtlas:getFont([index])
number = IO:getMouseWheelH()
ImGui:popFont()
flag = IO:wantCaptureMouse()
</syntaxhighlight>
flag = IO:wantCaptureKeyboard()
flag = IO:wantTextInput()
flag = IO:wantSetMousePos()
flag = IO:wantSaveIniSettings()
number = IO:getFramerate()
number = IO:getMetricsRenderVertices()
number = IO:getMetricsRenderIndices()
number = IO:getMetricsRenderWindows()
number = IO:getMetricsActiveWindows()
number = IO:getMetricsActiveAllocations()
x, y = IO:getMouseDelta()
number = IO:getMouseDownSec(mouse_button)
IO:setDisplaySize(w, h)
w, h = IO:getDisplaySize()
number = IO:getDeltaTime()
-- reset mouse buttons state
IO:resetMouseDown()
-- reset key states (including ALT/SHIFT/CTRL/SUPER (META))
IO:resetKeysDown()
-- set ALT/SHIFT/CTRL/SUPER (META) key state
IO:setModKeyDown(key_code, bool) -- "key_code" is a gideros MOD key
-- set any key state
IO:setKeysDown(key_code, bool) -- "key_code" is a gideros regular "keyCode"
-- adds text to active text input widget
IO:addInputCharactersUTF8(text)
-- emulate wheel scrolling
IO:setMouseWheel(number)
-- sets mouse position (data only, no visual changes)
IO:setMousePos(x, y)
-- set mouse state, where index: 0 - left mouse, 1 - right, 2 - middle, 3 - unused, 4 - unused.
IO:setMouseDown(mouse_button, state) -- "mouse_button" is a gideros mouse button code


'''Minimal example''':
-- "key" is any ImGui KeyCode (check [here](#keyboard-keys))
<syntaxhighlight lang="lua">
-- "down" is a boolean
local UI = ImGui.new()
IO:addKeyEvent(key, down)
local IO = UI:getIO()
IO:addKeyAnalogEvent(key, down, number)
local FontAtlas = IO:getFonts()
IO:AddMousePosEvent(x, y)
local VDS_font = FontAtlas:addFont("fonts/VDS.ttf", 16, {
-- "button" is any ImGui button (check [here](#MouseButton))
    oversampleH = 2,
IO:addMouseButtonEvent(button, down)
    oversampleV = 2,
IO:addMouseWheelEvent(x, y)
glyphs = {
 
ranges = {ImGui.GlyphRanges_Cyrillic}
IO:setAppAcceptingEvents([accepting_events = true])
}
</syntaxhighlight>
})
IO:setFontDefault(VDS_font)
FontAtlas:build()
stage:addChild(UI)


-- you can use multiple fonts at the same time
== Style setters/getters ==
function enterFrame(e)
'''GetStyle'''() instance access the Style structure (colors, sizes). Always use PushStyleCol(), PushStyleVar() to modify style mid-frame!
UI:newFrame(e.deltaTime)
<syntaxhighlight lang="lua">
local Style = ImGui:getStyle()
UI:pushFont(font1)
UI:text("Font1")
UI:popFont()
UI:pushFont(font2)
UI:text("Font2")
UI:popFont()
UI:render()
UI:endFrame()
end
</syntaxhighlight>
</syntaxhighlight>


'''Glyphs example''':
'''Setters/getters''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local fonts = io:getFonts()
Style:setColor(ImGui.Col, color, alpha)
fonts:addFont(font_path, font_size, {
color, alpha = Style:getColor(ImGui.Col)
glyphs = {
Style:setAlpha(value)
ranges = {
value = Style:getAlpha()
{
 
0x2590,0x2593, -- range1
Style:setWindowRounding(value)
0x2660,0x266B  -- range2
value = Style:getWindowRounding()
-- ...
Style:setWindowBorderSize(value)
},
value = Style:getWindowBorderSize()
ImGui.GlyphRanges_Cyrillic,
Style:setChildRounding(value)
{
value = Style:getChildRounding()
0x01C0, 0x01C3 -- range3
Style:setChildBorderSize(value)
},
value = Style:getChildBorderSize()
ImGui.GlyphRanges_Korean
Style:setPopupRounding(value)
},
value = Style:getPopupRounding()
Style:setPopupBorderSize(value)
-- same structure:
value = Style:getPopupBorderSize()
ranges = {
Style:setFrameRounding(value)
{
value = Style:getFrameRounding()
0x2590,0x2593, -- range1
Style:setFrameBorderSize(value)
0x2660,0x266B, -- range2
value = Style:getFrameBorderSize()
0x01C0,0x01C3  -- range3
Style:setIndentSpacing(value)
-- ...
value = Style:getIndentSpacing()
},
Style:setColumnsMinSpacing(value)
ImGui.GlyphRanges_Cyrillic,
value = Style:getColumnsMinSpacing()
ImGui.GlyphRanges_Korean
Style:setScrollbarSize(value)
}
value = Style:getScrollbarSize()
},
Style:setScrollbarRounding(value)
mergeMode = true, -- merge into previous font
value = Style:getScrollbarRounding()
})
Style:setGrabMinSize(value)
fonts:build()
value = Style:getGrabMinSize()
</syntaxhighlight>
Style:setGrabRounding(value)
 
value = Style:getGrabRounding()
'''Icons example''':
Style:setLogSliderDeadzone(value)
<syntaxhighlight lang="lua">
value = Style:getLogSliderDeadzone()
local icon = utf8.char(0x2590)
Style:setTabRounding(value)
ImGui:text("My icon >>" .. icon .. " << !!!")
value = Style:getTabRounding()
 
Style:setTabBorderSize(value)
-- or with new Luau support:
value = Style:getTabBorderSize()
ImGui:text("My icon >> \u{2590} << !!!")
Style:setTabMinWidthForCloseButton(value)
-- can be also stored in memory:
value = Style:getTabMinWidthForCloseButton()
local icon = "\u{2590}"
Style:setMouseCursorScale(value)
</syntaxhighlight>
value = Style:getMouseCursorScale()
 
Style:setCurveTessellationTol(value)
== Font ==
value = Style:getCurveTessellationTol()
<syntaxhighlight lang="lua">
Style:setCircleSegmentMaxError(value)
number = Font:getSize()
value = Style:getCircleSegmentMaxError()
FontAtlas = Font:getContainerAtlas()
Style:setWindowPadding(x, y)
Font:setScale(number)
x, y = Style:getWindowPadding()
number = Font:getScale()
Style:setWindowMinSize(x, y)
number = Font:getAscent()
x, y = Style:getWindowMinSize()
number = Font:getDescent()
Style:setWindowTitleAlign(x, y)
bool = Font:isLoaded()
x, y = Style:getWindowTitleAlign()
string = Font:getDebugName()
Style:setFramePadding(x, y)
w, h = Font:calcTextSizeA(size, max_width, wrap_width, string)
x, y = Style:getFramePadding()
Font:calcWordWrapPositionA(scale, string, wrap_width) -- not tested
Style:setCellPadding(x, y)
</syntaxhighlight>
x, y = Style:getCellPadding()
 
Style:setItemSpacing(x, y)
== INPUTS ==
x, y = Style:getItemSpacing()
<syntaxhighlight lang="lua">
Style:setItemInnerSpacing(x, y)
ImGui:onMouseHover(event)
x, y = Style:getItemInnerSpacing()
ImGui:onMouseMove(event)
Style:setTouchExtraPadding(x, y)
ImGui:onMouseDown(event)
x, y = Style:getTouchExtraPadding()
ImGui:onMouseUp(event)
Style:setButtonTextAlign(x, y)
ImGui:onMouseWheel(event)
x, y = Style:getButtonTextAlign()
Style:setSelectableTextAlign(x, y)
x, y = Style:getSelectableTextAlign()
Style:setDisplayWindowPadding(x, y)
x, y = Style:getDisplayWindowPadding()
Style:setDisplaySafeAreaPadding(x, y)
x, y = Style:getDisplaySafeAreaPadding()
Style:setWindowMenuButtonPosition(ImGui.Dir)
dir = Style:getWindowMenuButtonPosition()
Style:setColorButtonPosition(ImGui.Dir)
dir = Style:getColorButtonPosition()
Style:setAntiAliasedLines(flag)
flag = Style:getAntiAliasedLines()
Style:setAntiAliasedLinesUseTex(flag)
flag = Style:getAntiAliasedLinesUseTex()
Style:setAntiAliasedFill(flag)
flag = Style:getAntiAliasedFill()
Style:setDisabledAlpha(number)
alpha = Style:getDisabledAlpha()
Style:setSeparatorTextBorderSize(number)
number = Style:getSeparatorTextBorderSize()
Style:setSeparatorTextAlign(x, y)
x, y = Style:getSeparatorTextAlign()
Style:setSeparatorTextPadding(x, y)
x, y = Style:getSeparatorTextPadding()
</syntaxhighlight>


ImGui:onTouchMove(event)
=== DEFAULT STYLES ===
ImGui:onTouchBegin(event)
<syntaxhighlight lang="lua">
ImGui:onTouchEnd(event)
ImGui:setDarkStyle()
ImGui:onTouchCancel(event)
ImGui:setLightStyle()
ImGui:setClassicStyle()
</syntaxhighlight>


ImGui:onKeyUp(event)
== Render ==
ImGui:onKeyDown(event)
'''NewFrame'''() start a new Dear ImGui frame, you can submit any command from this point until Render()/EndFrame().
ImGui:onKeyChar(event)
</syntaxhighlight>


'''Usage examples''':
'''EndFrame'''() ends the Dear ImGui frame. Automatically called by Render(). If you don't need to render data (skipping rendering) you may call EndFrame() without Render()... but you'll have wasted CPU already! If you don't need to render, better to not create any windows and not call NewFrame() at all!
<syntaxhighlight lang="lua">
local UI = ImGui.new(nil, false, false, false)
</syntaxhighlight>


'''Mouse'''
'''Render'''() ends the Dear ImGui frame, finalize the draw data.
<syntaxhighlight lang="lua">
stage:addEventListener("mouseHover", function(e) UI:onMouseHover(e) end)
stage:addEventListener("mouseMove", function(e) UI:onMouseMove(e) end)
stage:addEventListener("mouseDown", function(e) UI:onMouseDown(e) end)
stage:addEventListener("mouseUp", function(e) UI:onMouseUp(e) end)
stage:addEventListener("mouseWheel", function(e) UI:onMouseWheel(e) end)
</syntaxhighlight>


'''Touch'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
stage:addEventListener("touchesCancel", function(e) ui:onTouchCancel(e) end)
ImGui:newFrame(deltaTime)
stage:addEventListener("touchesMove", function(e) ui:onTouchMove(e) end)
ImGui:render()
stage:addEventListener("touchesBegin", function(e) ui:onTouchBegin(e) end)
ImGui:endFrame()
stage:addEventListener("touchesEnd", function(e) ui:onTouchEnd(e) end)
</syntaxhighlight>
</syntaxhighlight>


'''Keyboard'''
=== Demos ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
stage:addEventListener("keyUp", function(e) UI:onKeyUp(e) end)
is_openFlag = ImGui:showUserGuide()
stage:addEventListener("keyDown", function(e) UI:onKeyDown(e) end)
is_openFlag = ImGui:showDemoWindow([p_open])
stage:addEventListener("keyChar", function(e) UI:onKeyChar(e) end)
is_openFlag = ImGui:showAboutWindow([p_open])
is_openFlag = ImGui:showStyleEditor()
is_openFlag = ImGui:showFontSelector()
is_openFlag = ImGui:showMetricsWindow([p_open])
is_openFlag = ImGui:showStyleSelector(label)
is_openFlag = ImGui:ShowStackToolWindow([p_open])
ImGui:showLuaStyleEditor()
</syntaxhighlight>
</syntaxhighlight>


== Style setters/getters ==
== Windows ==
Get style settings instance:
* Begin() = push window to the stack and start appending to it. End() = pop window from the stack.
* You may append multiple times to the same window during the same frame.
* Passing bool* p_open != NULL shows a window-closing widget in the upper-right corner of the window, which clicking will set the boolean to false when clicked.
* Begin() return false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window. Always call a matching End() for each Begin() call, regardless of its return value! [Important: due to legacy reason, this is inconsistent with most other functions such as BeginMenu / EndMenu, BeginPopup / EndPopup, etc. where the EndXXX call should only be called if the corresponding BeginXXX function returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]
* Note that the bottom of window stack always contains a window called "Debug".
 
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local Style = ImGui:getStyle()
p_open, draw = ImGui:beginWindow(label, p_open [, ImGui.WindowFlags = 0])
-- do not show "X" button
draw = ImGui:beginWindow(label, nil [, ImGui.WindowFlags = 0])
-- start a window with no borders, no paddings, no rounding and ImGui.WindowFlags_Fullscreen flag
p_open, draw = ImGui:beginFullScreenWindow(label, p_open [, ImGui.WindowFlags = 0])
-- do not show "X" button
draw = ImGui:beginFullScreenWindow(label, nil [, ImGui.WindowFlags = 0])
ImGui:endWindow()
</syntaxhighlight>
</syntaxhighlight>


'''Setters/getters''':
=== Child Windows ===
Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window. Child windows can embed their own child. For each independent axis of size:
* == 0.0f -> use remaining host window size
* > 0.0f -> fixed size
* < 0.0f -> use remaining window size minus abs(size) Each axis can use a different mode, e.g. ImVec2(0,400). BeginChild() returns false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window.
 
'''Tip'''
Always call a matching EndChild() for each BeginChild() call, regardless of its return value [as with Begin: this is due to legacy reason and inconsistent with most BeginXXX functions apart from the regular Begin() which behaves like BeginChild().]
 
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Style:setColor(ImGui.Col, color, alpha)
ImGui:beginChild(id [, w = 0, h = 0, borderFlag = false, ImGui.WindowFlags = 0])
color, alpha = Style:getColor(ImGui.Col)
ImGui:endChild()
Style:setAlpha(value)
</syntaxhighlight>
value = Style:getAlpha()
 
Style:setWindowRounding(value)
=== Windows Utilities ===
value = Style:getWindowRounding()
* Current window = the window we are appending into while inside a Begin() / End() block.
Style:setWindowBorderSize(value)
* Next window = next window we will Begin() into.
value = Style:getWindowBorderSize()
 
Style:setChildRounding(value)
* Prefer using SetNextXXX functions (before Begin) rather than SetXXX functions (after Begin()).
value = Style:getChildRounding()
 
Style:setChildBorderSize(value)
<syntaxhighlight lang="lua">
value = Style:getChildBorderSize()
flag = ImGui:isWindowAppearing()
Style:setPopupRounding(value)
flag = ImGui:isWindowCollapsed()
value = Style:getPopupRounding()
flag = ImGui:isWindowFocused([ImGui.FocusedFlags = 0])
Style:setPopupBorderSize(value)
flag = ImGui:isWindowHovered([ImGui.HoveredFlags = 0])
value = Style:getPopupBorderSize()
x, y = ImGui:getWindowPos()
Style:setFrameRounding(value)
w, h = ImGui:getWindowSize()
value = Style:getFrameRounding()
w = ImGui:getWindowWidth()
Style:setFrameBorderSize(value)
h = ImGui:getWindowHeight()
value = Style:getFrameBorderSize()
x1,y1, x2,y2 = ImGui:getWindowBounds() -- returns window region rectangle in global coordinates
Style:setIndentSpacing(value)
 
value = Style:getIndentSpacing()
ImGui:setNextWindowPos(x, y [, ImGui.Cond = 0, pivotX = 0, pivotY = 0])
Style:setColumnsMinSpacing(value)
ImGui:setNextWindowSize(w, h [, ImGui.Cond = 0])
value = Style:getColumnsMinSpacing()
ImGui:setNextWindowContentSize(w, h)
Style:setScrollbarSize(value)
ImGui:setNextWindowCollapsed(flag [, ImGui.Cond = 0])
value = Style:getScrollbarSize()
ImGui:setNextWindowFocus()
Style:setScrollbarRounding(value)
ImGui:setNextWindowBgAlpha(alpha)
value = Style:getScrollbarRounding()
ImGui:setNextWindowScroll(x, y)
Style:setGrabMinSize(value)
ImGui:setWindowPos(name, x, y [, ImGui.Cond = 0]) OR ImGui:setWindowPos(x, y [, ImGui.Cond = 0])
value = Style:getGrabMinSize()
ImGui:setWindowSize(name, w, h [, ImGui.Cond = 0]) OR ImGui:setWindowSize(w, h [, ImGui.Cond = 0])
Style:setGrabRounding(value)
ImGui:setWindowCollapsed(name, flag [, ImGui.Cond = 0]) OR ImGui:setWindowCollapsed(flag [, ImGui.Cond = 0])
value = Style:getGrabRounding()
ImGui:setWindowFocus(name) OR ImGui:setWindowFocus()
Style:setLogSliderDeadzone(value)
ImGui:setWindowFontScale(scale)
value = Style:getLogSliderDeadzone()
-- scroll window when touching void
Style:setTabRounding(value)
ImGui:scrollWhenDragging(x, y)
value = Style:getTabRounding()
</syntaxhighlight>
Style:setTabBorderSize(value)
 
value = Style:getTabBorderSize()
'''☠️Note: because Dear ImGui is an Immediate Mode GUI framework, functions that fetch window properties (like scrolling, window sizes, or content regions) internally query the "current window" pointer. If ImGui:begin() hasn't been called yet, or if ImGui:end() was already called, that pointer is NULL, causing a fatal segmentation fault/crash'''
Style:setTabMinWidthForCloseButton(value)
 
value = Style:getTabMinWidthForCloseButton()
=== Window size constraints ===
Style:setMouseCursorScale(value)
Can be used to set minimum and maximum window size, plus contraint the size if needed.
value = Style:getMouseCursorScale()
<syntaxhighlight lang="lua">
Style:setCurveTessellationTol(value)
-- call this function before ImGui:beginWindow()
value = Style:getCurveTessellationTol()
ImGui:setNextWindowSizeConstraints(min_w, min_h, max_w, max_h [, resize_callback, user_data]))
Style:setCircleSegmentMaxError(value)
-- resizeCallback is a function:
value = Style:getCircleSegmentMaxError()
function (callbackData [, user_data])
Style:setWindowPadding(x, y)
-- do some math, and return desired size
x, y = Style:getWindowPadding()
-- ...
Style:setWindowMinSize(x, y)
return desired_width, desired_height
x, y = Style:getWindowMinSize()
end
Style:setWindowTitleAlign(x, y)
</syntaxhighlight>
x, y = Style:getWindowTitleAlign()
 
Style:setFramePadding(x, y)
'''Resize callback''':
x, y = Style:getFramePadding()
<syntaxhighlight lang="lua">
Style:setCellPadding(x, y)
-- get window position
x, y = Style:getCellPadding()
x, y = callbackData:getPos()
Style:setItemSpacing(x, y)
x = callbackData:getX()
x, y = Style:getItemSpacing()
y = callbackData:getY()
Style:setItemInnerSpacing(x, y)
 
x, y = Style:getItemInnerSpacing()
-- get currrent size
Style:setTouchExtraPadding(x, y)
current_width, current_height = callbackData:getCurrentSize()
x, y = Style:getTouchExtraPadding()
current_width = callbackData:getCurrentWidth()
Style:setButtonTextAlign(x, y)
current_height = callbackData:getCurrentHeight()
x, y = Style:getButtonTextAlign()
 
Style:setSelectableTextAlign(x, y)
-- get desired size
x, y = Style:getSelectableTextAlign()
desired_width, desired_height = callbackData:getDesiredSize()
Style:setDisplayWindowPadding(x, y)
desired_width = callbackData:getDesiredWidth()
x, y = Style:getDisplayWindowPadding()
desired_height = callbackData:getDesiredHeight()
Style:setDisplaySafeAreaPadding(x, y)
</syntaxhighlight>
x, y = Style:getDisplaySafeAreaPadding()
 
Style:setWindowMenuButtonPosition(ImGui.Dir)
'''Example''':
dir = Style:getWindowMenuButtonPosition()
<syntaxhighlight lang="lua">
Style:setColorButtonPosition(ImGui.Dir)
require "ImGui"
dir = Style:getColorButtonPosition()
 
Style:setAntiAliasedLines(flag)
local function stepSize(callback_data, step)
flag = Style:getAntiAliasedLines()
local w, h = callback_data:getDesiredSize()
Style:setAntiAliasedLinesUseTex(flag)
w = (w // step) * step
flag = Style:getAntiAliasedLinesUseTex()
h = (h // step) * step
Style:setAntiAliasedFill(flag)
return w, h
flag = Style:getAntiAliasedFill()
end
Style:setDisabledAlpha(number)
 
alpha = Style:getDisabledAlpha()
local ui = ImGui.new()
Style:setSeparatorTextBorderSize(number)
stage:addChild(ui)
number = Style:getSeparatorTextBorderSize()
 
Style:setSeparatorTextAlign(x, y)
stage:addEventListener("enterFrame", function(e)
x, y = Style:getSeparatorTextAlign()
ui:newFrame(e.deltaTime)
Style:setSeparatorTextPadding(x, y)
x, y = Style:getSeparatorTextPadding()
-- window size step is 32 (last argument, that is passed to the callback as second argument)
ui:setNextWindowSizeConstraints(200, 200, 400, 400, stepSize, 32)
if (ui:beginWindow("My window")) then
ui:textWrapped("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.")
end
ui:endWindow()
ui:showDemoWindow()
ui:render()
ui:endFrame()
end)
</syntaxhighlight>
</syntaxhighlight>


== DEFAULT STYLES ==
=== Content region ===
<syntaxhighlight lang="lua">
* Those functions are bound to be redesigned soon (they are confusing, incomplete and return values in local window coordinates which increases confusion)
ImGui:setDarkStyle()
ImGui:setLightStyle()
ImGui:setClassicStyle()
</syntaxhighlight>


== Color convert ==
'''Note''': use ''DOT'' instead of ''COLON'', so you can use it without creating an ImGui object
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
r, g, b, a = ImGui.colorConvertHEXtoRGB(color [, alpha = 1])
scaleX, scaleY = ImGui:getContentRegionMax()
hex = ImGui.colorConvertRGBtoHEX(r, g, b)
w, h = ImGui:getContentRegionAvail()
h, s, v = ImGui.colorConvertRGBtoHSV(r, g, b)
x, y = ImGui:getWindowContentRegionMin()
r, g, b = ImGui.colorConvertHSVtoRGB(h, s, v)
x, y = ImGui:getWindowContentRegionMax()
h, s, v = ImGui.colorConvertHEXtoHSV(hex)
hex = ImGui.colorConvertHSVtoHEX(h, s, v)
</syntaxhighlight>
</syntaxhighlight>


== IO Functions ==
'''☠️Note: because Dear ImGui is an Immediate Mode GUI framework, functions that fetch window properties (like scrolling, window sizes, or content regions) internally query the "current window" pointer. If ImGui:begin() hasn't been called yet, or if ImGui:end() was already called, that pointer is NULL, causing a fatal segmentation fault/crash'''
Get IO instance:
<syntaxhighlight lang="lua">
local IO = ImGui:getIO()
</syntaxhighlight>


'''Functions''':
=== Windows Scrolling ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
IO:setFontDefault(font)
x = ImGui:getScrollX()
ImGuiConfigFlag = IO:getConfigFlags()
y = ImGui:getScrollY()
IO:setConfigFlags(ImGui.ConfigFlag)
maxX = ImGui:getScrollMaxX()
IO:addConfigFlags(ImGui.ConfigFlag)
maxY = ImGui:getScrollMaxY()
ImGuiBackendFlag = IO:getBackendFlags()
ImGui:setScrollX(value)
IO:setBackendFlags(ImGui.BackendFlag)
ImGui:setScrollY(value)
number = IO:getIniSavingRate()
ImGui:setScrollHereX([ratio = 0.5])
IO:setIniSavingRate(number)
ImGui:setScrollHereY([ratio = 0.5])
string = IO:getIniFilename()
ImGui:setScrollFromPosX(x [, ratio = 0.5])
IO:setIniFilename(string)
ImGui:setScrollFromPosY(y [, ratio = 0.5])
IO:saveIniSettings([path]) -- if path is not defined it uses default path, which is set by IO:setIniFilename()
</syntaxhighlight>
IO:loadIniSettings([path])
 
string = IO:getLogFilename()
'''☠️Note: because Dear ImGui is an Immediate Mode GUI framework, functions that fetch window properties (like scrolling, window sizes, or content regions) internally query the "current window" pointer. If ImGui:begin() hasn't been called yet, or if ImGui:end() was already called, that pointer is NULL, causing a fatal segmentation fault/crash'''
IO:setLogFilename(string)
 
number = IO:getMouseDoubleClickTime()
'''Example'''
IO:setMouseDoubleClickTime(number)
<syntaxhighlight lang="lua">
number = IO:getMouseDragThreshold()
self.doresetscrollbar = false
IO:setMouseDragThreshold(number)
...
flag = IO:getMouseDrawCursor()
self.doresetscrollbar = true
IO:setMouseDrawCursor(flag)
 
number = IO:getMouseDoubleClickMaxDist()
function Level1:onEnterFrame(e)
IO:setMouseDoubleClickMaxDist(number)
self.imgui:newFrame(e.deltaTime)
number = IO:getKeyRepeatDelay()
self.imgui:beginWindow("window") -- #1
IO:setKeyRepeatDelay(number)
if self.doresetscrollbar then
number = IO:getKeyRepeatRate()
self.doresetscrollbar = false
IO:setKeyRepeatRate(number)
self.imgui:setScrollY(0)
number = IO:getFontGlobalScale()
end
IO:setFontGlobalScale(number)
...
bool = IO:getFontAllowUserScaling()
self.imgui:endWindow() -- #1
IO:setFontAllowUserScaling(bool)
self.imgui:endFrame()
number, number = IO:getDisplayFramebufferScale()
self.imgui:render()
IO:setDisplayFramebufferScale(number, number)
end
bool = IO:getConfigMacOSXBehaviors()
</syntaxhighlight>
IO:setConfigMacOSXBehaviors(bool)
 
bool = IO:getConfigInputTextCursorBlink()
== Parameters stacks (shared) ==
IO:setConfigInputTextCursorBlink(bool)
<syntaxhighlight lang="lua">
bool = IO:getConfigWindowsResizeFromEdges()
ImGui:pushStyleColor(ImGui.Col, color, alpha) -- https://wiki.gideros.rocks/index.php/Dear_ImGui_Flags#Col
IO:setConfigWindowsResizeFromEdges(bool)
ImGui:popStyleColor([count = 1])
bool = IO:getConfigWindowsMoveFromTitleBarOnly()
ImGui:pushStyleVar(ImGui.StyleVar, value) OR ImGui:pushStyleVar(ImGui.StyleVar, value1, value2)
IO:setConfigWindowsMoveFromTitleBarOnly(bool)
ImGui:popStyleVar([count = 1])
number = IO:getConfigWindowsMemoryCompactTimer()
color, alpha = ImGui:getStyleColor(ImGui.Col)
IO:setConfigWindowsMemoryCompactTimer(number)
fontSize = ImGui:getFontSize()
string = IO:getBackendPlatformName()
</syntaxhighlight>
string = IO:getBackendRendererName()
 
bool = IO:IsMouseDown(button)
=== Parameters stacks (current window) ===
number = IO:getMouseWheel()
<syntaxhighlight lang="lua">
number = IO:getMouseWheelH()
ImGui:pushItemWidth(w)
flag = IO:wantCaptureMouse()
ImGui:popItemWidth()
flag = IO:wantCaptureKeyboard()
ImGui:setNextItemWidth(w)
flag = IO:wantTextInput()
w = ImGui:calcItemWidth()
flag = IO:wantSetMousePos()
ImGui:pushTextWrapPos([localX = 0])
flag = IO:wantSaveIniSettings()
ImGui:popTextWrapPos()
number = IO:getFramerate()
ImGui:pushTabStop(flag)
number = IO:getMetricsRenderVertices()
ImGui:popTabStop()
number = IO:getMetricsRenderIndices()
ImGui:pushButtonRepeat(flag)
number = IO:getMetricsRenderWindows()
ImGui:popButtonRepeat()
number = IO:getMetricsActiveWindows()
</syntaxhighlight>
number = IO:getMetricsActiveAllocations()
 
x, y = IO:getMouseDelta()
== Cursor / Layout ==
number = IO:getMouseDownSec(mouse_button)
* By "cursor" we mean the current output position.
IO:setDisplaySize(w, h)
* The typical widget behavior is to output themselves at the current cursor position, then move the cursor one line down.
w, h = IO:getDisplaySize()
* You can call SameLine() between widgets to undo the last carriage return and output at the right of the preceeding widget.
number = IO:getDeltaTime()
* '''Attention'''! We currently have inconsistencies between window-local and absolute positions we will aim to fix with future API:
-- reset mouse buttons state
** '''Window-local coordinates''': ''SameLine''(), ''GetCursorPos''(), ''SetCursorPos''(), ''GetCursorStartPos''(), ''GetContentRegionMax''(), ''GetWindowContentRegion''*(), ''PushTextWrapPos''()
IO:resetMouseDown()
** '''Absolute coordinate''': ''GetCursorScreenPos''(), ''SetCursorScreenPos''(), all ImDrawList:: functions
-- reset key states (including ALT/SHIFT/CTRL/SUPER (META))
 
IO:resetKeysDown()
<syntaxhighlight lang="lua">
-- set ALT/SHIFT/CTRL/SUPER (META) key state
ImGui:separator()
IO:setModKeyDown(key_code, bool) -- "key_code" is a gideros MOD key
ImGui:sameLine([offset_x = 0, spacing = -1])
-- set any key state
ImGui:newLine()
IO:setKeysDown(key_code, bool) -- "key_code" is a gideros regular "keyCode"
ImGui:spacing()
-- adds text to active text input widget
ImGui:dummy(w, h)
IO:addInputCharactersUTF8(text)
ImGui:indent([indent = 0])
-- emulate wheel scrolling
ImGui:unindent([indent = 0])
IO:setMouseWheel(number)
ImGui:beginGroup()
-- sets mouse position (data only, no visual changes)
ImGui:endGroup()
IO:setMousePos(x, y)
-- set mouse state, where index: 0 - left mouse, 1 - right, 2 - middle, 3 - unused, 4 - unused.
x, y = ImGui:getCursorPos()
IO:setMouseDown(mouse_button, state) -- "mouse_button" is a gideros mouse button code
x = ImGui:getCursorPosX()
 
y = ImGui:getCursorPosY()
-- "key" is any ImGui KeyCode (check [here](#keyboard-keys))
ImGui:setCursorPos(local_x, local_y)
-- "down" is a boolean
ImGui:setCursorPosX(local_x)
IO:addKeyEvent(key, down)
ImGui:setCursorPosY(local_y)
IO:addKeyAnalogEvent(key, down, number)
x, y = ImGui:getCursorStartPos()
IO:AddMousePosEvent(x, y)
x, y = ImGui:getCursorScreenPos()
-- "button" is any ImGui button (check [here](#MouseButton))
ImGui:setCursorScreenPos(x, y)
IO:addMouseButtonEvent(button, down)
ImGui:alignTextToFramePadding()
IO:addMouseWheelEvent(x, y)
lineH = ImGui:getTextLineHeight()
 
lineH = ImGui:getTextLineHeightWithSpacing()
IO:setAppAcceptingEvents([accepting_events = true])
frameH = ImGui:getFrameHeight()
frameH = ImGui:getFrameHeightWithSpacing()
</syntaxhighlight>
 
== ID stack/scopes ==
* Read the FAQ for more details about how ID are handled in Dear Imgui. If you are creating widgets in a loop you most likely want to push a unique identifier (e.g. object pointer, loop index) to uniquely differentiate them.
* The resulting ID are hashes of the entire stack.
* You can also use the "Label##foobar" syntax within widget label to distinguish them from each others.
* In this header file we use the "label"/"name" terminology to denote a string that will be displayed and used as an ID, whereas "str_id" denote a string that is only used as an ID and not normally displayed.
 
<syntaxhighlight lang="lua">
ImGui:pushID(anyValue)  
ImGui:pushID(str)
ImGui:popID()
number = ImGui:getID(anyValue)
number = ImGui:getID(str)
number = ImGui:getItemID()
</syntaxhighlight>
</syntaxhighlight>


== Context ==
== WIDGETS ==
=== Widgets: Text ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string OR nil = ImGui:getHoveredWindow()
ImGui:textUnformatted(text [, textEnd])
string OR nil = ImGui:getHoveredWindowRoot()
ImGui:text(text)
string OR nil = ImGui:getHoveredWindowUnderMovingWindow()
ImGui:textColored(text, color, alpha)
string OR nil = ImGui:getMovingWindow()
ImGui:textDisabled(text)
string OR nil = ImGui:getActiveIdWindow()
ImGui:textWrapped(text)
id = ImGui:getActiveId()
ImGui:labelText(text, label)
id = ImGui:getActiveIdPreviousFrame()
ImGui:bulletText(text)
number = ImGui:getActiveIdTimer()
ImGui:separatorText(label)
id = ImGui:getActiveIdAllowOverlap()
id = ImGui:getHoveredId()
id = ImGui:getHoveredIdPreviousFrame()
number = ImGui:getHoveredIdTimer()
id = ImGui:getHoveredIdAllowOverlap()
bool = ImGui:getDragDropActive()
id = ImGui:getDragDropPayloadSourceId()
string = ImGui:getDragDropPayloadDataType()
number = ImGui:getDragDropPayloadDataSize()
</syntaxhighlight>
</syntaxhighlight>


== WIDGETS & STUFF ==
=== Widgets: Main ===
=== Windows ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
p_open, draw = ImGui:beginWindow(label, p_open [, ImGui.WindowFlags = 0])
flag = ImGui:button(text [, w = 0, h = 0])
-- do not show "X" button
flag = ImGui:smallButton(text)
draw = ImGui:beginWindow(label, nil [, ImGui.WindowFlags = 0])
flag = ImGui:invisibleButton(string_ID [, w = 0, h = 0])
-- start a window with no borders, no paddings, no rounding and ImGui.WindowFlags_Fullscreen flag
flag = ImGui:arrowButton(string_ID [, ImGui.Dir = 0])
p_open, draw = ImGui:beginFullScreenWindow(label, p_open [, ImGui.WindowFlags = 0])  
flag = ImGui:checkbox(text, flag)
-- do not show "X" button
flags, is_changed = ImGui:checkboxFlags(label [, flags = 0, flags_value = 0])
draw = ImGui:beginFullScreenWindow(label, nil [, ImGui.WindowFlags = 0])  
number, is_changed = ImGui:radioButton(text, number, number)
ImGui:endWindow()
is_changed = ImGui:radioButton(text, flag)
ImGui:progressBar(fraction [, anchor_x = -1, anchor_y = 0, overlay_string = nil])
ImGui:bullet()
</syntaxhighlight>
</syntaxhighlight>


=== Disabled groups ===
=== Widgets: Images ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:beginDisabled(disabledFlag)
-- Images are streched (ImGui default functions)
ImGui:endDisabled()
ImGui:image(texture, w, h
</syntaxhighlight>
[, tint_color = 0xffffff, tint_alpha = 1,
border_color = 0xffffff, border_alpha = 0])
 
ImGui:imageUV(texture,
w, h,
uv0x, uv0y,
uv1x, uv1y,
[, tint_color = 0xffffff, tint_alpha = 1, border_color = 0xffffff, border_alpha = 0])


=== Child Windows ===
pressFlag = ImGui:imageButton(str_id, texture, w, h
<syntaxhighlight lang="lua">
[, tint_color = 0xffffff, tint_alpha = 1,
ImGui:beginChild(id [, w = 0, h = 0, borderFlag = false, ImGui.WindowFlags = 0])
border_color = 0xffffff, border_alpha = 0])
ImGui:endChild()
</syntaxhighlight>


=== Windows Utilities ===
pressFlag = ImGui:imageButtonUV(str_id, texture, w, h,
<syntaxhighlight lang="lua">
uv0x, uv0y, uv1x, uv1y
flag = ImGui:isWindowAppearing()
[, tint_color = 0xffffff, tint_alpha = 1,
flag = ImGui:isWindowCollapsed()
border_color = 0xffffff, border_alpha = 0])
flag = ImGui:isWindowFocused([ImGui.FocusedFlags = 0])
flag = ImGui:isWindowHovered([ImGui.HoveredFlags = 0])
x, y = ImGui:getWindowPos()
w, h = ImGui:getWindowSize()
w = ImGui:getWindowWidth()
h = ImGui:getWindowHeight()


x1,y1, x2,y2 = ImGui:getWindowBounds() -- returns window region rectangle in global coordinates
-- Images are scaled (extended by @MultiPain)
ImGui:setNextWindowPos(x, y [, ImGui.Cond = 0, pivotX = 0, pivotY = 0])
-- padding deprecated
ImGui:setNextWindowSize(w, h [, ImGui.Cond = 0])
-- (use "ImGui:pushStyleVar(ImGui.StyleVar_FramePadding, x, y)/ImGui:popStyleVar()")
ImGui:setNextWindowContentSize(w, h)
ImGui:scaledImage(str_id, texture, w, h
ImGui:setNextWindowCollapsed(flag [, ImGui.Cond = 0])
[, fit_mode = ImGui.ImageScaleMode_LetterBox, keep_size = false,
ImGui:setNextWindowFocus()
anchor_x = 0.5, anchor_y = 0.5,
ImGui:setNextWindowBgAlpha(alpha)
tint_col = 0xffffff, tint_alpha = 1,
ImGui:setNextWindowScroll(x, y)
border_col = 0, border_alpha = 0,
ImGui:setWindowPos(name, x, y [, ImGui.Cond = 0]) OR ImGui:setWindowPos(x, y [, ImGui.Cond = 0])
bg_col = 0, bg_alpha = 0])
ImGui:setWindowSize(name, w, h [, ImGui.Cond = 0]) OR ImGui:setWindowSize(w, h [, ImGui.Cond = 0])
ImGui:setWindowCollapsed(name, flag [, ImGui.Cond = 0]) OR ImGui:setWindowCollapsed(flag [, ImGui.Cond = 0])
ImGui:setWindowFocus(name) OR ImGui:setWindowFocus()
ImGui:setWindowFontScale(scale)
-- scroll window when touching void
ImGui:scrollWhenDragging(x, y)
</syntaxhighlight>


=== Window size constraints ===
pressFlag = ImGui:scaledImageButton(str_id, texture, w, h
Can be used to set minimum and maximum window size, plus contraint the size if needed.
[, fit_mode = ImGui.ImageScaleMode_LetterBox, keep_size = false,
ImGui.ButtonFlags = 0, anchor_x = 0.5, anchor_y = 0.5,
clip_offset_x = 0, clip_offset_y = 0,
tint_col = 0xffffff, tint_alpha = 1,
border_col = 0, border_alpha = 0,
bg_col = 0, bg_alpha = 0])
 
pressFlag = ImGui:scaledImageButtonWithText(texture, label, image_w, image_h
[, button_w = 0, button_h = 0, ImGui.ButtonFlags = 0,
fit_mode = ImGui.ImageScaleMode_LetterBox, keep_size = false,
anchor_x = 0.5, anchor_y = 0.5, image_side = ImGui.Dir_Left,
clip_offset_x = 0, clip_offset_y = 0,
tint_col = 0xffffff, tint_alpha = 1,
border_col = 0, border_alpha = 0,
bg_col = 0, bg_alpha = 0])
</syntaxhighlight>
 
=== Widgets: Combo Box ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- call this function before ImGui:beginWindow()
openFlag = ImGui:beginCombo(text, preview_text [, ImGui.ComboFlags = 0])
ImGui:setNextWindowSizeConstraints(min_w, min_h, max_w, max_h [, resize_callback, user_data]))
ImGui:endCombo()
-- resizeCallback is a function:
current_item, is_open = ImGui:combo(label, current_item, items) -- items (table): {"item1", "item2", ...}
function (callbackData [, user_data])
-- do some math, and return desired size
-- ...
return desired_width, desired_height
end
</syntaxhighlight>
</syntaxhighlight>


'''Resize callback''':
=== Widgets: Drags ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- get window position
value, is_changed = ImGui:dragFloat(label, value
x, y = callbackData:getPos()
[, inc_step = 1, min = 0, max = 0,
x = callbackData:getX()
format_string = "%.3f", ImGui.SliderFlags = 0])
y = callbackData:getY()


-- get currrent size
value1, value2, is_changed = ImGui:dragFloat2(label, value1, value2
current_width, current_height = callbackData:getCurrentSize()
[, inc_step = 1, min = 0, max = 0,
current_width = callbackData:getCurrentWidth()
format_string = "%.3f", ImGui.SliderFlags = 0])
current_height = callbackData:getCurrentHeight()
 
value1, value2, value3, is_changed = ImGui:dragFloat3(label, value1, value2, value3
[, inc_step = 1, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])
 
value1, value2, value3, value4, is_changed = ImGui:dragFloat4(label, value1, value2, value3, value4
[, inc_step = 1, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])


-- get desired size
value_min, value_max, is_changed = ImGui:dragFloatRange2(label, value_min, value_max
deserid_width, deserid_height = callbackData:getDesiredSize()
[, inc_step = 1, min = 0, max = 0,
deserid_width = callbackData:getDesiredWidth()
format_min_string = "%.3f", ImGui.SliderFlags = 0])
deserid_height = callbackData:getDesiredHeight()
-- table must be an array of any size > 0
</syntaxhighlight>
is_changed = ImGui:dragFloatT(label, table
[, inc_step = 1, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])


'''Example''':
value, is_changed = ImGui:dragInt(label, value
<syntaxhighlight lang="lua">
[, inc_step = 1, min = 0, max = 0,
require "ImGui"
format_string = "%d", ImGui.SliderFlags = 0])


local function stepSize(callback_data, step)
value1, value2, is_changed = ImGui:dragInt2(label, value1, value2
local w, h = callback_data:getDesiredSize()
[, inc_step = 1, min = 0, max = 0,
w = (w // step) * step
format_string = "%d", ImGui.SliderFlags = 0])
h = (h // step) * step
return w, h
end


local ui = ImGui.new()
value1, value2, value3, is_changed = ImGui:dragInt3(label, value1, value2, value3
stage:addChild(ui)
[, inc_step = 1, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])


stage:addEventListener("enterFrame", function(e)
value1, value2, value3, value4, is_changed = ImGui:dragInt4(label, value1, value2, value3, value4
ui:newFrame(e.deltaTime)
[, inc_step = 1, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])
-- window size step is 32 (last argument, that is passed to the callback as second argument)
 
ui:setNextWindowSizeConstraints(200, 200, 400, 400, stepSize, 32)
v_current_min, v_current_max, flag = ImGui:dragIntRange2(label, v_current_min, v_current_max
if (ui:beginWindow("My window")) then
[, v_speed = 1, v_min = 0, v_max = 0,
format = "%d", format_max = nil, ImGui.SliderFlags = 0])
ui:textWrapped("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.")
end
ui:endWindow()
ui:showDemoWindow()
ui:render()
ui:endFrame()
end)
</syntaxhighlight>


=== Content region ===
-- table must be an array of any size > 0
<syntaxhighlight lang="lua">
is_changed = ImGui:dragIntT(label, table
scaleX, scaleY = ImGui:getContentRegionMax()
[, inc_step = 1, min = 0, max = 0,
w, h = ImGui:getContentRegionAvail()
format_string = "%d", ImGui.SliderFlags = 0])
x, y = ImGui:getWindowContentRegionMin()
x, y = ImGui:getWindowContentRegionMax()
</syntaxhighlight>
</syntaxhighlight>


=== Windows Scrolling ===
=== Widgets: Sliders ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
x = ImGui:getScrollX()
value, is_changed = ImGui:sliderFloat(label, value
y = ImGui:getScrollY()
[, min = 0, max = 0,
maxX = ImGui:getScrollMaxX()
format_string = "%.3f", ImGui.SliderFlags = 0])
maxY = ImGui:getScrollMaxY()
 
ImGui:setScrollX(value)
value1, value2, is_changed = ImGui:sliderFloat2(label, value1, value2
ImGui:setScrollY(value)
[, min = 0, max = 0,
ImGui:setScrollHereX([ratio = 0.5])
format_string = "%.3f", ImGui.SliderFlags = 0])
ImGui:setScrollHereY([ratio = 0.5])
ImGui:setScrollFromPosX(x [, ratio = 0.5])
ImGui:setScrollFromPosY(y [, ratio = 0.5])
</syntaxhighlight>


=== Parameters stacks (shared) ===
value1, value2, value3, is_changed = ImGui:sliderFloat3(label, value1, value2, value3
<syntaxhighlight lang="lua">
[, min = 0, max = 0,
ImGui:pushStyleColor(ImGui.Col, color, alpha)
format_string = "%.3f", ImGui.SliderFlags = 0])
ImGui:popStyleColor([count = 1])
ImGui:pushStyleVar(ImGui.StyleVar, value) OR ImGui:pushStyleVar(ImGui.StyleVar, value1, value2)
ImGui:popStyleVar([count = 1])
color, alpha = ImGui:getStyleColor(ImGui.Col)
fontSize = ImGui:getFontSize()
</syntaxhighlight>


=== Parameters stacks (current window) ===
value1, value2, value3, value4, is_changed = ImGui:sliderFloat4(label, value1, value2, value3, value4
<syntaxhighlight lang="lua">
[, min = 0, max = 0,
ImGui:pushItemWidth(w)
format_string = "%.3f", ImGui.SliderFlags = 0])
ImGui:popItemWidth()
 
ImGui:setNextItemWidth(w)
value_in_rad, is_changed = ImGui:sliderAngle(label, value_in_rad
w = ImGui:calcItemWidth()
[, min_degrees = -360, max_degrees = 360,
ImGui:pushTextWrapPos([localX = 0])
format_string = "%.0f deg", ImGui.SliderFlags = 0])
ImGui:popTextWrapPos()
 
ImGui:pushTabStop(flag)
-- table must be an array of any size > 0
ImGui:popTabStop()
is_changed = ImGui:sliderFloatT(label, table
ImGui:pushButtonRepeat(flag)
[, min = 0, max = 0,
ImGui:popButtonRepeat()
format_string = "%.3f", ImGui.SliderFlags = 0])
</syntaxhighlight>
 
value, is_changed = ImGui:sliderInt(label, value
[, min = 0, max = 0,
format_string = "%d, ImGui.SliderFlags = 0"])


=== Cursor / Layout ===
value1, value2, is_changed = ImGui:sliderInt2(label, value1, value2
<syntaxhighlight lang="lua">
[, min = 0, max = 0,
ImGui:separator()
format_string = "%d, ImGui.SliderFlags = 0"])
ImGui:sameLine([offset_x = 0, spacing = -1])
ImGui:newLine()
ImGui:spacing()
ImGui:dummy(w, h)
ImGui:indent([indent = 0])
ImGui:unindent([indent = 0])
ImGui:beginGroup()
ImGui:endGroup()
x, y = ImGui:getCursorPos()
x = ImGui:getCursorPosX()
y = ImGui:getCursorPosY()
ImGui:setCursorPos(local_x, local_y)
ImGui:setCursorPosX(local_x)
ImGui:setCursorPosY(local_y)
x, y = ImGui:getCursorStartPos()
x, y = ImGui:getCursorScreenPos()
ImGui:setCursorScreenPos(x, y)
ImGui:alignTextToFramePadding()
lineH = ImGui:getTextLineHeight()
lineH = ImGui:getTextLineHeightWithSpacing()
frameH = ImGui:getFrameHeight()
frameH = ImGui:getFrameHeightWithSpacing()
</syntaxhighlight>


=== ID stack/scopes ===
value1, value2, value3, is_changed = ImGui:sliderInt3(label, value1, value2, value3
<syntaxhighlight lang="lua">
[, min = 0, max = 0,
ImGui:pushID(anyValue)
format_string = "%d, ImGui.SliderFlags = 0"])
ImGui:pushID(str)
ImGui:popID()
number = ImGui:getID(any_value)
number = ImGui:getID(string)
number = ImGui:getItemID()
</syntaxhighlight>


=== Widgets: Text ===
value1, value2, value3, value4, is_changed = ImGui:sliderInt4(label, value1, value2, value3, value4
<syntaxhighlight lang="lua">
[, min = 0, max = 0,
ImGui:textUnformatted(text [, textEnd])
format_string = "%d, ImGui.SliderFlags = 0"])
ImGui:text(text)
 
ImGui:textColored(text, color, alpha)
-- table must be an array of any size > 0
ImGui:textDisabled(text)
is_changed = ImGui:sliderIntT(label, table
ImGui:textWrapped(text)
[, min = 0, max = 0,
ImGui:labelText(text, label)
format_string = "%d", ImGui.SliderFlags = 0])
ImGui:bulletText(text)
ImGui:separatorText(label)
</syntaxhighlight>


=== Widgets: Main ===
value, is_changed = ImGui:vSliderFloat(label, w, h, value, min, max
<syntaxhighlight lang="lua">
[, format_string = "%.3f", ImGui.SliderFlags = 0])
flag = ImGui:button(text [, w = 0, h = 0])
flag = ImGui:smallButton(text)
flag = ImGui:invisibleButton(string_ID [, w = 0, h = 0])
flag = ImGui:arrowButton(string_ID [, ImGui.Dir = 0])
flag = ImGui:checkbox(text, flag)
flags, is_changed = ImGui:checkboxFlags(label [, flags = 0, flags_value = 0])
number, is_changed = ImGui:radioButton(text, number, number)
is_changed = ImGui:radioButton(text, flag)
ImGui:progressBar(fraction [, anchor_x = -1, anchor_y = 0, overlay_string = nil])
ImGui:bullet()
</syntaxhighlight>


=== Widgets: Images ===
value, is_changed = ImGui:vSliderInt(label, w, h, value, min, max
<syntaxhighlight lang="lua">
[, format_string = "%d", ImGui.SliderFlags = 0])
-- Images are streched (ImGui default functions)
 
ImGui:image(texture, w, h
value, is_changed = ImGui:filledSliderFloat(label, mirror_flag, value
[, tint_color = 0xffffff, tint_alpha = 1,  
[, min = 0, max = 0,
border_color = 0xffffff, border_alpha = 0])
format_string = "%.3f", ImGui.SliderFlags = 0])


ImGui:imageUV(texture,
value1, value2, is_changed = ImGui:filledSliderFloat2(label, mirror_flag, value1, value2
w, h,
[, min = 0, max = 0,
uv0x, uv0y,
format_string = "%.3f", ImGui.SliderFlags = 0])
uv1x, uv1y,
[, tint_color = 0xffffff, tint_alpha = 1, border_color = 0xffffff, border_alpha = 0])


pressFlag = ImGui:imageButton(str_id, texture, w, h
value1, value2, value3, is_changed = ImGui:filledSliderFloat3(label, mirror_flag, value1, value2, value3
[, tint_color = 0xffffff, tint_alpha = 1,  
[, min = 0, max = 0,
border_color = 0xffffff, border_alpha = 0])
format_string = "%.3f", ImGui.SliderFlags = 0])


pressFlag = ImGui:imageButtonUV(str_id, texture, w, h,
value1, value2, value3, value4, is_changed = ImGui:filledSliderFloat4(label, mirror_flag, value1, value2, value3, value4
uv0x, uv0y, uv1x, uv1y
[, min = 0, max = 0,
[, tint_color = 0xffffff, tint_alpha = 1,  
format_string = "%.3f", ImGui.SliderFlags = 0])
border_color = 0xffffff, border_alpha = 0])


-- Images are scaled (extended by @MultiPain)
-- table must be an array of any size > 0
-- padding deprecated
is_changed = ImGui:filledSliderFloatT(label, mirror_flag, table
-- (use "ImGui:pushStyleVar(ImGui.StyleVar_FramePadding, x, y)/ImGui:popStyleVar()")
[, min = 0, max = 0,
ImGui:scaledImage(str_id, texture, w, h
[, fit_mode = ImGui.ImageScaleMode_LetterBox, keep_size = false,
anchor_x = 0.5, anchor_y = 0.5,
tint_col = 0xffffff, tint_alpha = 1,
border_col = 0, border_alpha = 0,
bg_col = 0, bg_alpha = 0])
 
pressFlag = ImGui:scaledImageButton(str_id, texture, w, h
[, fit_mode = ImGui.ImageScaleMode_LetterBox, keep_size = false,
ImGui.ButtonFlags = 0, anchor_x = 0.5, anchor_y = 0.5,
clip_offset_x = 0, clip_offset_y = 0,
tint_col = 0xffffff, tint_alpha = 1,
border_col = 0, border_alpha = 0,
bg_col = 0, bg_alpha = 0])
pressFlag = ImGui:scaledImageButtonWithText(texture, label, image_w, image_h
[, button_w = 0, button_h = 0, ImGui.ButtonFlags = 0,
fit_mode = ImGui.ImageScaleMode_LetterBox, keep_size = false,
anchor_x = 0.5, anchor_y = 0.5, image_side = ImGui.Dir_Left,
clip_offset_x = 0, clip_offset_y = 0,
tint_col = 0xffffff, tint_alpha = 1,
border_col = 0, border_alpha = 0,
bg_col = 0, bg_alpha = 0])
</syntaxhighlight>
 
=== Widgets: Combo Box ===
<syntaxhighlight lang="lua">
openFlag = ImGui:beginCombo(text, preview_text [, ImGui.ComboFlags = 0])
ImGui:endCombo()
current_item, is_open = ImGui:combo(label, current_item, items) -- items (table): {"item1", "item2", ...}
</syntaxhighlight>
 
=== Widgets: Drags ===
<syntaxhighlight lang="lua">
value, is_changed = ImGui:dragFloat(label, value
[, inc_step = 1, min = 0, max = 0,  
format_string = "%.3f", ImGui.SliderFlags = 0])
format_string = "%.3f", ImGui.SliderFlags = 0])


value1, value2, is_changed = ImGui:dragFloat2(label, value1, value2
value_in_rad, is_changed = ImGui:filledSliderAngle(label, mirror_flag, value_in_rad
[, inc_step = 1, min = 0, max = 0,  
[, min_degrees = -360, max_degrees = 360,
format_string = "%.3f", ImGui.SliderFlags = 0])
format_string = "%.0f deg", ImGui.SliderFlags = 0])


value1, value2, value3, is_changed = ImGui:dragFloat3(label, value1, value2, value3
value, is_changed = ImGui:filledSliderInt(label, mirror_flag, value
[, inc_step = 1, min = 0, max = 0,  
[, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])
format_string = "%d", ImGui.SliderFlags = 0])


value1, value2, value3, value4, is_changed = ImGui:dragFloat4(label, value1, value2, value3, value4
value1, value2, is_changed = ImGui:filledSliderInt2(label, mirror_flag, value1, value2
[, inc_step = 1, min = 0, max = 0,
[, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])
 
value_min, value_max, is_changed = ImGui:dragFloatRange2(label, value_min, value_max
[, inc_step = 1, min = 0, max = 0,
format_min_string = "%.3f", ImGui.SliderFlags = 0])
-- table must be an array of any size > 0
is_changed = ImGui:dragFloatT(label, table
[, inc_step = 1, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])
 
value, is_changed = ImGui:dragInt(label, value
[, inc_step = 1, min = 0, max = 0,  
format_string = "%d", ImGui.SliderFlags = 0])
format_string = "%d", ImGui.SliderFlags = 0])


value1, value2, is_changed = ImGui:dragInt2(label, value1, value2  
value1, value2, value3, is_changed = ImGui:filledSliderInt3(label, mirror_flag, value1, value2, value3
[, inc_step = 1, min = 0, max = 0,  
[, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])
format_string = "%d", ImGui.SliderFlags = 0])


value1, value2, value3, is_changed = ImGui:dragInt3(label, value1, value2, value3  
value1, value2, value3, value4, is_changed = ImGui:filledSliderInt4(label, mirror_flag, value1, value2, value3, value4
[, inc_step = 1, min = 0, max = 0,  
[, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])
format_string = "%d", ImGui.SliderFlags = 0])


value1, value2, value3, value4, is_changed = ImGui:dragInt4(label, value1, value2, value3, value4
-- table must be an array of any size > 0
[, inc_step = 1, min = 0, max = 0,  
is_changed = ImGui:filledSliderIntT(label, mirror_flag, table
[, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])
format_string = "%d", ImGui.SliderFlags = 0])


v_current_min, v_current_max, flag = ImGui:dragIntRange2(label, v_current_min, v_current_max
value, is_changed = ImGui:vFilledSliderFloat(label, mirror_flag, w, h, value, min, max
[, v_speed = 1, v_min = 0, v_max = 0,  
[, format_string = "%.3f", ImGui.SliderFlags = 0])
format = "%d", format_max = nil, ImGui.SliderFlags = 0])


-- table must be an array of any size > 0
value, is_changed = ImGui:vFilledSliderInt(label, mirror_flag, w, h, value, min, max
is_changed = ImGui:dragIntT(label, table
[, format_string = "%d", ImGui.SliderFlags = 0])
[, inc_step = 1, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])
</syntaxhighlight>
</syntaxhighlight>


=== Widgets: Sliders ===
=== Widgets: Input with Keyboard ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
value, is_changed = ImGui:sliderFloat(label, value  
text, flag = ImGui:inputText(label, text, buffer_size [, ImGui.InputTextFlags = 0])
[, min = 0, max = 0,  
text, flag = ImGui:inputTextMultiline(label, text, buffer_size [, w = 0, h = 0, ImGui.InputTextFlags = 0])
format_string = "%.3f", ImGui.SliderFlags = 0])
text, flag = ImGui:inputTextWithHint(label, text, hint, buffer_size [, ImGui.InputTextFlags = 0])
value, flag = ImGui:inputFloat(label, value [, step = 0, step_fast = 0, format = "%.3f", ImGui.InputTextFlags = 0])
value1, value2, flag = ImGui:inputFloat2(label, value1, value2 [, format = "%.3f", ImGui.InputTextFlags = 0])
value1, value2, value3, flag = ImGui:inputFloat3(label, value1, value2, value3 [, format = "%.3f", ImGui.InputTextFlags = 0])
value1, value2, value3, value4, flag = ImGui:inputFloat4(label, value1, value2, value3, value4 [, format = "%.3f", ImGui.InputTextFlags = 0])
-- table must be an array of any size > 0
flag = ImGui:inputFloatT(label, table [, format = "%.3f", ImGui.InputTextFlags = 0])
value,  flag = ImGui:inputInt(label, value [, step = 0, step_fast = 0, ImGui.InputTextFlags = 0])
value1, value2, flag = ImGui:inputInt2(label, value1, value2 [, ImGui.InputTextFlags = 0])
value1, value2, value3, flag = ImGui:inputInt3(label, value1, value2, value3 [, ImGui.InputTextFlags = 0])
value1, value2, value3, value4, flag = ImGui:inputInt4(label, value1, value2, value3, value4 [, ImGui.InputTextFlags = 0])
-- table must be an array of any size > 0
flag = ImGui:inputIntT(label, table [, format = "%d", ImGui.InputTextFlags = 0])
value, flag = ImGui:inputDouble(label, value [, step = 0, step_fast = 0, format = "%.6f", ImGui.InputTextFlags = 0])
</syntaxhighlight>


value1, value2, is_changed = ImGui:sliderFloat2(label, value1, value2
'''Input text callbacks''':
[, min = 0, max = 0,  
<syntaxhighlight lang="lua">
format_string = "%.3f", ImGui.SliderFlags = 0])
ImGui:inputText(label, text, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])
ImGui:inputTextMultiline(label, text, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])
ImGui:inputTextWithHint(label, text, hint, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])


value1, value2, value3, is_changed = ImGui:sliderFloat3(label, value1, value2, value3
callback_function = function(callback_data, user_data)
[, min = 0, max = 0,
-- do something with data
format_string = "%.3f", ImGui.SliderFlags = 0])
-- see below
end
</syntaxhighlight>


value1, value2, value3, value4, is_changed = ImGui:sliderFloat4(label, value1, value2, value3, value4
'''callback_data''':
[, min = 0, max = 0,
<syntaxhighlight lang="lua">
format_string = "%.3f", ImGui.SliderFlags = 0])
ImGuiInputTextFlags = callback_data:getEventFlag()
ImGuiInputTextFlags = callback_data:getFlags()


value_in_rad, is_changed = ImGui:sliderAngle(label, value_in_rad
number = callback_data:getEventChar()
[, min_degrees = -360, max_degrees = 360,
format_string = "%.0f deg", ImGui.SliderFlags = 0])


-- table must be an array of any size > 0
callback_data:setEventChar(number)
is_changed = ImGui:sliderFloatT(label, table
[, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])


value, is_changed = ImGui:sliderInt(label, value
keyCode = callback_data:getEventKey()
[, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])


value1, value2, is_changed = ImGui:sliderInt2(label, value1, value2
string = callback_data:getBuf()
[, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])


value1, value2, value3, is_changed = ImGui:sliderInt3(label, value1, value2, value3
callback_data:setBuf(string)
[, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])


value1, value2, value3, value4, is_changed = ImGui:sliderInt4(label, value1, value2, value3, value4
number = callback_data:getBufTextLen()
[, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])


-- table must be an array of any size > 0
callback_data:setBufTextLen(number)
is_changed = ImGui:sliderIntT(label, table
[, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 0])


value, is_changed = ImGui:vSliderFloat(label, w, h, value, min, max
number = callback_data:getBufSize()
[, format_string = "%.3f", ImGui.SliderFlags = 0])


value, is_changed = ImGui:vSliderInt(label, w, h, value, min, max
callback_data:setBufDirty(bool)
[, format_string = "%d", ImGui.SliderFlags = 0])
bool = callback_data:isBufDirty()


value, is_changed = ImGui:filledSliderFloat(label, mirror_flag, value
callback_data:setCursorPos(number)
[, min = 0, max = 0,
number = callback_data:getCursorPos()
format_string = "%.3f", ImGui.SliderFlags = 0])


value1, value2, is_changed = ImGui:filledSliderFloat2(label, mirror_flag, value1, value2
callback_data:setSelectionStart(s_start)
[, min = 0, max = 0,
number = callback_data:getSelectionStart()
format_string = "%.3f", ImGui.SliderFlags = 0])


value1, value2, value3, is_changed = ImGui:filledSliderFloat3(label, mirror_flag, value1, value2, value3
callback_data:setSelectionEnd(s_end)
[, min = 0, max = 0,
s_end = callback_data:getSelectionEnd()
format_string = "%.3f", ImGui.SliderFlags = 0])


value1, value2, value3, value4, is_changed = ImGui:filledSliderFloat4(label, mirror_flag, value1, value2, value3, value4
callback_data:setSelection(s_start, s_end)
[, min = 0, max = 0,
s_start, s_end = callback_data:getSelection()
format_string = "%.3f", ImGui.SliderFlags = 0])


-- table must be an array of any size > 0
callback_data:selectAll()
is_changed = ImGui:filledSliderFloatT(label, mirror_flag, table
callback_data:clearSelection()
[, min = 0, max = 0,
bool = callback_data:hasSelection()
format_string = "%.3f", ImGui.SliderFlags = 0])


value_in_rad, is_changed = ImGui:filledSliderAngle(label, mirror_flag, value_in_rad
callback_data:deleteChars(position, bytesCount)
[, min_degrees = -360, max_degrees = 360,
callback_data:insertChars(position, text)
format_string = "%.0f deg", ImGui.SliderFlags = 0])
</syntaxhighlight>


value, is_changed = ImGui:filledSliderInt(label, mirror_flag, value
'''Example''':
[, min = 0, max = 0,
<syntaxhighlight lang="lua">
format_string = "%d", ImGui.SliderFlags = 0])
require "ImGui"


value1, value2, is_changed = ImGui:filledSliderInt2(label, mirror_flag, value1, value2
ui = ImGui.new()
[, min = 0, max = 0,
stage:addChild(ui)
format_string = "%d", ImGui.SliderFlags = 0])


value1, value2, value3, is_changed = ImGui:filledSliderInt3(label, mirror_flag, value1, value2, value3
local testMessage1 = ""
[, min = 0, max = 0,
local testMessage2 = ""
format_string = "%d", ImGui.SliderFlags = 0])
local testMessage3 = ""


value1, value2, value3, value4, is_changed = ImGui:filledSliderInt4(label, mirror_flag, value1, value2, value3, value4
-- Add ".." at the end of current input string
[, min = 0, max = 0,
function myCallback1(data)
format_string = "%d", ImGui.SliderFlags = 0])
data:insertChars(data:getCursorPos(), "..")
end


-- table must be an array of any size > 0
-- Replace all chars if UP/DOWN arrow is pressed
is_changed = ImGui:filledSliderIntT(label, mirror_flag, table
function myCallback2(data)
[, min = 0, max = 0,  
local key = data:getEventKey()
format_string = "%d", ImGui.SliderFlags = 0])
if (key == key_code.UP) then
 
data:deleteChars(0, data:getBufTextLen())
value, is_changed = ImGui:vFilledSliderFloat(label, mirror_flag, w, h, value, min, max
data:insertChars(0, "Pressed Up!")
[, format_string = "%.3f", ImGui.SliderFlags = 0])
data:selectAll()
elseif (key == key_code.DOWN) then
data:deleteChars(0, data:getBufTextLen())
data:insertChars(0, "Pressed Down!")
data:selectAll()
end
end


value, is_changed = ImGui:vFilledSliderInt(label, mirror_flag, w, h, value, min, max
-- Switch case of the first char
[, format_string = "%d", ImGui.SliderFlags = 0])
function myCallback3(data)
</syntaxhighlight>
local buf = data:getBuf()
local s = buf:sub(1,1)
if ((s >= 'a' and s <= 'z') or (s >= 'A' and s <= 'Z')) then
local first = string.char(string.byte(s) ~ 32)
data:setBuf(first .. buf:sub(2))
data:setBufDirty(true)
end
end


=== Widgets: Input with Keyboard ===
function enterFrame(e)
<syntaxhighlight lang="lua">
ui:newFrame(e.deltaTime)
text, flag = ImGui:inputText(label, text, buffer_size [, ImGui.InputTextFlags = 0])
text, flag = ImGui:inputTextMultiline(label, text, buffer_size [, w = 0, h = 0, ImGui.InputTextFlags = 0])
testMessage1 = ui:inputText(
text, flag = ImGui:inputTextWithHint(label, text, hint, buffer_size [, ImGui.InputTextFlags = 0])
"Label1",  
value,  flag = ImGui:inputFloat(label, value [, step = 0, step_fast = 0, format = "%.3f", ImGui.InputTextFlags = 0])
testMessage1,  
value1, value2, flag = ImGui:inputFloat2(label, value1, value2 [, format = "%.3f", ImGui.InputTextFlags = 0])
64,  
value1, value2, value3, flag = ImGui:inputFloat3(label, value1, value2, value3 [, format = "%.3f", ImGui.InputTextFlags = 0])
ImGui.InputTextFlags_CallbackCompletion,  
value1, value2, value3, value4, flag = ImGui:inputFloat4(label, value1, value2, value3, value4 [, format = "%.3f", ImGui.InputTextFlags = 0])
myCallback1
-- table must be an array of any size > 0
)
flag = ImGui:inputFloatT(label, table [, format = "%.3f", ImGui.InputTextFlags = 0])
testMessage2 = ui:inputText(
value, flag = ImGui:inputInt(label, value [, step = 0, step_fast = 0, ImGui.InputTextFlags = 0])
"Label2",  
value1, value2, flag = ImGui:inputInt2(label, value1, value2 [, ImGui.InputTextFlags = 0])
testMessage2,  
value1, value2, value3, flag = ImGui:inputInt3(label, value1, value2, value3 [, ImGui.InputTextFlags = 0])
64,  
value1, value2, value3, value4, flag = ImGui:inputInt4(label, value1, value2, value3, value4 [, ImGui.InputTextFlags = 0])
ImGui.InputTextFlags_CallbackHistory,  
-- table must be an array of any size > 0
myCallback2
flag = ImGui:inputIntT(label, table [, format = "%d", ImGui.InputTextFlags = 0])
)
value, flag = ImGui:inputDouble(label, value [, step = 0, step_fast = 0, format = "%.6f", ImGui.InputTextFlags = 0])
testMessage3 = ui:inputText(
"Label3",  
testMessage3,  
64,  
ImGui.InputTextFlags_CallbackEdit,
myCallback3
)
ui:render()
ui:endFrame()
end
 
stage:addEventListener("enterFrame", enterFrame)
</syntaxhighlight>
</syntaxhighlight>


'''Input text callbacks''':
=== Widgets: Color Editor/Picker ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:inputText(label, text, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])
hexColor, is_touching = ImGui:colorEdit3(label, color [, ImGui.ColorEditFlags = 0]) -- alpha ignored, no need to pass it!
ImGui:inputTextMultiline(label, text, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])
hexColor, alpha, is_touching = ImGui:colorEdit4(label, color [, alpha = 1, ImGui.ColorEditFlags = 0])
ImGui:inputTextWithHint(label, text, hint, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])
hexColor, is_touching = ImGui:colorPicker3(label, color [, ImGui.ColorEditFlags = 0])
 
hexColor, alpha, originalColor, originalAlpha, is_touching = ImGui:colorPicker4(label, color
callback_function = function(callback_data, user_data)
[, alpha = 1, original_color = 0xffffff, original_alpha = 1, ImGui.ColorEditFlags = 0])
-- do something with data
isHoveringFlag = ImGui:colorButton(string_ID, color [, alpha = 1, ImGui.ColorEditFlags = 0, w = 0, h = 0])
-- see below
ImGui:setColorEditOptions(ImGui.ColorEditFlags)
end
</syntaxhighlight>
</syntaxhighlight>


'''callback_data''':
=== Widgets: Trees ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGuiInputTextFlags = callback_data:getEventFlag()
is_openFlag = ImGui:treeNode(label [, format_string])
ImGuiInputTextFlags = callback_data:getFlags()
ImGui:treeNodeEx(label, ImGui.TreeNodeFlags [, format_string])
ImGui:treePush(str_id)
ImGui:treePop()
number = ImGui:getTreeNodeToLabelSpacing()
is_openFlag, p_open = ImGui:collapsingHeader(label, p_open [, ImGui.TreeNodeFlags = 0])
is_openFlag = ImGui:collapsingHeader(label [, ImGui.TreeNodeFlags = 0])
ImGui:setNextItemOpen(is_open, ImGui.Cond)
</syntaxhighlight>


number = callback_data:getEventChar()
=== Widgets: Selectables ===
<syntaxhighlight lang="lua">
result?, selected = ImGui:selectable(label, selected [, ImGui.SelectableFlags = 0, w = 0, h = 0])
</syntaxhighlight>


callback_data:setEventChar(number)
=== Widgets: List Boxes ===
<syntaxhighlight lang="lua">
-- item_table: {"Item0", "Item1", ...}
current_item, is_openFlag = ImGui:listBox(label, current_item, item_table [, max_visible_items = -1])
result? = ImGui:listBoxHeader(label [, w = 0, h = 0])
result? = ImGui:listBoxHeader2(label, items_count)
ImGui:listBoxFooter()
</syntaxhighlight>


keyCode = callback_data:getEventKey()
=== Widgets: Data Plotting ===
'''Caching''':


string = callback_data:getBuf()
If you have big array of points it is better to cache it instead of translating lua table to C++ vector every time you call `ImGui:plotLines()`. But in this case you need to manage memory by yourself (free points pointer when you dont need it).
<syntaxhighlight lang="lua">
-- store points in memory
-- points_table: {0.01, 0.5, 10, -50, ...}
-- ptr: c++ pointer to a given vector
ptr = ImGui.cachePoints(points_table)


callback_data:setBuf(string)
-- delete points from memory
ImGui.freePoints(ptr)
</syntaxhighlight>


number = callback_data:getBufTextLen()
'''Plot functions''':
<syntaxhighlight lang="lua">
-- len (number): points array length
ImGui:plotCachedLines(label, ptr, len,
[, values_offset = 0, overlay_text = nil,
scale_min = math.huge, scale_max = math.huge,
w = 0, h = 0])


callback_data:setBufTextLen(number)
ImGui:plotCachedHistogram(label, ptr, len,
[, values_offset = 0, overlay_text = nil,
scale_min = math.huge, scale_max = math.huge,
w = 0, h = 0])


number = callback_data:getBufSize()
ImGui:plotLines(label, points_table
[, values_offset = 0, overlay_text = nil,
scale_min = math.huge, scale_max = math.huge,
w = 0, h = 0])


callback_data:setBufDirty(bool)
ImGui:plotHistogram(label, points_table
bool = callback_data:isBufDirty()
[, values_offset = 0, overlay_text = nil,
scale_min = math.huge, scale_max = math.huge,
w = 0, h = 0])
</syntaxhighlight>


callback_data:setCursorPos(number)
'''Example''':
number = callback_data:getCursorPos()
<syntaxhighlight lang="lua">
-- delete ptr if it exist
function deletePtr()
if pointsPtr then
ImGui.freePoints(pointsPtr)
end
end


callback_data:setSelectionStart(s_start)
function onEnterFrame()
number = callback_data:getSelectionStart()
ui:newFrame(e.deltaTime)
if ui:button("Generate") then
deletePtr()
points = generatePoints() -- returns big array
pointsPtr = ImGui.cachePoints(points)
end
if pointsPtr then
ui:plotCachedLines("Big data", pointsPtr, #points)
end
ui:render()
ui:endFrame()
end


callback_data:setSelectionEnd(s_end)
-- do not forget to clear memory when app is closing
s_end = callback_data:getSelectionEnd()
function onAppExit()
 
deletePtr()
callback_data:setSelection(s_start, s_end)
end
s_start, s_end = callback_data:getSelection()
</syntaxhighlight>


callback_data:selectAll()
=== Widgets: Value() Helpers ===
callback_data:clearSelection()
<syntaxhighlight lang="lua">
bool = callback_data:hasSelection()
ImGui:value(prefix, bool)
ImGui:value(prefix, number)
ImGui:value(prefix, float, format_string)
</syntaxhighlight>


callback_data:deleteChars(position, bytesCount)
=== Widgets: Menus ===
callback_data:insertChars(position, text)
<syntaxhighlight lang="lua">
result? = ImGui:beginMenuBar()
ImGui:endMenuBar()
result? = ImGui:beginMainMenuBar()
ImGui:endMainMenuBar()
result = ImGui:beginMenu(label [, enabled = true])
result = ImGui:beginMenuEx(label, [icon = "", enabled = true])
ImGui:endMenu()
result = ImGui:menuItem(label [, shortcut = "", selected = false, enabled = true])
result = ImGui:menuItemEx(label, [icon = "", shortcut = "", selected = false, enabled = true])
</syntaxhighlight>
</syntaxhighlight>


'''Example''':
=== Widgets: Tooltips ===
Tooltip are windows following the mouse which do not take focus away.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
require "ImGui"
ImGui:beginTooltip()
 
ImGui:endTooltip()
ui = ImGui.new()
ImGui:setTooltip(text)
stage:addChild(ui)
</syntaxhighlight>
 
=== Disabled groups ===
<syntaxhighlight lang="lua">
ImGui:beginDisabled(disabledFlag)
ImGui:endDisabled()
</syntaxhighlight>
 
== Popups, Modals ==
The properties of popups windows are: - They block normal mouse hovering detection outside them. (*1) - Unless modal, they can be closed by clicking anywhere outside them, or by pressing ESCAPE. Because hovering detection is disabled outside the popup, when clicking outside the click will not be seen by underlying widgets! (*'''1''')


local testMessage1 = ""
* Their visibility state (~bool) is held internally by Dear ImGui instead of being held by the programmer as we are used to with regular Begin() calls. User can manipulate the visibility state by calling OpenPopup(), CloseCurrentPopup() etc.
local testMessage2 = ""
* We default to use the right mouse (ImGuiMouseButton_Right=1) for the Popup Context functions.
local testMessage3 = ""
* Those three properties are connected: we need to retain popup visibility state in the library because popups may be closed as any time.


-- Add ".." at the end of current input string
('''1'''.) You can bypass that restriction and detect hovering even when normally blocked by a popup. To do this use the ImGuiHoveredFlags_AllowWhenBlockedByPopup when calling IsItemHovered() or IsWindowHovered(). This is what BeginPopupContextItem() and BeginPopupContextWindow() are doing already, allowing a right-click to reopen another popups without losing the click.
function myCallback1(data)
data:insertChars(data:getCursorPos(), "..")
end


-- Replace all chars if UP/DOWN arrow is pressed
<syntaxhighlight lang="lua">
function myCallback2(data)
result? = ImGui:beginPopup(str_id [, ImGui.WindowFlags = 0])
local key = data:getEventKey()
p_open, result? = ImGui:beginPopupModal(str_id, p_open [, ImGui.WindowFlags = 0])
if (key == key_code.UP) then
ImGui:endPopup()
data:deleteChars(0, data:getBufTextLen())
ImGui:openPopup(str_id [, ImGui.PopupFlags = 0])
data:insertChars(0, "Pressed Up!")
ImGui:openPopupOnItemClick(str_id [, ImGui.PopupFlags = 0])
data:selectAll()
ImGui:closeCurrentPopup()
elseif (key == key_code.DOWN) then
result? = ImGui:beginPopupContextItem(str_id [, ImGui.PopupFlags = 0])
data:deleteChars(0, data:getBufTextLen())
result? = ImGui:beginPopupContextWindow(str_id [, ImGui.PopupFlags = 0])
data:insertChars(0, "Pressed Down!")
result? = ImGui:beginPopupContextVoid(str_id [, ImGui.PopupFlags = 0])
data:selectAll()
result? = ImGui:isPopupOpen(str_id [, ImGui.PopupFlags = 0])
end
</syntaxhighlight>
end


-- Switch case of the first char
== Columns ==
function myCallback3(data)
* You can also use SameLine(pos_x) to mimic simplified columns.
local buf = data:getBuf()
* The columns API is work-in-progress and rather lacking (columns are arguably the worst part of dear imgui at the moment!)
local s = buf:sub(1,1)
* There is a maximum of 64 columns.
if ((s >= 'a' and s <= 'z') or (s >= 'A' and s <= 'Z')) then
* Currently working on new 'Tables' api which will replace columns around Q2 2020 (see GitHub #2957).
local first = string.char(string.byte(s) ~ 32)
data:setBuf(first .. buf:sub(2))
data:setBufDirty(true)
end
end


function enterFrame(e)
<syntaxhighlight lang="lua">
ui:newFrame(e.deltaTime)
ImGui:columns([count = 1, id = nil, border = true])
ImGui:nextColumn()
testMessage1 = ui:inputText(
index = ImGui:getColumnIndex()
"Label1",  
width = ImGui:getColumnWidth([column_index = -1])
testMessage1,
ImGui:setColumnWidth(column_index, width)
64,  
offset = ImGui:getColumnOffset([column_index = -1])
ImGui.InputTextFlags_CallbackCompletion,
ImGui:setColumnOffset(column_index, offset)
myCallback1
number = ImGui:getColumnsCount()
)
</syntaxhighlight>
testMessage2 = ui:inputText(
 
"Label2",
== Tab Bars, Tabs ==
testMessage2,  
<syntaxhighlight lang="lua">
64,
bool = ImGui:beginTabBar(str_id [, ImGui.TabBarFlags = 0])
ImGui.InputTextFlags_CallbackHistory,
ImGui:endTabBar()
myCallback2
p_open, bool = ImGui:beginTabItem(label, p_open [, ImGui.TabItemFlags = 0])
)
ImGui:endTabItem()
testMessage3 = ui:inputText(
ImGui:setTabItemClosed(tab_or_docked_window_label)
"Label3",  
ImGui:tabItemButton(label [, ImGui.TabItemFlags = 0])
testMessage3,  
</syntaxhighlight>
64,
ImGui.InputTextFlags_CallbackEdit,
myCallback3
)
ui:render()
ui:endFrame()
end


stage:addEventListener("enterFrame", enterFrame)
== Logging/Capture ==
All text output from the interface can be captured into tty/file/clipboard. By default, tree nodes are automatically opened during logging.
<syntaxhighlight lang="lua">
ImGui:logToTTY(auto_open_depth = -1)
ImGui:logToFile(auto_open_depth = -1, filename = nil)
ImGui:logToClipboard(auto_open_depth = -1)
ImGui:logFinish()
ImGui:logButtons()
ImGui:logText(text)  
</syntaxhighlight>
</syntaxhighlight>


=== Widgets: Color Editor/Picker ===
== Drag and drop ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
hexColor, is_touching = ImGui:colorEdit3(label, color [, ImGui.ColorEditFlags = 0]) -- alpha ignored, no need to pass it!
flag = ImGui:beginDragDropSource([ImGui.DragDropFlags flags = 0])
hexColor, alpha, is_touching = ImGui:colorEdit4(label, color [, alpha = 1, ImGui.ColorEditFlags = 0])
flag = ImGui:setNumDragDropPayload(str_type, number [, ImGui.Cond cond = 0])
hexColor, is_touching = ImGui:colorPicker3(label, color [, ImGui.ColorEditFlags = 0])
flag = ImGui:setStrDragDropPayload(str_type, string [, ImGui.Cond cond = 0])
hexColor, alpha, originalColor, originalAlpha, is_touching = ImGui:colorPicker4(label, color
ImGui:endDragDropSource()
[, alpha = 1, original_color = 0xffffff, original_alpha = 1, ImGui.ColorEditFlags = 0])
flag = ImGui:beginDragDropTarget()
isHoveringFlag = ImGui:colorButton(string_ID, color [, alpha = 1, ImGui.ColorEditFlags = 0, w = 0, h = 0])
ImGuiPayload = ImGui:acceptDragDropPayload(type [, ImGui.DragDropFlags flags = 0])
ImGui:setColorEditOptions(ImGui.ColorEditFlags)
ImGui:endDragDropTarget()
ImGuiPayload = ImGui:getDragDropPayload()
</syntaxhighlight>
</syntaxhighlight>


=== Widgets: Trees ===
'''Payload''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
is_openFlag = ImGui:treeNode(label [, format_string])
number = ImGuiPayload:getNumData()
ImGui:treeNodeEx(label, ImGui.TreeNodeFlags [, format_string])
string = ImGuiPayload:getStrData()
ImGui:treePush(str_id)
ImGuiPayload:clear()
ImGui:treePop()
number = ImGuiPayload:getDataSize()
number = ImGui:getTreeNodeToLabelSpacing()
flag = ImGuiPayload:isDataType(type) -- type must be the same as in "ImGui:acceptDragDropPayload(type)"
is_openFlag, p_open = ImGui:collapsingHeader(label, p_open [, ImGui.TreeNodeFlags = 0])
flag = ImGuiPayload:isPreview()
is_openFlag = ImGui:collapsingHeader(label [, ImGui.TreeNodeFlags = 0])
flag = ImGuiPayload:isDelivery()
ImGui:setNextItemOpen(is_open, ImGui.Cond)
</syntaxhighlight>
</syntaxhighlight>


=== Widgets: Selectables ===
'''Usage example''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
result?, selected = ImGui:selectable(label, selected [, ImGui.SelectableFlags = 0, w = 0, h = 0])
require "ImGui"
</syntaxhighlight>


=== Widgets: List Boxes ===
local imgui = ImGui.new()
<syntaxhighlight lang="lua">
stage:addChild(imgui)
-- item_table: {"Item0", "Item1", ...}
current_item, is_openFlag = ImGui:listBox(label, current_item, item_table [, max_visible_items = -1])
result? = ImGui:listBoxHeader(label [, w = 0, h = 0])
result? = ImGui:listBoxHeader2(label, items_count)
ImGui:listBoxFooter()
</syntaxhighlight>


=== Widgets: Data Plotting ===
local names = {
'''Caching''':
"Bobby", "Beatrice", "Betty",
"Brianna", "Barry", "Bernard",
"Bibi", "Blaine", "Bryn"
}
-- modes:
local Mode_Copy = 0
local Mode_Move = 1
local Mode_Swap = 2
local mode = 0 -- current mode


If you have big array of points it is better to cache it instead of translating lua table to C++ vector every time you call `ImGui:plotLines()`. But in this case you need to manage memory by yourself (free points pointer when you dont need it).
function onEnterFrame(e)
<syntaxhighlight lang="lua">
imgui:newFrame(e.deltaTime)
-- store points in memory
-- points_table: {0.01, 0.5, 10, -50, ...}
if (imgui:radioButton("Copy", mode == Mode_Copy)) then mode = Mode_Copy end imgui:sameLine()
-- ptr: c++ pointer to a given vector
if (imgui:radioButton("Move", mode == Mode_Move)) then mode = Mode_Move end imgui:sameLine()
ptr = ImGui.cachePoints(points_table)
if (imgui:radioButton("Swap", mode == Mode_Swap)) then mode = Mode_Swap end
 
-- delete points from memory
for i,v in ipairs(names) do
ImGui.freePoints(ptr)
imgui:pushID(i)
</syntaxhighlight>
if (((i-1) % 3) ~= 0) then imgui:sameLine() end
 
'''Plot functions''':
imgui:button(v, 60, 60)
<syntaxhighlight lang="lua">
-- len (number): points array lenght
if (imgui:beginDragDropSource(ImGui.DragDropFlags_None)) then
ImGui:plotCachedLines(label, ptr, len,
--imgui:setStrDragDropPayload("DND_DEMO_CELL", "ID_"..i) -- used for strings
[, values_offset = 0, overlay_text = nil,
imgui:setNumDragDropPayload("DND_DEMO_CELL", i) -- used for numbers
scale_min = math.huge, scale_max = math.huge,
w = 0, h = 0])
if (mode == Mode_Copy) then imgui:text(("Copy %s"):format(v)) end
if (mode == Mode_Move) then imgui:text(("Move %s"):format(v)) end
ImGui:plotCachedHistogram(label, ptr, len,
if (mode == Mode_Swap) then imgui:text(("Swap %s"):format(v)) end
[, values_offset = 0, overlay_text = nil,
imgui:endDragDropSource()
scale_min = math.huge, scale_max = math.huge,
end
w = 0, h = 0])
 
if (imgui:beginDragDropTarget()) then
ImGui:plotLines(label, points_table
local payload = imgui:acceptDragDropPayload("DND_DEMO_CELL")
[, values_offset = 0, overlay_text = nil,
if (payload) then
scale_min = math.huge, scale_max = math.huge,
--local payload_n = tonumber(payload:getStrData():sub(4)) -- if "setStrDragDropPayload" was used
w = 0, h = 0])
local payload_n = payload:getNumData() -- if "setNumDragDropPayload" was used
 
ImGui:plotHistogram(label, points_table
if (mode == Mode_Copy) then
[, values_offset = 0, overlay_text = nil,
names[i] = names[payload_n];
scale_min = math.huge, scale_max = math.huge,  
end
w = 0, h = 0])
if (mode == Mode_Move) then
</syntaxhighlight>
names[i] = names[payload_n];
 
names[payload_n] = "";
'''Example''':
end
<syntaxhighlight lang="lua">
-- delete ptr if it exist
if (mode == Mode_Swap) then
function deletePtr()
names[i], names[payload_n] = names[payload_n], names[i]
if pointsPtr then
end
ImGui.freePoints(pointsPtr)
end
imgui:endDragDropTarget()
end
imgui:popID()
end
end
imgui:render()
imgui:endFrame()
end
end


function onEnterFrame()
stage:addEventListener("enterFrame", onEnterFrame)
ui:newFrame(e.deltaTime)
</syntaxhighlight>
 
if ui:button("Generate") then
== Clipping ==
deletePtr()
<syntaxhighlight lang="lua">
points = generatePoints() -- returns big array
ImGui:pushClipRect(min_x, min_y, max_x, max_y, intersect_with_current_clip_rect)
pointsPtr = ImGui.cachePoints(points)
ImGui:popClipRect()
end
</syntaxhighlight>
if pointsPtr then
ui:plotCachedLines("Big data", pointsPtr, #points)
end
ui:render()
ui:endFrame()
end


-- do not forget to clear memory when app is closing
== ImGuiListClipper ==
function onAppExit()
Try to avoid creating new instances in "enterFrame" event.
deletePtr()
end
</syntaxhighlight>


== Widgets: Value() Helpers ==
'''Constructor''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:value(prefix, bool)
instance = ImGuiListClipper.new()
ImGui:value(prefix, number)
ImGui:value(prefix, float, format_string)
</syntaxhighlight>
</syntaxhighlight>


== Widgets: Menus ==
'''Methods''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
result? = ImGui:beginMenuBar()
ImGuiListClipper:beginClip(number_of_items [, item_height = -1]) -- if item_height <= 0 then it is calculated automatically
ImGui:endMenuBar()
ImGuiListClipper:endClip()
result? = ImGui:beginMainMenuBar()
bool = ImGuiListClipper:step()
ImGui:endMainMenuBar()
number = ImGuiListClipper:getDisplayStart()
result = ImGui:beginMenu(label [, enabled = true])
number = ImGuiListClipper:getDisplayEnd()
result = ImGui:beginMenuEx(label, [icon = "", enabled = true])
number = ImGuiListClipper:getStartPosY()
ImGui:endMenu()
number = ImGuiListClipper:getItemsCount()
result = ImGui:menuItem(label [, shortcut = "", selected = false, enabled = true])
ImGuiListClipper:forceDisplayRangeByIndices(number_min, number_max)
result = ImGui:menuItemEx(label, [icon = "", shortcut = "", selected = false, enabled = true])
ImGui:beginTooltip()
ImGui:endTooltip()
ImGui:setTooltip(text)
</syntaxhighlight>
</syntaxhighlight>


== Popups, Modals ==
'''Usage example''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
result? = ImGui:beginPopup(str_id [, ImGui.WindowFlags = 0])
require "ImGui"
p_open, result? = ImGui:beginPopupModal(str_id, p_open [, ImGui.WindowFlags = 0])
ImGui:endPopup()
ImGui:openPopup(str_id [, ImGui.PopupFlags = 0])
ImGui:openPopupOnItemClick(str_id [, ImGui.PopupFlags = 0])
ImGui:closeCurrentPopup()
result? = ImGui:beginPopupContextItem(str_id [, ImGui.PopupFlags = 0])
result? = ImGui:beginPopupContextWindow(str_id [, ImGui.PopupFlags = 0])
result? = ImGui:beginPopupContextVoid(str_id [, ImGui.PopupFlags = 0])
result? = ImGui:isPopupOpen(str_id [, ImGui.PopupFlags = 0])
</syntaxhighlight>


== Tables ==
local imgui = ImGui.new()
<syntaxhighlight lang="lua">
stage:addChild(imgui)
flag = ImGui:beginTable(str_id, column [, ImGui.TableFlags = 0, outer_w = 0, outer_h = 0, inner_width = 0])
 
ImGui:endTable()
clipper = ImGuiListClipper.new()
ImGui:tableNextRow([ImGui.TableRowFlags = 0, min_row_height = 0])
flag = ImGui:tableNextColumn()
flag = ImGui:tableSetColumnIndex(column_n)
ImGui:tableSetupColumn(label [, ImGui.TableColumnFlags = 0, init_width_or_weight = 0, user_id = 0])
ImGui:tableSetupScrollFreeze(cols, rows)
ImGui:tableHeadersRow()
TableSortSpecs = ImGui:tableGetSortSpecs() -- see below
number = ImGui:tableGetColumnCount()
number = ImGui:tableGetColumnIndex()
number = ImGui:tableGetRowIndex()
string = ImGui:tableGetColumnName([column_n = -1])
ImGuiTableColumnFlags = ImGui:tableGetColumnFlags([column_n = -1])
ImGui:tableSetBgColor(ImGui.TableBgTarget, color [, alpha = 1, column_n = -1])
</syntaxhighlight>


== Table sort specs ==
function onEnterFrame(e)
<syntaxhighlight lang="lua">
imgui:newFrame(e.deltaTime)
-- TableSortSpecs = ImGui:tableGetSortSpecs()
number = TableSortSpecs:getSpecsCount()
flag = TableSortSpecs:isSpecsDirty()
TableSortSpecs:setSpecsDirty(flag)
table = TableSortSpecs:getColumnSortSpecs() -- see below
</syntaxhighlight>


== Table column sort specs ==
if (imgui:beginWindow("Clipper demo")) then
<syntaxhighlight lang="lua">
if (imgui:beginTable("table", 3)) then
-- table = TableSortSpecs:getColumnSortSpecs()
imgui:tableSetupScrollFreeze(0, 1) -- cols, rows
-- each value of this table is an object that have this functions:
imgui:tableSetupColumn("One")
number = item:getColumnUserID()  
imgui:tableSetupColumn("Two")
number = item:getColumnIndex() -- 0 based
imgui:tableSetupColumn("Three")
number = item:getSortOrder() -- used in multi sorted tables
imgui:tableHeadersRow()
number = item:getSortDirection() -- ImGui.SortDirection_Ascending OR ImGui.SortDirection_Descending
</syntaxhighlight>
Example: https://github.com/MultiPain/Gideros_examples/blob/master/ImGuiTablesDemo/assets/TablesDemo.lua</br>


== Columns ==
clipper:beginClip(100)
<syntaxhighlight lang="lua">
while (clipper:step()) do
ImGui:columns([count = 1, id = nil, border = true])
for row = clipper:getDisplayStart(), clipper:getDisplayEnd() do
ImGui:nextColumn()
imgui:tableNextRow()
index = ImGui:getColumnIndex()
for column = 1, 3 do
width = ImGui:getColumnWidth([column_index = -1])
imgui:tableSetColumnIndex(column - 1)
ImGui:setColumnWidth(column_index, width)
imgui:text(("col: %d; row: %d"):format(column, row))
offset = ImGui:getColumnOffset([column_index = -1])
end
ImGui:setColumnOffset(column_index, offset)
end
number = ImGui:getColumnsCount()
end
</syntaxhighlight>
clipper:endClip()
 
imgui:endTable()
end
end
imgui:endWindow()
 
imgui:endFrame()
imgui:render()
end


== Tab Bars, Tabs ==
stage:addEventListener("enterFrame", onEnterFrame)
<syntaxhighlight lang="lua">
bool = ImGui:beginTabBar(str_id [, ImGui.TabBarFlags = 0])
ImGui:endTabBar()
p_open, bool = ImGui:beginTabItem(label, p_open [, ImGui.TabItemFlags = 0])
ImGui:endTabItem()
ImGui:setTabItemClosed(tab_or_docked_window_label)
ImGui:tabItemButton(label [, ImGui.TabItemFlags = 0])
</syntaxhighlight>
</syntaxhighlight>


== Logging/Capture ==
== Context ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:logToTTY(auto_open_depth = -1)  
string OR nil = ImGui:getHoveredWindow()
ImGui:logToFile(auto_open_depth = -1, filename = nil)  
string OR nil = ImGui:getHoveredWindowRoot()
ImGui:logToClipboard(auto_open_depth = -1)  
string OR nil = ImGui:getHoveredWindowUnderMovingWindow()
ImGui:logFinish()  
string OR nil = ImGui:getMovingWindow()
ImGui:logButtons()  
string OR nil = ImGui:getActiveIdWindow()
ImGui:logText(text)  
id = ImGui:getActiveId()
id = ImGui:getActiveIdPreviousFrame()
number = ImGui:getActiveIdTimer()
id = ImGui:getActiveIdAllowOverlap()
id = ImGui:getHoveredId()
id = ImGui:getHoveredIdPreviousFrame()
number = ImGui:getHoveredIdTimer()
id = ImGui:getHoveredIdAllowOverlap()
bool = ImGui:getDragDropActive()
id = ImGui:getDragDropPayloadSourceId()
string = ImGui:getDragDropPayloadDataType()
number = ImGui:getDragDropPayloadDataSize()
</syntaxhighlight>
</syntaxhighlight>


== Drag and drop ==
== Focus, Activation ==
* Prefer using "SetItemDefaultFocus()" over "if (IsWindowAppearing()) SetScrollHereY()" when applicable to signify "this is the default item"
* Most of the functions are referring to the last/previous item we submitted.
* See Demo Window under "Widgets->Querying Status" for an interactive visualization of most of those functions.
 
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
flag = ImGui:beginDragDropSource([ImGui.DragDropFlags flags = 0])
ImGui:setItemDefaultFocus()
flag = ImGui:setNumDragDropPayload(str_type, number [, ImGui.Cond cond = 0])
ImGui:setKeyboardFocusHere([offset = 0])
flag = ImGui:setStrDragDropPayload(str_type, string [, ImGui.Cond cond = 0])
flag = ImGui:isItemHovered([ImGui.HoveredFlags = 0])
ImGui:endDragDropSource()
flag = ImGui:isItemActive()
flag = ImGui:beginDragDropTarget()
flag = ImGui:isItemFocused()
ImGuiPayload = ImGui:acceptDragDropPayload(type [, ImGui.DragDropFlags flags = 0])
flag = ImGui:isItemClicked(mouse_button)
ImGui:endDragDropTarget()
flag = ImGui:isItemVisible()
ImGuiPayload = ImGui:getDragDropPayload()
flag = ImGui:isItemEdited()
flag = ImGui:isItemActivated()
flag = ImGui:isItemDeactivated()
flag = ImGui:isItemDeactivatedAfterEdit()
flag = ImGui:isItemToggledOpen()
flag = ImGui:isAnyItemHovered()
flag = ImGui:isAnyItemActive()
flag = ImGui:isAnyItemFocused()
minX, minY, maxX, maxY = ImGui:getItemRect()
x, y = ImGui:getItemRectMin()
x, y = ImGui:getItemRectMax()
w, h = ImGui:getItemRectSize()
ImGui:setItemAllowOverlap()
</syntaxhighlight>
</syntaxhighlight>


'''Payload''':
== INPUTS ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
number = ImGuiPayload:getNumData()
ImGui:onMouseHover(event)
string = ImGuiPayload:getStrData()
ImGui:onMouseMove(event)
ImGuiPayload:clear()
ImGui:onMouseDown(event)
number = ImGuiPayload:getDataSize()
ImGui:onMouseUp(event)
flag = ImGuiPayload:isDataType(type) -- type must be the same as in "ImGui:acceptDragDropPayload(type)"
ImGui:onMouseWheel(event)
flag = ImGuiPayload:isPreview()
 
flag = ImGuiPayload:isDelivery()
ImGui:onTouchMove(event)
ImGui:onTouchBegin(event)
ImGui:onTouchEnd(event)
ImGui:onTouchCancel(event)
 
ImGui:onKeyUp(event)
ImGui:onKeyDown(event)
ImGui:onKeyChar(event)
</syntaxhighlight>
</syntaxhighlight>


'''Usage example''':
'''Usage examples''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
require "ImGui"
local UI = ImGui.new(nil, false, false, false)
</syntaxhighlight>


local imgui = ImGui.new()
'''Mouse'''
stage:addChild(imgui)
<syntaxhighlight lang="lua">
stage:addEventListener("mouseHover", function(e) UI:onMouseHover(e) end)
stage:addEventListener("mouseMove", function(e) UI:onMouseMove(e) end)
stage:addEventListener("mouseDown", function(e) UI:onMouseDown(e) end)
stage:addEventListener("mouseUp", function(e) UI:onMouseUp(e) end)
stage:addEventListener("mouseWheel", function(e) UI:onMouseWheel(e) end)
</syntaxhighlight>


local names = {
'''Touch'''
"Bobby", "Beatrice", "Betty",
<syntaxhighlight lang="lua">
"Brianna", "Barry", "Bernard",
stage:addEventListener("touchesCancel", function(e) ui:onTouchCancel(e) end)
"Bibi", "Blaine", "Bryn"
stage:addEventListener("touchesMove", function(e) ui:onTouchMove(e) end)
}
stage:addEventListener("touchesBegin", function(e) ui:onTouchBegin(e) end)
-- modes:
stage:addEventListener("touchesEnd", function(e) ui:onTouchEnd(e) end)
local Mode_Copy = 0
</syntaxhighlight>
local Mode_Move = 1
local Mode_Swap = 2
local mode = 0 -- current mode


function onEnterFrame(e)
'''Keyboard'''
imgui:newFrame(e.deltaTime)
<syntaxhighlight lang="lua">
stage:addEventListener("keyUp", function(e) UI:onKeyUp(e) end)
if (imgui:radioButton("Copy", mode == Mode_Copy)) then mode = Mode_Copy end imgui:sameLine()
stage:addEventListener("keyDown", function(e) UI:onKeyDown(e) end)
if (imgui:radioButton("Move", mode == Mode_Move)) then mode = Mode_Move end imgui:sameLine()
stage:addEventListener("keyChar", function(e) UI:onKeyChar(e) end)
if (imgui:radioButton("Swap", mode == Mode_Swap)) then mode = Mode_Swap end
</syntaxhighlight>
 
for i,v in ipairs(names) do
== Miscellaneous Utilities ==
imgui:pushID(i)
<syntaxhighlight lang="lua">
if (((i-1) % 3) ~= 0) then imgui:sameLine() end
flag = ImGui:isRectVisible(w, h [, max_x, max_y])
number = ImGui:getTime()
imgui:button(v, 60, 60)
number = ImGui:getFrameCount()
str = ImGui:getStyleColorName(idx)
if (imgui:beginDragDropSource(ImGui.DragDropFlags_None)) then
flag = ImGui:beginChildFrame(id, w, h [, ImGui.WindowFlags = 0]) -- id (number)
--imgui:setStrDragDropPayload("DND_DEMO_CELL", "ID_"..i) -- used for strings
ImGui:endChildFrame()
imgui:setNumDragDropPayload("DND_DEMO_CELL", i) -- used for numbers
</syntaxhighlight>
 
if (mode == Mode_Copy) then imgui:text(("Copy %s"):format(v)) end
=== Text Utilities ===
if (mode == Mode_Move) then imgui:text(("Move %s"):format(v)) end
<syntaxhighlight lang="lua">
if (mode == Mode_Swap) then imgui:text(("Swap %s"):format(v)) end
w, h = ImGui:calcTextSize(text [, hide_text_after_double_hash = false, wrap_width = -1])
imgui:endDragDropSource()
</syntaxhighlight>
end
 
=== Color convert ===
if (imgui:beginDragDropTarget()) then
'''Note''': use ''DOT'' instead of ''COLON'', so you can use it without creating an ImGui object
local payload = imgui:acceptDragDropPayload("DND_DEMO_CELL")
<syntaxhighlight lang="lua">
if (payload) then
r, g, b, a = ImGui.colorConvertHEXtoRGB(color [, alpha = 1])
--local payload_n = tonumber(payload:getStrData():sub(4))  -- if "setStrDragDropPayload" was used
hex = ImGui.colorConvertRGBtoHEX(r, g, b)
local payload_n = payload:getNumData() -- if "setNumDragDropPayload" was used
h, s, v = ImGui.colorConvertRGBtoHSV(r, g, b)
r, g, b = ImGui.colorConvertHSVtoRGB(h, s, v)
if (mode == Mode_Copy) then
h, s, v = ImGui.colorConvertHEXtoHSV(hex)
names[i] = names[payload_n];
hex = ImGui.colorConvertHSVtoHEX(h, s, v)
end
</syntaxhighlight>
if (mode == Mode_Move) then
 
names[i] = names[payload_n];
=== Inputs Utilities: Keyboard ===
names[payload_n] = "";
* For 'int user_key_index' you can use your own indices/enums according to how your backend/engine stored them in io.KeysDown[].
end
* We don't know the meaning of those value. You can use GetKeyIndex() to map a ImGuiKey_ value into the user index.
 
if (mode == Mode_Swap) then
<syntaxhighlight lang="lua">
names[i], names[payload_n] = names[payload_n], names[i]
string = ImGui:getKeyName(keyCode)
end
flag = ImGui:isKeyDown(keyCode)
end
flag = ImGui:isKeyPressed(keyCode [, repeat = true])
imgui:endDragDropTarget()
flag = ImGui:isKeyReleased(keyCode)
end
number = ImGui:getKeyPressedAmount(keyCode, repeat_delay, rate)
imgui:popID()
ImGui:setNextFrameWantCaptureKeyboard([want_capture_keyboard_value = true])
end
imgui:render()
imgui:endFrame()
end
 
stage:addEventListener("enterFrame", onEnterFrame)
</syntaxhighlight>
</syntaxhighlight>


== Clipping ==
=== Shortcut system ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:pushClipRect(min_x, min_y, max_x, max_y, intersect_with_current_clip_rect)
-- (keyChord: an ImGuiKey optionally OR-ed with one or more ImGuiMod_XXX values (ImGuiKey | ImGuiMod_XXX))
ImGui:popClipRect()
ImGui:shortcut(keyChord [, owner_id = 0, ImGui.InputFlags = 0])
</syntaxhighlight>


== ImGuiListClipper ==
-- (useful to disable CTRL + TAB combo: ImGui:setShortcutRouting(ImGui.Mod_Ctrl | ImGui.Key_Tab, ImGui.KeyOwner_None))
Try to avoid creating new instances in "enterFrame" event.
ImGui:setShortcutRouting(keyChord [, owner_id = 0, ImGui.InputFlags = 0])


'''Constructor''':
ImGui:setItemKeyOwner(keyCode [, ImGui.InputFlags = 0])
<syntaxhighlight lang="lua">
instance = ImGuiListClipper.new()
</syntaxhighlight>


'''Methods''':
ImGui:setKeyOwner(keyCode, owner_id, [, ImGui.InputFlags = 0])
<syntaxhighlight lang="lua">
ImGuiListClipper:beginClip(number_of_items [, item_height = -1]) -- if item_height <= 0 then it is calculated automatically
ImGuiListClipper:endClip()
bool = ImGuiListClipper:step()
number = ImGuiListClipper:getDisplayStart()
number = ImGuiListClipper:getDisplayEnd()
number = ImGuiListClipper:getStartPosY()
number = ImGuiListClipper:getItemsCount()
ImGuiListClipper:forceDisplayRangeByIndices(number_min, number_max)
</syntaxhighlight>
</syntaxhighlight>


'''Usage example''':
'''Focused window and global application ''button'' shortcut example'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
require "ImGui"
require "ImGui"
Line 1,388: Line 1,412:
local imgui = ImGui.new()
local imgui = ImGui.new()
stage:addChild(imgui)
stage:addChild(imgui)
 
imgui:setClassicStyle()
clipper = ImGuiListClipper.new()


function onEnterFrame(e)
function onEnterFrame(e)
imgui:newFrame(e.deltaTime)
imgui:newFrame(e.deltaTime)


if (imgui:beginWindow("Clipper demo")) then
-- focused window button shortcut
if (imgui:beginTable("table", 3)) then
if imgui:button("PLAY##01", 32*2, 32*0.6) or imgui:shortcut(ImGui.Key_P) then
imgui:tableSetupScrollFreeze(0, 1) -- cols, rows
print(ImGui:getItemID()) -- 2102678615
imgui:tableSetupColumn("One")
end
imgui:tableSetupColumn("Two")
imgui:sameLine(32*2.5)
imgui:tableSetupColumn("Three")
-- focused window button shortcut (using item ID)
imgui:tableHeadersRow()
if imgui:button("PLAY##02", 32*2, 32*0.6) or imgui:shortcut(ImGui.Key_Q, 8325, ImGui.FocusedFlags_AnyWindow) then
print(ImGui:getItemID()) -- 8325
end


clipper:beginClip(100)
-- global app button shortcut
while (clipper:step()) do
if imgui:button("PLAY##03", 32*2, 32*0.6) or imgui:isKeyPressed(KeyCode.C) then
for row = clipper:getDisplayStart(), clipper:getDisplayEnd() do
print(ImGui:getItemID()) -- 1157645807
imgui:tableNextRow()
for column = 1, 3 do
imgui:tableSetColumnIndex(column - 1)
imgui:text(("col: %d; row: %d"):format(column, row))
end
end
end
clipper:endClip()
 
imgui:endTable()
end
end
end
imgui:endWindow()


imgui:render()
imgui:endFrame()
imgui:endFrame()
imgui:render()
end
end


stage:addEventListener("enterFrame", onEnterFrame)
stage:addEventListener(Event.ENTER_FRAME, onEnterFrame)
</syntaxhighlight>
</syntaxhighlight>


== ImGuiTextFilter ==
'''Global application ''checkbox'' shortcut example'''
Try to avoid creating new instaces in "enterFrame" event.
 
'''Constructor''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
filter = ImGuiTextFilter.new()
require "ImGui"
</syntaxhighlight>


'''Methods''':
local imgui = ImGui.new()
<syntaxhighlight lang="lua">
stage:addChild(imgui)
-- draws the input field
imgui:setClassicStyle()
isValueChanged = filter:draw(label [, width = 0])
 
-- draws the input field (using ImGui:inutTextWithHint())
-- some vars
isValueChanged = filter:drawWithHint(label, hint [, width = 0])
local islooping = false


filter:setBuffer(text) -- set filter text
function onEnterFrame(e)
filter:build() -- update filter internals (see example below)
imgui:newFrame(e.deltaTime)
bool = filter:passFilter(text) -- returns true if filter input matches with "text"
local ischanged = false
</syntaxhighlight>


'''Usage example 1''':</br>
islooping, ischanged = imgui:checkbox("looping(L)", islooping)
https://github.com/MultiPain/Gideros_ImGui/blob/master/imgui_src/imgui_demo.cpp#L5657
if imgui:isKeyPressed(KeyCode.L) then
<syntaxhighlight lang="lua">
islooping = not islooping
require "ImGui"
ischanged = true
end
if ischanged then
print("islooping", islooping)
end


local imgui = ImGui.new()
imgui:render()
stage:addChild(imgui)
imgui:endFrame()
end


local filter = ImGuiTextFilter.new()
stage:addEventListener(Event.ENTER_FRAME, onEnterFrame)
local items = { "aaa1.c", "bbb1.c", "ccc1.c", "aaa2.cpp", "bbb2.cpp", "ccc2.cpp", "abc.h", "hello, world" }
</syntaxhighlight>


function onEnterFrame(e)
=== Inputs Utilities: Mouse ===
imgui:newFrame(e.deltaTime)
* To refer to a mouse button, you may use named enums in your code e.g. ImGuiMouseButton_Left, ImGuiMouseButton_Right.
* You can also use regular integer: it is forever guaranteed that 0=Left, 1=Right, 2=Middle.
* Dragging operations are only reported after mouse has moved a certain distance away from the initial clicking position (see 'lock_threshold' and 'io.MouseDraggingThreshold')


if (imgui:beginWindow("Filter demo")) then
<syntaxhighlight lang="lua">
imgui:text([[
-- "mouse_button" is any gideros mouse button code
Filter usage:
flag = ImGui:isMouseDown(mouse_button)
""        display all lines
flag = ImGui:isMouseClicked(mouse_button [, repeat = false]) -- "mouse_button" is any gideros mouse button code
"xxx"      display lines containing "xxx"
flag = ImGui:isMouseReleased(mouse_button) -- "mouse_button" is any gideros mouse button code
"xxx,yyy"  display lines containing "xxx" or "yyy"
flag = ImGui:isMouseDoubleClicked(mouse_button) -- "mouse_button" is any gideros mouse button code
"-xxx"     hide lines containing "xxx"
flag = ImGui:isMouseHoveringRect(min_x, min_y, max_x, max_y [, clip = true])
]])
flag = ImGui:isMousePosValid([x = inf, y = inf])
flag = ImGui:isAnyMouseDown()
x, y = ImGui:getMousePos()
x, y = ImGui:getMousePosOnOpeningCurrentPopup()
flag = ImGui:isMouseDragging(mouse_button [, lock_threshold = -1]) -- "mouse_button" is any gideros mouse button code
x, y = ImGui:getMouseDragDelta(mouse_button [, lock_threshold = -1]) -- "mouse_button" is any gideros mouse button code
ImGui:resetMouseDragDelta(mouse_button) -- "mouse_button" is any gideros mouse button code
ImGuiMouseCursor = ImGui:getMouseCursor()
ImGui:setMouseCursor(ImGui.MouseCursor)
ImGui:setNextFrameWantCaptureMouse([want_capture_mouse_value = true])
ImGui:setNextFrameWantCaptureKeyboard([want_capture_keyboard_value = true])
ImGui:updateCursor()
</syntaxhighlight>
 
== FONTS ==
<syntaxhighlight lang="lua">
IO = imgui:getIO()
FontAtlas = IO:getFonts()


filter:draw("Filter")
Font = FontAtlas:addFont(ttf_font_path, font_size [, options])


for i, text in ipairs(items) do
-- options (table): all parameters are optional
if filter:passFilter(text) then
--     fontDataOwnedByAtlas - bool
imgui:bulletText(text)
--     pixelSnapH - bool
end
--     mergeMode - bool
end
--     fontNo - number
end
--     oversampleH - number
imgui:endWindow()
--     oversampleV - number
 
--     glyphExtraSpacingX - number
imgui:endFrame()
--     glyphExtraSpacingY - number
imgui:render()
--     glyphOffsetX - number
end
--     glyphOffsetY - number
 
--     glyphMinAdvanceX - number
stage:addEventListener("enterFrame", onEnterFrame)
--     glyphMaxAdvanceX - number
</syntaxhighlight>
--     rasterizerFlags - number
 
--     rasterizerMultiply - number
'''Usage example 2''':
--
<syntaxhighlight lang="lua">
--     glyphs - table:
require "ImGui"
--     text(string): represents available chars
--     chars(table): list of specific char code (example: {0x7262, ...})
--     ranges(table): predefined glyph ranges (example: {ImGui.GlyphRanges_Default, ImGui.GlyphRanges_Japanese, ...})
FontAtlas:addFonts(fontsDescription)
-- fontsDescriptions(table):
--      description(table):
--          ttf_font_path(string): path to a font
--          font_size(number): font size
--          options(table): see description above
-- example:
-- FontAtlas:addFonts{ {"fonts/DroidSans.ttf", 16}, {"fonts/ProggyTiny.ttf", 16} }


local imgui = ImGui.new()
Font = FontAtlas:getFont([index]) -- get font by index (if index is 0 or nil you will get default font instance)
stage:addChild(imgui)
FontAtlas:build() -- call after multiple FontAtlas:addFont(...) calls to update ImGui font atlas
FontAtlas:clearInputData()
FontAtlas:clearTexData()
FontAtlas:clearFonts()
FontAtlas:clear()
table = FontAtlas:getFonts() -- returns a table with all fonts (included default)
flag = FontAtlas:isBuilt()
number = FontAtlas:addCustomRectRegular(width, height)
number = FontAtlas:addCustomRectFontGlyph(font, id, width, height, advance_x [, offset_x, offset_y])
w, h, x, y, glyph_id, offset_x, offset_y, font, is_packed_flag = FontAtlas:getCustomRectByIndex(index)


local filter = ImGuiTextFilter.new()
ImGui:pushFont(font) -- font (table): object returned by FontAtlas:addFont(...) or FontAtlas:getFont([index])
local searchText = ""
ImGui:popFont()
local items = { "aaa1.c", "bbb1.c", "ccc1.c", "aaa2.cpp", "bbb2.cpp", "ccc2.cpp", "abc.h", "hello, world" }
</syntaxhighlight>


function onEnterFrame(e)
'''Minimal example''':
imgui:newFrame(e.deltaTime)
<syntaxhighlight lang="lua">
local UI = ImGui.new()
local IO = UI:getIO()
local FontAtlas = IO:getFonts()
local VDS_font = FontAtlas:addFont("fonts/VDS.ttf", 16, {
    oversampleH = 2,
    oversampleV = 2,
glyphs = {
ranges = {ImGui.GlyphRanges_Cyrillic}
}
})
IO:setFontDefault(VDS_font)
FontAtlas:build()
stage:addChild(UI)


-- draw standart text input control
-- you can use multiple fonts at the same time
-- filter:drawWithHint("Filter", "Search")
function enterFrame(e)
-- draw custom control
UI:newFrame(e.deltaTime)
local ischanged = false
searchText, ischanged = imgui:inputText("Filter", searchText, 256, ImGui.InputTextFlags_EnterReturnsTrue)
UI:pushFont(font1)
if ischanged then
UI:text("Font1")
filter:setBuffer(searchText)
UI:popFont()
-- try to avoid calling "build" function every frame
filter:build()
UI:pushFont(font2)
end
UI:text("Font2")
 
UI:popFont()
for i, item in ipairs(items) do
if not filter:passFilter(item) then
UI:render()
continue
UI:endFrame()
end
imgui:bulletText(item)
end
 
imgui:endFrame()
imgui:render()
end
end
stage:addEventListener("enterFrame", onEnterFrame)
</syntaxhighlight>
</syntaxhighlight>


== Focus, Activation ==
'''Glyphs example''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:setItemDefaultFocus()
local fonts = io:getFonts()
ImGui:setKeyboardFocusHere([offset = 0])
fonts:addFont(font_path, font_size, {
flag = ImGui:isItemHovered([ImGui.HoveredFlags = 0])
glyphs = {
flag = ImGui:isItemActive()
ranges = {
flag = ImGui:isItemFocused()
{
flag = ImGui:isItemClicked(mouse_button)
0x2590,0x2593, -- range1
flag = ImGui:isItemVisible()
0x2660,0x266B  -- range2
flag = ImGui:isItemEdited()
-- ...
flag = ImGui:isItemActivated()
},
flag = ImGui:isItemDeactivated()
ImGui.GlyphRanges_Cyrillic,
flag = ImGui:isItemDeactivatedAfterEdit()
{
flag = ImGui:isItemToggledOpen()
0x01C0, 0x01C3 -- range3
flag = ImGui:isAnyItemHovered()
},
flag = ImGui:isAnyItemActive()
ImGui.GlyphRanges_Korean
flag = ImGui:isAnyItemFocused()
},
minX, minY, maxX, maxY = ImGui:getItemRect()
x, y = ImGui:getItemRectMin()
-- same structure:
x, y = ImGui:getItemRectMax()
ranges = {
w, h = ImGui:getItemRectSize()
{
ImGui:setItemAllowOverlap()
0x2590,0x2593, -- range1
0x2660,0x266B, -- range2
0x01C0,0x01C3  -- range3
-- ...
},  
ImGui.GlyphRanges_Cyrillic,
ImGui.GlyphRanges_Korean
}
},
mergeMode = true, -- merge into previous font
})
fonts:build()
</syntaxhighlight>
</syntaxhighlight>


== Miscellaneous Utilities ==
'''Icons example''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
flag = ImGui:isRectVisible(w, h [, max_x, max_y])
local icon = utf8.char(0x2590)
number = ImGui:getTime()
ImGui:text("My icon >>" .. icon .. " << !!!")
number = ImGui:getFrameCount()
str = ImGui:getStyleColorName(idx)
flag = ImGui:beginChildFrame(id, w, h [, ImGui.WindowFlags = 0]) -- id (number)
ImGui:endChildFrame()
</syntaxhighlight>


== Text Utilities ==
-- or with new Luau support:
<syntaxhighlight lang="lua">
ImGui:text("My icon >> \u{2590} << !!!")
w, h = ImGui:calcTextSize(text [, hide_text_after_double_hash = false, wrap_width = -1])
-- can be also stored in memory:
local icon = "\u{2590}"
</syntaxhighlight>
</syntaxhighlight>


== Inputs Utilities: Keyboard ==
=== Font ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string = ImGui:getKeyName(keyCode)
number = Font:getSize()
flag = ImGui:isKeyDown(keyCode)
FontAtlas = Font:getContainerAtlas()
flag = ImGui:isKeyPressed(keyCode [, repeat = true])
Font:setScale(number)
flag = ImGui:isKeyReleased(keyCode)
number = Font:getScale()
number = ImGui:getKeyPressedAmount(keyCode, repeat_delay, rate)
number = Font:getAscent()
ImGui:setNextFrameWantCaptureKeyboard([want_capture_keyboard_value = true])
number = Font:getDescent()
bool = Font:isLoaded()
string = Font:getDebugName()
w, h = Font:calcTextSizeA(size, max_width, wrap_width, string)
Font:calcWordWrapPositionA(scale, string, wrap_width) -- not tested
</syntaxhighlight>
</syntaxhighlight>


== Shortcut system ==
== Tables ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- (keyChord: an ImGuiKey optionally OR-ed with one or more ImGuiMod_XXX values (ImGuiKey | ImGuiMod_XXX))
flag = ImGui:beginTable(str_id, column [, ImGui.TableFlags = 0, outer_w = 0, outer_h = 0, inner_width = 0])
ImGui:shortcut(keyChord [, owner_id = 0, ImGui.InputFlags = 0])
ImGui:endTable()
ImGui:tableNextRow([ImGui.TableRowFlags = 0, min_row_height = 0])
flag = ImGui:tableNextColumn()
flag = ImGui:tableSetColumnIndex(column_n)
ImGui:tableSetupColumn(label [, ImGui.TableColumnFlags = 0, init_width_or_weight = 0, user_id = 0])
ImGui:tableSetupScrollFreeze(cols, rows)
ImGui:tableHeadersRow()
TableSortSpecs = ImGui:tableGetSortSpecs() -- see below
number = ImGui:tableGetColumnCount()
number = ImGui:tableGetColumnIndex()
number = ImGui:tableGetRowIndex()
string = ImGui:tableGetColumnName([column_n = -1])
ImGuiTableColumnFlags = ImGui:tableGetColumnFlags([column_n = -1])
ImGui:tableSetBgColor(ImGui.TableBgTarget, color [, alpha = 1, column_n = -1])
</syntaxhighlight>


-- (useful to disable CTRL + TAB combo: ImGui:setShortcutRouting(ImGui.Mod_Ctrl | ImGui.Key_Tab, ImGui.KeyOwner_None))
=== Table sort specs ===
ImGui:setShortcutRouting(keyChord [, owner_id = 0, ImGui.InputFlags = 0])
<syntaxhighlight lang="lua">
 
number = TableSortSpecs:getSpecsCount() -- TableSortSpecs = ImGui:tableGetSortSpecs()
ImGui:setItemKeyOwner(keyCode [, ImGui.InputFlags = 0])
flag = TableSortSpecs:isSpecsDirty() -- TableSortSpecs = ImGui:tableGetSortSpecs()
 
TableSortSpecs:setSpecsDirty(flag) -- TableSortSpecs = ImGui:tableGetSortSpecs()
ImGui:setKeyOwner(keyCode, owner_id, [, ImGui.InputFlags = 0])
table = TableSortSpecs:getColumnSortSpecs() -- TableSortSpecs = ImGui:tableGetSortSpecs(), see below
</syntaxhighlight>
</syntaxhighlight>


== Inputs Utilities: Mouse ==
=== Table column sort specs ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- "mouse_button" is any gideros mouse button code
-- table = TableSortSpecs:getColumnSortSpecs()
flag = ImGui:isMouseDown(mouse_button)
-- each value of this table is an object that have these functions:
flag = ImGui:isMouseClicked(mouse_button [, repeat = false])
number = item:getColumnUserID()  
flag = ImGui:isMouseReleased(mouse_button)
number = item:getColumnIndex() -- 0 based
flag = ImGui:isMouseDoubleClicked(mouse_button)
number = item:getSortOrder() -- used in multi sorted tables
flag = ImGui:isMouseHoveringRect(min_x, min_y, max_x, max_y [, clip = true])
number = item:getSortDirection() -- ImGui.SortDirection_Ascending OR ImGui.SortDirection_Descending
flag = ImGui:isMousePosValid([x = inf, y = inf])
flag = ImGui:isAnyMouseDown()
x, y = ImGui:getMousePos()
x, y = ImGui:getMousePosOnOpeningCurrentPopup()
flag = ImGui:isMouseDragging(mouse_button [, lock_threshold = -1])
x, y = ImGui:getMouseDragDelta(mouse_button [, lock_threshold = -1])
ImGui:resetMouseDragDelta(mouse_button)
ImGuiMouseCursor = ImGui:getMouseCursor()
ImGui:setMouseCursor(ImGui.MouseCursor)
ImGui:setNextFrameWantCaptureMouse([want_capture_mouse_value = true])
ImGui:setNextFrameWantCaptureKeyboard([want_capture_keyboard_value = true])
ImGui:updateCursor()
</syntaxhighlight>
</syntaxhighlight>
Example: https://github.com/MultiPain/Gideros_examples/blob/master/ImGuiTablesDemo/assets/TablesDemo.lua</br>


== Render ==
== ImGuiTextFilter ==
Try to avoid creating new instaces in "enterFrame" event.
 
'''Constructor''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:newFrame(deltaTime)
filter = ImGuiTextFilter.new()
ImGui:render()
ImGui:endFrame()
</syntaxhighlight>
</syntaxhighlight>


== Demos ==
'''Methods''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
is_openFlag = ImGui:showUserGuide()
-- draws the input field
is_openFlag = ImGui:showDemoWindow([p_open])
isValueChanged = filter:draw(label [, width = 0])
is_openFlag = ImGui:showAboutWindow([p_open])
-- draws the input field (using ImGui:inutTextWithHint())
is_openFlag = ImGui:showStyleEditor()
isValueChanged = filter:drawWithHint(label, hint [, width = 0])
is_openFlag = ImGui:showFontSelector()
 
is_openFlag = ImGui:showMetricsWindow([p_open])
filter:setBuffer(text) -- set filter text
is_openFlag = ImGui:showStyleSelector(label)
filter:build() -- update filter internals (see example below)
is_openFlag = ImGui:ShowStackToolWindow([p_open])
bool = filter:passFilter(text) -- returns true if filter input matches with "text"
ImGui:showLuaStyleEditor()
</syntaxhighlight>
</syntaxhighlight>
 
 
'''Usage example 1''':
== TextEditor ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
require "ImGui"
-- otherTextEditor: another "ImGuiTextEditor" instance to copy setting  
 
TextEditor = ImGuiTextEditor.new([other_text_editor])
local imgui = ImGui.new()
</syntaxhighlight>
stage:addChild(imgui)
 
 
'''Functions''':
local filter = ImGuiTextFilter.new()
<syntaxhighlight lang="lua">
local items = { "aaa1.c", "bbb1.c", "ccc1.c", "aaa2.cpp", "bbb2.cpp", "ccc2.cpp", "abc.h", "hello, world" }
LanguageDefinition = TextEditor:getLanguageCPP()
 
LanguageDefinition = TextEditor:getLanguageGLSL()
function onEnterFrame(e)
LanguageDefinition = TextEditor:getLanguageHLSL()
imgui:newFrame(e.deltaTime)
LanguageDefinition = TextEditor:getLanguageC()
 
LanguageDefinition = TextEditor:getLanguageSQL()
if (imgui:beginWindow("Filter demo")) then
LanguageDefinition = TextEditor:getLanguageAngelScript()
imgui:text([[
LanguageDefinition = TextEditor:getLanguageLua()
Filter usage:
 
""        display all lines
TextEditor:setLanguageDefinition(LanguageDefinition)
"xxx"      display lines containing "xxx"
LanguageDefinition = TextEditor:getLanguageDefinition()
"xxx,yyy"  display lines containing "xxx" or "yyy"
 
"-xxx"    hide lines containing "xxx"
Palette = TextEditor:getPaletteDark()
]])
Palette = TextEditor:getPaletteLight()
 
Palette = TextEditor:getPaletteRetro()
filter:draw("Filter")
 
 
TextEditor:setPalette(Palette)
for i, text in ipairs(items) do
Palette = TextEditor:getPalette()
if filter:passFilter(text) then
 
imgui:bulletText(text)
TextEditor:setPaletteColor(TE_ColorIndex, color [, alpha = 1]) -- see TextEditor enums below
end
color, alpha = TextEditor:getPaletteColor(TE_ColorIndex)
end
 
end
TextEditor:loadPalette(table) -- 42 elements table
imgui:endWindow()
-- example:
 
--[[ dark palete:
imgui:endFrame()
TextEditor:loadPalette{
imgui:render()
0x7f7f7f, 1, -- Default
end
 
stage:addEventListener("enterFrame", onEnterFrame)
</syntaxhighlight>
 
'''Usage example 2''':
<syntaxhighlight lang="lua">
require "ImGui"
 
local imgui = ImGui.new()
stage:addChild(imgui)
 
local filter = ImGuiTextFilter.new()
local searchText = ""
local items = { "aaa1.c", "bbb1.c", "ccc1.c", "aaa2.cpp", "bbb2.cpp", "ccc2.cpp", "abc.h", "hello, world" }
 
function onEnterFrame(e)
imgui:newFrame(e.deltaTime)
 
-- draw standart text input control
-- filter:drawWithHint("Filter", "Search")
-- draw custom control
local ischanged = false
searchText, ischanged = imgui:inputText("Filter", searchText, 256, ImGui.InputTextFlags_EnterReturnsTrue)
if ischanged then
filter:setBuffer(searchText)
-- try to avoid calling "build" function every frame
filter:build()
end
 
for i, item in ipairs(items) do
if not filter:passFilter(item) then
continue
end
imgui:bulletText(item)
end
 
imgui:endFrame()
imgui:render()
end
 
stage:addEventListener("enterFrame", onEnterFrame)
</syntaxhighlight>
 
== TextEditor ==
<syntaxhighlight lang="lua">
-- otherTextEditor: another "ImGuiTextEditor" instance to copy setting
TextEditor = ImGuiTextEditor.new([other_text_editor])
</syntaxhighlight>
 
'''Functions''':
<syntaxhighlight lang="lua">
LanguageDefinition = TextEditor:getLanguageCPP()
LanguageDefinition = TextEditor:getLanguageGLSL()
LanguageDefinition = TextEditor:getLanguageHLSL()
LanguageDefinition = TextEditor:getLanguageC()
LanguageDefinition = TextEditor:getLanguageSQL()
LanguageDefinition = TextEditor:getLanguageAngelScript()
LanguageDefinition = TextEditor:getLanguageLua()
 
TextEditor:setLanguageDefinition(LanguageDefinition)
LanguageDefinition = TextEditor:getLanguageDefinition()
 
Palette = TextEditor:getPaletteDark()
Palette = TextEditor:getPaletteLight()
Palette = TextEditor:getPaletteRetro()
 
TextEditor:setPalette(Palette)
Palette = TextEditor:getPalette()
 
TextEditor:setPaletteColor(TE_ColorIndex, color [, alpha = 1]) -- see TextEditor enums below
color, alpha = TextEditor:getPaletteColor(TE_ColorIndex)
 
TextEditor:loadPalette(table) -- 42 elements table
-- example:
--[[ dark palete:
TextEditor:loadPalette{
0x7f7f7f, 1, -- Default
0xd69c56, 1, -- Keyword
0xd69c56, 1, -- Keyword
0x00ff00, 1, -- Number
0x00ff00, 1, -- Number
Line 1,784: Line 1,932:


== DRAW LISTS ==
== DRAW LISTS ==
 
'''Window draw list''':
=== Window draw list ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local list = ImGui:getWindowDrawList()
local list = ImGui:getWindowDrawList()
Line 1,970: Line 2,117:


stage:addEventListener("enterFrame", onEnterFrame)
stage:addEventListener("enterFrame", onEnterFrame)
</syntaxhighlight>
== EXPERIMENTAL ==
<syntaxhighlight lang="lua">
p_open = ImGui:showLog(title, p_open [, ImGui.WindowFlags = 0]) -- draw log window
ImGui:writeLog(text)
</syntaxhighlight>
Gestures (touch only, turned OFF by default) ''WIP'':
* tap gesture (Left Mouse Button)
* hold gesture (Right Mouse Button)
<syntaxhighlight lang="lua">
ImGui:setTouchGesturesEnabled(bool)
bool = ImGui:isTouchGesturesEnabled()
</syntaxhighlight>
</syntaxhighlight>



Latest revision as of 03:19, 27 October 2026

Dear ImGui LUA binding for Gideros Mobile

GitHub https://github.com/MultiPain/Gideros_ImGui

Constructor

-- font_atlas: copy fonts
-- mouse_listeners: adds internal mouse event listeners
-- keyboard_listeners: adds internal keyboard event listeners
-- touch_listeners: adds internal touch event listeners
ImGui.new([font_atlas = nil, mouse_listeners = true, keyboard_listeners = true, touch_listeners = false])

IO Functions

GetIO() access the IO structure (mouse/keyboard/gamepad inputs, time, various configuration options/flags)

local IO = ImGui:getIO()

Functions:

Settings/.Ini Utilities
* The disk functions are automatically called if io.IniFilename != NULL (default is "imgui.ini").
* Set io.IniFilename to NULL to load/save manually. Read io.WantSaveIniSettings description about handling .ini saving manually.
IO:setFontDefault(font)
ImGuiConfigFlag = IO:getConfigFlags()
IO:setConfigFlags(ImGui.ConfigFlag)
IO:addConfigFlags(ImGui.ConfigFlag)
ImGuiBackendFlag = IO:getBackendFlags()
IO:setBackendFlags(ImGui.BackendFlag)
number = IO:getIniSavingRate()
IO:setIniSavingRate(number)
string = IO:getIniFilename()
IO:setIniFilename(string)
IO:saveIniSettings([path]) -- if path is not defined the it uses default path, which is set by IO:setIniFilename()
IO:loadIniSettings([path])
string = IO:getLogFilename()
IO:setLogFilename(string)
number = IO:getMouseDoubleClickTime()
IO:setMouseDoubleClickTime(number)
number = IO:getMouseDragThreshold()
IO:setMouseDragThreshold(number)
flag = IO:getMouseDrawCursor()
IO:setMouseDrawCursor(flag)
number = IO:getMouseDoubleClickMaxDist()
IO:setMouseDoubleClickMaxDist(number)
number = IO:getKeyRepeatDelay()
IO:setKeyRepeatDelay(number)
number = IO:getKeyRepeatRate()
IO:setKeyRepeatRate(number)
number = IO:getFontGlobalScale()
IO:setFontGlobalScale(number)
bool = IO:getFontAllowUserScaling()
IO:setFontAllowUserScaling(bool)
number, number = IO:getDisplayFramebufferScale()
IO:setDisplayFramebufferScale(number, number)
bool = IO:getConfigMacOSXBehaviors()
IO:setConfigMacOSXBehaviors(bool)
bool = IO:getConfigInputTextCursorBlink()
IO:setConfigInputTextCursorBlink(bool)
bool = IO:getConfigWindowsResizeFromEdges()
IO:setConfigWindowsResizeFromEdges(bool)
bool = IO:getConfigWindowsMoveFromTitleBarOnly()
IO:setConfigWindowsMoveFromTitleBarOnly(bool)
number = IO:getConfigWindowsMemoryCompactTimer()
IO:setConfigWindowsMemoryCompactTimer(number)
string = IO:getBackendPlatformName()
string = IO:getBackendRendererName()
bool = IO:IsMouseDown(button)
number = IO:getMouseWheel()
number = IO:getMouseWheelH()
flag = IO:wantCaptureMouse()
flag = IO:wantCaptureKeyboard()
flag = IO:wantTextInput()
flag = IO:wantSetMousePos()
flag = IO:wantSaveIniSettings()
number = IO:getFramerate()
number = IO:getMetricsRenderVertices()
number = IO:getMetricsRenderIndices()
number = IO:getMetricsRenderWindows()
number = IO:getMetricsActiveWindows()
number = IO:getMetricsActiveAllocations()
x, y = IO:getMouseDelta()
number = IO:getMouseDownSec(mouse_button)
IO:setDisplaySize(w, h)
w, h = IO:getDisplaySize()
number = IO:getDeltaTime()
-- reset mouse buttons state
IO:resetMouseDown()
-- reset key states (including ALT/SHIFT/CTRL/SUPER (META))
IO:resetKeysDown()
-- set ALT/SHIFT/CTRL/SUPER (META) key state
IO:setModKeyDown(key_code, bool) -- "key_code" is a gideros MOD key
-- set any key state
IO:setKeysDown(key_code, bool) -- "key_code" is a gideros regular "keyCode"
-- adds text to active text input widget
IO:addInputCharactersUTF8(text)
-- emulate wheel scrolling
IO:setMouseWheel(number)
-- sets mouse position (data only, no visual changes)
IO:setMousePos(x, y)
-- set mouse state, where index: 0 - left mouse, 1 - right, 2 - middle, 3 - unused, 4 - unused.
IO:setMouseDown(mouse_button, state) -- "mouse_button" is a gideros mouse button code

-- "key" is any ImGui KeyCode (check [here](#keyboard-keys))
-- "down" is a boolean
IO:addKeyEvent(key, down)
IO:addKeyAnalogEvent(key, down, number)
IO:AddMousePosEvent(x, y)
-- "button" is any ImGui button (check [here](#MouseButton))
IO:addMouseButtonEvent(button, down)
IO:addMouseWheelEvent(x, y)

IO:setAppAcceptingEvents([accepting_events = true])

Style setters/getters

GetStyle() instance access the Style structure (colors, sizes). Always use PushStyleCol(), PushStyleVar() to modify style mid-frame!

local Style = ImGui:getStyle()

Setters/getters:

Style:setColor(ImGui.Col, color, alpha)
color, alpha = Style:getColor(ImGui.Col)
Style:setAlpha(value)
value = Style:getAlpha()

Style:setWindowRounding(value)
value = Style:getWindowRounding()
Style:setWindowBorderSize(value)
value = Style:getWindowBorderSize()
Style:setChildRounding(value)
value = Style:getChildRounding()
Style:setChildBorderSize(value)
value = Style:getChildBorderSize()
Style:setPopupRounding(value)
value = Style:getPopupRounding()
Style:setPopupBorderSize(value)
value = Style:getPopupBorderSize()
Style:setFrameRounding(value)
value = Style:getFrameRounding()
Style:setFrameBorderSize(value)
value = Style:getFrameBorderSize()
Style:setIndentSpacing(value)
value = Style:getIndentSpacing()
Style:setColumnsMinSpacing(value)
value = Style:getColumnsMinSpacing()
Style:setScrollbarSize(value)
value = Style:getScrollbarSize()
Style:setScrollbarRounding(value)
value = Style:getScrollbarRounding()
Style:setGrabMinSize(value)
value = Style:getGrabMinSize()
Style:setGrabRounding(value)
value = Style:getGrabRounding()
Style:setLogSliderDeadzone(value)
value = Style:getLogSliderDeadzone()
Style:setTabRounding(value)
value = Style:getTabRounding()
Style:setTabBorderSize(value)
value = Style:getTabBorderSize()
Style:setTabMinWidthForCloseButton(value)
value = Style:getTabMinWidthForCloseButton()
Style:setMouseCursorScale(value)
value = Style:getMouseCursorScale()
Style:setCurveTessellationTol(value)
value = Style:getCurveTessellationTol()
Style:setCircleSegmentMaxError(value)
value = Style:getCircleSegmentMaxError()
Style:setWindowPadding(x, y)
x, y = Style:getWindowPadding()
Style:setWindowMinSize(x, y)
x, y = Style:getWindowMinSize()
Style:setWindowTitleAlign(x, y)
x, y = Style:getWindowTitleAlign()
Style:setFramePadding(x, y)
x, y = Style:getFramePadding()
Style:setCellPadding(x, y)
x, y = Style:getCellPadding()
Style:setItemSpacing(x, y)
x, y = Style:getItemSpacing()
Style:setItemInnerSpacing(x, y)
x, y = Style:getItemInnerSpacing()
Style:setTouchExtraPadding(x, y)
x, y = Style:getTouchExtraPadding()
Style:setButtonTextAlign(x, y)
x, y = Style:getButtonTextAlign()
Style:setSelectableTextAlign(x, y)
x, y = Style:getSelectableTextAlign()
Style:setDisplayWindowPadding(x, y)
x, y = Style:getDisplayWindowPadding()
Style:setDisplaySafeAreaPadding(x, y)
x, y = Style:getDisplaySafeAreaPadding()
Style:setWindowMenuButtonPosition(ImGui.Dir)
dir = Style:getWindowMenuButtonPosition()
Style:setColorButtonPosition(ImGui.Dir)
dir = Style:getColorButtonPosition()
Style:setAntiAliasedLines(flag)
flag = Style:getAntiAliasedLines()
Style:setAntiAliasedLinesUseTex(flag)
flag = Style:getAntiAliasedLinesUseTex()
Style:setAntiAliasedFill(flag)
flag = Style:getAntiAliasedFill()
Style:setDisabledAlpha(number)
alpha = Style:getDisabledAlpha()
Style:setSeparatorTextBorderSize(number)
number = Style:getSeparatorTextBorderSize()
Style:setSeparatorTextAlign(x, y)
x, y = Style:getSeparatorTextAlign()
Style:setSeparatorTextPadding(x, y)
x, y = Style:getSeparatorTextPadding()

DEFAULT STYLES

ImGui:setDarkStyle()
ImGui:setLightStyle()
ImGui:setClassicStyle()

Render

NewFrame() start a new Dear ImGui frame, you can submit any command from this point until Render()/EndFrame().

EndFrame() ends the Dear ImGui frame. Automatically called by Render(). If you don't need to render data (skipping rendering) you may call EndFrame() without Render()... but you'll have wasted CPU already! If you don't need to render, better to not create any windows and not call NewFrame() at all!

Render() ends the Dear ImGui frame, finalize the draw data.

ImGui:newFrame(deltaTime)
ImGui:render()
ImGui:endFrame()

Demos

is_openFlag = ImGui:showUserGuide()
is_openFlag = ImGui:showDemoWindow([p_open])
is_openFlag = ImGui:showAboutWindow([p_open])
is_openFlag = ImGui:showStyleEditor()
is_openFlag = ImGui:showFontSelector()
is_openFlag = ImGui:showMetricsWindow([p_open])
is_openFlag = ImGui:showStyleSelector(label)
is_openFlag = ImGui:ShowStackToolWindow([p_open])
ImGui:showLuaStyleEditor()

Windows

  • Begin() = push window to the stack and start appending to it. End() = pop window from the stack.
  • You may append multiple times to the same window during the same frame.
  • Passing bool* p_open != NULL shows a window-closing widget in the upper-right corner of the window, which clicking will set the boolean to false when clicked.
  • Begin() return false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window. Always call a matching End() for each Begin() call, regardless of its return value! [Important: due to legacy reason, this is inconsistent with most other functions such as BeginMenu / EndMenu, BeginPopup / EndPopup, etc. where the EndXXX call should only be called if the corresponding BeginXXX function returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]
  • Note that the bottom of window stack always contains a window called "Debug".
p_open, draw = ImGui:beginWindow(label, p_open [, ImGui.WindowFlags = 0])
-- do not show "X" button
draw = ImGui:beginWindow(label, nil [, ImGui.WindowFlags = 0])
-- start a window with no borders, no paddings, no rounding and ImGui.WindowFlags_Fullscreen flag
p_open, draw = ImGui:beginFullScreenWindow(label, p_open [, ImGui.WindowFlags = 0]) 
-- do not show "X" button
draw = ImGui:beginFullScreenWindow(label, nil [, ImGui.WindowFlags = 0]) 
ImGui:endWindow()

Child Windows

Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window. Child windows can embed their own child. For each independent axis of size:

  • == 0.0f -> use remaining host window size
  • > 0.0f -> fixed size
  • < 0.0f -> use remaining window size minus abs(size) Each axis can use a different mode, e.g. ImVec2(0,400). BeginChild() returns false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window.
Tip
Always call a matching EndChild() for each BeginChild() call, regardless of its return value [as with Begin: this is due to legacy reason and inconsistent with most BeginXXX functions apart from the regular Begin() which behaves like BeginChild().]
ImGui:beginChild(id [, w = 0, h = 0, borderFlag = false, ImGui.WindowFlags = 0])
ImGui:endChild()

Windows Utilities

  • Current window = the window we are appending into while inside a Begin() / End() block.
  • Next window = next window we will Begin() into.
  • Prefer using SetNextXXX functions (before Begin) rather than SetXXX functions (after Begin()).
flag = ImGui:isWindowAppearing()
flag = ImGui:isWindowCollapsed()
flag = ImGui:isWindowFocused([ImGui.FocusedFlags = 0])
flag = ImGui:isWindowHovered([ImGui.HoveredFlags = 0])
x, y = ImGui:getWindowPos()
w, h = ImGui:getWindowSize()
w = ImGui:getWindowWidth()
h = ImGui:getWindowHeight()
x1,y1, x2,y2 = ImGui:getWindowBounds() -- returns window region rectangle in global coordinates

ImGui:setNextWindowPos(x, y [, ImGui.Cond = 0, pivotX = 0, pivotY = 0])
ImGui:setNextWindowSize(w, h [, ImGui.Cond = 0])
ImGui:setNextWindowContentSize(w, h)
ImGui:setNextWindowCollapsed(flag [, ImGui.Cond = 0])
ImGui:setNextWindowFocus()
ImGui:setNextWindowBgAlpha(alpha)
ImGui:setNextWindowScroll(x, y)
ImGui:setWindowPos(name, x, y [, ImGui.Cond = 0]) OR ImGui:setWindowPos(x, y [, ImGui.Cond = 0])
ImGui:setWindowSize(name, w, h [, ImGui.Cond = 0]) OR ImGui:setWindowSize(w, h [, ImGui.Cond = 0])
ImGui:setWindowCollapsed(name, flag [, ImGui.Cond = 0]) OR ImGui:setWindowCollapsed(flag [, ImGui.Cond = 0])
ImGui:setWindowFocus(name) OR ImGui:setWindowFocus()
ImGui:setWindowFontScale(scale)
-- scroll window when touching void
ImGui:scrollWhenDragging(x, y)
☠️Note: because Dear ImGui is an Immediate Mode GUI framework, functions that fetch window properties (like scrolling, window sizes, or content regions) internally query the "current window" pointer. If ImGui:begin() hasn't been called yet, or if ImGui:end() was already called, that pointer is NULL, causing a fatal segmentation fault/crash

Window size constraints

Can be used to set minimum and maximum window size, plus contraint the size if needed.

-- call this function before ImGui:beginWindow()
ImGui:setNextWindowSizeConstraints(min_w, min_h, max_w, max_h [, resize_callback, user_data]))
-- resizeCallback is a function:
function (callbackData [, user_data])
	-- do some math, and return desired size
	-- ...
	return desired_width, desired_height
end

Resize callback:

-- get window position
x, y = callbackData:getPos()
x = callbackData:getX()
y = callbackData:getY()

-- get currrent size
current_width, current_height = callbackData:getCurrentSize()
current_width = callbackData:getCurrentWidth()
current_height = callbackData:getCurrentHeight()

-- get desired size
desired_width, desired_height = callbackData:getDesiredSize()
desired_width = callbackData:getDesiredWidth()
desired_height = callbackData:getDesiredHeight()

Example:

require "ImGui"

local function stepSize(callback_data, step)
	local w, h = callback_data:getDesiredSize()
	w = (w // step) * step
	h = (h // step) * step
	return w, h
end

local ui = ImGui.new()
stage:addChild(ui)

stage:addEventListener("enterFrame", function(e)
	ui:newFrame(e.deltaTime)
	
	-- window size step is 32 (last argument, that is passed to the callback as second argument)
	ui:setNextWindowSizeConstraints(200, 200, 400, 400, stepSize, 32)
	if (ui:beginWindow("My window")) then 
		
		ui:textWrapped("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.")
	end
	ui:endWindow()
	
	ui:showDemoWindow()
	
	ui:render()
	ui:endFrame()
end)

Content region

  • Those functions are bound to be redesigned soon (they are confusing, incomplete and return values in local window coordinates which increases confusion)
scaleX, scaleY = ImGui:getContentRegionMax()
w, h = ImGui:getContentRegionAvail()
x, y = ImGui:getWindowContentRegionMin()
x, y = ImGui:getWindowContentRegionMax()
☠️Note: because Dear ImGui is an Immediate Mode GUI framework, functions that fetch window properties (like scrolling, window sizes, or content regions) internally query the "current window" pointer. If ImGui:begin() hasn't been called yet, or if ImGui:end() was already called, that pointer is NULL, causing a fatal segmentation fault/crash

Windows Scrolling

x = ImGui:getScrollX()
y = ImGui:getScrollY()
maxX = ImGui:getScrollMaxX()
maxY = ImGui:getScrollMaxY()
ImGui:setScrollX(value)
ImGui:setScrollY(value)
ImGui:setScrollHereX([ratio = 0.5])
ImGui:setScrollHereY([ratio = 0.5])
ImGui:setScrollFromPosX(x [, ratio = 0.5])
ImGui:setScrollFromPosY(y [, ratio = 0.5])
☠️Note: because Dear ImGui is an Immediate Mode GUI framework, functions that fetch window properties (like scrolling, window sizes, or content regions) internally query the "current window" pointer. If ImGui:begin() hasn't been called yet, or if ImGui:end() was already called, that pointer is NULL, causing a fatal segmentation fault/crash

Example

self.doresetscrollbar = false
...
self.doresetscrollbar = true

function Level1:onEnterFrame(e)
	self.imgui:newFrame(e.deltaTime)
	self.imgui:beginWindow("window") -- #1
	if self.doresetscrollbar then
		self.doresetscrollbar = false
		self.imgui:setScrollY(0)
	end
...
	self.imgui:endWindow() -- #1
	self.imgui:endFrame()
	self.imgui:render()
end

Parameters stacks (shared)

ImGui:pushStyleColor(ImGui.Col, color, alpha) -- https://wiki.gideros.rocks/index.php/Dear_ImGui_Flags#Col
ImGui:popStyleColor([count = 1])
ImGui:pushStyleVar(ImGui.StyleVar, value) OR ImGui:pushStyleVar(ImGui.StyleVar, value1, value2)
ImGui:popStyleVar([count = 1])
color, alpha = ImGui:getStyleColor(ImGui.Col)
fontSize = ImGui:getFontSize()

Parameters stacks (current window)

ImGui:pushItemWidth(w)
ImGui:popItemWidth()
ImGui:setNextItemWidth(w)
w = ImGui:calcItemWidth()
ImGui:pushTextWrapPos([localX = 0])
ImGui:popTextWrapPos()
ImGui:pushTabStop(flag)
ImGui:popTabStop()
ImGui:pushButtonRepeat(flag)
ImGui:popButtonRepeat()

Cursor / Layout

  • By "cursor" we mean the current output position.
  • The typical widget behavior is to output themselves at the current cursor position, then move the cursor one line down.
  • You can call SameLine() between widgets to undo the last carriage return and output at the right of the preceeding widget.
  • Attention! We currently have inconsistencies between window-local and absolute positions we will aim to fix with future API:
    • Window-local coordinates: SameLine(), GetCursorPos(), SetCursorPos(), GetCursorStartPos(), GetContentRegionMax(), GetWindowContentRegion*(), PushTextWrapPos()
    • Absolute coordinate: GetCursorScreenPos(), SetCursorScreenPos(), all ImDrawList:: functions
ImGui:separator()
ImGui:sameLine([offset_x = 0, spacing = -1])
ImGui:newLine()
ImGui:spacing()
ImGui:dummy(w, h)
ImGui:indent([indent = 0])
ImGui:unindent([indent = 0])
ImGui:beginGroup()
ImGui:endGroup()
 
x, y = ImGui:getCursorPos()
x = ImGui:getCursorPosX()
y = ImGui:getCursorPosY()
ImGui:setCursorPos(local_x, local_y)
ImGui:setCursorPosX(local_x)
ImGui:setCursorPosY(local_y)
x, y = ImGui:getCursorStartPos()
x, y = ImGui:getCursorScreenPos()
ImGui:setCursorScreenPos(x, y)
ImGui:alignTextToFramePadding()
lineH = ImGui:getTextLineHeight()
lineH = ImGui:getTextLineHeightWithSpacing()
frameH = ImGui:getFrameHeight()
frameH = ImGui:getFrameHeightWithSpacing()

ID stack/scopes

  • Read the FAQ for more details about how ID are handled in Dear Imgui. If you are creating widgets in a loop you most likely want to push a unique identifier (e.g. object pointer, loop index) to uniquely differentiate them.
  • The resulting ID are hashes of the entire stack.
  • You can also use the "Label##foobar" syntax within widget label to distinguish them from each others.
  • In this header file we use the "label"/"name" terminology to denote a string that will be displayed and used as an ID, whereas "str_id" denote a string that is only used as an ID and not normally displayed.
ImGui:pushID(anyValue) 
ImGui:pushID(str)
ImGui:popID()
number = ImGui:getID(anyValue)
number = ImGui:getID(str)
number = ImGui:getItemID()

WIDGETS

Widgets: Text

ImGui:textUnformatted(text [, textEnd])
ImGui:text(text)
ImGui:textColored(text, color, alpha)
ImGui:textDisabled(text)
ImGui:textWrapped(text)
ImGui:labelText(text, label)
ImGui:bulletText(text)
ImGui:separatorText(label)

Widgets: Main

flag = ImGui:button(text [, w = 0, h = 0])
flag = ImGui:smallButton(text)
flag = ImGui:invisibleButton(string_ID [, w = 0, h = 0])
flag = ImGui:arrowButton(string_ID [, ImGui.Dir = 0])
flag = ImGui:checkbox(text, flag)
flags, is_changed = ImGui:checkboxFlags(label [, flags = 0, flags_value = 0])
number, is_changed = ImGui:radioButton(text, number, number)
is_changed = ImGui:radioButton(text, flag)
ImGui:progressBar(fraction [, anchor_x = -1, anchor_y = 0, overlay_string = nil])
ImGui:bullet()

Widgets: Images

-- Images are streched (ImGui default functions)
ImGui:image(texture, w, h
	[, tint_color = 0xffffff, tint_alpha = 1,
	border_color = 0xffffff, border_alpha = 0])

ImGui:imageUV(texture,
	w, h,
	uv0x, uv0y,
	uv1x, uv1y,
	[, tint_color = 0xffffff, tint_alpha = 1, border_color = 0xffffff, border_alpha = 0])

pressFlag = ImGui:imageButton(str_id, texture, w, h
	[, tint_color = 0xffffff, tint_alpha = 1,
	border_color = 0xffffff, border_alpha = 0])

pressFlag = ImGui:imageButtonUV(str_id, texture, w, h,
	uv0x, uv0y, uv1x, uv1y
	[, tint_color = 0xffffff, tint_alpha = 1,
	border_color = 0xffffff, border_alpha = 0])

-- Images are scaled (extended by @MultiPain)
-- padding deprecated
-- (use "ImGui:pushStyleVar(ImGui.StyleVar_FramePadding, x, y)/ImGui:popStyleVar()")
ImGui:scaledImage(str_id, texture, w, h
	[, fit_mode = ImGui.ImageScaleMode_LetterBox, keep_size = false,
	anchor_x = 0.5, anchor_y = 0.5,
	tint_col = 0xffffff, tint_alpha = 1,
	border_col = 0, border_alpha = 0,
	bg_col = 0, bg_alpha = 0])

pressFlag = ImGui:scaledImageButton(str_id, texture, w, h
	[, fit_mode = ImGui.ImageScaleMode_LetterBox, keep_size = false,
	ImGui.ButtonFlags = 0, anchor_x = 0.5, anchor_y = 0.5,
	clip_offset_x = 0, clip_offset_y = 0,
	tint_col = 0xffffff, tint_alpha = 1,
	border_col = 0, border_alpha = 0,
	bg_col = 0, bg_alpha = 0])

pressFlag = ImGui:scaledImageButtonWithText(texture, label, image_w, image_h
	[, button_w = 0, button_h = 0, ImGui.ButtonFlags = 0,
	fit_mode = ImGui.ImageScaleMode_LetterBox, keep_size = false,
	anchor_x = 0.5, anchor_y = 0.5, image_side = ImGui.Dir_Left,
	clip_offset_x = 0, clip_offset_y = 0,
	tint_col = 0xffffff, tint_alpha = 1,
	border_col = 0, border_alpha = 0,
	bg_col = 0, bg_alpha = 0])

Widgets: Combo Box

openFlag = ImGui:beginCombo(text, preview_text [, ImGui.ComboFlags = 0])
ImGui:endCombo()
current_item, is_open = ImGui:combo(label, current_item, items) -- items (table): {"item1", "item2", ...}

Widgets: Drags

value, is_changed = ImGui:dragFloat(label, value
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value1, value2, is_changed = ImGui:dragFloat2(label, value1, value2
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value1, value2, value3, is_changed = ImGui:dragFloat3(label, value1, value2, value3
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value1, value2, value3, value4, is_changed = ImGui:dragFloat4(label, value1, value2, value3, value4
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value_min, value_max, is_changed = ImGui:dragFloatRange2(label, value_min, value_max
	[, inc_step = 1, min = 0, max = 0,
	format_min_string = "%.3f", ImGui.SliderFlags = 0])
-- table must be an array of any size > 0
is_changed = ImGui:dragFloatT(label, table
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value, is_changed = ImGui:dragInt(label, value
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

value1, value2, is_changed = ImGui:dragInt2(label, value1, value2
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

value1, value2, value3, is_changed = ImGui:dragInt3(label, value1, value2, value3
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

value1, value2, value3, value4, is_changed = ImGui:dragInt4(label, value1, value2, value3, value4
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

v_current_min, v_current_max, flag = ImGui:dragIntRange2(label, v_current_min, v_current_max
	[, v_speed = 1, v_min = 0, v_max = 0,
	format = "%d", format_max = nil, ImGui.SliderFlags = 0])

-- table must be an array of any size > 0
is_changed = ImGui:dragIntT(label, table
	[, inc_step = 1, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

Widgets: Sliders

value, is_changed = ImGui:sliderFloat(label, value
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value1, value2, is_changed = ImGui:sliderFloat2(label, value1, value2
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value1, value2, value3, is_changed = ImGui:sliderFloat3(label, value1, value2, value3
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value1, value2, value3, value4, is_changed = ImGui:sliderFloat4(label, value1, value2, value3, value4
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value_in_rad, is_changed = ImGui:sliderAngle(label, value_in_rad
	[, min_degrees = -360, max_degrees = 360,
	format_string = "%.0f deg", ImGui.SliderFlags = 0])

-- table must be an array of any size > 0
is_changed = ImGui:sliderFloatT(label, table
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value, is_changed = ImGui:sliderInt(label, value
	[, min = 0, max = 0,
	format_string = "%d, ImGui.SliderFlags = 0"])

value1, value2, is_changed = ImGui:sliderInt2(label, value1, value2
	[, min = 0, max = 0,
	format_string = "%d, ImGui.SliderFlags = 0"])

value1, value2, value3, is_changed = ImGui:sliderInt3(label, value1, value2, value3
	[, min = 0, max = 0,
	format_string = "%d, ImGui.SliderFlags = 0"])

value1, value2, value3, value4, is_changed = ImGui:sliderInt4(label, value1, value2, value3, value4
	[, min = 0, max = 0,
	format_string = "%d, ImGui.SliderFlags = 0"])

-- table must be an array of any size > 0
is_changed = ImGui:sliderIntT(label, table
	[, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

value, is_changed = ImGui:vSliderFloat(label, w, h, value, min, max
	[, format_string = "%.3f", ImGui.SliderFlags = 0])

value, is_changed = ImGui:vSliderInt(label, w, h, value, min, max
	[, format_string = "%d", ImGui.SliderFlags = 0])

value, is_changed = ImGui:filledSliderFloat(label, mirror_flag, value
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value1, value2, is_changed = ImGui:filledSliderFloat2(label, mirror_flag, value1, value2
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value1, value2, value3, is_changed = ImGui:filledSliderFloat3(label, mirror_flag, value1, value2, value3
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value1, value2, value3, value4, is_changed = ImGui:filledSliderFloat4(label, mirror_flag, value1, value2, value3, value4
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

-- table must be an array of any size > 0
is_changed = ImGui:filledSliderFloatT(label, mirror_flag, table
	[, min = 0, max = 0,
	format_string = "%.3f", ImGui.SliderFlags = 0])

value_in_rad, is_changed = ImGui:filledSliderAngle(label, mirror_flag, value_in_rad
	[, min_degrees = -360, max_degrees = 360,
	format_string = "%.0f deg", ImGui.SliderFlags = 0])

value, is_changed = ImGui:filledSliderInt(label, mirror_flag, value
	[, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

value1, value2, is_changed = ImGui:filledSliderInt2(label, mirror_flag, value1, value2
	[, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

value1, value2, value3, is_changed = ImGui:filledSliderInt3(label, mirror_flag, value1, value2, value3
	[, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

value1, value2, value3, value4, is_changed = ImGui:filledSliderInt4(label, mirror_flag, value1, value2, value3, value4
	[, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

-- table must be an array of any size > 0
is_changed = ImGui:filledSliderIntT(label, mirror_flag, table
	[, min = 0, max = 0,
	format_string = "%d", ImGui.SliderFlags = 0])

value, is_changed = ImGui:vFilledSliderFloat(label, mirror_flag, w, h, value, min, max
	[, format_string = "%.3f", ImGui.SliderFlags = 0])

value, is_changed = ImGui:vFilledSliderInt(label, mirror_flag, w, h, value, min, max
	[, format_string = "%d", ImGui.SliderFlags = 0])

Widgets: Input with Keyboard

text, flag = ImGui:inputText(label, text, buffer_size [, ImGui.InputTextFlags = 0])
text, flag = ImGui:inputTextMultiline(label, text, buffer_size [, w = 0, h = 0, ImGui.InputTextFlags = 0])
text, flag = ImGui:inputTextWithHint(label, text, hint, buffer_size [, ImGui.InputTextFlags = 0])
value,  flag = ImGui:inputFloat(label, value [, step = 0, step_fast = 0, format = "%.3f", ImGui.InputTextFlags = 0])
value1, value2, flag = ImGui:inputFloat2(label, value1, value2 [, format = "%.3f", ImGui.InputTextFlags = 0])
value1, value2, value3, flag = ImGui:inputFloat3(label, value1, value2, value3 [, format = "%.3f", ImGui.InputTextFlags = 0])
value1, value2, value3, value4, flag = ImGui:inputFloat4(label, value1, value2, value3, value4 [, format = "%.3f", ImGui.InputTextFlags = 0])
-- table must be an array of any size > 0
flag = ImGui:inputFloatT(label, table [, format = "%.3f", ImGui.InputTextFlags = 0])
value,  flag = ImGui:inputInt(label, value [, step = 0, step_fast = 0, ImGui.InputTextFlags = 0])
value1, value2, flag = ImGui:inputInt2(label, value1, value2 [, ImGui.InputTextFlags = 0])
value1, value2, value3, flag = ImGui:inputInt3(label, value1, value2, value3 [, ImGui.InputTextFlags = 0])
value1, value2, value3, value4, flag = ImGui:inputInt4(label, value1, value2, value3, value4 [, ImGui.InputTextFlags = 0])
-- table must be an array of any size > 0
flag = ImGui:inputIntT(label, table [, format = "%d", ImGui.InputTextFlags = 0])
value, flag = ImGui:inputDouble(label, value [, step = 0, step_fast = 0, format = "%.6f", ImGui.InputTextFlags = 0])

Input text callbacks:

ImGui:inputText(label, text, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])
ImGui:inputTextMultiline(label, text, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])
ImGui:inputTextWithHint(label, text, hint, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])

callback_function = function(callback_data, user_data)
	-- do something with data
	-- see below
end

callback_data:

ImGuiInputTextFlags = callback_data:getEventFlag()
ImGuiInputTextFlags = callback_data:getFlags()

number = callback_data:getEventChar()

callback_data:setEventChar(number)

keyCode = callback_data:getEventKey()

string = callback_data:getBuf()

callback_data:setBuf(string)

number = callback_data:getBufTextLen()

callback_data:setBufTextLen(number)

number = callback_data:getBufSize()

callback_data:setBufDirty(bool)
bool = callback_data:isBufDirty()

callback_data:setCursorPos(number)
number = callback_data:getCursorPos()

callback_data:setSelectionStart(s_start)
number = callback_data:getSelectionStart()

callback_data:setSelectionEnd(s_end)
s_end = callback_data:getSelectionEnd()

callback_data:setSelection(s_start, s_end)
s_start, s_end = callback_data:getSelection()

callback_data:selectAll()
callback_data:clearSelection()
bool = callback_data:hasSelection()

callback_data:deleteChars(position, bytesCount)
callback_data:insertChars(position, text)

Example:

require "ImGui"

ui = ImGui.new()
stage:addChild(ui)

local testMessage1 = ""
local testMessage2 = ""
local testMessage3 = ""

-- Add ".." at the end of current input string
function myCallback1(data)
	data:insertChars(data:getCursorPos(), "..")
end

-- Replace all chars if UP/DOWN arrow is pressed
function myCallback2(data)
	local key = data:getEventKey()
	if (key == key_code.UP) then
		data:deleteChars(0, data:getBufTextLen())
		data:insertChars(0, "Pressed Up!")
		data:selectAll()
	elseif (key == key_code.DOWN) then
		data:deleteChars(0, data:getBufTextLen())
		data:insertChars(0, "Pressed Down!")
		data:selectAll()
	end
end

-- Switch case of the first char
function myCallback3(data)
	local buf = data:getBuf()
	local s = buf:sub(1,1)
	if ((s >= 'a' and s <= 'z') or (s >= 'A' and s <= 'Z')) then 
		local first = string.char(string.byte(s) ~ 32)
		data:setBuf(first .. buf:sub(2))
		data:setBufDirty(true)
	end
end

function enterFrame(e)
	ui:newFrame(e.deltaTime)
	
	testMessage1 = ui:inputText(
		"Label1", 
		testMessage1, 
		64, 
		ImGui.InputTextFlags_CallbackCompletion, 
		myCallback1
	)
	testMessage2 = ui:inputText(
		"Label2", 
		testMessage2, 
		64, 
		ImGui.InputTextFlags_CallbackHistory, 
		myCallback2
	)
	testMessage3 = ui:inputText(
		"Label3", 
		testMessage3, 
		64, 
		ImGui.InputTextFlags_CallbackEdit, 
		myCallback3
	)
	
	ui:render()
	ui:endFrame()
end

stage:addEventListener("enterFrame", enterFrame)

Widgets: Color Editor/Picker

hexColor, is_touching = ImGui:colorEdit3(label, color [, ImGui.ColorEditFlags = 0]) -- alpha ignored, no need to pass it!
hexColor, alpha, is_touching = ImGui:colorEdit4(label, color [, alpha = 1, ImGui.ColorEditFlags = 0])
hexColor, is_touching = ImGui:colorPicker3(label, color [, ImGui.ColorEditFlags = 0])
hexColor, alpha, originalColor, originalAlpha, is_touching = ImGui:colorPicker4(label, color
	[, alpha = 1, original_color = 0xffffff, original_alpha = 1, ImGui.ColorEditFlags = 0])
isHoveringFlag = ImGui:colorButton(string_ID, color [, alpha = 1, ImGui.ColorEditFlags = 0, w = 0, h = 0])
ImGui:setColorEditOptions(ImGui.ColorEditFlags)

Widgets: Trees

is_openFlag = ImGui:treeNode(label [, format_string])
ImGui:treeNodeEx(label, ImGui.TreeNodeFlags [, format_string])
ImGui:treePush(str_id)
ImGui:treePop()
number = ImGui:getTreeNodeToLabelSpacing()
is_openFlag, p_open = ImGui:collapsingHeader(label, p_open [, ImGui.TreeNodeFlags = 0])
is_openFlag = ImGui:collapsingHeader(label [, ImGui.TreeNodeFlags = 0])
ImGui:setNextItemOpen(is_open, ImGui.Cond)

Widgets: Selectables

result?, selected = ImGui:selectable(label, selected [, ImGui.SelectableFlags = 0, w = 0, h = 0])

Widgets: List Boxes

-- item_table: {"Item0", "Item1", ...}
current_item, is_openFlag = ImGui:listBox(label, current_item, item_table [, max_visible_items = -1])
result? = ImGui:listBoxHeader(label [, w = 0, h = 0])
result? = ImGui:listBoxHeader2(label, items_count)
ImGui:listBoxFooter()

Widgets: Data Plotting

Caching:

If you have big array of points it is better to cache it instead of translating lua table to C++ vector every time you call `ImGui:plotLines()`. But in this case you need to manage memory by yourself (free points pointer when you dont need it).

-- store points in memory
-- points_table: {0.01, 0.5, 10, -50, ...}
-- ptr: c++ pointer to a given vector
ptr = ImGui.cachePoints(points_table)

-- delete points from memory
ImGui.freePoints(ptr)

Plot functions:

-- len (number): points array length
ImGui:plotCachedLines(label, ptr, len,
	[, values_offset = 0, overlay_text = nil,
	scale_min = math.huge, scale_max = math.huge,
	w = 0, h = 0])

ImGui:plotCachedHistogram(label, ptr, len,
	[, values_offset = 0, overlay_text = nil,
	scale_min = math.huge, scale_max = math.huge,
	w = 0, h = 0])

ImGui:plotLines(label, points_table
	[, values_offset = 0, overlay_text = nil,
	scale_min = math.huge, scale_max = math.huge,
	w = 0, h = 0])

ImGui:plotHistogram(label, points_table
	[, values_offset = 0, overlay_text = nil,
	scale_min = math.huge, scale_max = math.huge,
	w = 0, h = 0])

Example:

-- delete ptr if it exist
function deletePtr()
	if pointsPtr then
		ImGui.freePoints(pointsPtr)
	end
end

function onEnterFrame()
	ui:newFrame(e.deltaTime)
	
	if ui:button("Generate") then
		deletePtr()
		points = generatePoints() -- returns big array
		pointsPtr = ImGui.cachePoints(points)
	end
	
	if pointsPtr then
		ui:plotCachedLines("Big data", pointsPtr, #points)
	end
	
	ui:render()
	ui:endFrame()
end

-- do not forget to clear memory when app is closing
function onAppExit()
	deletePtr()
end

Widgets: Value() Helpers

ImGui:value(prefix, bool)
ImGui:value(prefix, number)
ImGui:value(prefix, float, format_string)

Widgets: Menus

result? = ImGui:beginMenuBar()
ImGui:endMenuBar()
result? = ImGui:beginMainMenuBar()
ImGui:endMainMenuBar()
result = ImGui:beginMenu(label [, enabled = true])
result = ImGui:beginMenuEx(label, [icon = "", enabled = true])
ImGui:endMenu()
result = ImGui:menuItem(label [, shortcut = "", selected = false, enabled = true])
result = ImGui:menuItemEx(label, [icon = "", shortcut = "", selected = false, enabled = true])

Widgets: Tooltips

Tooltip are windows following the mouse which do not take focus away.

ImGui:beginTooltip()
ImGui:endTooltip()
ImGui:setTooltip(text)

Disabled groups

ImGui:beginDisabled(disabledFlag)
ImGui:endDisabled()

Popups, Modals

The properties of popups windows are: - They block normal mouse hovering detection outside them. (*1) - Unless modal, they can be closed by clicking anywhere outside them, or by pressing ESCAPE. Because hovering detection is disabled outside the popup, when clicking outside the click will not be seen by underlying widgets! (*1)

  • Their visibility state (~bool) is held internally by Dear ImGui instead of being held by the programmer as we are used to with regular Begin() calls. User can manipulate the visibility state by calling OpenPopup(), CloseCurrentPopup() etc.
  • We default to use the right mouse (ImGuiMouseButton_Right=1) for the Popup Context functions.
  • Those three properties are connected: we need to retain popup visibility state in the library because popups may be closed as any time.

(1.) You can bypass that restriction and detect hovering even when normally blocked by a popup. To do this use the ImGuiHoveredFlags_AllowWhenBlockedByPopup when calling IsItemHovered() or IsWindowHovered(). This is what BeginPopupContextItem() and BeginPopupContextWindow() are doing already, allowing a right-click to reopen another popups without losing the click.

result? = ImGui:beginPopup(str_id [, ImGui.WindowFlags = 0])
p_open, result? = ImGui:beginPopupModal(str_id, p_open [, ImGui.WindowFlags = 0])
ImGui:endPopup()
ImGui:openPopup(str_id [, ImGui.PopupFlags = 0])
ImGui:openPopupOnItemClick(str_id [, ImGui.PopupFlags = 0])
ImGui:closeCurrentPopup()
result? = ImGui:beginPopupContextItem(str_id [, ImGui.PopupFlags = 0])
result? = ImGui:beginPopupContextWindow(str_id [, ImGui.PopupFlags = 0])
result? = ImGui:beginPopupContextVoid(str_id [, ImGui.PopupFlags = 0])
result? = ImGui:isPopupOpen(str_id [, ImGui.PopupFlags = 0])

Columns

  • You can also use SameLine(pos_x) to mimic simplified columns.
  • The columns API is work-in-progress and rather lacking (columns are arguably the worst part of dear imgui at the moment!)
  • There is a maximum of 64 columns.
  • Currently working on new 'Tables' api which will replace columns around Q2 2020 (see GitHub #2957).
ImGui:columns([count = 1, id = nil, border = true])
ImGui:nextColumn()
index = ImGui:getColumnIndex()
width = ImGui:getColumnWidth([column_index = -1])
ImGui:setColumnWidth(column_index, width)
offset = ImGui:getColumnOffset([column_index = -1])
ImGui:setColumnOffset(column_index, offset)
number = ImGui:getColumnsCount()

Tab Bars, Tabs

bool = ImGui:beginTabBar(str_id [, ImGui.TabBarFlags = 0])
ImGui:endTabBar()
p_open, bool = ImGui:beginTabItem(label, p_open [, ImGui.TabItemFlags = 0])
ImGui:endTabItem()
ImGui:setTabItemClosed(tab_or_docked_window_label)
ImGui:tabItemButton(label [, ImGui.TabItemFlags = 0])

Logging/Capture

All text output from the interface can be captured into tty/file/clipboard. By default, tree nodes are automatically opened during logging.

ImGui:logToTTY(auto_open_depth = -1) 
ImGui:logToFile(auto_open_depth = -1, filename = nil) 
ImGui:logToClipboard(auto_open_depth = -1) 
ImGui:logFinish() 
ImGui:logButtons() 
ImGui:logText(text)

Drag and drop

flag = ImGui:beginDragDropSource([ImGui.DragDropFlags flags = 0])
flag = ImGui:setNumDragDropPayload(str_type, number [, ImGui.Cond cond = 0])
flag = ImGui:setStrDragDropPayload(str_type, string [, ImGui.Cond cond = 0])
ImGui:endDragDropSource()
flag = ImGui:beginDragDropTarget()
ImGuiPayload = ImGui:acceptDragDropPayload(type [, ImGui.DragDropFlags flags = 0])
ImGui:endDragDropTarget()
ImGuiPayload = ImGui:getDragDropPayload()

Payload:

number = ImGuiPayload:getNumData()
string = ImGuiPayload:getStrData()
ImGuiPayload:clear()
number = ImGuiPayload:getDataSize()
flag = ImGuiPayload:isDataType(type) -- type must be the same as in "ImGui:acceptDragDropPayload(type)"
flag = ImGuiPayload:isPreview()
flag = ImGuiPayload:isDelivery()

Usage example:

require "ImGui"

local imgui = ImGui.new()
stage:addChild(imgui)

local names = {
	"Bobby", "Beatrice", "Betty",
	"Brianna", "Barry", "Bernard",
	"Bibi", "Blaine", "Bryn"
}
-- modes:
local Mode_Copy = 0
local Mode_Move = 1
local Mode_Swap = 2
 
local mode = 0 -- current mode

function onEnterFrame(e)
	imgui:newFrame(e.deltaTime)
 
	if (imgui:radioButton("Copy", mode == Mode_Copy)) then mode = Mode_Copy end imgui:sameLine()
	if (imgui:radioButton("Move", mode == Mode_Move)) then mode = Mode_Move end imgui:sameLine()
	if (imgui:radioButton("Swap", mode == Mode_Swap)) then mode = Mode_Swap end
 
	for i,v in ipairs(names) do
		imgui:pushID(i)
		if (((i-1) % 3) ~= 0) then imgui:sameLine() end
 
		imgui:button(v, 60, 60)
 
		if (imgui:beginDragDropSource(ImGui.DragDropFlags_None)) then
			--imgui:setStrDragDropPayload("DND_DEMO_CELL", "ID_"..i) -- used for strings
			imgui:setNumDragDropPayload("DND_DEMO_CELL", i) -- used for numbers
 
			if (mode == Mode_Copy) then imgui:text(("Copy %s"):format(v)) end
			if (mode == Mode_Move) then imgui:text(("Move %s"):format(v)) end
			if (mode == Mode_Swap) then imgui:text(("Swap %s"):format(v)) end
			imgui:endDragDropSource()
		end
 
		if (imgui:beginDragDropTarget()) then
			local payload = imgui:acceptDragDropPayload("DND_DEMO_CELL")
			if (payload) then
				--local payload_n = tonumber(payload:getStrData():sub(4))  -- if "setStrDragDropPayload" was used
				local payload_n = payload:getNumData() -- if "setNumDragDropPayload" was used
 
				if (mode == Mode_Copy) then
					names[i] = names[payload_n];
				end
				if (mode == Mode_Move) then
					names[i] = names[payload_n];
					names[payload_n] = "";
				end
 
				if (mode == Mode_Swap) then
					names[i], names[payload_n] = names[payload_n], names[i]
				end
			end
			imgui:endDragDropTarget()
		end
		imgui:popID()
	end
	imgui:render()
	imgui:endFrame()
end

stage:addEventListener("enterFrame", onEnterFrame)

Clipping

ImGui:pushClipRect(min_x, min_y, max_x, max_y, intersect_with_current_clip_rect)
ImGui:popClipRect()

ImGuiListClipper

Try to avoid creating new instances in "enterFrame" event.

Constructor:

instance = ImGuiListClipper.new()

Methods:

ImGuiListClipper:beginClip(number_of_items [, item_height = -1]) -- if item_height <= 0 then it is calculated automatically
ImGuiListClipper:endClip()
bool = ImGuiListClipper:step()
number = ImGuiListClipper:getDisplayStart()
number = ImGuiListClipper:getDisplayEnd()
number = ImGuiListClipper:getStartPosY()
number = ImGuiListClipper:getItemsCount()
ImGuiListClipper:forceDisplayRangeByIndices(number_min, number_max)

Usage example:

require "ImGui"

local imgui = ImGui.new()
stage:addChild(imgui)

clipper = ImGuiListClipper.new()

function onEnterFrame(e)
	imgui:newFrame(e.deltaTime)

	if (imgui:beginWindow("Clipper demo")) then
		if (imgui:beginTable("table", 3)) then
			imgui:tableSetupScrollFreeze(0, 1) -- cols, rows
			imgui:tableSetupColumn("One")
			imgui:tableSetupColumn("Two")
			imgui:tableSetupColumn("Three")
			imgui:tableHeadersRow()

			clipper:beginClip(100)
			while (clipper:step()) do
				for row = clipper:getDisplayStart(), clipper:getDisplayEnd() do
					imgui:tableNextRow()
					for column = 1, 3 do
						imgui:tableSetColumnIndex(column - 1)
						imgui:text(("col: %d; row: %d"):format(column, row))
					end
				end
			end
			clipper:endClip()

			imgui:endTable()
		end
	end
	imgui:endWindow()

	imgui:endFrame()
	imgui:render()
end

stage:addEventListener("enterFrame", onEnterFrame)

Context

string OR nil = ImGui:getHoveredWindow()
string OR nil = ImGui:getHoveredWindowRoot()
string OR nil = ImGui:getHoveredWindowUnderMovingWindow()
string OR nil = ImGui:getMovingWindow()
string OR nil = ImGui:getActiveIdWindow()
id = ImGui:getActiveId()
id = ImGui:getActiveIdPreviousFrame()
number = ImGui:getActiveIdTimer()
id = ImGui:getActiveIdAllowOverlap()
id = ImGui:getHoveredId()
id = ImGui:getHoveredIdPreviousFrame()
number = ImGui:getHoveredIdTimer()
id = ImGui:getHoveredIdAllowOverlap()
bool = ImGui:getDragDropActive()
id = ImGui:getDragDropPayloadSourceId()
string = ImGui:getDragDropPayloadDataType()
number = ImGui:getDragDropPayloadDataSize()

Focus, Activation

  • Prefer using "SetItemDefaultFocus()" over "if (IsWindowAppearing()) SetScrollHereY()" when applicable to signify "this is the default item"
  • Most of the functions are referring to the last/previous item we submitted.
  • See Demo Window under "Widgets->Querying Status" for an interactive visualization of most of those functions.
ImGui:setItemDefaultFocus()
ImGui:setKeyboardFocusHere([offset = 0])
flag = ImGui:isItemHovered([ImGui.HoveredFlags = 0])
flag = ImGui:isItemActive()
flag = ImGui:isItemFocused()
flag = ImGui:isItemClicked(mouse_button)
flag = ImGui:isItemVisible()
flag = ImGui:isItemEdited()
flag = ImGui:isItemActivated()
flag = ImGui:isItemDeactivated()
flag = ImGui:isItemDeactivatedAfterEdit()
flag = ImGui:isItemToggledOpen()
flag = ImGui:isAnyItemHovered()
flag = ImGui:isAnyItemActive()
flag = ImGui:isAnyItemFocused()
minX, minY, maxX, maxY = ImGui:getItemRect()
x, y = ImGui:getItemRectMin()
x, y = ImGui:getItemRectMax()
w, h = ImGui:getItemRectSize()
ImGui:setItemAllowOverlap()

INPUTS

ImGui:onMouseHover(event)
ImGui:onMouseMove(event)
ImGui:onMouseDown(event)
ImGui:onMouseUp(event)
ImGui:onMouseWheel(event)

ImGui:onTouchMove(event)
ImGui:onTouchBegin(event)
ImGui:onTouchEnd(event)
ImGui:onTouchCancel(event)

ImGui:onKeyUp(event)
ImGui:onKeyDown(event)
ImGui:onKeyChar(event)

Usage examples:

local UI = ImGui.new(nil, false, false, false)

Mouse

stage:addEventListener("mouseHover", function(e) UI:onMouseHover(e) end)
stage:addEventListener("mouseMove", function(e) UI:onMouseMove(e) end)
stage:addEventListener("mouseDown", function(e) UI:onMouseDown(e) end)
stage:addEventListener("mouseUp", function(e) UI:onMouseUp(e) end)
stage:addEventListener("mouseWheel", function(e) UI:onMouseWheel(e) end)

Touch

stage:addEventListener("touchesCancel", function(e) ui:onTouchCancel(e) end)
stage:addEventListener("touchesMove", function(e) ui:onTouchMove(e) end)
stage:addEventListener("touchesBegin", function(e) ui:onTouchBegin(e) end)
stage:addEventListener("touchesEnd", function(e) ui:onTouchEnd(e) end)

Keyboard

stage:addEventListener("keyUp", function(e) UI:onKeyUp(e) end)
stage:addEventListener("keyDown", function(e) UI:onKeyDown(e) end)
stage:addEventListener("keyChar", function(e) UI:onKeyChar(e) end)

Miscellaneous Utilities

flag = ImGui:isRectVisible(w, h [, max_x, max_y])
number = ImGui:getTime()
number = ImGui:getFrameCount()
str = ImGui:getStyleColorName(idx)
flag = ImGui:beginChildFrame(id, w, h [, ImGui.WindowFlags = 0]) -- id (number)
ImGui:endChildFrame()

Text Utilities

w, h = ImGui:calcTextSize(text [, hide_text_after_double_hash = false, wrap_width = -1])

Color convert

Note: use DOT instead of COLON, so you can use it without creating an ImGui object

r, g, b, a = ImGui.colorConvertHEXtoRGB(color [, alpha = 1])
hex = ImGui.colorConvertRGBtoHEX(r, g, b)
h, s, v = ImGui.colorConvertRGBtoHSV(r, g, b)
r, g, b = ImGui.colorConvertHSVtoRGB(h, s, v)
h, s, v = ImGui.colorConvertHEXtoHSV(hex)
hex = ImGui.colorConvertHSVtoHEX(h, s, v)

Inputs Utilities: Keyboard

  • For 'int user_key_index' you can use your own indices/enums according to how your backend/engine stored them in io.KeysDown[].
  • We don't know the meaning of those value. You can use GetKeyIndex() to map a ImGuiKey_ value into the user index.
string = ImGui:getKeyName(keyCode)
flag = ImGui:isKeyDown(keyCode)
flag = ImGui:isKeyPressed(keyCode [, repeat = true])
flag = ImGui:isKeyReleased(keyCode)
number = ImGui:getKeyPressedAmount(keyCode, repeat_delay, rate)
ImGui:setNextFrameWantCaptureKeyboard([want_capture_keyboard_value = true])

Shortcut system

-- (keyChord: an ImGuiKey optionally OR-ed with one or more ImGuiMod_XXX values (ImGuiKey | ImGuiMod_XXX))
ImGui:shortcut(keyChord [, owner_id = 0, ImGui.InputFlags = 0])

-- (useful to disable CTRL + TAB combo: ImGui:setShortcutRouting(ImGui.Mod_Ctrl | ImGui.Key_Tab, ImGui.KeyOwner_None))
ImGui:setShortcutRouting(keyChord [, owner_id = 0, ImGui.InputFlags = 0])

ImGui:setItemKeyOwner(keyCode [, ImGui.InputFlags = 0])

ImGui:setKeyOwner(keyCode, owner_id, [, ImGui.InputFlags = 0])

Focused window and global application button shortcut example

require "ImGui"

local imgui = ImGui.new()
stage:addChild(imgui)
imgui:setClassicStyle()

function onEnterFrame(e)
	imgui:newFrame(e.deltaTime)

	-- focused window button shortcut
	if imgui:button("PLAY##01", 32*2, 32*0.6) or imgui:shortcut(ImGui.Key_P) then
		print(ImGui:getItemID()) -- 2102678615
	end
	imgui:sameLine(32*2.5)
	-- focused window button shortcut (using item ID)
	if imgui:button("PLAY##02", 32*2, 32*0.6) or imgui:shortcut(ImGui.Key_Q, 8325, ImGui.FocusedFlags_AnyWindow) then
		print(ImGui:getItemID()) -- 8325
	end

	-- global app button shortcut
	if imgui:button("PLAY##03", 32*2, 32*0.6) or imgui:isKeyPressed(KeyCode.C) then
		print(ImGui:getItemID()) -- 1157645807
	end

	imgui:render()
	imgui:endFrame()
end

stage:addEventListener(Event.ENTER_FRAME, onEnterFrame)

Global application checkbox shortcut example

require "ImGui"

local imgui = ImGui.new()
stage:addChild(imgui)
imgui:setClassicStyle()

-- some vars
local islooping = false

function onEnterFrame(e)
	imgui:newFrame(e.deltaTime)
	local ischanged = false

	islooping, ischanged = imgui:checkbox("looping(L)", islooping)
	if imgui:isKeyPressed(KeyCode.L) then
		islooping = not islooping
		ischanged = true
	end
	if ischanged then
		print("islooping", islooping)
	end

	imgui:render()
	imgui:endFrame()
end

stage:addEventListener(Event.ENTER_FRAME, onEnterFrame)

Inputs Utilities: Mouse

  • To refer to a mouse button, you may use named enums in your code e.g. ImGuiMouseButton_Left, ImGuiMouseButton_Right.
  • You can also use regular integer: it is forever guaranteed that 0=Left, 1=Right, 2=Middle.
  • Dragging operations are only reported after mouse has moved a certain distance away from the initial clicking position (see 'lock_threshold' and 'io.MouseDraggingThreshold')
-- "mouse_button" is any gideros mouse button code
flag = ImGui:isMouseDown(mouse_button)
flag = ImGui:isMouseClicked(mouse_button [, repeat = false]) -- "mouse_button" is any gideros mouse button code
flag = ImGui:isMouseReleased(mouse_button) -- "mouse_button" is any gideros mouse button code
flag = ImGui:isMouseDoubleClicked(mouse_button) -- "mouse_button" is any gideros mouse button code
flag = ImGui:isMouseHoveringRect(min_x, min_y, max_x, max_y [, clip = true])
flag = ImGui:isMousePosValid([x = inf, y = inf])
flag = ImGui:isAnyMouseDown()
x, y = ImGui:getMousePos()
x, y = ImGui:getMousePosOnOpeningCurrentPopup()
flag = ImGui:isMouseDragging(mouse_button [, lock_threshold = -1]) -- "mouse_button" is any gideros mouse button code
x, y = ImGui:getMouseDragDelta(mouse_button [, lock_threshold = -1]) -- "mouse_button" is any gideros mouse button code
ImGui:resetMouseDragDelta(mouse_button) -- "mouse_button" is any gideros mouse button code
ImGuiMouseCursor = ImGui:getMouseCursor()
ImGui:setMouseCursor(ImGui.MouseCursor)
ImGui:setNextFrameWantCaptureMouse([want_capture_mouse_value = true])
ImGui:setNextFrameWantCaptureKeyboard([want_capture_keyboard_value = true])
ImGui:updateCursor()

FONTS

IO = imgui:getIO()
FontAtlas = IO:getFonts()

Font = FontAtlas:addFont(ttf_font_path, font_size [, options])

-- options (table): all parameters are optional
--	    fontDataOwnedByAtlas - bool
--	    pixelSnapH - bool
--	    mergeMode - bool
--	    fontNo - number
--	    oversampleH - number
--	    oversampleV - number
--	    glyphExtraSpacingX - number
--	    glyphExtraSpacingY - number
--	    glyphOffsetX - number
--	    glyphOffsetY - number
--	    glyphMinAdvanceX - number
--	    glyphMaxAdvanceX - number
--	    rasterizerFlags - number
--	    rasterizerMultiply - number
--	
--	    glyphs - table:
--		    text(string): represents available chars
--		    chars(table): list of specific char code (example: {0x7262, ...})
--		    ranges(table): predefined glyph ranges (example: {ImGui.GlyphRanges_Default, ImGui.GlyphRanges_Japanese, ...})
FontAtlas:addFonts(fontsDescription)
-- fontsDescriptions(table):
--      description(table):
--          ttf_font_path(string): path to a font
--          font_size(number): font size
--          options(table): see description above
-- example:
-- FontAtlas:addFonts{ {"fonts/DroidSans.ttf", 16}, {"fonts/ProggyTiny.ttf", 16} }

Font = FontAtlas:getFont([index]) -- get font by index (if index is 0 or nil you will get default font instance)
FontAtlas:build() -- call after multiple FontAtlas:addFont(...) calls to update ImGui font atlas 
FontAtlas:clearInputData()
FontAtlas:clearTexData()
FontAtlas:clearFonts()
FontAtlas:clear()
table = FontAtlas:getFonts() -- returns a table with all fonts (included default)
flag = FontAtlas:isBuilt()
number = FontAtlas:addCustomRectRegular(width, height)
number = FontAtlas:addCustomRectFontGlyph(font, id, width, height, advance_x [, offset_x, offset_y])
w, h, x, y, glyph_id, offset_x, offset_y, font, is_packed_flag = FontAtlas:getCustomRectByIndex(index)

ImGui:pushFont(font) -- font (table): object returned by FontAtlas:addFont(...) or FontAtlas:getFont([index])
ImGui:popFont()

Minimal example:

local UI = ImGui.new()
local IO = UI:getIO()
local FontAtlas = IO:getFonts()
local VDS_font = FontAtlas:addFont("fonts/VDS.ttf", 16, {
    oversampleH = 2,
    oversampleV = 2,
	glyphs = {
		ranges = {ImGui.GlyphRanges_Cyrillic}
	}
})
IO:setFontDefault(VDS_font)
FontAtlas:build()
stage:addChild(UI)

-- you can use multiple fonts at the same time
function enterFrame(e)
	UI:newFrame(e.deltaTime)
	
	UI:pushFont(font1)
	UI:text("Font1")
	UI:popFont()
	
	UI:pushFont(font2)
	UI:text("Font2")
	UI:popFont()
	
	UI:render()
	UI:endFrame()
end

Glyphs example:

local fonts = io:getFonts()
fonts:addFont(font_path, font_size, {
	glyphs = {
		ranges = {
			{
				0x2590,0x2593, -- range1
				0x2660,0x266B  -- range2
				-- ...
			},
			ImGui.GlyphRanges_Cyrillic,
			{
				0x01C0, 0x01C3 -- range3
			},
			ImGui.GlyphRanges_Korean
		},
 
		-- same structure:
		ranges = {
			{
				0x2590,0x2593, -- range1
				0x2660,0x266B, -- range2
				0x01C0,0x01C3  -- range3
				-- ...
			}, 
			ImGui.GlyphRanges_Cyrillic, 
			ImGui.GlyphRanges_Korean
		}
	},
	mergeMode = true, -- merge into previous font
})
fonts:build()

Icons example:

local icon = utf8.char(0x2590)
ImGui:text("My icon >>" .. icon .. " << !!!")

-- or with new Luau support:
ImGui:text("My icon >> \u{2590} << !!!")
-- can be also stored in memory:
local icon = "\u{2590}"

Font

number = Font:getSize()
FontAtlas = Font:getContainerAtlas()
Font:setScale(number)
number = Font:getScale()
number = Font:getAscent()
number = Font:getDescent()
bool = Font:isLoaded()
string = Font:getDebugName()
w, h = Font:calcTextSizeA(size, max_width, wrap_width, string)
Font:calcWordWrapPositionA(scale, string, wrap_width) -- not tested

Tables

flag = ImGui:beginTable(str_id, column [, ImGui.TableFlags = 0, outer_w = 0, outer_h = 0, inner_width = 0])
ImGui:endTable()
ImGui:tableNextRow([ImGui.TableRowFlags = 0, min_row_height = 0])
flag = ImGui:tableNextColumn()
flag = ImGui:tableSetColumnIndex(column_n)
ImGui:tableSetupColumn(label [, ImGui.TableColumnFlags = 0, init_width_or_weight = 0, user_id = 0])
ImGui:tableSetupScrollFreeze(cols, rows)
ImGui:tableHeadersRow()
TableSortSpecs = ImGui:tableGetSortSpecs() -- see below
number = ImGui:tableGetColumnCount()
number = ImGui:tableGetColumnIndex()
number = ImGui:tableGetRowIndex()
string = ImGui:tableGetColumnName([column_n = -1])
ImGuiTableColumnFlags = ImGui:tableGetColumnFlags([column_n = -1])
ImGui:tableSetBgColor(ImGui.TableBgTarget, color [, alpha = 1, column_n = -1])

Table sort specs

number = TableSortSpecs:getSpecsCount() -- TableSortSpecs = ImGui:tableGetSortSpecs()
flag = TableSortSpecs:isSpecsDirty() -- TableSortSpecs = ImGui:tableGetSortSpecs()
TableSortSpecs:setSpecsDirty(flag) -- TableSortSpecs = ImGui:tableGetSortSpecs()
table = TableSortSpecs:getColumnSortSpecs() -- TableSortSpecs = ImGui:tableGetSortSpecs(), see below

Table column sort specs

-- table = TableSortSpecs:getColumnSortSpecs()
-- each value of this table is an object that have these functions:
number = item:getColumnUserID() 
number = item:getColumnIndex() -- 0 based
number = item:getSortOrder() -- used in multi sorted tables
number = item:getSortDirection() -- ImGui.SortDirection_Ascending OR ImGui.SortDirection_Descending

Example: https://github.com/MultiPain/Gideros_examples/blob/master/ImGuiTablesDemo/assets/TablesDemo.lua

ImGuiTextFilter

Try to avoid creating new instaces in "enterFrame" event.

Constructor:

filter = ImGuiTextFilter.new()

Methods:

-- draws the input field
isValueChanged = filter:draw(label [, width = 0])
-- draws the input field (using ImGui:inutTextWithHint())
isValueChanged = filter:drawWithHint(label, hint [, width = 0])

filter:setBuffer(text) -- set filter text
filter:build() -- update filter internals (see example below)
bool = filter:passFilter(text) -- returns true if filter input matches with "text"

Usage example 1:

require "ImGui"

local imgui = ImGui.new()
stage:addChild(imgui)

local filter = ImGuiTextFilter.new()
local items = { "aaa1.c", "bbb1.c", "ccc1.c", "aaa2.cpp", "bbb2.cpp", "ccc2.cpp", "abc.h", "hello, world" }

function onEnterFrame(e)
	imgui:newFrame(e.deltaTime)

	if (imgui:beginWindow("Filter demo")) then
		imgui:text([[
Filter usage:
	""         display all lines
	"xxx"      display lines containing "xxx"
	"xxx,yyy"  display lines containing "xxx" or "yyy"
	"-xxx"     hide lines containing "xxx"
		]])

		filter:draw("Filter")

		for i, text in ipairs(items) do
			if filter:passFilter(text) then
				imgui:bulletText(text)
			end
		end
	end
	imgui:endWindow()

	imgui:endFrame()
	imgui:render()
end

stage:addEventListener("enterFrame", onEnterFrame)

Usage example 2:

require "ImGui"

local imgui = ImGui.new()
stage:addChild(imgui)

local filter = ImGuiTextFilter.new()
local searchText = ""
local items = { "aaa1.c", "bbb1.c", "ccc1.c", "aaa2.cpp", "bbb2.cpp", "ccc2.cpp", "abc.h", "hello, world" }

function onEnterFrame(e)
	imgui:newFrame(e.deltaTime)

	-- draw standart text input control
--	filter:drawWithHint("Filter", "Search")
	-- draw custom control
	local ischanged = false
	searchText, ischanged = imgui:inputText("Filter", searchText, 256, ImGui.InputTextFlags_EnterReturnsTrue)
	if ischanged then
		filter:setBuffer(searchText)
		-- try to avoid calling "build" function every frame
		filter:build()
	end

	for i, item in ipairs(items) do
		if not filter:passFilter(item) then
			continue
		end
		imgui:bulletText(item)
	end

	imgui:endFrame()
	imgui:render()
end

stage:addEventListener("enterFrame", onEnterFrame)

TextEditor

-- otherTextEditor: another "ImGuiTextEditor" instance to copy setting
TextEditor = ImGuiTextEditor.new([other_text_editor])

Functions:

LanguageDefinition = TextEditor:getLanguageCPP()
LanguageDefinition = TextEditor:getLanguageGLSL()
LanguageDefinition = TextEditor:getLanguageHLSL()
LanguageDefinition = TextEditor:getLanguageC()
LanguageDefinition = TextEditor:getLanguageSQL()
LanguageDefinition = TextEditor:getLanguageAngelScript()
LanguageDefinition = TextEditor:getLanguageLua()

TextEditor:setLanguageDefinition(LanguageDefinition)
LanguageDefinition = TextEditor:getLanguageDefinition()

Palette = TextEditor:getPaletteDark()
Palette = TextEditor:getPaletteLight()
Palette = TextEditor:getPaletteRetro()

TextEditor:setPalette(Palette)
Palette = TextEditor:getPalette()

TextEditor:setPaletteColor(TE_ColorIndex, color [, alpha = 1]) -- see TextEditor enums below
color, alpha = TextEditor:getPaletteColor(TE_ColorIndex)

TextEditor:loadPalette(table) -- 42 elements table
-- example:
--[[ dark palete:
TextEditor:loadPalette{
	0x7f7f7f, 1,	-- Default
	0xd69c56, 1,	-- Keyword
	0x00ff00, 1,	-- Number
	0x7070e0, 1,	-- String
	0x70a0e0, 1,	-- Char literal
	0xffffff, 1,	-- Punctuation
	0x408080, 1,	-- Preprocessor
	0xaaaaaa, 1,	-- Identifier
	0x9bc64d, 1,	-- Known identifier
	0xc040a0, 1,	-- Preproc identifier
	0x206020, 1,	-- Comment (single line)
	0x406020, 1,	-- Comment (multi line)
	0x101010, 1,	-- Background
	0xe0e0e0, 1,	-- Cursor
	0xa06020, 0.5,	-- Selection
	0x0020ff, 0.5,	-- ErrorMarker
	0xf08000, 0.25, -- Breakpoint
	0x707000, 1,	-- Line number
	0x000000, 0.25, -- Current line fill
	0x808080, 0.25, -- Current line fill (inactive)
	0xa0a0a0, 0.25, -- Current line edge
}
]]

-- see below
TextEditor:setErrorMarkers(error_markers)
TextEditor:setBreakpoints(breakpoints)

TextEditor:render(string_id [, w = 0, h = 0, border = 0])

TextEditor:setText(string)
TextEditor:getText()
TextEditor:setTextLines(table) -- set editor text using table. Structure: {"line 1", "line 2", "line 3", ...}
table = TextEditor:getTextLines()

string = TextEditor:getSelectedText()
string = TextEditor:getCurrentLineText()

number = TextEditor:getTotalLines()
bool = TextEditor:isOverwrite()

bool = TextEditor:setReadOnly()
bool = TextEditor:isReadOnly()
bool = TextEditor:isTextChanged()
bool = TextEditor:isCursorPositionChanged()

TextEditor:setColorizerEnable()
bool = TextEditor:isColorizerEnabled()

line, column = TextEditor:getCursorPosition() -- 0 based line & column number 
TextEditor:setCursorPosition(line, column)

TextEditor:setHandleMouseInputs(bool)
bool = TextEditor:isHandleMouseInputsEnabled()

TextEditor:setHandleKeyboardInputs(bool)
bool = TextEditor:isHandleKeyboardInputsEnabled()

TextEditor:setTextEditorChildIgnored(bool)
bool = TextEditor:isTextEditorChildIgnored()

TextEditor:setShowWhitespaces(bool)
bool = TextEditor:isShowingWhitespaces()

TextEditor:setTabSize(size)
size = TextEditor:getTabSize()

TextEditor:insertText(string)

TextEditor:moveUp([amount = 1, select = false])
TextEditor:moveDown([amount = 1, select = false])
TextEditor:moveLeft([amount = 1, select = false])
TextEditor:moveRight([amount = 1, select = false])
TextEditor:moveTop([select = false])
TextEditor:moveBottom([select = false])
TextEditor:moveHome([select = false])
TextEditor:moveEnd([select = false])

TextEditor:setSelectionStart(line, column)
TextEditor:setSelectionEnd(line, column)
TextEditor:setSelection(start_line, start_column, end_line, end_column)
TextEditor:selectWordUnderCursor()
TextEditor:selectAll()
bool = TextEditor:hasSelection()

TextEditor:copy()
TextEditor:cut()
TextEditor:paste()
TextEditor:delete()

bool = TextEditor:canUndo()
bool = TextEditor:canRedo()
TextEditor:undo()
TextEditor:redo()

LanguageDefinition

string = LanguageDefinition:getName()

ErrorMarkers

ErrorMarkers = ImGuiErrorMarkers.new()

ErrorMarkers:add(line, message)
ErrorMarkers:remove(line)
message = ErrorMarkers:get(line)
number = ErrorMarkers:getSize()

Breakpoints

Breakpoints = ImGuiBreakpoints.new()

Breakpoints:add(line)
Breakpoints:remove(line)
bool = Breakpoints:get(line)
number = Breakpoints:getSize()

DRAW LISTS

Window draw list:

local list = ImGui:getWindowDrawList()

Background draw list:

local list = ImGui:getBackgroundDrawList()

Foreground draw list:

local list = ImGui:getForegroundDrawList()

Draw lists commands:

DrawList:pushClipRect(clip_rect_min_x, clip_rect_min_y, clip_rect_max_x, clip_rect_max_y [, intersect_with_current_clip_rect = false])
DrawList:pushClipRectFullScreen()
DrawList:popClipRect()
DrawList:pushTextureID(texture)
DrawList:popTextureID()
x, y = DrawList:getClipRectMin()
x, y = DrawList:getClipRectMax()
DrawList:addLine(p1_x, p1_y, p2_x, p2_y, color [, alpha = 1, thickness = 1])
DrawList:addRect(
	p_min_x, p_min_y, 
	p_max_x, p_max_y, 
	color 
	[, alpha = 1, 
	rounding = 0, rounding_corners = ImGui.DrawFlags_RoundCornersAll, 
	thickness = 1])
DrawList:addRectFilled(p_min_x, p_min_y, p_max_x, p_max_y, color [, alpha = 1, rounding = 0, rounding_corners = ImGui.DrawFlags_RoundCornersAll])
DrawList:addRectFilledMultiColor(p_min_x, p_min_y, p_max_x, p_max_y, color_upr_left, color_upr_right, color_bot_right, color_bot_left)
DrawList:addQuad(p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, color [, alpha = 1, thickness = 1])
DrawList:addQuadFilled(p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, color)
DrawList:addTriangle(p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, color [, alpha = 1, thickness = 1])
DrawList:addTriangleFilled(p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, color)
DrawList:addCircle(center_x, center_y, radius, color [, alpha = 1, num_segments = 12, thickness = 1])
DrawList:addCircleFilled(center_x, center_y, radius, color [, alpha = 1, num_segments = 12])
DrawList:addNgon(center_x, center_y, radius, color [, alpha = 1, num_segments = 12, thickness = 1])
DrawList:addNgonFilled(center_x, center_y, radius, color [, alpha = 1, num_segments = 12])
DrawList:addText(x, y, color, alpha, text) -- x, y (number), text_begin (string), text_end (string)
DrawList:addFontText(font, font_size, 
	pos_x, pos_y, 
	color, alpha, 
	text 
	[, wrap_with = 0, 
	cpu_fine_clip_rect_x, cpu_fine_clip_rect_y, 
	cpu_fine_clip_rect_w, cpu_fine_clip_rect_h])
DrawList:addPolyline(points_table, color, alpha, closed, thickness) -- points_table (table), color (number), closed (bool), thickness (number)
DrawList:addConvexPolyFilled(points_table, color) -- points_table (table), color (number)
DrawList:addBezierCubic(
	p1_x, p1_y, 
	p2_x, p2_y, 
	p3_x, p3_y, 
	p4_x, p4_y, 
	color, alpha, thickness [, num_segments = 0])
DrawList:addBezierQuadratic(
	p1_x, p1_y, 
	p2_x, p2_y, 
	p3_x, p3_y, 
	color, alpha, thickness [, num_segments = 0])
DrawList:addImage(texture, 
	x, y, 
	x + w, y + h 
	[, tint_color = 0xffffff, tint_alpha = 1]) 
DrawList:addImageUV(texture, 
	x, y, 
	x + w, y + h, 
	uv0x, uv0y, 
	uv1x, uv1y 
	[, tint_color = 0xffffff, tint_alpha = 1]) 
DrawList:addImageQuad(texture, 
	x, y, 
	x + w, y, 
	x + w, y + h, 
	x, y + h 
	[, tint_color = 0xffffff, tint_alpha = 1, 
	uv0x = 0, uv0y = 0, 
	uv1x = 1, uv1y = 0, 
	uv2x = 1, uv2y = 1, 
	uv3x = 0, uv3y = 1])
DrawList:addImageRounded(texture, 
	x, y, 
	x + w, 
	y + h, 
	tint_color, tint_alpha, round_radius 
	[, corner_flags = ImGui.CorenerFlags_All])
DrawList:addImageRoundedUV(texture, 
	x, y, 
	x + w, y + h, 
	uv0x, uv0y, 
	uv1x, uv1y, 
	tint_color, tint_alpha, round_radius 
	[, corner_flags = ImGui.CorenerFlags_All])
DrawList:pathClear()
DrawList:pathLineTo(x, y)
DrawList:pathLineToMergeDuplicate(x, y)
DrawList:pathFillConvex(color)
DrawList:pathStroke(color, alpha, closed [, thickness = 1])
DrawList:pathArcTo(center_x, center_y, radius, a_min, a_max [, num_segments = 10])
DrawList:pathArcToFast(center_x, center_y, radius, a_min, a_max)
DrawList:pathBezierCubicCurveTo(p2x, p2y, p3x, p3y, p4x, p4y [, num_segments = 0])
DrawList:pathBezierQuadraticCurveTo(p2x, p2y, p3x, p3y [, num_segments = 0])
DrawList:pathRect(min_x, min_y, max_x, max_y [, rounding = 0, ImGui.DrawFlags = 0])
-- CUSTOM
-- rotate any draw list item around its center point
DrawList:rotateBegin()
DrawList:rotateEnd(radians)
-- example:
...
local list = ImGui:getWindowDrawList()
list:rotateBegin()
list:addLine(100, 100, 100, 250, 0xff0000, 1, 10)
list:rotateEnd(math.pi/2.2)
...

Usage example:

-- reference: https://github.com/ocornut/imgui/issues/3606#issuecomment-731726406
require "ImGui"

local imgui = ImGui.new()
local IO = imgui:getIO()
local w = 320
local h = 180
IO:setDisplaySize(w*2, h*2)
stage:addChild(imgui)

local cos,sin,sqrt = math.cos, math.sin, math.sqrt
local HSV2RGB = ImGui.colorConvertHSVtoRGB
local RGB2HEX = ImGui.colorConvertRGBtoHEX
local p = { -1,-1, 1,-1, 1,1, -1,1 }
local function conv(z, szx, szy, ox, oy, vx, vy) return ((vx/z)*szx*5+szx*0.5)+ox, ((vy/z)*szy*5+szy*0.5)+oy end
local function R(vx, vy, ng) ng*=0.1 local cosn = cos(ng) local sinn = sin(ng) return vx*cosn-vy*sinn, vx*sinn+vy*cosn end
local function FX(d, ax, ay, bx, by, sw, sh, t)
	d:addRectFilled(ax,ay,bx,by,0,1,0)
	t *= 4
	for i = 0, 19 do
		local z = 21-i-(t-(t//1))*2
		local ng, ot0, ot1 = -t*2.1+z, -t+z*0.2, -t+(z+1)*0.2
		local s, of, pts =
			{ cos((t+z)*0.1)*0.2+1, sin((t+z)*0.1)*0.2+1, cos((t+z+1)*0.1)*0.2+1, sin((t+z+1)*0.1)*0.2+1 },
			{ cos(ot0)*0.3, sin(ot0)*0.3, cos(ot1)*0.3, sin(ot1)*0.3 },
			{ }
		for j = 0, 7 do
			local m, n = ((j%4)+1)*2, j//4
			pts[j*2+1], pts[j*2+2] =
				conv( (z+n)*2, sw, sh, ax, ay, R(p[m-1]*s[n*2+1]+of[n*2+1], p[m-0]*s[n*2+2]+of[n*2+2], ng+n) )
		end
		for j = 0, 3 do
			local it = ( (((i&1) ~= 0) and 0.5 or 0.6) + j*0.05 ) * ( (21-z)/21 )
			d:addConvexPolyFilled(
				{
					pts[j*2+1], pts[j*2+2], pts[((j+1)%4)*2+1], pts[((j+1)%4)*2+2],
					pts[(((j+1)%4)+4)*2+1], pts[(((j+1)%4)+4)*2+2], pts[(j+4)*2+1],
					pts[(j+4)*2+2]
				},
				RGB2HEX(HSV2RGB(0.6+sin(t*0.03)*0.5, 1, sqrt(it)))
			)
		end
	end
end

function onEnterFrame(e)
	imgui:newFrame(e.deltaTime)
	if imgui:beginWindow("FX", nil, ImGui.WindowFlags_AlwaysAutoResize) then
		imgui:invisibleButton("canvas", w, h)
		local min_x, min_y = imgui:getItemRectMin()
		local max_x, max_y = imgui:getItemRectMax()
		local draw_list = imgui:getWindowDrawList()
		draw_list:pushClipRect(min_x, min_y, max_x, max_y)
		FX(draw_list, min_x, min_y, max_x, max_y, w, h, imgui:getTime())
		draw_list:popClipRect()
	end
	imgui:endWindow()
	imgui:render()
	imgui:endFrame()
end

stage:addEventListener("enterFrame", onEnterFrame)

EXPERIMENTAL

p_open = ImGui:showLog(title, p_open [, ImGui.WindowFlags = 0]) -- draw log window
ImGui:writeLog(text)

Gestures (touch only, turned OFF by default) WIP:

  • tap gesture (Left Mouse Button)
  • hold gesture (Right Mouse Button)
ImGui:setTouchGesturesEnabled(bool)
bool = ImGui:isTouchGesturesEnabled()


Dear ImGui