API Reference

imgui_version()::VersionNumber

Return the upstream ImGui version.

AcceptDragDropPayload(type, flags=ImGuiDragDropFlags_(0)) -> Ptr{ImGuiPayload}

AddBezierCubic(handle::Ptr{ImDrawList}, pos0, cp0, cp1, pos1, col, thickness, num_segments=0)

AddCallback(handle::Ptr{ImDrawList}, callback, callback_data)

Your rendering function must check for UserCallback in ImDrawCmd and call the function instead of rendering triangles.

AddCircle(handle::Ptr{ImDrawList}, centre, radius, col, num_segments=12, thickness=1.0)

AddCircleFilled(handle::Ptr{ImDrawList}, centre, radius, col, num_segments=12)

AddConvexPolyFilled(handle::Ptr{ImDrawList}, points, num_points, col)

AddDrawCmd(handle::Ptr{ImDrawList})

This is useful if you need to forcefully create a new draw call (to allow for dependent rendering / blending). Otherwise primitives are merged into the same draw-call as much as possible.

AddFont(self::Ptr{ImFontAtlas}, font_cfg) -> Ptr{ImFont}

AddFontDefault(self::Ptr{ImFontAtlas}, font_cfg=C_NULL) -> Ptr{ImFont}

AddFontFromFileTTF(self::Ptr{ImFontAtlas}, filename, size_pixels, font_cfg=C_NULL, glyph_ranges=C_NULL) -> Ptr{ImFont}

AddFontFromMemoryCompressedBase85TTF(self::Ptr{ImFontAtlas}, compressed_font_data_base85, size_pixels, font_cfg=C_NULL, glyph_ranges=C_NULL) -> Ptr{ImFont}

'compressedfontdata_base85' still owned by caller.

AddFontFromMemoryCompressedTTF(self::Ptr{ImFontAtlas}, compressed_font_data, compressed_font_size, size_pixels, font_cfg=C_NULL, glyph_ranges=C_NULL) -> Ptr{ImFont}

'compressedfontdata' still owned by caller.

AddFontFromMemoryTTF(self::Ptr{ImFontAtlas}, font_data, font_size, size_pixels, font_cfg=C_NULL, glyph_ranges=C_NULL) -> Ptr{ImFont}

AddImage(handle::Ptr{ImDrawList}, user_texture_id, a, b, uv_a=(0,0), uv_b=(1,1), col=0xffffffff)

AddImageQuad(handle::Ptr{ImDrawList}, user_texture_id, a, b, c, d, uv_a=(0,0), uv_b=(1,0), uv_c=(1,1), uv_d=(0,1), col=0xffffffff)

AddImageRounded(handle::Ptr{ImDrawList}, user_texture_id, a, b, uv_a, uv_b, col, rounding, rounding_corners=ImDrawFlags_All)

AddInputCharacter(io::Ptr{ImGuiIO}, c)

Add new character into InputCharacters[].

AddInputCharactersUTF8(io::Ptr{ImGuiIO}, utf8_chars)

Add new characters into InputCharacters[] from an UTF-8 string.

AddLine(handle::Ptr{ImDrawList}, a, b, col, thickness=1.0)

AddPolyline(handle::Ptr{ImDrawList}, points, num_points, col, closed, thickness)

AddQuad(handle::Ptr{ImDrawList}, a, b, c, d, col, thickness=1.0)

AddQuadFilled(handle::Ptr{ImDrawList}, a, b, c, d, col)

AddRect(handle::Ptr{ImDrawList}, a, b, col, rounding=0.0, rounding_corners_flags=ImDrawFlags_RoundCornersAll, thickness=1.0)

Arguments

• a: upper-left
• b: lower-right
• rounding_corners_flags: 4-bits corresponding to which corner to round

AddRectFilled(handle::Ptr{ImDrawList}, a, b, col, rounding=0.0, rounding_corners_flags=ImDrawFlags_RoundCornersAll)

Arguments

• a: upper-left
• b: lower-right

AddRectFilledMultiColor(handle::Ptr{ImDrawList}, a, b, col_upr_left, col_upr_right, col_bot_right, col_bot_left)

AddText(handle::Ptr{ImDrawList}, font::Ptr{ImFont}, font_size, pos, col, text_begin, text_end=C_NULL, wrap_width=0.0, cpu_fine_clip_rect=C_NULL)

AddText(handle::Ptr{ImDrawList}, pos, col, text_begin, text_end=C_NULL)

AddTriangle(handle::Ptr{ImDrawList}, a, b, c, col, thickness=1.0)

AddTriangleFilled(handle::Ptr{ImDrawList}, a, b, c, col)

AlignTextToFramePadding()

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

Append(handle::Ptr{ImGuiTextBuffer}, str, str_end=C_NULL)

Text buffer for logging/accumulating text.

ArrowButton(str_id, dir) -> Bool

Return true when the value has been changed or when pressed/selected. Create a square button with an arrow shape.

Begin(name, p_open=C_NULL, flags=0) -> Bool

Push window to the stack and start appending to it.

Usage

• you may append multiple times to the same window during the same frame.
• passing p_open != C_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.

Begin(handle::Ptr{ImGuiListClipper}, items_count, items_height=-1.0)

Automatically called by constructor if you passed items_count or by Step in Step 1.

Begin(handle::Ptr{ImGuiTextBuffer}) -> Cstring

BeginChild(str_id, size=(0,0), border=false, flags=0) -> Bool
BeginChild(id::Integer, size=(0,0), border=false, flags=0) -> Bool

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

Return false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window.

For each independent axis of size:

• x == 0.0: use remaining host window size
• x > 0.0: fixed size
• x < 0.0: use remaining window size minus abs(size)

Each axis can use a different mode, e.g. ImVec2(0,400).

BeginChildFrame(id, size, flags=0) -> Bool

Helper to create a child window / scrolling region that looks like a normal widget frame.

BeginCombo(label, preview_value, flags=0) -> Bool

The new BeginCombo/EndCombo api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable items.

BeginDragDropSource(flags=ImGuiDragDropFlags_(0)) -> bool

Call when the current item is active. If this return true, you can call SetDragDropPayload + EndDragDropSource.

BeginDragDropTarget() -> bool

Call after submitting an item that may receive a payload. If this returns true, you can call AcceptDragDropPayload + EndDragDropTarget.

BeginGroup()

Lock horizontal starting position + capture group bounding box into one "item", so you can use IsItemHovered or layout primitives such as SameLine on whole group, etc.

BeginListBox(label, size=(0,0))

Use if you want to reimplement ListBox will custom data or interactions. If the function return true, you can output elements then call EndListBox afterwards.

BeginMainMenuBar() -> Bool

Create and append to a full screen menu-bar.

BeginMenu(label, enabled=true) -> Bool

Create a sub-menu entry. only call EndMenu() if this returns true!

BeginMenuBar() -> Bool

Append to menu-bar of current window (requires ImGuiWindowFlags_MenuBar flag set on parent window).

BeginPopup(str_id, flags=0) -> Bool

Return true if the popup is open, and you can start outputting to it.

BeginPopupContextItem(str_id=C_NULL, flags=1) -> Bool

Helper to open and begin popup when clicked on last item. if you can pass a CNULL strid only if the previous item had an id. If you want to use that on a non-interactive item such as Text you need to pass in an explicit ID here.

BeginPopupContextVoid(str_id=C_NULL, popup_flags=1) -> Bool

Helper to open and begin popup when clicked in void (where there are no imgui windows).

BeginPopupContextWindow(str_id=C_NULL, popup_flags=1) -> Bool

Helper to open and begin popup when clicked on current window.

BeginPopupModal(name, p_open=C_NULL, flags=0) -> Bool

Modal dialog (regular window with title bar, block interactions behind the modal window, can't close the modal window by clicking outside).

igBeginTabBar(str_id, flags=ImGuiTabBarFlags_(0)) -> Bool

Create and append into a TabBar.

BeginTabItem(label, p_open=C_NULL, flags=ImGuiTabItemFlags_(0)) -> Bool

BeginTable(str_id, columns_count, flags = ImGuiTableFlags_(0), outer_size = ImVec2(0,0), inner_width = 0.0) -> Bool

Begin a table entry.

BeginTooltip()

Begin/append a tooltip window to create full-featured tooltip (with any kind of items).

Build(self::Ptr{ImFontAtlas}) -> Bool

Build pixels data. This is called automatically for you by the GetTexData*** functions.

Bullet()

Draw a small circle and keep the cursor on the same line. advance cursor x position by GetTreeNodeToLabelSpacing(), same distance that TreeNode() uses

BulletText(formatted_text)

Shortcut for Bullet+Text.

Button(label) -> Bool
Button(label, size) -> Bool

Return true when the value has been changed or when pressed/selected.

C_str(handle::Ptr{ImGuiTextBuffer}) -> Cstring

CalcItemWidth() -> Cfloat

Return width of item given pushed settings and current cursor position.

CalcTextSize(text, text_end=C_NULL, hide_text_after_double_hash=false, wrap_width=-1) -> ImVec2

ChannelsMerge(handle::Ptr{ImDrawList})

ChannelsSetCurrent(handle::Ptr{ImDrawList}, channel_index)

ChannelsSplit(handle::Ptr{ImDrawList}, channels_count)

Checkbox(label, v) -> Bool

Return true when the value has been changed or when pressed/selected.

CheckboxFlags(label, flags, flags_value) -> Bool

Return true when the value has been changed or when pressed/selected.

Clear(self::Ptr{ImFontAtlas})

Clear all input and output.

Clear(handle::Ptr{ImGuiTextBuffer})

ClearFonts(self::Ptr{ImFontAtlas})

Clear output font data (glyphs storage, UV coordinates).

ClearInputCharacters(io)

Clear the text input buffer manually.

ClearInputData(self::Ptr{ImFontAtlas})

Clear input data (all ImFontConfig structures including sizes, TTF data, glyph ranges, etc.) = all the data used to build the texture and fonts.

ClearTexData(self::Ptr{ImFontAtlas})

Clear output texture data (CPU side). Saves RAM once the texture has been copied to graphics memory.

Clipper() -> Ptr{ImGuiListClipper}

Manually clip large list of items.

If you are submitting lots of evenly spaced items and you have a random access to the list, you can perform coarse clipping based on visibility to save yourself from processing those items at all.

If you are submitting lots of evenly spaced items and you have a random access to the list, you can perform coarse clipping based on visibility to save yourself from processing those items at all.

The clipper calculates the range of visible items and advance the cursor to compensate for the non-visible items we have skipped. ImGui already clip items based on their bounds but it needs to measure text size to do so. Coarse clipping before submission makes this cost and your own data fetching/submission cost null.

Example

clipper = CImGui.Clipper()
Begin(clipper, 1000)  # we have 1000 elements, evenly spaced.
while CImGui.Step()
    dis_start = CImGui.Get(clipper, :DisplayStart)
    dis_end = CImGui.Get(clipper, :DisplayEnd)-1
    foreach(i->CImGui.Text("line number $i"), dis_start:dis_end)
end

• Step 0: the clipper let you process the first element, regardless of it being visible or not, so we can measure the element height (step skipped if we passed a known height as second arg to constructor).
• Step 1: the clipper infer height from first element, calculate the actual range of elements to display, and position the cursor before the first element.
• (Step 2: dummy step only required if an explicit items_height was passed to constructor or Begin and user call Step. Does nothing and switch to Step 3.)
• Step 3: the clipper validate that we have reached the expected Y position (corresponding to element DisplayEnd), advance the cursor to the end of the list and then returns false to end the loop.

Arguments

• items_count: use -1 to ignore (you can call Begin later). use INT_MAX if you don't know how many items you have (in which case the cursor won't be advanced in the final step).
• items_height: use -1.0 to be calculated automatically on first step. otherwise pass in the distance between your items, typically GetTextLineHeightWithSpacing or GetFrameHeightWithSpacing. If you don't specify an items_height, you NEED to call Step. If you specify items_height you may call the old Begin/End api directly, but prefer calling Step.

CloneOutput(handle::Ptr{ImDrawList}) -> Ptr{ImDrawList}

Create a clone of the CmdBuffer/IdxBuffer/VtxBuffer.

CloseCurrentPopup()

Close the popup we have begin-ed into. clicking on a MenuItem or Selectable automatically close the current popup.

CollapsingHeader(label, p_open::Ref, flags=ImGuiTreeNodeFlags_(0)) -> Bool

When p_open isn't C_NULL, display an additional small close button on upper right of the header.

CollapsingHeader(label, flags=ImGuiTreeNodeFlags_(0)) -> Bool

If returning true the header is open. Doesn't indent nor push on ID stack. User doesn't have to call TreePop.

ColorButton(desc_id, col, flags=0, size=(0,0))

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

ColorConvertFloat4ToU32(in) -> ImU32

Convert ImVec4 color to ImU32. You could use Base.convert(::Type{ImU32}, x::ImVec4) instead.

ColorConvertU32ToFloat4(in) -> ImVec4

Convert ImU32 color to ImVec4. You could use Base.convert(::Type{ImVec4}, x::ImU32) instead.

ColorEdit3(label, col, flags=0) -> Bool

ColorEdit4(label, col, flags=0) -> Bool

ColorPicker3(label, col, flags=0)

ColorPicker4(label, col, flags=0, ref_col=C_NULL)

Columns(count=1, id=C_NULL, border=true)

Combo(label, current_item, items::Vector, items_count, popup_max_height_in_items=-1) -> Bool

The old Combo api are helpers over BeginCombo/EndCombo which are kept available for convenience purpose.

Combo(label, current_item, items_getter::Union{Ptr,Base.CFunction}, data, items_count, popup_max_height_in_items=-1) -> Bool

Combo(label, current_item, items_separated_by_zeros, popup_max_height_in_items=-1) -> Bool

Separate items with within a string, end item-list with . e.g. OneTwoThree

CreateContext() -> Ptr{ImGuiContext}
CreateContext(shared_font_atlas::Ptr{ImFontAtlas}) -> Ptr{ImGuiContext}

Return a handle of ImGuiContext.

Destroy(handle::Ptr{ImGuiListClipper})

Destroy(handle::Ptr{ImGuiTextBuffer})

DestroyContext()
DestroyContext(ctx::Ptr{ImGuiContext})

Destroy ImGuiContext. DestroyContext() will destroy current context.

DragFloat(label, v, v_speed=1.0, v_min=0.0, v_max=0.0, format="%.3f", flag=0) -> Bool

If v_min >= v_max we have no bound.

DragFloat2(label, v, v_speed=1.0, v_min=0.0, v_max=0.0, format="%.3f", flag=0) -> Bool

The expected number of elements to be accessible in v is 2.

DragFloat3(label, v, v_speed=1.0, v_min=0.0, v_max=0.0, format="%.3f", flag=0) -> Bool

The expected number of elements to be accessible in v is 3.

DragFloat4(label, v, v_speed=1.0, v_min=0.0, v_max=0.0, format="%.3f", flag=0) -> Bool

The expected number of elements to be accessible in v is 4.

DragFloatRange2(label, v_current_min, v_current_max, v_speed=1.0, v_min=0.0, v_max=0.0, format="%.3f", format_max=C_NULL, flag=0) -> Bool

DragInt(label, v, v_speed=1.0, v_min=0, v_max=0, format="%d", flag=0)

DragInt2(label, v, v_speed=1.0, v_min=0, v_max=0, format="%d", flag=0)

The expected number of elements to be accessible in v is 2.

DragInt3(label, v, v_speed=1.0, v_min=0, v_max=0, format="%d", flag=0)

The expected number of elements to be accessible in v is 3.

DragInt4(label, v, v_speed=1.0, v_min=0, v_max=0, format="%d", flag=0)

The expected number of elements to be accessible in v is 4.

DragIntRange2(label, v_current_min, v_current_max, v_speed=1.0, v_min=0, v_max=0, format="%d", format_max=C_NULL, flag=0)

DragScalar(label, data_type, v, v_speed, v_min=C_NULL, v_max=C_NULL, format=C_NULL, flags=0)

DragScalarN(label, data_type, v, components, v_speed, v_min=C_NULL, v_max=C_NULL, format=C_NULL, flag=0)

Dummy(size)
Dummy(x, y)

Add a dummy item of given size.

Empty(handle::Ptr{ImGuiTextBuffer}) -> Bool

End(handle::Ptr{ImGuiListClipper})

Automatically called on the last call of Step that returns false.

End(handle::Ptr{ImGuiTextBuffer}) -> Cstring

End()

Pop window from the stack. See also Begin.

EndChild()

See also BeginChild.

EndChildFrame()

EndCombo()

See also BeginCombo.

EndDragDropSource()

EndDragDropTarget()

EndFrame()

Calling this function ends the ImGui frame. This function is automatically called by Render, so you likely don't need to call it yourself directly. If you don't need to render data (skipping rendering), you may call EndFrame but you'll have wasted CPU already! If you don't need to render, better to not create any imgui windows and not call NewFrame at all!

EndGroup()

See BeginGroup.

EndListBox()

Terminate the scrolling region.

EndMainMenuBar()

EndMenu()

EndMenuBar()

EndPopup()

See BeginPopup, BeginPopupContextItem, BeginPopupContextWindow, BeginPopupContextVoid, BeginPopupModal.

EndTabBar()

Only call EndTabBar if BeginTabBar returns true!

EndTabItem()

Only call EndTabItem if BeginTabItem returns true!

EndTable()

Only call EndTable if BeginTable returns true!

EndTooltip()

See BeginTooltip.

GetBackgroundDrawList() -> Ptr{ImDrawList}

This draw list will be the first rendering one. Useful to quickly draw shapes/text behind dear imgui contents.

GetClipRectMax(handle::Ptr{ImDrawList}) -> ImVec2

GetClipRectMin(handle::Ptr{ImDrawList}) -> ImVec2

GetClipboardText() -> String

GetColorU32(r, g, b, a) -> ImU32
GetColorU32(col::ImVec4) -> ImU32
GetColorU32(col::ImU32) -> ImU32
GetColorU32(idx::Integer, alpha_mul=1.0) -> ImU32

Retrieve given style color with style alpha applied and optional extra alpha multiplier.

GetColumnIndex() -> Cint

Return current column index.

GetColumnOffset(column_index=-1) -> Cfloat

Get position of column line (in pixels, from the left side of the contents region). Pass -1 to use current column, otherwise 0..GetColumnsCount() inclusive. Column 0 is typically 0.0.

GetColumnWidth(column_index=-1) -> Cfloat

Return column width (in pixels). Pass -1 to use current column.

GetColumnsCount() -> Cint

GetContentRegionAvail() -> ImVec2

Return GetContentRegionMax - GetCursorPos.

GetContentRegionMax() -> ImVec2

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

GetCurrentContext() -> Ptr{ImGuiContext}

Return a handle of the current context.

GetCursorPos() -> ImVec2

Return cursor position which is relative to window position.

GetCursorPosX() -> Cfloat

GetCursorPosY() -> Cfloat

GetCursorScreenPos() -> ImVec2

Return cursor position in absolute screen coordinates [0..io.DisplaySize]. This is useful to work with ImDrawList API.

GetCursorStartPos() -> ImVec2

Return initial cursor position in window coordinates.

GetDragDropPayload() -> Ptr{ImGuiPayload}

Peek directly into the current payload from anywhere. May return C_NULL.

GetDrawData() -> Ptr{ImDrawData}

Return a handle of ImDrawData which is valid after Render and until the next call to NewFrame. This is what you have to render.

GetDrawListSharedData() -> Ptr{ImDrawListSharedData}

This function might be used when creating your own ImDrawList instances.

GetFont() -> Ptr{ImFont}

Get current font.

GetFontSize() -> Cfloat

Get current font size (= height in pixels) of current font with current scale applied.

GetFontTexUvWhitePixel() -> ImVec2

Get UV coordinate for a while pixel, useful to draw custom shapes via the ImDrawList API.

GetForegroundDrawList() -> Ptr{ImDrawList}

this draw list will be the last rendered one. Useful to quickly draw shapes/text over dear imgui contents.

GetFrameCount() -> Cint

GetFrameHeight() -> Cfloat

Return FontSize + ImGuiStyle.FramePadding.y * 2.

GetFrameHeightWithSpacing() -> Cfloat

Return FontSize + ImGuiStyle.FramePadding.y * 2 + ImGuiStyle.ItemSpacing.y (distance in pixels between 2 consecutive lines of framed widgets).

GetGlyphRangesChineseFull(self::Ptr{ImFontAtlas}) -> Ptr{ImWchar}

Default + Half-Width + Japanese Hiragana/Katakana + full set of about 21000 CJK Unified Ideographs.

GetGlyphRangesChineseSimplifiedCommon(self::Ptr{ImFontAtlas}) -> Ptr{ImWchar}

Default + Half-Width + Japanese Hiragana/Katakana + set of 2500 CJK Unified Ideographs for common simplified Chinese.

GetGlyphRangesCyrillic(self::Ptr{ImFontAtlas}) -> Ptr{ImWchar}

Default + about 400 Cyrillic characters.

GetGlyphRangesDefault(self::Ptr{ImFontAtlas}) -> Ptr{ImWchar}

Basic Latin, Extended Latin.

GetGlyphRangesJapanese(self::Ptr{ImFontAtlas}) -> Ptr{ImWchar}

Default + Hiragana, Katakana, Half-Width, Selection of 1946 Ideographs.

GetGlyphRangesKorean(self::Ptr{ImFontAtlas}) -> Ptr{ImWchar}

Default + Korean characters.

GetGlyphRangesThai(self::Ptr{ImFontAtlas}) -> Ptr{ImWchar}

Default + Thai characters.

GetID(str_id::AbstractString) -> ImGuiID
GetID(str_id_begin::AbstractString, str_id_end::AbstractString) -> ImGuiID
GetID(ptr_id::Ptr) -> ImGuiID

Calculate unique ID (hash of whole ID stack + given parameter). e.g. if you want to query into ImGuiStorage yourself.

GetIO() -> Ptr{ImGuiIO}

Return a handle of ImGuiIO which is for accessing the IO structure:

• mouse/keyboard/gamepad inputs
• time
• various configuration options/flags

GetItemRectMax() -> ImVec2

Return bounding rectangle of last item, in screen space. See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

GetItemRectMin() -> ImVec2

Return bounding rectangle of last item, in screen space. See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

GetItemRectSize() -> ImVec2

Return size of last item, in screen space. See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

GetKeyData(imgui_key) -> Ptr{ImGuiKeyData}

Get the key data for a specific key.

GetKeyPressedAmount(key_index, repeat_delay, rate) -> Cint

Uses provided repeat rate/delay. Return a count, most often 0 or 1 but might be >1 if RepeatRate is small enough that DeltaTime > RepeatRate

GetMouseCursor() -> ImGuiMouseCursor

Get desired cursor type, reset in ImGui::NewFrame(), this is updated during the frame. valid before Render. If you use software rendering by setting io.MouseDrawCursor ImGui will render those for you.

GetMouseDragDelta(button=0, lock_threshold=-1.0) -> ImVec2

Dragging amount since clicking. if lock_threshold < -1.0f uses io.MouseDraggingThreshold.

GetMousePos() -> ImVec2

Shortcut to ImGui::GetIO().MousePos provided by user, to be consistent with other calls.

GetMousePosOnOpeningCurrentPopup() -> ImVec2

Retrieve backup of mouse position at the time of opening popup we have BeginPopup into.

GetScrollMaxX() -> Cfloat

Return maximum scrolling amount ~~ ContentSize.X - WindowSize.X.

GetScrollMaxY() -> Cfloat

Return maximum scrolling amount ~~ ContentSize.Y - WindowSize.Y.

GetScrollX() -> Cfloat

Return scrolling amount [0..GetScrollMaxX()]. See also GetScrollMaxX.

GetScrollY() -> Cfloat

Return scrolling amount [0..GetScrollMaxY()].

GetStateStorage()

GetStyle() -> Ptr{ImGuiStyle}

Return a handle of ImGuiStyle which is for accessing the Style structure (colors, sizes).

GetStyleColorName(idx::Integer) -> String

GetStyleColorVec4(idx) -> ImVec4

Retrieve style color as stored in [ImGuiStyle] structure. Use to feed back into PushStyleColor, otherwise use GetColorU32 to get style color with style alpha baked in.

GetTexDataAsAlpha8(self::Ptr{ImFontAtlas}, out_pixels, out_width, out_height, out_bytes_per_pixel=C_NULL)

1 byte per-pixel.

GetTexDataAsRGBA32(self::Ptr{ImFontAtlas}, out_pixels, out_width, out_height, out_bytes_per_pixel=C_NULL)

4 bytes-per-pixel.

GetTextLineHeight() -> Cfloat

Return FontSize.

GetTextLineHeightWithSpacing() -> Cfloat

Return FontSize + ImGuiStyle.ItemSpacing.y (distance in pixels between 2 consecutive lines of text).

GetTime() -> Cdouble

GetTreeNodeToLabelSpacing()

Horizontal distance preceding label when using TreeNode*() or Bullet() == (g.FontSize + style.FramePadding.x*2) for a regular unframed TreeNode.

GetVersion() -> Cstring

Get the compiled version string e.g. "1.23"

GetWindowContentRegionMax() -> ImVec2

Return content boundaries max (roughly (0,0)+Size-Scroll) where Size can be override with SetNextWindowContentSize, in window coordinates.

GetWindowContentRegionMin() -> ImVec2

Return content boundaries min (roughly (0,0)-Scroll), in window coordinates.

GetWindowContentRegionWidth() -> ImVec2

GetWindowDrawList() -> Ptr{ImDrawList}

Return draw list associated to the window, to append your own drawing primitives.

GetWindowHeight() -> Cfloat

Return current window height (shortcut for GetWindowSize().y).

GetWindowPos() -> ImVec2

Return current window position in screen space (useful if you want to do your own drawing via the ImDrawList API.

GetWindowSize() -> ImVec2

Return current window size.

GetWindowWidth() -> Cfloat

Return current window width (shortcut for GetWindowSize().x).

HSV(h, s, v, a=1.0) -> ImVec4

Image(user_texture_id, size, uv0=(0,0), uv1=(1,1), tint_col=(1,1,1,1), border_col=(0,0,0,0))

ImageButton(str_id, user_texture_id, size, uv0=(0,0), uv1=(1,1), bg_col=(0,0,0,0), tint_col=(1,1,1,1)) -> Bool

Indent()
Indent(indent_w)

Move content position toward the right, by ImGuiStyle.IndentSpacing or indent_w if indent_w != 0.

InputDouble(label, v, step=0.0, step_fast=0.0, format="%.6f", flags=0) -> Bool

InputFloat(label, v, step=0, step_fast=0, format="%.3f", flags=0) -> Bool

InputFloat2(label, v, format="%.3f", flags=0) -> Bool

The expected number of elements to be accessible in v is 2.

InputFloat3(label, v, format="%.3f", flags=0) -> Bool

The expected number of elements to be accessible in v is 3.

InputFloat4(label, v, format="%.3f", flags=0) -> Bool

The expected number of elements to be accessible in v is 4.

InputInt(label, v, step=1, step_fast=100, flags=0) -> Bool

InputInt2(label, v, flags=0) -> Bool

The expected number of elements to be accessible in v is 2.

InputInt3(label, v, flags=0) -> Bool

The expected number of elements to be accessible in v is 3.

InputInt4(label, v, flags=0) -> Bool

The expected number of elements to be accessible in v is 4.

InputScalar(label, data_type, v, step=C_NULL, step_fast=C_NULL, format=C_NULL, flags=0) -> Bool

InputScalarN(label, data_type, v, components, step=C_NULL, step_fast=C_NULL, format=C_NULL, flags=0) -> Bool

InputText(label, buf, buf_size, flags=0, callback=C_NULL, user_data=C_NULL) -> Bool

InputTextMultiline(label, buf, buf_size, size=(0,0), flags=0, callback=C_NULL, user_data=C_NULL) -> Bool

InputTextWithHint(label, hint, buf, buf_size, flags=0, callback=C_NULL, user_data=C_NULL) -> Bool

InvisibleButton(str_id, size, flag = 0) -> Bool

Return true when the value has been changed or when pressed/selected. Flexible button behavior without the visuals, frequently useful to build custom behaviors using the public api along with IsItemActive, IsItemHovered, etc.

IsAnyItemActive() -> Bool

See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

 IsAnyItemFocused() -> Bool

See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsAnyItemHovered() -> Bool

See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsAnyMouseDown() -> Bool

Is any mouse button held.

IsBuilt(self::Ptr{ImFontAtlas}) -> Bool

IsItemActivated() -> Bool

Was the last item just made active (item was previously inactive).

IsItemActive() -> Bool

Is the last item active? (e.g. button being held, text field being edited. This will continuously return true while holding mouse button on an item. Items that don't interact will always return false) See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsItemClicked() -> Bool
IsItemClicked(mouse_button=0) -> Bool

Is the last item clicked? (e.g. button/node just clicked on) == IsMouseClicked(mouse_button) && IsItemHovered. See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsItemDeactivated() -> Bool

Was the last item just made inactive (item was previously active). Useful for Undo/Redo patterns with widgets that requires continuous editing. See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsItemDeactivatedAfterEdit() -> Bool

Was the last item just made inactive and made a value change when it was active? (e.g. Slider/Drag moved). Useful for Undo/Redo patterns with widgets that requires continuous editing. Note that you may get false positives (some widgets such as Combo/ListBox/Selectable will return true even when clicking an already selected item). See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsItemEdited() -> Bool

Did the last item modify its underlying value this frame? or was pressed? This is generally the same as the "bool" return value of many widgets. See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsItemFocused() -> Bool

Is the last item focused for keyboard/gamepad navigation? See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsItemHovered(flags=ImGuiHoveredFlags_(0)) -> Bool

Is the last item hovered? (and usable, aka not blocked by a popup, etc.). See the output of CImGui.GetFlags(CImGui.ImGuiHoveredFlags_) for options:

using CImGui, Markdown
CImGui.ShowFlags(CImGui.ImGuiHoveredFlags_) |> Markdown.parse

See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsItemToggledOpen() -> Bool

See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsItemVisible() -> Bool

Is the last item visible? (items may be out of sight because of clipping/scrolling). See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

IsKeyDown(user_key_index) -> Bool

Is key being held. == io.KeysDown[userkeyindex]. note that imgui doesn't know the semantic of each entry of io.KeysDown[]. Use your own indices/enums according to how your backend/engine stored them into io.KeysDown[]!

IsKeyPressed(user_key_index, repeat=true) -> Bool

Was key pressed (went from !Down to Down). If repeat=true, uses io.KeyRepeatDelay / KeyRepeatRate.

IsKeyReleased(user_key_index) -> Bool

Was key released (went from Down to !Down).

IsMouseClicked(button, repeat=false) -> Bool

Did mouse button clicked (went from !Down to Down) (0=left, 1=right, 2=middle)

IsMouseDoubleClicked(button) -> Bool

Did mouse button double-clicked. Uses io.MouseDoubleClickTime.

IsMouseDown(button) -> Bool

Is mouse button held (0=left, 1=right, 2=middle).

IsMouseDragging(button=0, lock_threshold=-1.0) -> Bool

Is mouse dragging. If lock_threshold < -1.0f uses io.MouseDraggingThreshold.

IsMouseHoveringRect(r_min, r_max, clip=true) -> Bool

Is mouse hovering given bounding rect (in screen space). Clipped by current clipping settings, but disregarding of other consideration of focus/window ordering/popup-block.

IsMousePosValid(mouse_pos=C_NULL) -> Bool

IsMouseReleased(button) -> Bool

Did mouse button released (went from Down to !Down).

IsPopupOpen(str_id) -> Bool

Return true if the popup is open.

IsRectVisible(size) -> Bool
IsRectVisible(x, y) -> Bool

Test if rectangle (of given size, starting from cursor position) is visible / not clipped.

IsRectVisibleVec2(rect_min::ImVec2, rect_max::ImVec2) -> Bool
IsRectVisibleVec2(rect_min::NTuple{2}, rect_max::NTuple{2}) -> Bool

Test if rectangle (in screen space) is visible / not clipped. to perform coarse clipping on user's side.

IsWindowAppearing() -> Bool

IsWindowCollapsed() -> Bool

IsWindowFocused(flags=0) -> Bool

Is current window focused? or its root/child, depending on flags. See the output of CImGui.GetFlags(CImGui.ImGuiFocusedFlags_) for options:

using CImGui, Markdown
CImGui.ShowFlags(CImGui.ImGuiFocusedFlags_) |> Markdown.parse

IsWindowHovered(flags=0) -> Bool

Is current window hovered (and typically: not blocked by a popup/modal)? See the output of CImGui.GetFlags(CImGui.ImGuiHoveredFlags_) for options:

using CImGui, Markdown
CImGui.ShowFlags(CImGui.ImGuiHoveredFlags_) |> Markdown.parse

if CImGui.Get_WantCaptureMouse(CImGui.GetIO())
    # ...
end

LabelText(label, formatted_text)

Display text+label aligned the same way as value+label widgets.

ListBox(label, current_item, items, items_count, height_in_items=-1)
ListBox(label, current_item, items_getter::Ptr{Cvoid}, data::Ptr{Cvoid}, items_count, height_in_items=-1)

LoadIniSettingsFromDisk(ini_filename)

Call after CreateContext and before the first call to NewFrame. NewFrame automatically calls LoadIniSettingsFromDisk(ImGuiIO.IniFilename).

LoadIniSettingsFromMemory(ini_data, ini_size=0)

Call after CreateContext and before the first call to NewFrame to provide .ini data from your own data source.

LogButtons()

Display buttons for logging to tty/file/clipboard.

LogFinish()

Stop logging (close file, etc.)

LogText(formatted_text)

Pass text data straight to log without being displayed.

LogToClipboard(max_depth=-1)

Start logging to OS clipboard.

All text output from interface is captured to clipboard. By default, tree nodes are automatically opened during logging.

LogToFile(max_depth=-1, filename=C_NULL)

Start logging to file.

All text output from interface is captured to file. By default, tree nodes are automatically opened during logging.

LogToTTY(max_depth=-1)

Start logging to tty.

All text output from interface is captured to tty. By default, tree nodes are automatically opened during logging.

MenuItem(label, shortcut=C_NULL, selected::Bool=false, enabled::Bool=true) -> Bool
MenuItem(label, shortcut, selected::Ref, enabled::Bool=true) -> Bool

Return true when activated. Shortcuts are displayed for convenience but not processed by ImGui at the moment.

NewFrame()

Start a new ImGui frame. You can submit any command from this point until Render or EndFrame.

NewLine()

Undo a SameLine.

NextColumn()

Next column, defaults to current row or next row if the current row is finished.

OpenPopup(str_id)

Call to mark popup as open (don't call every frame!). Popups are closed when user click outside, or if CloseCurrentPopup is called within a BeginPopup/EndPopup block. By default, Selectable/MenuItem are calling CloseCurrentPopup. Popup identifiers are relative to the current ID-stack (so OpenPopup and BeginPopup needs to be at the same level).

OpenPopupOnItemClick(str_id=C_NULL, mouse_button=1) -> Nothing

Helper to open popup when clicked on last item (note: actually triggers on the mouse released event to be consistent with popup behaviors).

PathArcTo(handle::Ptr{ImDrawList}, centre, radius, a_min, a_max, num_segments=10)

Stateful path API, add points then finish with PathFillConvex or PathStroke.

PathArcToFast(handle::Ptr{ImDrawList}, centre, radius, a_min_of_12, a_max_of_12)

Stateful path API, add points then finish with PathFillConvex or PathStroke.

PathBezierCurveTo(handle::Ptr{ImDrawList}, p1, p2, p3, num_segments=0)

Stateful path API, add points then finish with PathFillConvex or PathStroke.

PathClear(handle::Ptr{ImDrawList})

Stateful path API, add points then finish with PathFillConvex or PathStroke.

PathFillConvex(handle::Ptr{ImDrawList}, col)

PathLineTo(handle::Ptr{ImDrawList}, pos)

Stateful path API, add points then finish with PathFillConvex or PathStroke.

PathLineToMergeDuplicate(handle::Ptr{ImDrawList}, pos)

Stateful path API, add points then finish with PathFillConvex or PathStroke.

PathRect(handle::Ptr{ImDrawList}, rect_min, rect_max, rounding=0.0, rounding_corners_flags=ImDrawFlags_RoundCornersAll)

Stateful path API, add points then finish with PathFillConvex or PathStroke.

PathStroke(handle::Ptr{ImDrawList}, col, closed, thickness=1.0)

PlotHistogram(label, values, values_count, values_offset=0, overlay_text=C_NULL, scale_min=FLT_MAX, scale_max=FLT_MAX, graph_size=(0,0), stride=sizeof(Cfloat))
PlotHistogram(label, values_getter::Ptr, data::Ptr, values_count, values_offset=0, overlay_text=C_NULL, scale_min=FLT_MAX, scale_max=FLT_MAX, graph_size=ImVec2(0,0))

PlotLines(label, values, values_count::Integer, values_offset=0, overlay_text=C_NULL, scale_min=FLT_MAX, scale_max=FLT_MAX, graph_size=(0,0), stride=sizeof(Cfloat))
PlotLines(label, values_getter::Ptr, data::Ptr, values_count, values_offset=0, overlay_text=C_NULL, scale_min=FLT_MAX, scale_max=FLT_MAX, graph_size=(0,0))

PopButtonRepeat()

See PushButtonRepeat.

PopClipRect(handle::Ptr{ImDrawList})

PopClipRect()

PopFont()

See PushFont.

PopID()

See PushID.

PopItemWidth()

See PushItemWidth.

PopStyleColor(count=1)

See PushStyleColor.

PopStyleVar(count=1)

See PushStyleVar.

PopTabStop()

PopTextWrapPos()

See PushTextWrapPos.

PopTextureID(handle::Ptr{ImDrawList})

PrimQuadUV(handle::Ptr{ImDrawList}, a, b, c, d, uv_a, uv_b, uv_c, uv_d, col)

PrimRect(handle::Ptr{ImDrawList}, a, b, col)

Axis aligned rectangle (composed of two triangles).

PrimRectUV(handle::Ptr{ImDrawList}, a, b, uv_a, uv_b, col)

PrimReserve(handle::Ptr{ImDrawList}, idx_count, vtx_count)

PrimVtx(handle::Ptr{ImDrawList}, pos, uv, col)

PrimWriteIdx(handle::Ptr{ImDrawList}, idx)

PrimWriteVtx(handle::Ptr{ImDrawList}, pos, uv, col)

ProgressBar(fraction, size_arg=(-1,0), overlay=C_NULL)

PushButtonRepeat(repeat)

In "repeat" mode, Button*() functions return repeated true in a typematic manner (using ImGuiIO.KeyRepeatDelay/ImGuiIO.KeyRepeatRate setting). Note that you can call IsItemActive after any Button() to tell if the button is held in the current frame.

PushClipRect(clip_rect_min, clip_rect_max, intersect_with_current_clip_rect)

PushClipRect(handle::Ptr{ImDrawList}, clip_rect_min, clip_rect_max, intersect_with_current_clip_rect)

Render-level scissoring. This is passed down to your render function but not used for CPU-side coarse clipping. Prefer using higher-level PushClipRect to affect logic (hit-testing and widget culling).

PushClipRectFullScreen(handle::Ptr{ImDrawList})

PushFont(font)

Use C_NULL as a shortcut to push default font.

PushID(ptr_id::Ptr)
PushID(int_id::Integer)
PushID(str_id::AbstractString)
PushID(str_id_begin::AbstractString, str_id_end::AbstractString)

Push identifier into the ID stack. IDs are hash of the entire stack!

CImGui.Button("OK")          # Label = "OK",     ID = hash of (..., "OK")
CImGui.Button("Cancel")      # Label = "Cancel", ID = hash of (..., "Cancel")

CImGui.Begin("MyWindow")
CImGui.Button("OK")          # Label = "OK",     ID = hash of ("MyWindow", "OK")
CImGui.End()

CImGui.Button("OK")
CImGui.Button("OK")          # ID collision! Interacting with either button will trigger the first one.

CImGui.Begin("MyWindow")
CImGui.Button("Play")        # Label = "Play",   ID = hash of ("MyWindow", "Play")
CImGui.Button("Play##foo1")  # Label = "Play",   ID = hash of ("MyWindow", "Play##foo1")  # Different from above
CImGui.Button("Play##foo2")  # Label = "Play",   ID = hash of ("MyWindow", "Play##foo2")  # Different from above
CImGui.End()

CImGui.Checkbox("##On", &b)  # Label = "", ID = hash of (..., "##On") # No visible label, just a checkbox!

CImGui.Button("Hello###ID")  # Label = "Hello",  ID = hash of (..., "ID")
CImGui.Button("World###ID")  # Label = "World",  ID = hash of (..., "ID") # Same as above, even though the label looks different
buf = @sprintf("My game (%f FPS)###MyGame", fps)
CImGui.Begin(buf)            # Variable title,   ID = hash of "MyGame"

CImGui.Begin("Window")
for i = 0:100-1
    CImGui.PushID(i)         # Push i to the id tack
    CImGui.Button("Click")   # Label = "Click",  ID = Hash of ("Window", i, "Click")
    CImGui.PopID()
end
End()

CImGui.Button("Click")       # Label = "Click",  ID = hash of (..., "Click")
CImGui.PushID("node")
CImGui.Button("Click")       # Label = "Click",  ID = hash of (..., "node", "Click")
    CImGui.PushID(my_ptr)
    CImGui.Button("Click") # Label = "Click",  ID = hash of (..., "node", my_ptr, "Click")
    CImGui.PopID()
CImGui.PopID()

CImGui.Button("Click")     # Label = "Click",  ID = hash of (..., "Click")
if CImGui.TreeNode("node")
    CImGui.Button("Click") # Label = "Click",  ID = hash of (..., "node", "Click")
    CImGui.TreePop()
end

PushItemWidth(item_width)

Push width of items for the common item+label case, pixels:

• item_width == 0: default to ~2/3 of windows width
• item_width > 0: width in pixels
• item_width < 0: align xx pixels to the right of window (so -1.0 always align width to the right side)

PushStyleColor(idx, col)
PushStyleColor(idx, col::Integer)

See also GetStyleColorVec4, TextColored, TextDisabled.

PushStyleVar(idx, val)
PushStyleVar(idx, val::Real)

See also GetStyle.

PushTabStop(allow_keyboard_focus)

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

PushTextWrapPos(wrap_pos_x=0.0)

Word-wrapping for Text*() commands:

• wrap_pos_x < 0: no wrapping
• wrap_pos_x == 0: wrap to end of window (or column)
• wrap_pos_x > 0: wrap at wrap_pos_x position in window local space

PushTextureID(handle::Ptr{ImDrawList}, texture_id)

RadioButton(label, active::Bool) -> Bool
RadioButton(label, v::Ref, v_button::Integer) -> Bool

Return true when the value has been changed or when pressed/selected.

Example

if RadioButton("one", my_value==1)
    my_value = 1
end

Render()

Calling this function ends the ImGui frame. This function finalizes the draw data.

Reserve(handle::Ptr{ImGuiTextBuffer})

ResetMouseDragDelta(button=0)

SameLine(local_pos_x=0.0, spacing_w=-1.0)

Call this function between widgets or groups to layout them horizontally.

SaveIniSettingsToDisk(ini_filename)

SaveIniSettingsToMemory(out_ini_size=C_NULL)

Return a zero-terminated string with the .ini data which you can save by your own mean. Call when ImGuiIO.WantSaveIniSettings is set, then save data by your own mean and clear ImGuiIO.WantSaveIniSettings.

Selectable(label, selected::Bool=false, flags=0, size=(0,0)) -> Bool
Selectable(label, p_selected::Ref, flags=0, sizeImVec2(0,0)) -> Bool

Return true if is clicked, so you can modify your selection state:

• size.x == 0.0: use remaining width
• size.x > 0.0: specify width
• size.y == 0.0: use label height
• size.y > 0.0: specify height

Separator()

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

SetClipboardText(text)

SetColorEditOptions(flags)

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 _NoOptions flag to your calls.

SetColumnOffset(column_index, offset_x)

Set position of column line (in pixels, from the left side of the contents region). Pass -1 to use current column.

SetColumnWidth(column_index, width)

Set column width (in pixels). Pass -1 to use current column.

SetCurrentContext(ctx::Ptr{ImGuiContext})

Set current context to ctx.

SetCursorPos(x, y)
SetCursorPos(local_pos)

SetCursorPosX(local_x)

SetCursorPosX(local_y)

SetCursorScreenPos(pos)
SetCursorScreenPos(x, y)

Set cursor position in absolute screen coordinates [0..io.DisplaySize].

SetDragDropPayload(type, data, size, cond=ImGuiCond_(1)) -> bool

type is a user defined string of maximum 32 characters. Strings starting with '_' are reserved for dear imgui internal types. Data is copied and held by imgui.

SetItemAllowOverlap()

Allow last item to be overlapped by a subsequent item. Sometimes useful with invisible buttons, selectables, etc. to catch unused area. See Demo Window under "Widgets->Querying Status" for an interactive visualization of many of those functions.

SetItemDefaultFocus()

Make last item the default focused item of a window.

SetKeyboardFocusHere(offset=0)

Focus keyboard on the next widget. Use positive offset to access sub components of a multiple component widget. Use -1 to access previous widget.

SetMouseCursor(type)

Set desired cursor type.

SetNextFrameWantCaptureKeyboard(capture=true)

Manually override io.WantCaptureKeyboard flag next frame (said flag is entirely left for your application to handle). e.g. force capture keyboard when your widget is being hovered.

CaptureMouseFromApp(capture=true)

Manually override io.WantCaptureMouse flag next frame (said flag is entirely left for your application to handle).

SetNextItemOpen(is_open, cond=0)

Set next TreeNode/CollapsingHeader open state.

SetNextItemWidth(item_width)

Set width of the next common large "item+label" widget.

• item_width > 0.0: width in pixels
• item_width < 0.0: align xx pixels to the right of window (so -1.0 always align width to the right side)

SetNextWindowBgAlpha(alpha)

Set next window background color alpha. Helper to easily modify ImGuiCol_WindowBg/ChildBg/PopupBg. You may also use ImGuiWindowFlags_NoBackground.

SetNextWindowCollapsed(collapsed, cond=0)

Set next window collapsed state. Call before Begin.

SetNextWindowContentSize(size)
SetNextWindowContentSize(x, y)

Set next window content size (~ enforce the range of scrollbars). Not including window decorations (title bar, menu bar, etc.). Set an axis to 0.0 to leave it automatic. Call before Begin.

SetNextWindowFocus()

Set next window to be focused / front-most. Call before Begin.

SetNextWindowPos(pos, cond=0, pivot=(0,0))

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

SetNextWindowSize(size, cond=0)

Set next window size. Set axis to 0.0 to force an auto-fit on this axis. Call before Begin.

SetNextWindowSizeConstraints(size_min, size_max, custom_callback=C_NULL, custom_callback_data=C_NULL)

Set next window size limits. Use -1,-1 on either X/Y axis to preserve the current size. Use callback to apply non-trivial programmatic constraints.

SetScrollFromPosX(local_y, center_y_ratio=0.5)

Adjust scrolling amount to make given position visible. Generally GetCursorStartPos + offset to compute a valid position.

SetScrollFromPosY(local_y, center_y_ratio=0.5)

Adjust scrolling amount to make given position visible. Generally GetCursorStartPos + offset to compute a valid position.

SetScrollHereY(center_y_ratio=0.5)

Adjust scrolling amount to make current cursor position visible.

• center_y_ratio == 0.0: top
• center_y_ratio == 0.5: center
• center_y_ratio == 1.0: bottom

When using to make a "default/current item" visible, consider using SetItemDefaultFocus instead.

SetScrollX(scroll_x)

Set scrolling amount [0..GetScrollMaxX()].

SetScrollY(scroll_y)

Set scrolling amount [0..GetScrollMaxY()].

SetStateStorage(storage)

Replace current window storage with our own (if you want to manipulate it yourself, typically clear subsection of it)

SetTabItemClosed(tab_or_docked_window_label)

Notify TabBar or Docking system of a closed tab/window ahead (useful to reduce visual flicker on reorderable tab bars). For tab-bar: call after BeginTabBar() and before Tab submissions. Otherwise call with a window name.

SetTexID(self::Ptr{ImFontAtlas}, id)

SetTooltip(formatted_text)

Set a text-only tooltip, typically use with IsItemHovered. Overidde any previous call to SetTooltip.

SetWindowCollapsed(name::AbstractString, collapsed, cond=0)

Set named window collapsed state.

SetWindowCollapsedBool(collapsed, cond=0)

Set current window collapsed state.

SetWindowFocus(name::Ptr{Cvoid})
SetWindowFocus(name::AbstractString)

Set named window to be focused / front-most. Use C_NULL to remove focus.

SetWindowFocus()

Set current window to be focused / top-most.

SetWindowFontScale(scale)

Set font scale. Adjust ImGuiIO.FontGlobalScale if you want to scale all windows.

SetWindowPosStr(name::AbstractString, pos, cond=0)

Set named window position.

SetWindowPos(pos, cond=0)

Set current window position - call within Begin/End.

SetWindowSizeStr(name::AbstractString, size, cond=0)

Set named window size. Set axis to 0.0 to force an auto-fit on this axis.

SetWindowSize(size, cond=0)

Set current window size - call within Begin/End. Set to (0,0) to force an auto-fit.

ShowAboutWindow()
ShowAboutWindow(p_open=C_NULL)

Create about window. Display Dear ImGui version, credits and build/system information.

ShowDemoWindow()
ShowDemoWindow(p_open=C_NULL)

Create demo/test window. Demonstrate most ImGui features.

ShowFontSelector(label)

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

ShowMetricsWindow()
ShowMetricsWindow(p_open=C_NULL)

Create metrics window. Display Dear ImGui internals: draw commands (with individual draw calls and vertices), window list, basic internal state, etc.

ShowStyleEditor()
ShowStyleEditor(ref=C_NULL)

Add style editor block (not a window). You can pass in a reference ImGuiStyle structure to compare to, revert to and save to (else it uses the default style).

ShowStyleSelector()
ShowStyleSelector(label)

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

ShowUserGuide()

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

Size(handle::Ptr{ImGuiTextBuffer}) -> Cint

SliderAngle(label, v_rad, v_degrees_min=-360.0, v_degrees_max=360.0, format="%.0f deg", flags=0) -> Bool

SliderFloat(label, v, v_min, v_max, format="%.3f", flag=0) -> Bool

Create a slider widget.

Arguments

• format: adjust format to decorate the value with a prefix or a suffix for in-slider labels or unit display
  • "%.3f" -> 1.234
  • "%5.2f secs" -> 01.23 secs
  • "Biscuit: %.0f" -> Biscuit: 1

SliderFloat2(label, v, v_min, v_max, format="%.3f", flag=0) -> Bool

The expected number of elements to be accessible in v is 2.

SliderFloat3(label, v, v_min, v_max, format="%.3f", flag=0) -> Bool

The expected number of elements to be accessible in v is 3.

SliderFloat4(label, v, v_min, v_max, format="%.3f", flag=0) -> Bool

The expected number of elements to be accessible in v is 4.

SliderInt(label, v, v_min, v_max, format="%d", flags=0) -> Bool

SliderInt2(label, v, v_min, v_max, format="%d", flags=0) -> Bool

The expected number of elements to be accessible in v is 2.

SliderInt3(label, v, v_min, v_max, format="%d", flags=0) -> Bool

The expected number of elements to be accessible in v is 3.

SliderInt4(label, v, v_min, v_max, format="%d", flags=0) -> Bool

The expected number of elements to be accessible in v is 4.

SliderScalar(label, data_type, v, v_min, v_max, format=C_NULL, flag=0) -> Bool

SliderScalarN(label, data_type, v, components, v_min, v_max, format=C_NULL, flag=0) -> Bool

SmallButton(label) -> Bool

Return true when the value has been changed or when pressed/selected. It creates a button with FramePadding=(0,0) to easily embed within text.

Spacing()

Add vertical spacing.

Step(handle::Ptr{ImGuiListClipper}) -> Bool

Call until it returns false. The DisplayStart/DisplayEnd fields will be set and you can process/draw those items.

StyleColorsClassic()

Use the classic imgui style.

StyleColorsDark()

Use the new, recommended style. This is also the default style.

StyleColorsLight()

This style is best used with borders and a custom, thicker font.

TableGetColumnCount() -> CInt

return number of columns (value passed to BeginTable)

TableGetColumnFlags(column_n = -1) -> ImGuiTableColumnFlags

Return column flags so you can query their Enabled/Visible/Sorted/Hovered status flags. Pass -1 to use current column.

TableGetColumnIndex() -> CInt

Return current column index

TableGetColumnName(column_n = -1) -> String

return "" if column didn't have a name declared by TableSetupColumn(). Pass -1 to use current column.

TableGetRowIndex() -> CInt

Return current row index.

TableGetSortSpecs() -> Ptr{ImGuiTableSortSpecs}

get latest sort specs for the table (NULL if not sorting).

TableHeader(label)

Submit one header cell manually (rarely used)

TableHeadersRow()

Submit all headers cells based on data provided to TableSetupColumn() + submit context menu

TableNextColumn() -> Bool

Append into the next column (or first column of next row if currently in last column). Return true when column is visible.

TableNextRow(row_flags = ImGuiTableRowFlags_(0), min_row_height = 0.0)

Append into the first cell of a new row.

TableSetBgColor(bg_target, color, column_n = -1)

Change the color of a cell, row, or column. See ImGuiTableBgTarget_ flags for details.

TableSetColumnIndex(column_n) -> Bool

Append into the specified column. Return true when column is visible.

TableSetupColumn(label, flags = ImGuiTableColumnFlags_(0), init_width_or_weight = 0.0, user_id = ImGuiID(0))

Specify label, resizing policy, default width/weight, id, various other flags etc.

TableSetupScrollFreeze(cols, rows)

Lock columns/rows so they stay visible when scrolled.

Text(formatted_text)

Create a text widget.

TextBuffer() -> Ptr{ImGuiTextBuffer}

Helper: Growable text buffer for logging/accumulating text

TextColored(col, formatted_text)

Shortcut for PushStyleColor(ImGuiCol_Text, col); Text(text); PopStyleColor();.

TextDisabled(formatted_text)

Shortcut for PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); Text(text); PopStyleColor();.

TextUnformatted(text, text_end=C_NULL)

Raw text without formatting. Roughly equivalent to Text("%s", text) but:

1. doesn't require null terminated string if text_end is specified;
2. it's faster, no memory copy is done, no buffer size limits, recommended for long chunks of text.

TextWrapped(formatted_text)

Shortcut for PushTextWrapPos(0.0f); Text(text); PopTextWrapPos();. Note that this won't work on an auto-resizing window if there's no other widgets to extend the window width, yoy may need to set a size using SetNextWindowSize.

TreeNode(label::AbstractString) -> Bool

TreeNode functions return true when the node is open, in which case you need to also call TreePop when you are finished displaying the tree node contents.

TreeNode(str_id, formatted_text) -> Bool

Helper variation to completely decorelate the id from the displayed string. Read the FAQ in PushID's' doc about why and how to use ID. To align arbitrary text at the same level as a TreeNode you can use Bullet.

TreeNodePtr(ptr_id::Ptr, formatted_text) -> Bool

Helper variation to completely decorelate the id from the displayed string. Read the FAQ in PushID's' doc about why and how to use ID. To align arbitrary text at the same level as a TreeNode you can use Bullet.

TreeNodeEx(label, flags=0) -> Bool

TreeNodeEx(str_id, flags, formatted_text) -> Bool

TreeNodeEx(ptr_id::Ptr, flags, formatted_text) -> Bool

TreePop()

Unindent + PopID.

TreePush(ptr_id::Ptr=C_NULL)

Indent + PushID. Already called by TreeNode when returning true, but you can call TreePush/TreePop yourself if desired.

TreePush(str_id)

Indent + PushID. Already called by TreeNode when returning true, but you can call TreePush/TreePop yourself if desired.

Unindent()
Unindent(indent_w)

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

VSliderFloat(label, size, v, v_min, v_max, format="%.3f", flag=0) -> Bool

VSliderInt(label, size, v, v_min, v_max, format="%d", flag=0) -> Bool

VSliderScalar(label, size, data_type, v, v_min, v_max, format=C_NULL, flag=0) -> Bool

ValueBool(prefix, b)

Output single value in "name: value" format.

ValueFloat(prefix, v, float_format=C_NULL)

Output single value in "name: value" format.

ValueInt(prefix, v)

Output single value in "name: value" format.

ValueUint(prefix, v)

Output single value in "name: value" format.