Wraps ImGuiContext*.

Wraps ImGui::CreateContext().

Wraps ImGui::DestroyContext().

Wraps ImGui::GetCurrentContext().

Wraps ImGui::SetCurrentContext().

Start a new Dear ImGui frame, you can submit any command from this point until render/endFrame.

Wraps ImGui::NewFrame().

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!

Ends the Dear ImGui frame, finalize the draw data. You can then get call getDrawData.

Wraps ImDrawData*.

Valid after render and until the next call to newFrame. This is what you have to render.

Wraps IMGUI_CHECKVERSION()

Create demo window. Demonstrate most ImGui features. Call this to learn about the library! Try to make it always available in your application!

Create Stack Tool window. hover items with mouse to query information about the source of their unique ID.

Create Metrics/Debugger window. Display Dear ImGui internals: windows, draw commands, various internal state, etc.

Create About window. display Dear ImGui version, credits and build/system information.

Add style selector block (not a window), essentially a combo listing the default styles.

Add font selector block (not a window), essentially a combo listing the loaded fonts.

Add basic help/info block (not a window): how to manipulate ImGui as a end-user (mouse/keyboard controls).

Get the compiled version string e.g. "1.80 WIP" (essentially the value for IMGUI_VERSION from the compiled version of imgui.cpp).

Create Debug Log window. display a simplified log of important dear imgui events.

Helper to display buttons for logging to ttyfileclipboard.

Send text to logs.

New, recommended style (default).

Wraps ImGui::StyleColorsDark().

Best used with borders and a custom, thicker font.

Wraps ImGui::StyleColorsLight().

Classic ImGui style.

Wraps ImGui::StyleColorsClasic().

Append items to a window.

Action will get False if the window is collapsed or fully clipped.

You may append multiple times to the same window during the same frame by calling withWindow in multiple places.

Append items to a window unless it is collapsed or fully clipped.

You may append multiple times to the same window during the same frame by calling withWindowOpen in multiple places.

Append items to a closeable window unless it is collapsed or fully clipped.

You may append multiple times to the same window during the same frame by calling withWindowOpen in multiple places.

The Bool state variable will be set to False when the window's close button is pressed.

Append items to a fullscreen window.

The action runs inside a window that is set to behave as a backdrop. It has no typical window decorations, ignores events and does not jump to front.

You may append multiple times to it during the same frame by calling withFullscreen in multiple places.

Push window to the stack and start appending to it.

Returns 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!

Wraps ImGui::Begin() with default options.

Pop window from the stack.

Wraps ImGui::End().

Get draw list associated to the current window.

Get current window position in screen space.

Useful if you want to do your own drawing via the DrawList API.

Set next window position. Call before begin Use pivot=(0.5,0.5) to center on given point, etc.

Wraps ImGui::SetNextWindowPos()

Set next window size. Call before begin

Wraps ImGui::SetNextWindowSize()

Set next window size and position to match current display size.

Call before begin.

Wraps ImGui::SetNextWindowPos(), ImGui::SetNextWindowSize()

Set next window content size (~ scrollable client area, which enforce the range of scrollbars). Not including window decorations (title bar, menu bar, etc.) nor WindowPadding. call before begin

Wraps ImGui::SetNextWindowContentSize()

Set next window size limits. use -1,-1 on either X/Y axis to preserve the current size. Sizes will be rounded down.

Wraps ImGui::SetNextWindowContentSize()

Set next window collapsed state. call before begin

Wraps ImGui::SetNextWindowCollapsed()

Set next window to be focused / top-most. call before begin

Set next window background color alpha. helper to easily override the Alpha component of ImGuiCol_WindowBg, ChildBg, PopupBg. you may also use ImGuiWindowFlags_NoBackground.

Wraps ImGui::SetNextWindowBgAlpha()

Retrieve available space from a given point.

== GetContentRegionMax() - GetCursorPos()

Current content boundaries (typically window boundaries including scrolling, or current column boundaries), in window coordinates.

Content boundaries min for the full window (roughly (0,0) - Scroll), in window coordinates.

Content boundaries max for the full window (roughly (0,0) + Size - Scroll) where Size can be overridden with SetNextWindowContentSize(), in window coordinates.

Action wrapper for child windows.

Action will get False if the child region is collapsed or fully clipped.

Action-skipping wrapper for child windows.

Action will be skipped if the child region is collapsed or fully clipped.

Action wrapper to run in a context of another child window addressed by its name.

Action will get False if the child region is collapsed or fully clipped.

Begin 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.

Always call a matching endChild for each beginChild call, regardless of its return value.

Wraps ImGui::BeginChild().

Wraps ImGui::EndChild().

Modify a style color by pushing to the shared stack.

Always use this if you modify the style after newFrame.

Wraps ImGui::PushStyleColor()

Remove style color modifications from the shared stack

Wraps ImGui::PopStyleColor()

Modify a style variable by pushing to the shared stack.

Always use this if you modify the style after newFrame.

Wraps ImGui::PushStyleVar()

Remove style variable modifications from the shared stack

Wraps ImGui::PopStyleVar()

Allow focusing using TAB/Shift-TAB, enabled by default but you can disable it for certain widgets.

Render widgets inside the block using provided font.

Pushes a font into the parameters stack, so ImGui would render following text using it.

Pops a font pushed into the parameters stack

Should be called only after a corresponding pushFont call.

Font runtime data handle

Wraps ImFont*.

Separator, generally horizontal. inside a menu bar or in horizontal layout mode, this becomes a vertical separator.

Wraps ImGui::Separator()

Call between widgets or groups to layout them horizontally.

Wraps ImGui::SameLine.

undo a sameLine or force a new line when in an horizontal-layout context.

Wraps ImGui::NewLine()

Add vertical spacing.

Wraps ImGui::Spacing()

Add a dummy item of given size. unlike invisibleButton, dummy won't take the mouse click or be navigable into.

Wraps ImGui::Dummy()

Move content position toward the right, by indent_w, or style.IndentSpacing if indent_w <= 0

Wraps ImGui::Indent()

Move content position back to the left, by indent_w, or style.IndentSpacing if indent_w <= 0

Wraps ImGui::Unindent()

Affect large frame+labels widgets only.

Wraps ImGui::SetNextItemWidth()

Width of item given pushed settings and current cursor position. NOT necessarily the width of last item unlike most Item functions.

Push word-wrapping position for Text commands.

Negative: no wrapping. Zero: wrap to end of window (or column). Positive: wrap at wrap_pos_x position in window local space.

Lock horizontal starting position

Wraps ImGui::BeginGroup() and ImGui::EndGroup()

lock horizontal starting position

Wraps ImGui::BeginGroup()

unlock horizontal starting position + capture the whole group bounding box into one "item" (so you can use isItemHovered or layout primitives such as sameLine on whole group, etc.)

Wraps ImGui::EndGroup()

Set cursor position in window-local coordinates

Wraps ImGui::SetCursorPos()

Get cursor position in window-local coordinates.

Useful to overlap draw using setCursorPos.

Wraps ImGui::SetCursorPos()

Initial cursor position, in window coordinates.

Vertically align upcoming text baseline to FramePadding.y so that it will align properly to regularly framed items (call if you have text on a line before a framed item)

Wraps ImGui::AlignTextToFramePadding()

Add an element to a ID stack

Read the FAQ (http:/dearimgui.orgfaq) for more details about how ID are handled in dear imgui.

Those questions are answered and impacted by understanding of the ID stack system: * "Q: Why is my widget not reacting when I click on it?" * "Q: How can I have widgets with an empty label?" * "Q: How can I have multiple widgets with the same label?"

Wraps ImGui::PushId and ImGui::PopId

A supplementary class to match overloaded functions in C++ the library.

Plain text.

Colored text.

Plain text in a "disabled" color according to current style.

Plain text with a word-wrap capability.

Note that this won't work on an auto-resizing window if there's no other widgets to extend the window width, you may need to set a size using setNextWindowSize.

Label+text combo aligned to other label+value widgets.

Text with a little bullet aligned to the typical tree node.

Text with an horizontal line.

Shortcut for a labelled Bool.

Shortcut for a labelled Float.

Shortcut for a labelled Int.

Shortcut for a labelled Word.

A button. Returns True when clicked.

Wraps ImGui::Button().

Button with FramePadding=(0,0) to easily embed within text.

Wraps ImGui::SmallButton().

Flexible button behavior without the visuals.

Frequently useful to build custom behaviors using the public api (along with IsItemActive, IsItemHovered, etc).

Wraps ImGui::InvisibleButton().

Square button with an arrow shape.

Wraps ImGui::ArrowButton().

Image Area to draw a texture.

For OpenGL: The userTextureIDPtr points to the texture memory (eg. 0x0000000000000001)

See examplessdlImage.hs for the whole process.

Wraps ImGui::Image().

Wraps ImGui::Checkbox().

Checkbox for a bit mask inside a signed value.

Checkbox for a bit mask inside an unsigned value.

Draw a small circle + keep the cursor on the same line. Advance cursor x position by getTreeNodeToLabelSpacing, same distance that treeNode uses.

Create a combo box with a given label and preview value.

Action will get True if the combo box is open. In this state, you should populate the contents of the combo box - for example, by calling selectable.

Create a combo box with a given label and preview value.

Action will be called if the combo box is open to populate the contents of the combo box - for example, by calling selectable.

Begin creating a combo box with a given label and preview value.

Returns True if the combo box is open. In this state, you should populate the contents of the combo box - for example, by calling selectable.

Only call endCombo if beginCombo returns True!

Wraps ImGui::BeginCombo().

Only call endCombo if beginCombo returns True!

Wraps ImGui::EndCombo().

Wraps ImGui::Combo().

Wraps ImGui::DragFloat()

Wraps ImGui::DragFloat2()

Wraps ImGui::DragFloat3()

Wraps ImGui::DragFloat4()

Wraps ImGui::DragFloat()

Wraps ImGui::DragInt2()

Wraps ImGui::DragInt3()

Wraps ImGui::DragInt4()

Wraps ImGui::SliderFloat()

Wraps ImGui::SliderFloat2()

Wraps ImGui::SliderFloat3()

Wraps ImGui::SliderFloat4()

Slider widget to select an angle in radians, while displaying degrees.

Wraps ImGui::SliderInt()

Wraps ImGui::SliderInt2()

Wraps ImGui::SliderInt3()

Wraps ImGui::SliderInt4()

Wraps ImGui::InputText().

Wraps ImGui::InputTextMultiline().

Wraps ImGui::InputTextWithHint().

Wraps ImGui::ColorPicker3().

Wraps ImGui::ColorEdit3().

Wraps ImGui::ColorPicker3().

Wraps ImGui::ColorPicker3().

Display a color square/button, hover for details, return true when pressed.

Wraps ImGui::ColorButton().

Initialize current options (generally on application startup) if you want to select a default format, picker type, etc.

User will be able to change many settings, unless you pass the ImGuiColorEditFlags_NoOptions flag to your calls.

Create a table.

The action will get False if the entry is not visible.

Example usage:

withTableOpen defTableOptions "MyTable" do
  tableSetupColumn "Hello"
  tableSetupColumn "World"
  tableHeadersRow

  for_ [("a","1"),("b","2")] \(a,b) -> do
    tableNextRow
    tableNextColumn (text a)
    tableNextColumn (text b)

| Hello | World |
+-------+-------+
| a     | 1     |
| b     | 2     |

Wraps ImGui::BeginTable().

Only call endTable if beginTable returns true!

Wraps ImGui::EndTable().

Wraps ImGui::TableSetupColumn() using defTableColumnOptions.

Wraps ImGui::TableSetupColumn() with explicit options.

Wraps ImGui::TableHeadersRow(). submit all headers cells based on data provided to tableSetupColumn + submit context menu

Wraps ImGui::TableHeader(). submit one header cell manually (rarely used)

Wraps ImGui::TableSetupScrollFreeze(). lock columns/rows so they stay visible when scrolled.

Wraps ImGui::TableNextRow() with defTableRowOptions. append into the first cell of a new row.

Wraps ImGui::TableNextRow() with explicit options.

Wraps ImGui::TableSetColumnIndex(). append into the specified column. Return true when column is visible.

High-Level sorting. Returns of the underlying data should be sorted and to what specification. Number of Specifications is mostly 0 or 1, but can be more if ImGuiTableFlags_SortMulti is enabled on the table.

The Bool only fires true for one frame on each sorting event and resets automatically.

Must be called AFTER all columns are set up with tableSetupColumn

Hint: Don't forget to set ImGuiTableFlags_Sortable to enable sorting on tables.

Example usage:

sortedData <- newIORef [("a","1"), ("b","2")]

let sortable = defTableOptions { tableFlags = ImGuiTableFlags_Sortable }
withTableOpen sortable "MyTable" 2 $ do
  tableSetupColumn "Hello"
  tableSetupColumn "World"

  withSortableTable \isDirty sortSpecs -> do
    when isDirty $
      -- XXX: do your sorting & cache it. Dont sort every frame.
      modifyIORef' sortedData . sortBy $
        foldMap columnSorter sortSpecs

    tableHeadersRow
    for_ sortedData \(a, b) -> do
      tableNextRow
      tableNextColumn $ text a
      tableNextColumn $ text b

Wraps ImGui::TableGetColumnCount(). return number of columns (value passed to BeginTable)

Wraps ImGui::TableGetColumnIndex(). return current column index.

Wraps ImGui::TableGetRowIndex(). return current row index

Wraps @ImGui::TableGetColumnName returns "" if column didn't have a name declared by TableSetupColumn Nothing returns the current column name

Wraps ImGui::TableGetRowIndex(). return column flags so you can query their EnabledVisibleSorted/Hovered status flags. Nothing returns the current column flags

Wraps ImGui::TableSetColumnEnabled(). change user accessible enabled/disabled state of a column. Set to false to hide the column. User can use the context menu to change this themselves (right-click in headers, or right-click in columns body with ImGuiTableFlags_ContextMenuInBody)

Wraps ImGui::TableSetBgColor(). change the color of a cell, row, or column. See ImGuiTableBgTarget flags for details. Nothing sets the current row/column color

Wraps ImGui::TreeNode().

Wraps ImGui::TreePush().

Wraps ImGui::TreePop().

Wraps ImGui::SetNextItemOpen().

Wraps ImGui::Selectable() with default options.

Wraps ImGui::Selectable() with explicit options.