Dear ImGui API: Difference between revisions

From GiderosMobile
No edit summary
 
(45 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
 
-- "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)


'''Minimal example''':
IO:setAppAcceptingEvents([accepting_events = true])
</syntaxhighlight>
 
== Style setters/getters ==
'''GetStyle'''() instance access the Style structure (colors, sizes). Always use PushStyleCol(), PushStyleVar() to modify style mid-frame!
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local UI = ImGui.new()
local Style = ImGui:getStyle()
local IO = UI:getIO()
</syntaxhighlight>
local FontAtlas = IO:getFonts()
 
local VDS_font = FontAtlas:addFont("fonts/VDS.ttf", 16, {
'''Setters/getters''':
    oversampleH = 2,
<syntaxhighlight lang="lua">
    oversampleV = 2,
Style:setColor(ImGui.Col, color, alpha)
glyphs = {
color, alpha = Style:getColor(ImGui.Col)
ranges = {ImGui.GlyphRanges_Cyrillic}
Style:setAlpha(value)
}
value = Style:getAlpha()
})
IO:setFontDefault(VDS_font)
FontAtlas:build()
stage:addChild(UI)


-- you can use multiple fonts at the same time
Style:setWindowRounding(value)
function enterFrame(e)
value = Style:getWindowRounding()
UI:newFrame(e.deltaTime)
Style:setWindowBorderSize(value)
value = Style:getWindowBorderSize()
UI:pushFont(font1)
Style:setChildRounding(value)
UI:text("Font1")
value = Style:getChildRounding()
UI:popFont()
Style:setChildBorderSize(value)
value = Style:getChildBorderSize()
UI:pushFont(font2)
Style:setPopupRounding(value)
UI:text("Font2")
value = Style:getPopupRounding()
UI:popFont()
Style:setPopupBorderSize(value)
value = Style:getPopupBorderSize()
UI:render()
Style:setFrameRounding(value)
UI:endFrame()
value = Style:getFrameRounding()
end
Style:setFrameBorderSize(value)
</syntaxhighlight>
value = Style:getFrameBorderSize()
 
Style:setIndentSpacing(value)
'''Glyphs example''':
value = Style:getIndentSpacing()
<syntaxhighlight lang="lua">
Style:setColumnsMinSpacing(value)
local fonts = io:getFonts()
value = Style:getColumnsMinSpacing()
fonts:addFont(font_path, font_size, {
Style:setScrollbarSize(value)
glyphs = {
value = Style:getScrollbarSize()
ranges = {
Style:setScrollbarRounding(value)
{
value = Style:getScrollbarRounding()
0x2590,0x2593, -- range1
Style:setGrabMinSize(value)
0x2660,0x266B  -- range2
value = Style:getGrabMinSize()
-- ...
Style:setGrabRounding(value)
},
value = Style:getGrabRounding()
ImGui.GlyphRanges_Cyrillic,
Style:setLogSliderDeadzone(value)
{
value = Style:getLogSliderDeadzone()
0x01C0, 0x01C3 -- range3
Style:setTabRounding(value)
},
value = Style:getTabRounding()
ImGui.GlyphRanges_Korean
Style:setTabBorderSize(value)
},
value = Style:getTabBorderSize()
Style:setTabMinWidthForCloseButton(value)
-- same structure:
value = Style:getTabMinWidthForCloseButton()
ranges = {
Style:setMouseCursorScale(value)
{
value = Style:getMouseCursorScale()
0x2590,0x2593, -- range1
Style:setCurveTessellationTol(value)
0x2660,0x266B, -- range2
value = Style:getCurveTessellationTol()
0x01C0,0x01C3  -- range3
Style:setCircleSegmentMaxError(value)
-- ...
value = Style:getCircleSegmentMaxError()
},  
Style:setWindowPadding(x, y)
ImGui.GlyphRanges_Cyrillic,  
x, y = Style:getWindowPadding()
ImGui.GlyphRanges_Korean
Style:setWindowMinSize(x, y)
}
x, y = Style:getWindowMinSize()
},
Style:setWindowTitleAlign(x, y)
mergeMode = true, -- merge into previous font
x, y = Style:getWindowTitleAlign()
})
Style:setFramePadding(x, y)
fonts:build()
x, y = Style:getFramePadding()
</syntaxhighlight>
Style:setCellPadding(x, y)
 
x, y = Style:getCellPadding()
'''Icons example''':
Style:setItemSpacing(x, y)
<syntaxhighlight lang="lua">
x, y = Style:getItemSpacing()
local icon = utf8.char(0x2590)
Style:setItemInnerSpacing(x, y)
ImGui:text("My icon >>" .. icon .. " << !!!")
x, y = Style:getItemInnerSpacing()
 
Style:setTouchExtraPadding(x, y)
-- or with new Luau support:
x, y = Style:getTouchExtraPadding()
ImGui:text("My icon >> \u{2590} << !!!")
Style:setButtonTextAlign(x, y)
-- can be also stored in memory:
x, y = Style:getButtonTextAlign()
local icon = "\u{2590}"
Style:setSelectableTextAlign(x, y)
</syntaxhighlight>
x, y = Style:getSelectableTextAlign()
 
Style:setDisplayWindowPadding(x, y)
== Font ==
x, y = Style:getDisplayWindowPadding()
<syntaxhighlight lang="lua">
Style:setDisplaySafeAreaPadding(x, y)
number = Font:getSize()
x, y = Style:getDisplaySafeAreaPadding()
FontAtlas = Font:getContainerAtlas()
Style:setWindowMenuButtonPosition(ImGui.Dir)
Font:setScale(number)
dir = Style:getWindowMenuButtonPosition()
number = Font:getScale()
Style:setColorButtonPosition(ImGui.Dir)
number = Font:getAscent()
dir = Style:getColorButtonPosition()
number = Font:getDescent()
Style:setAntiAliasedLines(flag)
bool = Font:isLoaded()
flag = Style:getAntiAliasedLines()
string = Font:getDebugName()
Style:setAntiAliasedLinesUseTex(flag)
w, h = Font:calcTextSizeA(size, max_width, wrap_width, string)
flag = Style:getAntiAliasedLinesUseTex()
Font:calcWordWrapPositionA(scale, string, wrap_width) -- not tested
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>
</syntaxhighlight>


== INPUTS ==
=== DEFAULT STYLES ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:onMouseHover(event)
ImGui:setDarkStyle()
ImGui:onMouseMove(event)
ImGui:setLightStyle()
ImGui:onMouseDown(event)
ImGui:setClassicStyle()
ImGui:onMouseUp(event)
</syntaxhighlight>
ImGui:onMouseWheel(event)


ImGui:onTouchMove(event)
== Render ==
ImGui:onTouchBegin(event)
'''NewFrame'''() start a new Dear ImGui frame, you can submit any command from this point until Render()/EndFrame().
ImGui:onTouchEnd(event)
ImGui:onTouchCancel(event)


ImGui:onKeyUp(event)
'''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!
ImGui:onKeyDown(event)
ImGui:onKeyChar(event)
</syntaxhighlight>


'''Usage examples''':
'''Render'''() ends the Dear ImGui frame, finalize the draw data.
<syntaxhighlight lang="lua">
local UI = ImGui.new(nil, false, false, false)
</syntaxhighlight>


'''Mouse'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
stage:addEventListener("mouseHover", function(e) UI:onMouseHover(e) end)
ImGui:newFrame(deltaTime)
stage:addEventListener("mouseMove", function(e) UI:onMouseMove(e) end)
ImGui:render()
stage:addEventListener("mouseDown", function(e) UI:onMouseDown(e) end)
ImGui:endFrame()
stage:addEventListener("mouseUp", function(e) UI:onMouseUp(e) end)
stage:addEventListener("mouseWheel", function(e) UI:onMouseWheel(e) end)
</syntaxhighlight>
</syntaxhighlight>


'''Touch'''
=== Demos ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
stage:addEventListener("touchesCancel", function(e) ui:onTouchCancel(e) end)
is_openFlag = ImGui:showUserGuide()
stage:addEventListener("touchesMove", function(e) ui:onTouchMove(e) end)
is_openFlag = ImGui:showDemoWindow([p_open])
stage:addEventListener("touchesBegin", function(e) ui:onTouchBegin(e) end)
is_openFlag = ImGui:showAboutWindow([p_open])
stage:addEventListener("touchesEnd", function(e) ui:onTouchEnd(e) end)
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>


'''Keyboard'''
== 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".
 
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
stage:addEventListener("keyUp", function(e) UI:onKeyUp(e) end)
p_open, draw = ImGui:beginWindow(label, p_open [, ImGui.WindowFlags = 0])
stage:addEventListener("keyDown", function(e) UI:onKeyDown(e) end)
-- do not show "X" button
stage:addEventListener("keyChar", function(e) UI:onKeyChar(e) end)
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>


== Style setters/getters ==
=== Child Windows ===
Get style settings instance:
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">
local Style = ImGui:getStyle()
ImGui:beginChild(id [, w = 0, h = 0, borderFlag = false, ImGui.WindowFlags = 0])
ImGui:endChild()
</syntaxhighlight>
</syntaxhighlight>


'''Setters/getters''':
=== 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()).
 
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Style:setColor(ImGui.Col, color, alpha)
flag = ImGui:isWindowAppearing()
color, alpha = Style:getColor(ImGui.Col)
flag = ImGui:isWindowCollapsed()
Style:setAlpha(value)
flag = ImGui:isWindowFocused([ImGui.FocusedFlags = 0])
value = Style:getAlpha()
flag = ImGui:isWindowHovered([ImGui.HoveredFlags = 0])
Style:setWindowRounding(value)
x, y = ImGui:getWindowPos()
value = Style:getWindowRounding()
w, h = ImGui:getWindowSize()
Style:setWindowBorderSize(value)
w = ImGui:getWindowWidth()
value = Style:getWindowBorderSize()
h = ImGui:getWindowHeight()
Style:setChildRounding(value)
x1,y1, x2,y2 = ImGui:getWindowBounds() -- returns window region rectangle in global coordinates
value = Style:getChildRounding()
 
Style:setChildBorderSize(value)
ImGui:setNextWindowPos(x, y [, ImGui.Cond = 0, pivotX = 0, pivotY = 0])
value = Style:getChildBorderSize()
ImGui:setNextWindowSize(w, h [, ImGui.Cond = 0])
Style:setPopupRounding(value)
ImGui:setNextWindowContentSize(w, h)
value = Style:getPopupRounding()
ImGui:setNextWindowCollapsed(flag [, ImGui.Cond = 0])
Style:setPopupBorderSize(value)
ImGui:setNextWindowFocus()
value = Style:getPopupBorderSize()
ImGui:setNextWindowBgAlpha(alpha)
Style:setFrameRounding(value)
ImGui:setNextWindowScroll(x, y)
value = Style:getFrameRounding()
ImGui:setWindowPos(name, x, y [, ImGui.Cond = 0]) OR ImGui:setWindowPos(x, y [, ImGui.Cond = 0])
Style:setFrameBorderSize(value)
ImGui:setWindowSize(name, w, h [, ImGui.Cond = 0]) OR ImGui:setWindowSize(w, h [, ImGui.Cond = 0])
value = Style:getFrameBorderSize()
ImGui:setWindowCollapsed(name, flag [, ImGui.Cond = 0]) OR ImGui:setWindowCollapsed(flag [, ImGui.Cond = 0])
Style:setIndentSpacing(value)
ImGui:setWindowFocus(name) OR ImGui:setWindowFocus()
value = Style:getIndentSpacing()
ImGui:setWindowFontScale(scale)
Style:setColumnsMinSpacing(value)
-- scroll window when touching void
value = Style:getColumnsMinSpacing()
ImGui:scrollWhenDragging(x, y)
Style:setScrollbarSize(value)
</syntaxhighlight>
value = Style:getScrollbarSize()
 
Style:setScrollbarRounding(value)
'''☠️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'''
value = Style:getScrollbarRounding()
 
Style:setGrabMinSize(value)
=== Window size constraints ===
value = Style:getGrabMinSize()
Can be used to set minimum and maximum window size, plus contraint the size if needed.
Style:setGrabRounding(value)
<syntaxhighlight lang="lua">
value = Style:getGrabRounding()
-- call this function before ImGui:beginWindow()
Style:setLogSliderDeadzone(value)
ImGui:setNextWindowSizeConstraints(min_w, min_h, max_w, max_h [, resize_callback, user_data]))
value = Style:getLogSliderDeadzone()
-- resizeCallback is a function:
Style:setTabRounding(value)
function (callbackData [, user_data])
value = Style:getTabRounding()
-- do some math, and return desired size
Style:setTabBorderSize(value)
-- ...
value = Style:getTabBorderSize()
return desired_width, desired_height
Style:setTabMinWidthForCloseButton(value)
end
value = Style:getTabMinWidthForCloseButton()
</syntaxhighlight>
Style:setMouseCursorScale(value)
 
value = Style:getMouseCursorScale()
'''Resize callback''':
Style:setCurveTessellationTol(value)
<syntaxhighlight lang="lua">
value = Style:getCurveTessellationTol()
-- get window position
Style:setCircleSegmentMaxError(value)
x, y = callbackData:getPos()
value = Style:getCircleSegmentMaxError()
x = callbackData:getX()
Style:setWindowPadding(x, y)
y = callbackData:getY()
x, y = Style:getWindowPadding()
 
Style:setWindowMinSize(x, y)
-- get currrent size
x, y = Style:getWindowMinSize()
current_width, current_height = callbackData:getCurrentSize()
Style:setWindowTitleAlign(x, y)
current_width = callbackData:getCurrentWidth()
x, y = Style:getWindowTitleAlign()
current_height = callbackData:getCurrentHeight()
Style:setFramePadding(x, y)
 
x, y = Style:getFramePadding()
-- get desired size
Style:setCellPadding(x, y)
desired_width, desired_height = callbackData:getDesiredSize()
x, y = Style:getCellPadding()
desired_width = callbackData:getDesiredWidth()
Style:setItemSpacing(x, y)
desired_height = callbackData:getDesiredHeight()
x, y = Style:getItemSpacing()
</syntaxhighlight>
Style:setItemInnerSpacing(x, y)
 
x, y = Style:getItemInnerSpacing()
'''Example''':
Style:setTouchExtraPadding(x, y)
<syntaxhighlight lang="lua">
x, y = Style:getTouchExtraPadding()
require "ImGui"
Style:setButtonTextAlign(x, y)
 
x, y = Style:getButtonTextAlign()
local function stepSize(callback_data, step)
Style:setSelectableTextAlign(x, y)
local w, h = callback_data:getDesiredSize()
x, y = Style:getSelectableTextAlign()
w = (w // step) * step
Style:setDisplayWindowPadding(x, y)
h = (h // step) * step
x, y = Style:getDisplayWindowPadding()
return w, h
Style:setDisplaySafeAreaPadding(x, y)
end
x, y = Style:getDisplaySafeAreaPadding()
 
Style:setWindowMenuButtonPosition(ImGui.Dir)
local ui = ImGui.new()
dir = Style:getWindowMenuButtonPosition()
stage:addChild(ui)
Style:setColorButtonPosition(ImGui.Dir)
 
dir = Style:getColorButtonPosition()
stage:addEventListener("enterFrame", function(e)
Style:setAntiAliasedLines(flag)
ui:newFrame(e.deltaTime)
flag = Style:getAntiAliasedLines()
Style:setAntiAliasedLinesUseTex(flag)
-- window size step is 32 (last argument, that is passed to the callback as second argument)
flag = Style:getAntiAliasedLinesUseTex()
ui:setNextWindowSizeConstraints(200, 200, 400, 400, stepSize, 32)
Style:setAntiAliasedFill(flag)
if (ui:beginWindow("My window")) then
flag = Style:getAntiAliasedFill()
Style:setDisabledAlpha(number)
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.")
alpha = Style:getDisabledAlpha()
end
Style:setSeparatorTextBorderSize(number)
ui:endWindow()
number = Style:getSeparatorTextBorderSize()
Style:setSeparatorTextAlign(x, y)
ui:showDemoWindow()
x, y = Style:getSeparatorTextAlign()
Style:setSeparatorTextPadding(x, y)
ui:render()
x, y = Style:getSeparatorTextPadding()
ui:endFrame()
end)
</syntaxhighlight>
</syntaxhighlight>


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


== Color convert ==
'''☠️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'''
'''Note''': use ''DOT'' instead of ''COLON'', so you can use it without creating an ImGui object
 
=== Windows Scrolling ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
r, g, b, a = ImGui.colorConvertHEXtoRGB(color [, alpha = 1])
x = ImGui:getScrollX()
hex = ImGui.colorConvertRGBtoHEX(r, g, b)
y = ImGui:getScrollY()
h, s, v = ImGui.colorConvertRGBtoHSV(r, g, b)
maxX = ImGui:getScrollMaxX()
r, g, b = ImGui.colorConvertHSVtoRGB(h, s, v)
maxY = ImGui:getScrollMaxY()
h, s, v = ImGui.colorConvertHEXtoHSV(hex)
ImGui:setScrollX(value)
hex = ImGui.colorConvertHSVtoHEX(h, s, v)
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])
</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:
 
'''Example'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local IO = ImGui:getIO()
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
</syntaxhighlight>
</syntaxhighlight>


'''Functions''':
== Parameters stacks (shared) ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
IO:setFontDefault(font)
ImGui:pushStyleColor(ImGui.Col, color, alpha) -- https://wiki.gideros.rocks/index.php/Dear_ImGui_Flags#Col
ImGuiConfigFlag = IO:getConfigFlags()
ImGui:popStyleColor([count = 1])
IO:setConfigFlags(ImGui.ConfigFlag)
ImGui:pushStyleVar(ImGui.StyleVar, value) OR ImGui:pushStyleVar(ImGui.StyleVar, value1, value2)
IO:addConfigFlags(ImGui.ConfigFlag)
ImGui:popStyleVar([count = 1])
ImGuiBackendFlag = IO:getBackendFlags()
color, alpha = ImGui:getStyleColor(ImGui.Col)
IO:setBackendFlags(ImGui.BackendFlag)
fontSize = ImGui:getFontSize()
number = IO:getIniSavingRate()
</syntaxhighlight>
IO:setIniSavingRate(number)
 
string = IO:getIniFilename()
=== Parameters stacks (current window) ===
IO:setIniFilename(string)
<syntaxhighlight lang="lua">
IO:saveIniSettings([path]) -- if path is not defined it uses default path, which is set by IO:setIniFilename()
ImGui:pushItemWidth(w)
IO:loadIniSettings([path])
ImGui:popItemWidth()
string = IO:getLogFilename()
ImGui:setNextItemWidth(w)
IO:setLogFilename(string)
w = ImGui:calcItemWidth()
number = IO:getMouseDoubleClickTime()
ImGui:pushTextWrapPos([localX = 0])
IO:setMouseDoubleClickTime(number)
ImGui:popTextWrapPos()
number = IO:getMouseDragThreshold()
ImGui:pushTabStop(flag)
IO:setMouseDragThreshold(number)
ImGui:popTabStop()
flag = IO:getMouseDrawCursor()
ImGui:pushButtonRepeat(flag)
IO:setMouseDrawCursor(flag)
ImGui:popButtonRepeat()
number = IO:getMouseDoubleClickMaxDist()
</syntaxhighlight>
IO:setMouseDoubleClickMaxDist(number)
 
number = IO:getKeyRepeatDelay()
== Cursor / Layout ==
IO:setKeyRepeatDelay(number)
* By "cursor" we mean the current output position.
number = IO:getKeyRepeatRate()
* The typical widget behavior is to output themselves at the current cursor position, then move the cursor one line down.
IO:setKeyRepeatRate(number)
* You can call SameLine() between widgets to undo the last carriage return and output at the right of the preceeding widget.
number = IO:getFontGlobalScale()
* '''Attention'''! We currently have inconsistencies between window-local and absolute positions we will aim to fix with future API:
IO:setFontGlobalScale(number)
** '''Window-local coordinates''': ''SameLine''(), ''GetCursorPos''(), ''SetCursorPos''(), ''GetCursorStartPos''(), ''GetContentRegionMax''(), ''GetWindowContentRegion''*(), ''PushTextWrapPos''()
bool = IO:getFontAllowUserScaling()
** '''Absolute coordinate''': ''GetCursorScreenPos''(), ''SetCursorScreenPos''(), all ImDrawList:: functions
IO:setFontAllowUserScaling(bool)
 
number, number = IO:getDisplayFramebufferScale()
<syntaxhighlight lang="lua">
IO:setDisplayFramebufferScale(number, number)
ImGui:separator()
bool = IO:getConfigMacOSXBehaviors()
ImGui:sameLine([offset_x = 0, spacing = -1])
IO:setConfigMacOSXBehaviors(bool)
ImGui:newLine()
bool = IO:getConfigInputTextCursorBlink()
ImGui:spacing()
IO:setConfigInputTextCursorBlink(bool)
ImGui:dummy(w, h)
bool = IO:getConfigWindowsResizeFromEdges()
ImGui:indent([indent = 0])
IO:setConfigWindowsResizeFromEdges(bool)
ImGui:unindent([indent = 0])
bool = IO:getConfigWindowsMoveFromTitleBarOnly()
ImGui:beginGroup()
IO:setConfigWindowsMoveFromTitleBarOnly(bool)
ImGui:endGroup()
number = IO:getConfigWindowsMemoryCompactTimer()
IO:setConfigWindowsMemoryCompactTimer(number)
x, y = ImGui:getCursorPos()
string = IO:getBackendPlatformName()
x = ImGui:getCursorPosX()
string = IO:getBackendRendererName()
y = ImGui:getCursorPosY()
bool = IO:IsMouseDown(button)
ImGui:setCursorPos(local_x, local_y)
number = IO:getMouseWheel()
ImGui:setCursorPosX(local_x)
number = IO:getMouseWheelH()
ImGui:setCursorPosY(local_y)
flag = IO:wantCaptureMouse()
x, y = ImGui:getCursorStartPos()
flag = IO:wantCaptureKeyboard()
x, y = ImGui:getCursorScreenPos()
flag = IO:wantTextInput()
ImGui:setCursorScreenPos(x, y)
flag = IO:wantSetMousePos()
ImGui:alignTextToFramePadding()
flag = IO:wantSaveIniSettings()
lineH = ImGui:getTextLineHeight()
number = IO:getFramerate()
lineH = ImGui:getTextLineHeightWithSpacing()
number = IO:getMetricsRenderVertices()
frameH = ImGui:getFrameHeight()
number = IO:getMetricsRenderIndices()
frameH = ImGui:getFrameHeightWithSpacing()
number = IO:getMetricsRenderWindows()
</syntaxhighlight>
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()
IO:resetMouseDown() -- reset mouse buttons state
IO:resetKeysDown() -- reset key states (including ALT/SHIFT/CTRL/SUPER (META))
IO:setModKeyDown(key_code, bool) -- set ALT/SHIFT/CTRL/SUPER (META) key state ("key_code" is a gideros MOD key)
IO:setKeysDown(key_code, bool) -- set any key state ("key_code" is a Gideros regular "keyCode")
IO:addInputCharactersUTF8(text) -- adds text to active text input widget
IO:setMouseWheel(number) -- emulate wheel scrolling
IO:setMousePos(x, y) -- sets mouse position (data only, no visual changes)
IO:setMouseDown(mouse_button, state) -- set mouse state, where index: 0 - left mouse, 1 - right, 2 - middle, 3 - unused, 4 - unused ("mouse_button" is a Gideros mouse button code)


IO:addKeyEvent(key, down) -- "key" is any ImGui KeyCode (check keyboard-keys), "down" is a boolean
== ID stack/scopes ==
IO:addKeyAnalogEvent(key, down, number) -- "key" is any ImGui KeyCode (check keyboard-keys), "down" is a boolean
* 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.
IO:addMousePosEvent(x, y)
* The resulting ID are hashes of the entire stack.
IO:addMouseButtonEvent(button, down) -- "button" is any ImGui button (check MouseButton), "down" is a boolean
* You can also use the "Label##foobar" syntax within widget label to distinguish them from each others.
IO:addMouseWheelEvent(x, y)
* 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.


IO:setAppAcceptingEvents([accepting_events = true])
<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])
draw = ImGui:beginWindow(label, nil [, ImGui.WindowFlags = 0]) -- do not show "X" button
flag = ImGui:smallButton(text)
p_open, draw = ImGui:beginFullScreenWindow(label, p_open [, ImGui.WindowFlags = 0]) -- start a window with no borders, no paddings, no rounding and ImGui.WindowFlags_Fullscreen flag
flag = ImGui:invisibleButton(string_ID [, w = 0, h = 0])
draw = ImGui:beginFullScreenWindow(label, nil [, ImGui.WindowFlags = 0]) -- do not show "X" button
flag = ImGui:arrowButton(string_ID [, ImGui.Dir = 0])
ImGui:endWindow()
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>
</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
[, 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])
</syntaxhighlight>
</syntaxhighlight>


=== Child Windows ===
=== Widgets: Combo Box ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:beginChild(id [, w = 0, h = 0, borderFlag = false, ImGui.WindowFlags = 0])
openFlag = ImGui:beginCombo(text, preview_text [, ImGui.ComboFlags = 0])
ImGui:endChild()
ImGui:endCombo()
current_item, is_open = ImGui:combo(label, current_item, items) -- items (table): {"item1", "item2", ...}
</syntaxhighlight>
</syntaxhighlight>


=== Windows Utilities ===
=== Widgets: Drags ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
flag = ImGui:isWindowAppearing()
value, is_changed = ImGui:dragFloat(label, value
flag = ImGui:isWindowCollapsed()
[, inc_step = 1, min = 0, max = 0,
flag = ImGui:isWindowFocused([ImGui.FocusedFlags = 0])
format_string = "%.3f", ImGui.SliderFlags = 0])
flag = ImGui:isWindowHovered([ImGui.HoveredFlags = 0])
 
x, y = ImGui:getWindowPos()
value1, value2, is_changed = ImGui:dragFloat2(label, value1, value2
w, h = ImGui:getWindowSize()
[, inc_step = 1, min = 0, max = 0,
w = ImGui:getWindowWidth()
format_string = "%.3f", ImGui.SliderFlags = 0])
h = ImGui:getWindowHeight()


x1,y1, x2,y2 = ImGui:getWindowBounds() -- returns window region rectangle in global coordinates
value1, value2, value3, is_changed = ImGui:dragFloat3(label, value1, value2, value3
ImGui:setNextWindowPos(x, y [, ImGui.Cond = 0, pivotX = 0, pivotY = 0])
[, inc_step = 1, min = 0, max = 0,
ImGui:setNextWindowSize(w, h [, ImGui.Cond = 0])
format_string = "%.3f", ImGui.SliderFlags = 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)
ImGui:scrollWhenDragging(x, y) -- scroll window when touching void
</syntaxhighlight>


=== Window size constraints ===
value1, value2, value3, value4, is_changed = ImGui:dragFloat4(label, value1, value2, value3, value4
Can be used to set minimum and maximum window size, plus contraint the size if needed.
[, inc_step = 1, min = 0, max = 0,
<syntaxhighlight lang="lua">
format_string = "%.3f", ImGui.SliderFlags = 0])
ImGui:setNextWindowSizeConstraints(min_w, min_h, max_w, max_h [, resize_callback, user_data])) -- call this function before ImGui:beginWindow()
-- resizeCallback is a function:
function (callbackData [, user_data])
-- do some math, and return desired size
-- ...
return desired_width, desired_height
end
</syntaxhighlight>


'''Resize callback''':
value_min, value_max, is_changed = ImGui:dragFloatRange2(label, value_min, value_max
<syntaxhighlight lang="lua">
[, inc_step = 1, min = 0, max = 0,
x, y = callbackData:getPos() -- get window position
format_min_string = "%.3f", ImGui.SliderFlags = 0])
x = callbackData:getX()
-- table must be an array of any size > 0
y = callbackData:getY()
is_changed = ImGui:dragFloatT(label, table
[, inc_step = 1, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])


current_width, current_height = callbackData:getCurrentSize() -- get currrent size
value, is_changed = ImGui:dragInt(label, value
current_width = callbackData:getCurrentWidth()
[, inc_step = 1, min = 0, max = 0,
current_height = callbackData:getCurrentHeight()
format_string = "%d", ImGui.SliderFlags = 0])


desired_width, desired_height = callbackData:getDesiredSize() -- get desired size
value1, value2, is_changed = ImGui:dragInt2(label, value1, value2
desired_width = callbackData:getDesiredWidth()
[, inc_step = 1, min = 0, max = 0,
desired_height = callbackData:getDesiredHeight()
format_string = "%d", ImGui.SliderFlags = 0])
</syntaxhighlight>


'''Example''':
value1, value2, value3, is_changed = ImGui:dragInt3(label, value1, value2, value3
<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, value3, value4, is_changed = ImGui:dragInt4(label, value1, value2, value3, value4
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()
v_current_min, v_current_max, flag = ImGui:dragIntRange2(label, v_current_min, v_current_max
stage:addChild(ui)
[, v_speed = 1, v_min = 0, v_max = 0,
format = "%d", format_max = nil, ImGui.SliderFlags = 0])


stage:addEventListener("enterFrame", function(e)
-- table must be an array of any size > 0
ui:newFrame(e.deltaTime)
is_changed = ImGui:dragIntT(label, table
[, inc_step = 1, min = 0, max = 0,
-- window size step is 32 (last argument, that is passed to the callback as second argument)
format_string = "%d", ImGui.SliderFlags = 0])
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>


=== Content region ===
=== Widgets: Sliders ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
scaleX, scaleY = ImGui:getContentRegionMax()
value, is_changed = ImGui:sliderFloat(label, value
w, h = ImGui:getContentRegionAvail()
[, min = 0, max = 0,
x, y = ImGui:getWindowContentRegionMin()
format_string = "%.3f", ImGui.SliderFlags = 0])
x, y = ImGui:getWindowContentRegionMax()
 
</syntaxhighlight>
value1, value2, is_changed = ImGui:sliderFloat2(label, value1, value2
[, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])


=== Windows Scrolling ===
value1, value2, value3, is_changed = ImGui:sliderFloat3(label, value1, value2, value3
<syntaxhighlight lang="lua">
[, min = 0, max = 0,
x = ImGui:getScrollX()
format_string = "%.3f", ImGui.SliderFlags = 0])
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])
</syntaxhighlight>


=== Parameters stacks (shared) ===
value1, value2, value3, value4, is_changed = ImGui:sliderFloat4(label, value1, value2, value3, value4
<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)
value_in_rad, is_changed = ImGui:sliderAngle(label, value_in_rad
ImGui:popStyleVar([count = 1])
[, min_degrees = -360, max_degrees = 360,
color, alpha = ImGui:getStyleColor(ImGui.Col)
format_string = "%.0f deg", ImGui.SliderFlags = 0])
fontSize = ImGui:getFontSize()
</syntaxhighlight>


=== Parameters stacks (current window) ===
-- table must be an array of any size > 0
<syntaxhighlight lang="lua">
is_changed = ImGui:sliderFloatT(label, table
ImGui:pushItemWidth(w)
[, min = 0, max = 0,
ImGui:popItemWidth()
format_string = "%.3f", ImGui.SliderFlags = 0])
ImGui:setNextItemWidth(w)
w = ImGui:calcItemWidth()
ImGui:pushTextWrapPos([localX = 0])
ImGui:popTextWrapPos()
ImGui:pushTabStop(flag)
ImGui:popTabStop()
ImGui:pushButtonRepeat(flag)
ImGui:popButtonRepeat()
</syntaxhighlight>


=== Cursor / Layout ===
value, is_changed = ImGui:sliderInt(label, value
<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, is_changed = ImGui:sliderInt2(label, value1, value2
<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, is_changed = ImGui:sliderInt3(label, value1, value2, value3
<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)
ImGui:textDisabled(text)
ImGui:textWrapped(text)
ImGui:labelText(text, label)
ImGui:bulletText(text)
ImGui:separatorText(label)
</syntaxhighlight>


=== Widgets: Main ===
value1, value2, value3, value4, is_changed = ImGui:sliderInt4(label, value1, value2, value3, value4
<syntaxhighlight lang="lua">
[, min = 0, max = 0,
flag = ImGui:button(text [, w = 0, h = 0])
format_string = "%d, ImGui.SliderFlags = 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 ===
-- table must be an array of any size > 0
<syntaxhighlight lang="lua">
is_changed = ImGui:sliderIntT(label, table
ImGui:image(texture, w, h [, tint_color = 0xffffff, tint_alpha = 1, border_color = 0xffffff, border_alpha = 0]) -- images are streched (ImGui default functions)
[, min = 0, max = 0,
ImGui:imageUV(texture, w, h, uv0x, uv0y, uv1x, uv1y [, tint_color = 0xffffff, tint_alpha = 1, border_color = 0xffffff, border_alpha = 0]) -- images are streched (ImGui default functions)
format_string = "%d", ImGui.SliderFlags = 0])
pressFlag = ImGui:imageButton(str_id, texture, w, h [, tint_color = 0xffffff, tint_alpha = 1, border_color = 0xffffff, border_alpha = 0]) -- images are streched (ImGui default functions)
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 streched (ImGui default functions)


-- padding deprecated (use "ImGui:pushStyleVar(ImGui.StyleVar_FramePadding, x, y)/ImGui:popStyleVar()")
value, is_changed = ImGui:vSliderFloat(label, w, h, value, min, max
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]) -- images are scaled
[, format_string = "%.3f", ImGui.SliderFlags = 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]) -- images are scaled
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]) -- images are scaled
</syntaxhighlight>


=== Widgets: Combo Box ===
value, is_changed = ImGui:vSliderInt(label, w, h, value, min, max
<syntaxhighlight lang="lua">
[, format_string = "%d", ImGui.SliderFlags = 0])
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 ===
value, is_changed = ImGui:filledSliderFloat(label, mirror_flag, value
<syntaxhighlight lang="lua">
[, min = 0, max = 0,
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  
value1, value2, is_changed = ImGui:filledSliderFloat2(label, mirror_flag, value1, value2
[, inc_step = 1, min = 0, max = 0,  
[, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])
format_string = "%.3f", ImGui.SliderFlags = 0])


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


value1, value2, value3, value4, is_changed = ImGui:dragFloat4(label, value1, value2, value3, value4  
value1, value2, value3, value4, is_changed = ImGui:filledSliderFloat4(label, mirror_flag, value1, value2, value3, value4
[, inc_step = 1, min = 0, max = 0,  
[, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 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
-- table must be an array of any size > 0
is_changed = ImGui:dragFloatT(label, table  
is_changed = ImGui:filledSliderFloatT(label, mirror_flag, table
[, inc_step = 1, min = 0, max = 0,  
[, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])
format_string = "%.3f", ImGui.SliderFlags = 0])


value, is_changed = ImGui:dragInt(label, value  
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 = "%.0f deg", ImGui.SliderFlags = 0])
 
value, is_changed = ImGui:filledSliderInt(label, mirror_flag, value
[, 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, is_changed = ImGui:filledSliderInt2(label, mirror_flag, value1, value2
[, 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, 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, value4, is_changed = ImGui:dragInt4(label, value1, value2, value3, value4
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])
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
-- table must be an array of any size > 0
is_changed = ImGui:dragIntT(label, table  
is_changed = ImGui:filledSliderIntT(label, mirror_flag, table
[, inc_step = 1, min = 0, max = 0,  
[, min = 0, max = 0,
format_string = "%d", ImGui.SliderFlags = 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])
</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, is_changed = ImGui:sliderFloat2(label, value1, value2
value1, value2, flag = ImGui:inputFloat2(label, value1, value2 [, format = "%.3f", ImGui.InputTextFlags = 0])
[, min = 0, max = 0,  
value1, value2, value3, flag = ImGui:inputFloat3(label, value1, value2, value3 [, format = "%.3f", ImGui.InputTextFlags = 0])
format_string = "%.3f", ImGui.SliderFlags = 0])
value1, value2, value3, value4, flag = ImGui:inputFloat4(label, value1, value2, value3, value4 [, format = "%.3f", ImGui.InputTextFlags = 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
-- table must be an array of any size > 0
is_changed = ImGui:sliderFloatT(label, table  
flag = ImGui:inputFloatT(label, table [, format = "%.3f", ImGui.InputTextFlags = 0])
[, min = 0, max = 0,  
value,  flag = ImGui:inputInt(label, value [, step = 0, step_fast = 0, ImGui.InputTextFlags = 0])
format_string = "%.3f", ImGui.SliderFlags = 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>


value, is_changed = ImGui:sliderInt(label, value
'''Input text callbacks''':
[, min = 0, max = 0,  
<syntaxhighlight lang="lua">
format_string = "%d", 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, is_changed = ImGui:sliderInt2(label, value1, value2
callback_function = function(callback_data, user_data)
[, min = 0, max = 0,
-- do something with data
format_string = "%d", ImGui.SliderFlags = 0])
-- see below
end
</syntaxhighlight>


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


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


-- table must be an array of any size > 0
callback_data:setEventChar(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
keyCode = callback_data:getEventKey()
[, format_string = "%.3f", ImGui.SliderFlags = 0])


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


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


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


value1, value2, value3, is_changed = ImGui:filledSliderFloat3(label, mirror_flag, value1, value2, value3
callback_data:setBufTextLen(number)
[, 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
number = callback_data:getBufSize()
[, min = 0, max = 0,
format_string = "%.3f", ImGui.SliderFlags = 0])


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


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


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


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


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


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


-- table must be an array of any size > 0
callback_data:deleteChars(position, bytesCount)
is_changed = ImGui:filledSliderIntT(label, mirror_flag, table
callback_data:insertChars(position, text)
[, min = 0, max = 0,  
</syntaxhighlight>
format_string = "%d", ImGui.SliderFlags = 0])


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


value, is_changed = ImGui:vFilledSliderInt(label, mirror_flag, w, h, value, min, max
ui = ImGui.new()
[, format_string = "%d", ImGui.SliderFlags = 0])
stage:addChild(ui)
</syntaxhighlight>


=== Widgets: Input with Keyboard ===
local testMessage1 = ""
<syntaxhighlight lang="lua">
local testMessage2 = ""
text, flag = ImGui:inputText(label, text, buffer_size [, ImGui.InputTextFlags = 0])
local testMessage3 = ""
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])
</syntaxhighlight>


'''Input text callbacks''':
-- Add ".." at the end of current input string
<syntaxhighlight lang="lua">
function myCallback1(data)
ImGui:inputText(label, text, buffer_size [, ImGui.InputTextFlags = 0, callback_function, user_data])
data:insertChars(data:getCursorPos(), "..")
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
end
</syntaxhighlight>


'''callback_data''':
-- Replace all chars if UP/DOWN arrow is pressed
<syntaxhighlight lang="lua">
function myCallback2(data)
ImGuiInputTextFlags = callback_data:getEventFlag()
local key = data:getEventKey()
ImGuiInputTextFlags = callback_data:getFlags()
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


number = callback_data:getEventChar()
-- 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


callback_data:setEventChar(number)
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


keyCode = callback_data:getEventKey()
stage:addEventListener("enterFrame", enterFrame)
</syntaxhighlight>


string = callback_data:getBuf()
=== Widgets: Color Editor/Picker ===
<syntaxhighlight lang="lua">
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)
</syntaxhighlight>


callback_data:setBuf(string)
=== Widgets: Trees ===
<syntaxhighlight lang="lua">
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)
</syntaxhighlight>


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


callback_data:setBufTextLen(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>


number = callback_data:getBufSize()
=== Widgets: Data Plotting ===
'''Caching''':


callback_data:setBufDirty(bool)
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).
bool = callback_data:isBufDirty()
<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:setCursorPos(number)
-- delete points from memory
number = callback_data:getCursorPos()
ImGui.freePoints(ptr)
</syntaxhighlight>


callback_data:setSelectionStart(s_start)
'''Plot functions''':
number = callback_data:getSelectionStart()
<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:setSelectionEnd(s_end)
ImGui:plotCachedHistogram(label, ptr, len,
s_end = callback_data:getSelectionEnd()
[, values_offset = 0, overlay_text = nil,
scale_min = math.huge, scale_max = math.huge,
w = 0, h = 0])


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


callback_data:selectAll()
ImGui:plotHistogram(label, points_table
callback_data:clearSelection()
[, values_offset = 0, overlay_text = nil,
bool = callback_data:hasSelection()
scale_min = math.huge, scale_max = math.huge,
 
w = 0, h = 0])
callback_data:deleteChars(position, bytesCount)
callback_data:insertChars(position, text)
</syntaxhighlight>
</syntaxhighlight>


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


ui = ImGui.new()
function onEnterFrame()
stage:addChild(ui)
ui:newFrame(e.deltaTime)
 
local testMessage1 = ""
if ui:button("Generate") then
local testMessage2 = ""
deletePtr()
local testMessage3 = ""
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


-- Add ".." at the end of current input string
-- do not forget to clear memory when app is closing
function myCallback1(data)
function onAppExit()
data:insertChars(data:getCursorPos(), "..")
deletePtr()
end
end
</syntaxhighlight>


-- Replace all chars if UP/DOWN arrow is pressed
=== Widgets: Value() Helpers ===
function myCallback2(data)
<syntaxhighlight lang="lua">
local key = data:getEventKey()
ImGui:value(prefix, bool)
if (key == key_code.UP) then
ImGui:value(prefix, number)
data:deleteChars(0, data:getBufTextLen())
ImGui:value(prefix, float, format_string)
data:insertChars(0, "Pressed Up!")
</syntaxhighlight>
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
=== Widgets: Menus ===
function myCallback3(data)
<syntaxhighlight lang="lua">
local buf = data:getBuf()
result? = ImGui:beginMenuBar()
local s = buf:sub(1,1)
ImGui:endMenuBar()
if ((s >= 'a' and s <= 'z') or (s >= 'A' and s <= 'Z')) then
result? = ImGui:beginMainMenuBar()
local first = string.char(string.byte(s) ~ 32)
ImGui:endMainMenuBar()
data:setBuf(first .. buf:sub(2))
result = ImGui:beginMenu(label [, enabled = true])
data:setBufDirty(true)
result = ImGui:beginMenuEx(label, [icon = "", enabled = true])
end
ImGui:endMenu()
end
result = ImGui:menuItem(label [, shortcut = "", selected = false, enabled = true])
result = ImGui:menuItemEx(label, [icon = "", shortcut = "", selected = false, enabled = true])
</syntaxhighlight>
 
=== Widgets: Tooltips ===
Tooltip are windows following the mouse which do not take focus away.
<syntaxhighlight lang="lua">
ImGui:beginTooltip()
ImGui:endTooltip()
ImGui:setTooltip(text)
</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''')


function enterFrame(e)
* 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.
ui:newFrame(e.deltaTime)
* 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.
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)
('''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.
</syntaxhighlight>


=== Widgets: Color Editor/Picker ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
hexColor, is_touching = ImGui:colorEdit3(label, color [, ImGui.ColorEditFlags = 0]) -- alpha ignored, no need to pass it!
result? = ImGui:beginPopup(str_id [, ImGui.WindowFlags = 0])
hexColor, alpha, is_touching = ImGui:colorEdit4(label, color [, alpha = 1, ImGui.ColorEditFlags = 0])
p_open, result? = ImGui:beginPopupModal(str_id, p_open [, ImGui.WindowFlags = 0])
hexColor, is_touching = ImGui:colorPicker3(label, color [, ImGui.ColorEditFlags = 0])
ImGui:endPopup()
hexColor, alpha, originalColor, originalAlpha, is_touching = ImGui:colorPicker4(label, color
ImGui:openPopup(str_id [, ImGui.PopupFlags = 0])
[, alpha = 1, original_color = 0xffffff, original_alpha = 1, ImGui.ColorEditFlags = 0])
ImGui:openPopupOnItemClick(str_id [, ImGui.PopupFlags = 0])
isHoveringFlag = ImGui:colorButton(string_ID, color [, alpha = 1, ImGui.ColorEditFlags = 0, w = 0, h = 0])
ImGui:closeCurrentPopup()
ImGui:setColorEditOptions(ImGui.ColorEditFlags)
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>
</syntaxhighlight>


=== Widgets: Trees ===
== Columns ==
<syntaxhighlight lang="lua">
* You can also use SameLine(pos_x) to mimic simplified columns.
is_openFlag = ImGui:treeNode(label [, format_string])
* The columns API is work-in-progress and rather lacking (columns are arguably the worst part of dear imgui at the moment!)
ImGui:treeNodeEx(label, ImGui.TreeNodeFlags [, format_string])
* There is a maximum of 64 columns.
ImGui:treePush(str_id)
* Currently working on new 'Tables' api which will replace columns around Q2 2020 (see GitHub #2957).
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>


=== Widgets: Selectables ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
result?, selected = ImGui:selectable(label, selected [, ImGui.SelectableFlags = 0, w = 0, h = 0])
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()
</syntaxhighlight>
</syntaxhighlight>


=== Widgets: List Boxes ===
== Tab Bars, Tabs ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- item_table: {"Item0", "Item1", ...}
bool = ImGui:beginTabBar(str_id [, ImGui.TabBarFlags = 0])
current_item, is_openFlag = ImGui:listBox(label, current_item, item_table [, max_visible_items = -1])
ImGui:endTabBar()
result? = ImGui:listBoxHeader(label [, w = 0, h = 0])
p_open, bool = ImGui:beginTabItem(label, p_open [, ImGui.TabItemFlags = 0])
result? = ImGui:listBoxHeader2(label, items_count)
ImGui:endTabItem()
ImGui:listBoxFooter()
ImGui:setTabItemClosed(tab_or_docked_window_label)
ImGui:tabItemButton(label [, ImGui.TabItemFlags = 0])
</syntaxhighlight>
</syntaxhighlight>


=== Widgets: Data Plotting ===
== Logging/Capture ==
'''Caching''':
All text output from the interface can be captured into tty/file/clipboard. By default, tree nodes are automatically opened during logging.
 
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">
<syntaxhighlight lang="lua">
-- store points in memory
ImGui:logToTTY(auto_open_depth = -1)
-- points_table: {0.01, 0.5, 10, -50, ...}
ImGui:logToFile(auto_open_depth = -1, filename = nil)
-- ptr: c++ pointer to a given vector
ImGui:logToClipboard(auto_open_depth = -1)
ptr = ImGui.cachePoints(points_table)
ImGui:logFinish()
 
ImGui:logButtons()  
-- delete points from memory
ImGui:logText(text)  
ImGui.freePoints(ptr)
</syntaxhighlight>
</syntaxhighlight>


'''Plot functions''':
== Drag and drop ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- len (number): points array lenght
flag = ImGui:beginDragDropSource([ImGui.DragDropFlags flags = 0])
ImGui:plotCachedLines(label, ptr, len,
flag = ImGui:setNumDragDropPayload(str_type, number [, ImGui.Cond cond = 0])
[, values_offset = 0, overlay_text = nil,  
flag = ImGui:setStrDragDropPayload(str_type, string [, ImGui.Cond cond = 0])
scale_min = math.huge, scale_max = math.huge,
ImGui:endDragDropSource()
w = 0, h = 0])
flag = ImGui:beginDragDropTarget()
ImGuiPayload = ImGui:acceptDragDropPayload(type [, ImGui.DragDropFlags flags = 0])
ImGui:plotCachedHistogram(label, ptr, len,
ImGui:endDragDropTarget()
[, values_offset = 0, overlay_text = nil,
ImGuiPayload = ImGui:getDragDropPayload()
scale_min = math.huge, scale_max = math.huge,
</syntaxhighlight>
w = 0, h = 0])


ImGui:plotLines(label, points_table
'''Payload''':
[, values_offset = 0, overlay_text = nil,
<syntaxhighlight lang="lua">
scale_min = math.huge, scale_max = math.huge,
number = ImGuiPayload:getNumData()
w = 0, h = 0])
string = ImGuiPayload:getStrData()
 
ImGuiPayload:clear()
ImGui:plotHistogram(label, points_table
number = ImGuiPayload:getDataSize()
[, values_offset = 0, overlay_text = nil,
flag = ImGuiPayload:isDataType(type) -- type must be the same as in "ImGui:acceptDragDropPayload(type)"
scale_min = math.huge, scale_max = math.huge,
flag = ImGuiPayload:isPreview()
w = 0, h = 0])
flag = ImGuiPayload:isDelivery()
</syntaxhighlight>
</syntaxhighlight>


'''Example''':
'''Usage example''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- delete ptr if it exist
require "ImGui"
function deletePtr()
if pointsPtr then
ImGui.freePoints(pointsPtr)
end
end


function onEnterFrame()
local imgui = ImGui.new()
ui:newFrame(e.deltaTime)
stage:addChild(imgui)
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
local names = {
function onAppExit()
"Bobby", "Beatrice", "Betty",
deletePtr()
"Brianna", "Barry", "Bernard",
end
"Bibi", "Blaine", "Bryn"
</syntaxhighlight>
}
-- modes:
local Mode_Copy = 0
local Mode_Move = 1
local Mode_Swap = 2
local mode = 0 -- current mode


== Widgets: Value() Helpers ==
function onEnterFrame(e)
<syntaxhighlight lang="lua">
imgui:newFrame(e.deltaTime)
ImGui:value(prefix, bool)
ImGui:value(prefix, number)
if (imgui:radioButton("Copy", mode == Mode_Copy)) then mode = Mode_Copy end imgui:sameLine()
ImGui:value(prefix, float, format_string)
if (imgui:radioButton("Move", mode == Mode_Move)) then mode = Mode_Move end imgui:sameLine()
</syntaxhighlight>
if (imgui:radioButton("Swap", mode == Mode_Swap)) then mode = Mode_Swap end
 
== Widgets: Menus ==
for i,v in ipairs(names) do
<syntaxhighlight lang="lua">
imgui:pushID(i)
result? = ImGui:beginMenuBar()
if (((i-1) % 3) ~= 0) then imgui:sameLine() end
ImGui:endMenuBar()
result? = ImGui:beginMainMenuBar()
imgui:button(v, 60, 60)
ImGui:endMainMenuBar()
result = ImGui:beginMenu(label [, enabled = true])
if (imgui:beginDragDropSource(ImGui.DragDropFlags_None)) then
result = ImGui:beginMenuEx(label, [icon = "", enabled = true])
--imgui:setStrDragDropPayload("DND_DEMO_CELL", "ID_"..i) -- used for strings
ImGui:endMenu()
imgui:setNumDragDropPayload("DND_DEMO_CELL", i) -- used for numbers
result = ImGui:menuItem(label [, shortcut = "", selected = false, enabled = true])
result = ImGui:menuItemEx(label, [icon = "", shortcut = "", selected = false, enabled = true])
if (mode == Mode_Copy) then imgui:text(("Copy %s"):format(v)) end
ImGui:beginTooltip()
if (mode == Mode_Move) then imgui:text(("Move %s"):format(v)) end
ImGui:endTooltip()
if (mode == Mode_Swap) then imgui:text(("Swap %s"):format(v)) end
ImGui:setTooltip(text)
imgui:endDragDropSource()
</syntaxhighlight>
end
 
== Popups, Modals ==
if (imgui:beginDragDropTarget()) then
<syntaxhighlight lang="lua">
local payload = imgui:acceptDragDropPayload("DND_DEMO_CELL")
result? = ImGui:beginPopup(str_id [, ImGui.WindowFlags = 0])
if (payload) then
p_open, result? = ImGui:beginPopupModal(str_id, p_open [, ImGui.WindowFlags = 0])
--local payload_n = tonumber(payload:getStrData():sub(4)) -- if "setStrDragDropPayload" was used
ImGui:endPopup()
local payload_n = payload:getNumData() -- if "setNumDragDropPayload" was used
ImGui:openPopup(str_id [, ImGui.PopupFlags = 0])
ImGui:openPopupOnItemClick(str_id [, ImGui.PopupFlags = 0])
if (mode == Mode_Copy) then
ImGui:closeCurrentPopup()
names[i] = names[payload_n];
result? = ImGui:beginPopupContextItem(str_id [, ImGui.PopupFlags = 0])
end
result? = ImGui:beginPopupContextWindow(str_id [, ImGui.PopupFlags = 0])
if (mode == Mode_Move) then
result? = ImGui:beginPopupContextVoid(str_id [, ImGui.PopupFlags = 0])
names[i] = names[payload_n];
result? = ImGui:isPopupOpen(str_id [, ImGui.PopupFlags = 0])
names[payload_n] = "";
</syntaxhighlight>
end
 
== Tables ==
if (mode == Mode_Swap) then
<syntaxhighlight lang="lua">
names[i], names[payload_n] = names[payload_n], names[i]
flag = ImGui:beginTable(str_id, column [, ImGui.TableFlags = 0, outer_w = 0, outer_h = 0, inner_width = 0])
end
ImGui:endTable()
end
ImGui:tableNextRow([ImGui.TableRowFlags = 0, min_row_height = 0])
imgui:endDragDropTarget()
flag = ImGui:tableNextColumn()
end
flag = ImGui:tableSetColumnIndex(column_n)
imgui:popID()
ImGui:tableSetupColumn(label [, ImGui.TableColumnFlags = 0, init_width_or_weight = 0, user_id = 0])
end
ImGui:tableSetupScrollFreeze(cols, rows)
imgui:render()
ImGui:tableHeadersRow()
imgui:endFrame()
TableSortSpecs = ImGui:tableGetSortSpecs() -- see below
end
number = ImGui:tableGetColumnCount()
 
number = ImGui:tableGetColumnIndex()
stage:addEventListener("enterFrame", onEnterFrame)
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>
</syntaxhighlight>


== Table sort specs ==
== Clipping ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- TableSortSpecs = ImGui:tableGetSortSpecs()
ImGui:pushClipRect(min_x, min_y, max_x, max_y, intersect_with_current_clip_rect)
number = TableSortSpecs:getSpecsCount()
ImGui:popClipRect()
flag = TableSortSpecs:isSpecsDirty()
TableSortSpecs:setSpecsDirty(flag)
table = TableSortSpecs:getColumnSortSpecs() -- see below
</syntaxhighlight>
</syntaxhighlight>


== Table column sort specs ==
== ImGuiListClipper ==
Try to avoid creating new instances in "enterFrame" event.
 
'''Constructor''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- table = TableSortSpecs:getColumnSortSpecs()
instance = ImGuiListClipper.new()
-- each value of this table is an object that have this 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
</syntaxhighlight>
</syntaxhighlight>
Example: https://github.com/MultiPain/Gideros_examples/blob/master/ImGuiTablesDemo/assets/TablesDemo.lua</br>


== Columns ==
'''Methods''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:columns([count = 1, id = nil, border = true])
ImGuiListClipper:beginClip(number_of_items [, item_height = -1]) -- if item_height <= 0 then it is calculated automatically
ImGui:nextColumn()
ImGuiListClipper:endClip()
index = ImGui:getColumnIndex()
bool = ImGuiListClipper:step()
width = ImGui:getColumnWidth([column_index = -1])
number = ImGuiListClipper:getDisplayStart()
ImGui:setColumnWidth(column_index, width)
number = ImGuiListClipper:getDisplayEnd()
offset = ImGui:getColumnOffset([column_index = -1])
number = ImGuiListClipper:getStartPosY()
ImGui:setColumnOffset(column_index, offset)
number = ImGuiListClipper:getItemsCount()
number = ImGui:getColumnsCount()
ImGuiListClipper:forceDisplayRangeByIndices(number_min, number_max)
</syntaxhighlight>
</syntaxhighlight>


== Tab Bars, Tabs ==
'''Usage example''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool = ImGui:beginTabBar(str_id [, ImGui.TabBarFlags = 0])
require "ImGui"
ImGui:endTabBar()
 
p_open, bool = ImGui:beginTabItem(label, p_open [, ImGui.TabItemFlags = 0])
local imgui = ImGui.new()
ImGui:endTabItem()
stage:addChild(imgui)
ImGui:setTabItemClosed(tab_or_docked_window_label)
ImGui:tabItemButton(label [, ImGui.TabItemFlags = 0])
</syntaxhighlight>


== Logging/Capture ==
clipper = ImGuiListClipper.new()
<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>


== Drag and drop ==
function onEnterFrame(e)
<syntaxhighlight lang="lua">
imgui:newFrame(e.deltaTime)
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()
</syntaxhighlight>


'''Payload''':
if (imgui:beginWindow("Clipper demo")) then
<syntaxhighlight lang="lua">
if (imgui:beginTable("table", 3)) then
number = ImGuiPayload:getNumData()
imgui:tableSetupScrollFreeze(0, 1) -- cols, rows
string = ImGuiPayload:getStrData()
imgui:tableSetupColumn("One")
ImGuiPayload:clear()
imgui:tableSetupColumn("Two")
number = ImGuiPayload:getDataSize()
imgui:tableSetupColumn("Three")
flag = ImGuiPayload:isDataType(type) -- type must be the same as in "ImGui:acceptDragDropPayload(type)"
imgui:tableHeadersRow()
flag = ImGuiPayload:isPreview()
flag = ImGuiPayload:isDelivery()
</syntaxhighlight>


'''Usage example''':
clipper:beginClip(100)
<syntaxhighlight lang="lua">
while (clipper:step()) do
require "ImGui"
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()


local imgui = ImGui.new()
imgui:endTable()
stage:addChild(imgui)
end
end
imgui:endWindow()


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


function onEnterFrame(e)
stage:addEventListener("enterFrame", onEnterFrame)
imgui:newFrame(e.deltaTime)
</syntaxhighlight>
 
if (imgui:radioButton("Copy", mode == Mode_Copy)) then mode = Mode_Copy end imgui:sameLine()
== Context ==
if (imgui:radioButton("Move", mode == Mode_Move)) then mode = Mode_Move end imgui:sameLine()
<syntaxhighlight lang="lua">
if (imgui:radioButton("Swap", mode == Mode_Swap)) then mode = Mode_Swap end
string OR nil = ImGui:getHoveredWindow()
string OR nil = ImGui:getHoveredWindowRoot()
for i,v in ipairs(names) do
string OR nil = ImGui:getHoveredWindowUnderMovingWindow()
imgui:pushID(i)
string OR nil = ImGui:getMovingWindow()
if (((i-1) % 3) ~= 0) then imgui:sameLine() end
string OR nil = ImGui:getActiveIdWindow()
id = ImGui:getActiveId()
imgui:button(v, 60, 60)
id = ImGui:getActiveIdPreviousFrame()
number = ImGui:getActiveIdTimer()
if (imgui:beginDragDropSource(ImGui.DragDropFlags_None)) then
id = ImGui:getActiveIdAllowOverlap()
--imgui:setStrDragDropPayload("DND_DEMO_CELL", "ID_"..i) -- used for strings
id = ImGui:getHoveredId()
imgui:setNumDragDropPayload("DND_DEMO_CELL", i) -- used for numbers
id = ImGui:getHoveredIdPreviousFrame()
number = ImGui:getHoveredIdTimer()
if (mode == Mode_Copy) then imgui:text(("Copy %s"):format(v)) end
id = ImGui:getHoveredIdAllowOverlap()
if (mode == Mode_Move) then imgui:text(("Move %s"):format(v)) end
bool = ImGui:getDragDropActive()
if (mode == Mode_Swap) then imgui:text(("Swap %s"):format(v)) end
id = ImGui:getDragDropPayloadSourceId()
imgui:endDragDropSource()
string = ImGui:getDragDropPayloadDataType()
end
number = ImGui:getDragDropPayloadDataSize()
</syntaxhighlight>
if (imgui:beginDragDropTarget()) then
 
local payload = imgui:acceptDragDropPayload("DND_DEMO_CELL")
== Focus, Activation ==
if (payload) then
* Prefer using "SetItemDefaultFocus()" over "if (IsWindowAppearing()) SetScrollHereY()" when applicable to signify "this is the default item"
--local payload_n = tonumber(payload:getStrData():sub(4)) -- if "setStrDragDropPayload" was used
* Most of the functions are referring to the last/previous item we submitted.
local payload_n = payload:getNumData() -- if "setNumDragDropPayload" was used
* See Demo Window under "Widgets->Querying Status" for an interactive visualization of most of those functions.
 
if (mode == Mode_Copy) then
<syntaxhighlight lang="lua">
names[i] = names[payload_n];
ImGui:setItemDefaultFocus()
end
ImGui:setKeyboardFocusHere([offset = 0])
if (mode == Mode_Move) then
flag = ImGui:isItemHovered([ImGui.HoveredFlags = 0])
names[i] = names[payload_n];
flag = ImGui:isItemActive()
names[payload_n] = "";
flag = ImGui:isItemFocused()
end
flag = ImGui:isItemClicked(mouse_button)
flag = ImGui:isItemVisible()
if (mode == Mode_Swap) then
flag = ImGui:isItemEdited()
names[i], names[payload_n] = names[payload_n], names[i]
flag = ImGui:isItemActivated()
end
flag = ImGui:isItemDeactivated()
end
flag = ImGui:isItemDeactivatedAfterEdit()
imgui:endDragDropTarget()
flag = ImGui:isItemToggledOpen()
end
flag = ImGui:isAnyItemHovered()
imgui:popID()
flag = ImGui:isAnyItemActive()
end
flag = ImGui:isAnyItemFocused()
imgui:render()
minX, minY, maxX, maxY = ImGui:getItemRect()
imgui:endFrame()
x, y = ImGui:getItemRectMin()
end
x, y = ImGui:getItemRectMax()
 
w, h = ImGui:getItemRectSize()
stage:addEventListener("enterFrame", onEnterFrame)
ImGui:setItemAllowOverlap()
</syntaxhighlight>
</syntaxhighlight>


== Clipping ==
== INPUTS ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:pushClipRect(min_x, min_y, max_x, max_y, intersect_with_current_clip_rect)
ImGui:onMouseHover(event)
ImGui:popClipRect()
ImGui:onMouseMove(event)
</syntaxhighlight>
ImGui:onMouseDown(event)
ImGui:onMouseUp(event)
ImGui:onMouseWheel(event)


== ImGuiListClipper ==
ImGui:onTouchMove(event)
Try to avoid creating new instances in "enterFrame" event.
ImGui:onTouchBegin(event)
ImGui:onTouchEnd(event)
ImGui:onTouchCancel(event)


'''Constructor''':
ImGui:onKeyUp(event)
ImGui:onKeyDown(event)
ImGui:onKeyChar(event)
</syntaxhighlight>
 
'''Usage examples''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
instance = ImGuiListClipper.new()
local UI = ImGui.new(nil, false, false, false)
</syntaxhighlight>
</syntaxhighlight>


'''Methods''':
'''Mouse'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGuiListClipper:beginClip(number_of_items [, item_height = -1]) -- if item_height <= 0 then it is calculated automatically
stage:addEventListener("mouseHover", function(e) UI:onMouseHover(e) end)
ImGuiListClipper:endClip()
stage:addEventListener("mouseMove", function(e) UI:onMouseMove(e) end)
bool = ImGuiListClipper:step()
stage:addEventListener("mouseDown", function(e) UI:onMouseDown(e) end)
number = ImGuiListClipper:getDisplayStart()
stage:addEventListener("mouseUp", function(e) UI:onMouseUp(e) end)
number = ImGuiListClipper:getDisplayEnd()
stage:addEventListener("mouseWheel", function(e) UI:onMouseWheel(e) end)
number = ImGuiListClipper:getStartPosY()
number = ImGuiListClipper:getItemsCount()
ImGuiListClipper:forceDisplayRangeByIndices(number_min, number_max)
</syntaxhighlight>
</syntaxhighlight>


'''Usage example''':
'''Touch'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
require "ImGui"
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)
</syntaxhighlight>


local imgui = ImGui.new()
'''Keyboard'''
stage:addChild(imgui)
<syntaxhighlight lang="lua">
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)
</syntaxhighlight>


clipper = ImGuiListClipper.new()
== Miscellaneous Utilities ==
<syntaxhighlight lang="lua">
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()
</syntaxhighlight>


function onEnterFrame(e)
=== Text Utilities ===
imgui:newFrame(e.deltaTime)
<syntaxhighlight lang="lua">
w, h = ImGui:calcTextSize(text [, hide_text_after_double_hash = false, wrap_width = -1])
</syntaxhighlight>


if (imgui:beginWindow("Clipper demo")) then
=== Color convert ===
if (imgui:beginTable("table", 3)) then
'''Note''': use ''DOT'' instead of ''COLON'', so you can use it without creating an ImGui object
imgui:tableSetupScrollFreeze(0, 1) -- cols, rows
<syntaxhighlight lang="lua">
imgui:tableSetupColumn("One")
r, g, b, a = ImGui.colorConvertHEXtoRGB(color [, alpha = 1])
imgui:tableSetupColumn("Two")
hex = ImGui.colorConvertRGBtoHEX(r, g, b)
imgui:tableSetupColumn("Three")
h, s, v = ImGui.colorConvertRGBtoHSV(r, g, b)
imgui:tableHeadersRow()
r, g, b = ImGui.colorConvertHSVtoRGB(h, s, v)
h, s, v = ImGui.colorConvertHEXtoHSV(hex)
hex = ImGui.colorConvertHSVtoHEX(h, s, v)
</syntaxhighlight>


clipper:beginClip(100)
=== Inputs Utilities: Keyboard ===
while (clipper:step()) do
* For 'int user_key_index' you can use your own indices/enums according to how your backend/engine stored them in io.KeysDown[].
for row = clipper:getDisplayStart(), clipper:getDisplayEnd() do
* We don't know the meaning of those value. You can use GetKeyIndex() to map a ImGuiKey_ value into the user index.
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()
<syntaxhighlight lang="lua">
end
string = ImGui:getKeyName(keyCode)
end
flag = ImGui:isKeyDown(keyCode)
imgui:endWindow()
flag = ImGui:isKeyPressed(keyCode [, repeat = true])
flag = ImGui:isKeyReleased(keyCode)
number = ImGui:getKeyPressedAmount(keyCode, repeat_delay, rate)
ImGui:setNextFrameWantCaptureKeyboard([want_capture_keyboard_value = true])
</syntaxhighlight>


imgui:endFrame()
=== Shortcut system ===
imgui:render()
<syntaxhighlight lang="lua">
end
-- (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])


stage:addEventListener("enterFrame", onEnterFrame)
-- (useful to disable CTRL + TAB combo: ImGui:setShortcutRouting(ImGui.Mod_Ctrl | ImGui.Key_Tab, ImGui.KeyOwner_None))
</syntaxhighlight>
ImGui:setShortcutRouting(keyChord [, owner_id = 0, ImGui.InputFlags = 0])


== ImGuiTextFilter ==
ImGui:setItemKeyOwner(keyCode [, ImGui.InputFlags = 0])
Try to avoid creating new instaces in "enterFrame" event.


'''Constructor''':
ImGui:setKeyOwner(keyCode, owner_id, [, ImGui.InputFlags = 0])
<syntaxhighlight lang="lua">
filter = ImGuiTextFilter.new()
</syntaxhighlight>
</syntaxhighlight>


'''Methods''':
'''Focused window and global application ''button'' shortcut example'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- draws the input field
require "ImGui"
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
local imgui = ImGui.new()
filter:build() -- update filter internals (see example below)
stage:addChild(imgui)
bool = filter:passFilter(text) -- returns true if filter input matches with "text"
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)
</syntaxhighlight>
</syntaxhighlight>


'''Usage example 1''':</br>
'''Global application ''checkbox'' shortcut example'''
https://github.com/MultiPain/Gideros_ImGui/blob/master/imgui_src/imgui_demo.cpp#L5657
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
require "ImGui"
require "ImGui"
Line 1,397: Line 1,445:
local imgui = ImGui.new()
local imgui = ImGui.new()
stage:addChild(imgui)
stage:addChild(imgui)
imgui:setClassicStyle()


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


function onEnterFrame(e)
function onEnterFrame(e)
imgui:newFrame(e.deltaTime)
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


if (imgui:beginWindow("Filter demo")) then
imgui:render()
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:endFrame()
imgui:render()
end
end


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


'''Usage example 2''':
=== 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')
 
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
require "ImGui"
-- "mouse_button" is any gideros mouse button code
 
flag = ImGui:isMouseDown(mouse_button)
local imgui = ImGui.new()
flag = ImGui:isMouseClicked(mouse_button [, repeat = false]) -- "mouse_button" is any gideros mouse button code
stage:addChild(imgui)
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
local filter = ImGuiTextFilter.new()
flag = ImGui:isMouseHoveringRect(min_x, min_y, max_x, max_y [, clip = true])
local searchText = ""
flag = ImGui:isMousePosValid([x = inf, y = inf])
local items = { "aaa1.c", "bbb1.c", "ccc1.c", "aaa2.cpp", "bbb2.cpp", "ccc2.cpp", "abc.h", "hello, world" }
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>


function onEnterFrame(e)
== FONTS ==
imgui:newFrame(e.deltaTime)
<syntaxhighlight lang="lua">
IO = imgui:getIO()
FontAtlas = IO:getFonts()


-- draw standart text input control
Font = FontAtlas:addFont(ttf_font_path, font_size [, options])
-- 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
-- options (table): all parameters are optional
if not filter:passFilter(item) then
--     fontDataOwnedByAtlas - bool
continue
--     pixelSnapH - bool
end
--     mergeMode - bool
imgui:bulletText(item)
--     fontNo - number
end
--     oversampleH - number
 
--     oversampleV - number
imgui:endFrame()
--     glyphExtraSpacingX - number
imgui:render()
--     glyphExtraSpacingY - number
end
--     glyphOffsetX - number
 
--     glyphOffsetY - number
stage:addEventListener("enterFrame", onEnterFrame)
--     glyphMinAdvanceX - number
</syntaxhighlight>
--     glyphMaxAdvanceX - number
 
--     rasterizerFlags - number
== Focus, Activation ==
--     rasterizerMultiply - number
<syntaxhighlight lang="lua">
--
ImGui:setItemDefaultFocus()
--     glyphs - table:
ImGui:setKeyboardFocusHere([offset = 0])
--     text(string): represents available chars
flag = ImGui:isItemHovered([ImGui.HoveredFlags = 0])
--     chars(table): list of specific char code (example: {0x7262, ...})
flag = ImGui:isItemActive()
--     ranges(table): predefined glyph ranges (example: {ImGui.GlyphRanges_Default, ImGui.GlyphRanges_Japanese, ...})
flag = ImGui:isItemFocused()
FontAtlas:addFonts(fontsDescription)
flag = ImGui:isItemClicked(mouse_button)
-- fontsDescriptions(table):
flag = ImGui:isItemVisible()
--      description(table):
flag = ImGui:isItemEdited()
--          ttf_font_path(string): path to a font
flag = ImGui:isItemActivated()
--          font_size(number): font size
flag = ImGui:isItemDeactivated()
--          options(table): see description above
flag = ImGui:isItemDeactivatedAfterEdit()
-- example:
flag = ImGui:isItemToggledOpen()
-- FontAtlas:addFonts{ {"fonts/DroidSans.ttf", 16}, {"fonts/ProggyTiny.ttf", 16} }
flag = ImGui:isAnyItemHovered()
 
flag = ImGui:isAnyItemActive()
Font = FontAtlas:getFont([index]) -- get font by index (if index is 0 or nil you will get default font instance)
flag = ImGui:isAnyItemFocused()
FontAtlas:build() -- call after multiple FontAtlas:addFont(...) calls to update ImGui font atlas
minX, minY, maxX, maxY = ImGui:getItemRect()
FontAtlas:clearInputData()
x, y = ImGui:getItemRectMin()
FontAtlas:clearTexData()
x, y = ImGui:getItemRectMax()
FontAtlas:clearFonts()
w, h = ImGui:getItemRectSize()
FontAtlas:clear()
ImGui:setItemAllowOverlap()
table = FontAtlas:getFonts() -- returns a table with all fonts (included default)
</syntaxhighlight>
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)


== Miscellaneous Utilities ==
ImGui:pushFont(font) -- font (table): object returned by FontAtlas:addFont(...) or FontAtlas:getFont([index])
<syntaxhighlight lang="lua">
ImGui:popFont()
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()
</syntaxhighlight>
</syntaxhighlight>


== Text Utilities ==
'''Minimal example''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
w, h = ImGui:calcTextSize(text [, hide_text_after_double_hash = false, wrap_width = -1])
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
</syntaxhighlight>
</syntaxhighlight>


== Inputs Utilities: Keyboard ==
'''Glyphs example''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string = ImGui:getKeyName(keyCode)
local fonts = io:getFonts()
flag = ImGui:isKeyDown(keyCode)
fonts:addFont(font_path, font_size, {
flag = ImGui:isKeyPressed(keyCode [, repeat = true])
glyphs = {
flag = ImGui:isKeyReleased(keyCode)
ranges = {
number = ImGui:getKeyPressedAmount(keyCode, repeat_delay, rate)
{
ImGui:setNextFrameWantCaptureKeyboard([want_capture_keyboard_value = true])
0x2590,0x2593, -- range1
</syntaxhighlight>
0x2660,0x266B  -- range2
 
-- ...
== Shortcut system ==
},
<syntaxhighlight lang="lua">
ImGui.GlyphRanges_Cyrillic,
-- (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])
0x01C0, 0x01C3 -- range3
 
},
-- (useful to disable CTRL + TAB combo: ImGui:setShortcutRouting(ImGui.Mod_Ctrl | ImGui.Key_Tab, ImGui.KeyOwner_None))
ImGui.GlyphRanges_Korean
ImGui:setShortcutRouting(keyChord [, owner_id = 0, ImGui.InputFlags = 0])
},
-- 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()
</syntaxhighlight>


ImGui:setItemKeyOwner(keyCode [, ImGui.InputFlags = 0])
'''Icons example''':
<syntaxhighlight lang="lua">
local icon = utf8.char(0x2590)
ImGui:text("My icon >>" .. icon .. " << !!!")


ImGui:setKeyOwner(keyCode, owner_id, [, ImGui.InputFlags = 0])
-- or with new Luau support:
ImGui:text("My icon >> \u{2590} << !!!")
-- can be also stored in memory:
local icon = "\u{2590}"
</syntaxhighlight>
</syntaxhighlight>


== Inputs Utilities: Mouse ==
=== Font ===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- "mouse_button" is any gideros mouse button code
number = Font:getSize()
flag = ImGui:isMouseDown(mouse_button)
FontAtlas = Font:getContainerAtlas()
flag = ImGui:isMouseClicked(mouse_button [, repeat = false])
Font:setScale(number)
flag = ImGui:isMouseReleased(mouse_button)
number = Font:getScale()
flag = ImGui:isMouseDoubleClicked(mouse_button)
number = Font:getAscent()
flag = ImGui:isMouseHoveringRect(min_x, min_y, max_x, max_y [, clip = true])
number = Font:getDescent()
flag = ImGui:isMousePosValid([x = inf, y = inf])
bool = Font:isLoaded()
flag = ImGui:isAnyMouseDown()
string = Font:getDebugName()
x, y = ImGui:getMousePos()
w, h = Font:calcTextSizeA(size, max_width, wrap_width, string)
x, y = ImGui:getMousePosOnOpeningCurrentPopup()
Font:calcWordWrapPositionA(scale, string, wrap_width) -- not tested
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>


== Render ==
== Tables ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ImGui:newFrame(deltaTime)
flag = ImGui:beginTable(str_id, column [, ImGui.TableFlags = 0, outer_w = 0, outer_h = 0, inner_width = 0])
ImGui:render()
ImGui:endTable()
ImGui:endFrame()
ImGui:tableNextRow([ImGui.TableRowFlags = 0, min_row_height = 0])
</syntaxhighlight>
flag = ImGui:tableNextColumn()
 
flag = ImGui:tableSetColumnIndex(column_n)
== Demos ==
ImGui:tableSetupColumn(label [, ImGui.TableColumnFlags = 0, init_width_or_weight = 0, user_id = 0])
<syntaxhighlight lang="lua">
ImGui:tableSetupScrollFreeze(cols, rows)
is_openFlag = ImGui:showUserGuide()
ImGui:tableHeadersRow()
is_openFlag = ImGui:showDemoWindow([p_open])
TableSortSpecs = ImGui:tableGetSortSpecs() -- see below
is_openFlag = ImGui:showAboutWindow([p_open])
number = ImGui:tableGetColumnCount()
is_openFlag = ImGui:showStyleEditor()
number = ImGui:tableGetColumnIndex()
is_openFlag = ImGui:showFontSelector()
number = ImGui:tableGetRowIndex()
is_openFlag = ImGui:showMetricsWindow([p_open])
string = ImGui:tableGetColumnName([column_n = -1])
is_openFlag = ImGui:showStyleSelector(label)
ImGuiTableColumnFlags = ImGui:tableGetColumnFlags([column_n = -1])
is_openFlag = ImGui:ShowStackToolWindow([p_open])
ImGui:tableSetBgColor(ImGui.TableBgTarget, color [, alpha = 1, column_n = -1])
ImGui:showLuaStyleEditor()
</syntaxhighlight>
</syntaxhighlight>
 
 
=== Table sort specs ===
== TextEditor ==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
number = TableSortSpecs:getSpecsCount() -- TableSortSpecs = ImGui:tableGetSortSpecs()
-- otherTextEditor: another "ImGuiTextEditor" instance to copy setting  
flag = TableSortSpecs:isSpecsDirty() -- TableSortSpecs = ImGui:tableGetSortSpecs()
TextEditor = ImGuiTextEditor.new([other_text_editor])
TableSortSpecs:setSpecsDirty(flag) -- TableSortSpecs = ImGui:tableGetSortSpecs()
</syntaxhighlight>
table = TableSortSpecs:getColumnSortSpecs() -- TableSortSpecs = ImGui:tableGetSortSpecs(), see below
 
</syntaxhighlight>
'''Functions''':
 
<syntaxhighlight lang="lua">
=== Table column sort specs ===
LanguageDefinition = TextEditor:getLanguageCPP()
<syntaxhighlight lang="lua">
LanguageDefinition = TextEditor:getLanguageGLSL()
-- table = TableSortSpecs:getColumnSortSpecs()
LanguageDefinition = TextEditor:getLanguageHLSL()
-- each value of this table is an object that have these functions:
LanguageDefinition = TextEditor:getLanguageC()
number = item:getColumnUserID()
LanguageDefinition = TextEditor:getLanguageSQL()
number = item:getColumnIndex() -- 0 based
LanguageDefinition = TextEditor:getLanguageAngelScript()
number = item:getSortOrder() -- used in multi sorted tables
LanguageDefinition = TextEditor:getLanguageLua()
number = item:getSortDirection() -- ImGui.SortDirection_Ascending OR ImGui.SortDirection_Descending
 
</syntaxhighlight>
TextEditor:setLanguageDefinition(LanguageDefinition)
Example: https://github.com/MultiPain/Gideros_examples/blob/master/ImGuiTablesDemo/assets/TablesDemo.lua</br>
LanguageDefinition = TextEditor:getLanguageDefinition()
 
 
== ImGuiTextFilter ==
Palette = TextEditor:getPaletteDark()
Try to avoid creating new instaces in "enterFrame" event.
Palette = TextEditor:getPaletteLight()
 
Palette = TextEditor:getPaletteRetro()
'''Constructor''':
 
<syntaxhighlight lang="lua">
TextEditor:setPalette(Palette)
filter = ImGuiTextFilter.new()
Palette = TextEditor:getPalette()
</syntaxhighlight>
 
 
TextEditor:setPaletteColor(TE_ColorIndex, color [, alpha = 1]) -- see TextEditor enums below
'''Methods''':
color, alpha = TextEditor:getPaletteColor(TE_ColorIndex)
<syntaxhighlight lang="lua">
 
-- 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"
</syntaxhighlight>
 
'''Usage example 1''':
<syntaxhighlight lang="lua">
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)
</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
TextEditor:loadPalette(table) -- 42 elements table
-- example:
-- example:
Line 1,728: 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,914: 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