README.md

LOVE-IMGUI

A partial rewrite of slage's bindings to imgui. This is not compatible, and makes deviations in API design.

Getting Started

Just build the project, and copy the generated dynamic module next to your love executable or into the LÖVE application data folder (for instance C:/Users/<user>/AppData/Roaming/LOVE on Windows or ~/.local/shared/love on Linux).

Pre-built binaries for Windows and Mas OSX are provided in the releases page.

Differences

• New bindings generator implementation. While not an explicit API difference, the output may diverge unintentionally!
• return order is out-parameters first, return value last. This is not configurable.
• We're taking a maximalist approach to enums. All of these are valid and interchangable with no configuration necessary:

imgui.Begin("MyWindow", true, "AlwaysAutoResize|NoTitleBar")
imgui.Begin("MyWindow", true, {"AlwaysAutoResize", "NoTitleBar"})
imgui.Begin("MyWindow", true, {AlwaysAutoResize = true, NoTitleBar = true})

What's supported

This is a manually updated section, and may be out of date! Feel free to smack me if it is

On this branch, we're tracking the Docking branch of imgui. Everything besides the things I'm about to call out are usable:

• manual manipulation of drawlists
• Input text callbacks are only partially supported
• getter-based APIs for Combo() and ListBox() and PlotLines()
• drag-and-drop API

The direct list of functions unimplemented:

unimplemented function: GetIO
unimplemented function: GetWindowDrawList
unimplemented function: GetDrawData
unimplemented function: GetDragDropPayload
unimplemented function: LoadIniSettingsFromMemory
unimplemented function: GetMainViewport
unimplemented function: GetFont
unimplemented function: SetStateStorage
unimplemented function: GetWindowViewport
unimplemented function: FindViewportByPlatformHandle
unimplemented function: GetBackgroundDrawList
unimplemented function: SetNextWindowSizeConstraints
unimplemented function: GetDrawListSharedData
unimplemented function: PushFont
unimplemented function: GetForegroundDrawList
unimplemented function: SetDragDropPayload
unimplemented function: GetStateStorage
unimplemented function: RenderPlatformWindowsDefault
unimplemented function: SetNextWindowClass
unimplemented function: AcceptDragDropPayload
unimplemented function: GetPlatformIO
unimplemented function: SaveIniSettingsToMemory
unimplemented function: FindViewportByID

List of functions explicitly ignored:

-- C++ debug only
["DebugCheckVersionAndDataLayout"] = true,
-- allocation strategy is a C++ native thing
["SetAllocatorFunctions"] = true,
["MemAlloc"] = true,
["MemFree"] = true,
-- lua only supports doubles, no need for arbitrary type sizes
["DragScalar"] = true,
["DragScalarN"] = true,
["SliderScalar"] = true,
["SliderScalarN"] = true,
["VSliderScalar"] = true,
["InputScalar"] = true,
["InputScalarN"] = true,
-- color functions: use platform native equivalents instead
["GetColorU32"] = true,
["ColorConvertHSVtoRGB"] = true,
["ColorConvertFloat4ToU32"] = true,
["ColorConvertFloatu32ToFloat4"] = true,

Examples

Simple integration:

require "imgui"

local showTestWindow = false
local showAnotherWindow = false
local floatValue = 0
local sliderFloat = { 0.1, 0.5 }
local clearColor = { 0.2, 0.2, 0.2 }
local comboSelection = 1
local textValue = "text"

--
-- LOVE callbacks
--
function love.load(arg)
end

function love.update(dt)
    imgui.NewFrame()
end

function love.draw()

    -- Menu
    if imgui.BeginMainMenuBar() then
        if imgui.BeginMenu("File") then
            imgui.MenuItem("Test")
            imgui.EndMenu()
        end
        imgui.EndMainMenuBar()
    end

    -- Debug window
    imgui.Text("Hello, world!")
    clearColor[1], clearColor[2], clearColor[3] = imgui.ColorEdit3("Clear color", clearColor[1], clearColor[2], clearColor[3])
    
    -- Sliders
    floatValue = imgui.SliderFloat("SliderFloat", floatValue, 0.0, 1.0)
    sliderFloat[1], sliderFloat[2] = imgui.SliderFloat2("SliderFloat2", sliderFloat[1], sliderFloat[2], 0.0, 1.0)
    
    -- Combo
    comboSelection = imgui.Combo("Combo", comboSelection, { "combo1", "combo2", "combo3", "combo4" }, 4)

    -- Windows
    if imgui.Button("Test Window") then
        showTestWindow = not showTestWindow
    end
    
    if imgui.Button("Another Window") then
        showAnotherWindow = not showAnotherWindow
    end
    
    if showAnotherWindow then
        imgui.SetNextWindowPos(50, 50, "FirstUseEver")
        showAnotherWindow = imgui.Begin("Another Window", true, "AlwaysAutoResize|NoTitleBar")
        imgui.Text("Hello")
        -- Input text
        textValue = imgui.InputTextMultiline("InputText", textValue, 200, 300, 200)
        imgui.End()
    end

    if showTestWindow then
        showTestWindow = imgui.ShowDemoWindow(true)
    end

    love.graphics.clear(clearColor)
    imgui.Render()
end

function love.quit()
    imgui.ShutDown()
end

--
-- User inputs
--
function love.textinput(t)
    imgui.TextInput(t)
    if not imgui.GetWantCaptureKeyboard() then
        -- Pass event to the game
    end
end

function love.keypressed(key)
    imgui.KeyPressed(key)
    if not imgui.GetWantCaptureKeyboard() then
        -- Pass event to the game
    end
end

function love.keyreleased(key)
    imgui.KeyReleased(key)
    if not imgui.GetWantCaptureKeyboard() then
        -- Pass event to the game
    end
end

function love.mousemoved(x, y)
    imgui.MouseMoved(x, y)
    if not imgui.GetWantCaptureMouse() then
        -- Pass event to the game
    end
end

function love.mousepressed(x, y, button)
    imgui.MousePressed(button)
    if not imgui.GetWantCaptureMouse() then
        -- Pass event to the game
    end
end

function love.mousereleased(x, y, button)
    imgui.MouseReleased(button)
    if not imgui.GetWantCaptureMouse() then
        -- Pass event to the game
    end
end

function love.wheelmoved(x, y)
    imgui.WheelMoved(y)
    if not imgui.GetWantCaptureMouse() then
        -- Pass event to the game
    end
end