imgui package¶
- imgui.NONE = 0¶
No condition (always set the variable), same as _Always
- imgui.ALWAYS = 1¶
No condition (always set the variable)
- imgui.ONCE = 2¶
Set the variable once per runtime session (only the first call will succeed)
- imgui.FIRST_USE_EVER = 4¶
Set the variable if the object/window has no persistently saved data (no entry in .ini file)
- imgui.APPEARING = 8¶
Set the variable if the object/window is appearing after being hidden/inactive (or the first time)
- imgui.KEY_TAB = 0¶
for tabbing through fields
- imgui.KEY_LEFT_ARROW = 1¶
for text edit
- imgui.KEY_RIGHT_ARROW = 2¶
for text edit
- imgui.KEY_UP_ARROW = 3¶
for text edit
- imgui.KEY_DOWN_ARROW = 4¶
for text edit
- imgui.KEY_HOME = 7¶
for text edit
- imgui.KEY_END = 8¶
for text edit
- imgui.KEY_INSERT = 9¶
for text edit
- imgui.KEY_DELETE = 10¶
for text edit
- imgui.KEY_BACKSPACE = 11¶
for text edit
- imgui.KEY_SPACE = 12¶
for text edit
- imgui.KEY_ENTER = 13¶
for text edit
- imgui.KEY_ESCAPE = 14¶
for text edit
- imgui.KEY_A = 16¶
select all
- Type:
for text edit CTRL+A
- imgui.KEY_C = 17¶
copy
- Type:
for text edit CTRL+C
- imgui.KEY_V = 18¶
paste
- Type:
for text edit CTRL+V
- imgui.KEY_X = 19¶
cut
- Type:
for text edit CTRL+X
- imgui.KEY_Y = 20¶
redo
- Type:
for text edit CTRL+Y
- imgui.KEY_Z = 21¶
undo
- Type:
for text edit CTRL+Z
- imgui.NAV_INPUT_ACTIVATE = 0¶
activate / open / toggle / tweak value e.g. Cross (PS4), A (Xbox), A (Switch), Space (Keyboard)
- imgui.NAV_INPUT_CANCEL = 1¶
cancel / close / exit e.g. Circle (PS4), B (Xbox), B (Switch), Escape (Keyboard)
- imgui.NAV_INPUT_INPUT = 2¶
text input / on-screen keyboard e.g. Triang.(PS4), Y (Xbox), X (Switch), Return (Keyboard)
- imgui.NAV_INPUT_MENU = 3¶
toggle menu / hold: focus, move, resize e.g. Square (PS4), X (Xbox), Y (Switch), Alt (Keyboard)
- Type:
tap
- imgui.NAV_INPUT_DPAD_LEFT = 4¶
move / tweak / resize window (w/ PadMenu) e.g. D-pad Left/Right/Up/Down (Gamepads), Arrow keys (Keyboard)
- imgui.NAV_INPUT_L_STICK_LEFT = 8¶
scroll / move window (w/ PadMenu) e.g. Left Analog Stick Left/Right/Up/Down
- imgui.NAV_INPUT_FOCUS_PREV = 12¶
next window (w/ PadMenu) e.g. L1 or L2 (PS4), LB or LT (Xbox), L or ZL (Switch)
- imgui.NAV_INPUT_FOCUS_NEXT = 13¶
prev window (w/ PadMenu) e.g. R1 or R2 (PS4), RB or RT (Xbox), R or ZL (Switch)
- imgui.NAV_INPUT_TWEAK_SLOW = 14¶
slower tweaks e.g. L1 or L2 (PS4), LB or LT (Xbox), L or ZL (Switch)
- imgui.NAV_INPUT_TWEAK_FAST = 15¶
faster tweaks e.g. R1 or R2 (PS4), RB or RT (Xbox), R or ZL (Switch)
- imgui.STYLE_ALPHA = 0¶
float
.- Type:
associated type
- imgui.STYLE_WINDOW_PADDING = 1¶
Vec2
.- Type:
associated type
- imgui.STYLE_WINDOW_ROUNDING = 2¶
float
.- Type:
associated type
- imgui.STYLE_WINDOW_BORDERSIZE = 3¶
float
.- Type:
associated type
- imgui.STYLE_WINDOW_MIN_SIZE = 4¶
Vec2
.- Type:
associated type
- imgui.STYLE_WINDOW_TITLE_ALIGN = 5¶
Vec2
.- Type:
associated type
- imgui.STYLE_CHILD_ROUNDING = 6¶
float
.- Type:
associated type
- imgui.STYLE_CHILD_BORDERSIZE = 7¶
float
.- Type:
associated type
- imgui.STYLE_POPUP_ROUNDING = 8¶
float
.- Type:
associated type
- imgui.STYLE_POPUP_BORDERSIZE = 9¶
float
.- Type:
associated type
- imgui.STYLE_FRAME_PADDING = 10¶
Vec2
.- Type:
associated type
- imgui.STYLE_FRAME_ROUNDING = 11¶
float
.- Type:
associated type
- imgui.STYLE_FRAME_BORDERSIZE = 12¶
float
.- Type:
associated type
- imgui.STYLE_ITEM_SPACING = 13¶
Vec2
.- Type:
associated type
- imgui.STYLE_ITEM_INNER_SPACING = 14¶
Vec2
.- Type:
associated type
- imgui.STYLE_INDENT_SPACING = 15¶
float
.- Type:
associated type
- imgui.STYLE_CELL_PADDING = 16¶
Vec2
.- Type:
associated type
- imgui.STYLE_SCROLLBAR_SIZE = 17¶
float
.- Type:
associated type
- imgui.STYLE_SCROLLBAR_ROUNDING = 18¶
float
.- Type:
associated type
- imgui.STYLE_GRAB_MIN_SIZE = 19¶
float
.- Type:
associated type
- imgui.STYLE_GRAB_ROUNDING = 20¶
float
.- Type:
associated type
- imgui.STYLE_TAB_ROUNDING = 21¶
float
- Type:
associated type
- imgui.STYLE_BUTTON_TEXT_ALIGN = 22¶
flags ImGuiAlign_*.
- Type:
associated type
- imgui.STYLE_SELECTABLE_TEXT_ALIGN = 23¶
Vec2
- Type:
associated type
- imgui.BUTTON_MOUSE_BUTTON_LEFT = 1¶
React on left mouse button (default)
- imgui.BUTTON_MOUSE_BUTTON_RIGHT = 2¶
React on right mouse button
- imgui.BUTTON_MOUSE_BUTTON_MIDDLE = 4¶
React on center mouse button
- imgui.WINDOW_NO_TITLE_BAR = 1¶
Disable title-bar.
- imgui.WINDOW_NO_RESIZE = 2¶
Disable user resizing with the lower-right grip.
- imgui.WINDOW_NO_MOVE = 4¶
Disable user moving the window.
- imgui.WINDOW_NO_SCROLLBAR = 8¶
Disable scrollbars (window can still scroll with mouse or programmatically).
- imgui.WINDOW_NO_SCROLL_WITH_MOUSE = 16¶
Disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set.
- imgui.WINDOW_NO_COLLAPSE = 32¶
Disable user collapsing window by double-clicking on it.
- imgui.WINDOW_ALWAYS_AUTO_RESIZE = 64¶
Resize every window to its content every frame.
- imgui.WINDOW_NO_BACKGROUND = 128¶
Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).
- imgui.WINDOW_NO_SAVED_SETTINGS = 256¶
Never load/save settings in
.ini
file.
- imgui.WINDOW_NO_MOUSE_INPUTS = 512¶
Disable catching mouse, hovering test with pass through.
- imgui.WINDOW_MENU_BAR = 1024¶
Has a menu-bar.
- imgui.WINDOW_HORIZONTAL_SCROLLING_BAR = 2048¶
Allow horizontal scrollbar to appear (off by default). You may use SetNextWindowContentSize(ImVec2(width,0.0f)); prior to calling Begin() to specify width. Read code in imgui_demo in the “Horizontal Scrolling” section.
- imgui.WINDOW_NO_FOCUS_ON_APPEARING = 4096¶
Disable taking focus when transitioning from hidden to visible state.
- imgui.WINDOW_NO_BRING_TO_FRONT_ON_FOCUS = 8192¶
Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus).
- imgui.WINDOW_ALWAYS_VERTICAL_SCROLLBAR = 16384¶
Always show vertical scrollbar (even if ContentSize.y < Size.y).
- imgui.WINDOW_ALWAYS_HORIZONTAL_SCROLLBAR = 32768¶
Always show horizontal scrollbar (even if ContentSize.x < Size.x).
- imgui.WINDOW_ALWAYS_USE_WINDOW_PADDING = 65536¶
Ensure child windows without border uses style.WindowPadding (ignored by default for non-bordered child windows, because more convenient).
- imgui.WINDOW_NO_NAV_INPUTS = 262144¶
No gamepad/keyboard navigation within the window.
- imgui.WINDOW_NO_NAV_FOCUS = 524288¶
No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB).
- imgui.WINDOW_UNSAVED_DOCUMENT = 1048576¶
Append ‘*’ to title without affecting the ID, as a convenience to avoid using the ### operator. When used in a tab/docking context, tab is selected on closure and closure is deferred by one frame to allow code to cancel the closure (with a confirmation popup, etc.) without flicker.
- imgui.WINDOW_NO_NAV = 786432¶
imgui.WINDOW_NO_NAV_INPUTS | imgui.WINDOW_NO_NAV_FOCUS
.- Type:
Shortcut
- imgui.WINDOW_NO_DECORATION = 43¶
imgui.WINDOW_NO_TITLE_BAR | imgui.WINDOW_NO_RESIZE | imgui.WINDOW_NO_SCROLLBAR | imgui.WINDOW_NO_COLLAPSE
.- Type:
Shortcut
- imgui.WINDOW_NO_INPUTS = 786944¶
imgui.WINDOW_NO_MOUSE_INPUTS | imgui.WINDOW_NO_NAV_INPUTS | imgui.WINDOW_NO_NAV_FOCUS
.- Type:
Shortcut
- imgui.COLOR_EDIT_NO_ALPHA = 2¶
ignore Alpha component (will only read 3 components from the input pointer).
- Type:
ColorEdit, ColorPicker, ColorButton
- imgui.COLOR_EDIT_NO_PICKER = 4¶
disable picker when clicking on color square.
- Type:
ColorEdit
- imgui.COLOR_EDIT_NO_OPTIONS = 8¶
disable toggling options menu when right-clicking on inputs/small preview.
- Type:
ColorEdit
- imgui.COLOR_EDIT_NO_SMALL_PREVIEW = 16¶
disable color square preview next to the inputs. (e.g. to show only the inputs)
- Type:
ColorEdit, ColorPicker
- imgui.COLOR_EDIT_NO_INPUTS = 32¶
disable inputs sliders/text widgets (e.g. to show only the small preview color square).
- Type:
ColorEdit, ColorPicker
- imgui.COLOR_EDIT_NO_TOOLTIP = 64¶
disable tooltip when hovering the preview.
- Type:
ColorEdit, ColorPicker, ColorButton
- imgui.COLOR_EDIT_NO_LABEL = 128¶
disable display of inline text label (the label is still forwarded to the tooltip and picker).
- Type:
ColorEdit, ColorPicker
- imgui.COLOR_EDIT_NO_SIDE_PREVIEW = 256¶
disable bigger color preview on right side of the picker, use small color square preview instead.
- Type:
ColorPicker
- imgui.COLOR_EDIT_NO_DRAG_DROP = 512¶
disable drag and drop target. ColorButton: disable drag and drop source.
- Type:
ColorEdit
- imgui.COLOR_EDIT_NO_BORDER = 1024¶
disable border (which is enforced by default)
- Type:
ColorButton
- imgui.COLOR_EDIT_ALPHA_BAR = 65536¶
show vertical alpha bar/gradient in picker.
- Type:
ColorEdit, ColorPicker
- imgui.COLOR_EDIT_ALPHA_PREVIEW = 131072¶
display preview as a transparent color over a checkerboard, instead of opaque.
- Type:
ColorEdit, ColorPicker, ColorButton
- imgui.COLOR_EDIT_ALPHA_PREVIEW_HALF = 262144¶
display half opaque / half checkerboard, instead of opaque.
- Type:
ColorEdit, ColorPicker, ColorButton
- imgui.COLOR_EDIT_HDR = 524288¶
Currently only disable 0.0f..1.0f limits in RGBA edition (note: you probably want to use ImGuiColorEditFlags_Float flag as well).
- Type:
(WIP) ColorEdit
- imgui.COLOR_EDIT_DISPLAY_RGB = 1048576¶
override _display_ type among RGB/HSV/Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex.
- Type:
ColorEdit
- imgui.COLOR_EDIT_DISPLAY_HSV = 2097152¶
override _display_ type among RGB/HSV/Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex.
- Type:
ColorEdit
- imgui.COLOR_EDIT_DISPLAY_HEX = 4194304¶
override _display_ type among RGB/HSV/Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex.
- Type:
ColorEdit
- imgui.COLOR_EDIT_UINT8 = 8388608¶
_display_ values formatted as 0..255.
- Type:
ColorEdit, ColorPicker, ColorButton
- imgui.COLOR_EDIT_FLOAT = 16777216¶
_display_ values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers.
- Type:
ColorEdit, ColorPicker, ColorButton
- imgui.COLOR_EDIT_PICKER_HUE_BAR = 33554432¶
bar for Hue, rectangle for Sat/Value.
- Type:
ColorPicker
- imgui.COLOR_EDIT_PICKER_HUE_WHEEL = 67108864¶
wheel for Hue, triangle for Sat/Value.
- Type:
ColorPicker
- imgui.COLOR_EDIT_INPUT_RGB = 134217728¶
input and output data in RGB format.
- Type:
ColorEdit, ColorPicker
- imgui.COLOR_EDIT_INPUT_HSV = 268435456¶
input and output data in HSV format.
- Type:
ColorEdit, ColorPicker
- imgui.COLOR_EDIT_DEFAULT_OPTIONS = 177209344¶
imgui.COLOR_EDIT_UINT8 | imgui.COLOR_EDIT_DISPLAY_RGB | imgui.COLOR_EDIT_INPUT_RGB | imgui.COLOR_EDIT_PICKER_HUE_BAR
.- Type:
Shortcut
- imgui.TREE_NODE_SELECTED = 1¶
Draw as selected
- imgui.TREE_NODE_FRAMED = 2¶
Draw frame with background (e.g. for
imgui.core.collapsing_header()
).
- imgui.TREE_NODE_ALLOW_ITEM_OVERLAP = 4¶
Hit testing to allow subsequent widgets to overlap this one
- imgui.TREE_NODE_NO_TREE_PUSH_ON_OPEN = 8¶
Don’t do a
TreePush()
when open (e.g. forimgui.core.collapsing_header()
). No extra indent nor pushing on ID stack.
- imgui.TREE_NODE_NO_AUTO_OPEN_ON_LOG = 16¶
Don’t automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes).
- imgui.TREE_NODE_DEFAULT_OPEN = 32¶
Default node to be open
- imgui.TREE_NODE_OPEN_ON_DOUBLE_CLICK = 64¶
Need double-click to open node.
- imgui.TREE_NODE_OPEN_ON_ARROW = 128¶
Only open when clicking on the arrow part. If
TREE_NODE_OPEN_ON_DOUBLE_CLICK
is also set, single-click arrow or double-click all box to open.
- imgui.TREE_NODE_LEAF = 256¶
No collapsing, no arrow (use as a convenience for leaf nodes).
- imgui.TREE_NODE_BULLET = 512¶
Display a bullet instead of arrow.
- imgui.TREE_NODE_FRAME_PADDING = 1024¶
Use FramePadding (even for an unframed text node) to vertically align text baseline to regular widget height. Equivalent to calling
align_text_to_frame_padding()
- imgui.TREE_NODE_SPAN_AVAILABLE_WIDTH = 2048¶
Extend hit box to the right-most edge, even if not framed. This is not the default in order to allow adding other items on the same line. In the future we may refactor the hit system to be front-to-back, allowing natural overlaps and then this can become the default.
- imgui.TREE_NODE_SPAN_FULL_WIDTH = 4096¶
Extend hit box to the left-most and right-most edges (bypass the indented area).
- imgui.TREE_NODE_NAV_LEFT_JUPS_BACK_HERE = 8192¶
left direction may move to this TreeNode() from any of its child (items submitted between TreeNode and TreePop)
- Type:
(WIP) Nav
- imgui.TREE_NODE_COLLAPSING_HEADER = 26¶
imgui.TREE_NODE_FRAMED | imgui.TREE_NODE_NO_AUTO_OPEN_ON_LOG
.- Type:
Shortcut
- imgui.SELECTABLE_DONT_CLOSE_POPUPS = 1¶
Clicking this don’t close parent popup window.
- imgui.SELECTABLE_SPAN_ALL_COLUMNS = 2¶
Selectable frame can span all columns (text will still fit in current column).
- imgui.SELECTABLE_ALLOW_DOUBLE_CLICK = 4¶
Generate press events on double clicks too.
- imgui.COMBO_POPUP_ALIGN_LEFT = 1¶
Align the popup toward the left by default
- imgui.COMBO_HEIGHT_SMALL = 2¶
If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo()
- Type:
Max ~4 items visible. Tip
- imgui.COMBO_HEIGHT_REGULAR = 4¶
Max ~8 items visible (default)
- imgui.COMBO_HEIGHT_LARGE = 8¶
Max ~20 items visible
- imgui.COMBO_HEIGHT_LARGEST = 16¶
As many fitting items as possible
- imgui.COMBO_NO_ARROW_BUTTON = 32¶
Display on the preview box without the square arrow button
- imgui.COMBO_NO_PREVIEW = 64¶
Display only a square arrow button
- imgui.COMBO_HEIGHT_MASK = 30¶
imgui.COMBO_HEIGHT_SMALL | imgui.COMBO_HEIGHT_REGULAR | imgui.COMBO_HEIGHT_LARGE | imgui.COMBO_HEIGHT_LARGEST
.- Type:
Shortcut
- imgui.TAB_BAR_REORDERABLE = 1¶
Allow manually dragging tabs to re-order them + New tabs are appended at the end of list
- imgui.TAB_BAR_AUTO_SELECT_NEW_TABS = 2¶
Automatically select new tabs when they appear
- imgui.TAB_BAR_TAB_LIST_POPUP_BUTTON = 4¶
Disable buttons to open the tab list popup
- imgui.TAB_BAR_NO_CLOSE_WITH_MIDDLE_MOUSE_BUTTON = 8¶
Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button.
- imgui.TAB_BAR_NO_TAB_LIST_SCROLLING_BUTTONS = 16¶
Disable scrolling buttons (apply when fitting policy is ImGuiTabBarFlags_FittingPolicyScroll)
- imgui.TAB_BAR_NO_TOOLTIP = 32¶
Disable tooltips when hovering a tab
- imgui.TAB_BAR_FITTING_POLICY_RESIZE_DOWN = 64¶
Resize tabs when they don’t fit
- imgui.TAB_BAR_FITTING_POLICY_SCROLL = 128¶
Add scroll buttons when tabs don’t fit
- imgui.TAB_BAR_FITTING_POLICY_MASK = 192¶
TAB_BAR_FITTING_POLICY_RESIZE_DOWN | TAB_BAR_FITTING_POLICY_SCROLL
- imgui.TAB_BAR_FITTING_POLICY_DEFAULT = 64¶
TAB_BAR_FITTING_POLICY_RESIZE_DOWN
- imgui.TAB_ITEM_UNSAVED_DOCUMENT = 1¶
tab is selected on closure and closure is deferred by one frame to allow code to undo it without flicker.
- Type:
Append ‘*’ to title without affecting the ID, as a convenience to avoid using the ### operator. Also
- imgui.TAB_ITEM_SET_SELECTED = 2¶
Trigger flag to programmatically make the tab selected when calling BeginTabItem()
- imgui.TAB_ITEM_NO_CLOSE_WITH_MIDDLE_MOUSE_BUTTON = 4¶
Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button.
- imgui.TAB_ITEM_NO_PUSH_ID = 8¶
Don’t call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem()
- imgui.TAB_ITEM_NO_TOOLTIP = 16¶
Disable tooltip for the given tab
- imgui.TAB_ITEM_NO_REORDER = 32¶
Disable reordering this tab or having another tab cross over this tab
- imgui.TAB_ITEM_LEADING = 64¶
Enforce the tab position to the left of the tab bar (after the tab list popup button)
- imgui.TAB_ITEM_TRAILING = 128¶
Enforce the tab position to the right of the tab bar (before the scrolling buttons)
- imgui.TABLE_NONE = 0¶
# Features None
- imgui.TABLE_RESIZABLE = 1¶
Enable resizing columns.
- imgui.TABLE_REORDERABLE = 2¶
Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers)
- imgui.TABLE_HIDEABLE = 4¶
Enable hiding/disabling columns in context menu.
- imgui.TABLE_SORTABLE = 8¶
Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate.
- imgui.TABLE_NO_SAVED_SETTINGS = 16¶
Disable persisting columns order, width and sort settings in the .ini file.
- imgui.TABLE_CONTEXT_MENU_IN_BODY = 32¶
Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow().
- imgui.TABLE_ROW_BACKGROUND = 64¶
# Decorations Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually)
- imgui.TABLE_BORDERS_INNER_HORIZONTAL = 128¶
Draw horizontal borders between rows.
- imgui.TABLE_BORDERS_OUTER_HORIZONTAL = 256¶
Draw horizontal borders at the top and bottom.
- imgui.TABLE_BORDERS_INNER_VERTICAL = 512¶
Draw vertical borders between columns.
- imgui.TABLE_BORDERS_OUTER_VERTICAL = 1024¶
Draw vertical borders on the left and right sides.
- imgui.TABLE_BORDERS_HORIZONTAL = 384¶
Draw horizontal borders.
- imgui.TABLE_BORDERS_VERTICAL = 1536¶
Draw vertical borders.
- imgui.TABLE_BORDERS_INNER = 640¶
Draw inner borders.
- imgui.TABLE_BORDERS_OUTER = 1280¶
Draw outer borders.
- imgui.TABLE_BORDERS = 1920¶
Draw all borders.
- imgui.TABLE_NO_BORDERS_IN_BODY = 2048¶
[ALPHA] Disable vertical borders in columns Body (borders will always appears in Headers). -> May move to style
- imgui.TABLE_NO_BORDERS_IN_BODY_UTIL_RESIZE = 4096¶
[ALPHA] Disable vertical borders in columns Body until hovered for resize (borders will always appears in Headers). -> May move to style
- imgui.TABLE_SIZING_FIXED_FIT = 8192¶
# Sizing Policy (read above for defaults) Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width.
- imgui.TABLE_SIZING_FIXED_SAME = 16384¶
Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching the maximum contents width of all columns. Implicitly enable ImGuiTableFlags_NoKeepColumnsVisible.
- imgui.TABLE_SIZING_STRETCH_PROP = 24576¶
Columns default to _WidthStretch with default weights proportional to each columns contents widths.
- imgui.TABLE_SIZING_STRETCH_SAME = 32768¶
Columns default to _WidthStretch with default weights all equal, unless overriden by TableSetupColumn().
- imgui.TABLE_NO_HOST_EXTEND_X = 65536¶
# Sizing Extra Options Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used.
- imgui.TABLE_NO_HOST_EXTEND_Y = 131072¶
Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible.
- imgui.TABLE_NO_KEEP_COLUMNS_VISIBLE = 262144¶
Disable keeping column always minimally visible when ScrollX is off and table gets too small. Not recommended if columns are resizable.
- imgui.TABLE_PRECISE_WIDTHS = 524288¶
Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth.
- Type:
Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns
- imgui.TABLE_NO_CLIP = 1048576¶
# Clipping Disable clipping rectangle for every individual columns (reduce draw command count, items will be able to overflow into other columns). Generally incompatible with TableSetupScrollFreeze().
- imgui.TABLE_PAD_OUTER_X = 2097152¶
# Padding Default if BordersOuterV is on. Enable outer-most padding. Generally desirable if you have headers.
- imgui.TABLE_NO_PAD_OUTER_X = 4194304¶
Default if BordersOuterV is off. Disable outer-most padding.
- imgui.TABLE_NO_PAD_INNER_X = 8388608¶
Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off).
- imgui.TABLE_SCROLL_X = 16777216¶
# Scrolling Enable horizontal scrolling. Require ‘outer_size’ parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this create a child window, ScrollY is currently generally recommended when using ScrollX.
- imgui.TABLE_SCROLL_Y = 33554432¶
Enable vertical scrolling. Require ‘outer_size’ parameter of BeginTable() to specify the container size.
- imgui.TABLE_SORT_MULTI = 67108864¶
# Sorting Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1).
- imgui.TABLE_SORT_TRISTATE = 134217728¶
Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0).
- imgui.TABLE_COLUMN_NONE = 0¶
# Input configuration flags None
- imgui.TABLE_COLUMN_DEFAULT_HIDE = 1¶
Default as a hidden/disabled column.
- imgui.TABLE_COLUMN_DEFAULT_SORT = 2¶
Default as a sorting column.
- imgui.TABLE_COLUMN_WIDTH_STRETCH = 4¶
Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp).
- imgui.TABLE_COLUMN_WIDTH_FIXED = 8¶
Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable).
- imgui.TABLE_COLUMN_NO_RESIZE = 16¶
Disable manual resizing.
- imgui.TABLE_COLUMN_NO_REORDER = 32¶
Disable manual reordering this column, this will also prevent other columns from crossing over this column.
- imgui.TABLE_COLUMN_NO_HIDE = 64¶
Disable ability to hide/disable this column.
- imgui.TABLE_COLUMN_NO_CLIP = 128¶
Disable clipping for this column (all NoClip columns will render in a same draw command).
- imgui.TABLE_COLUMN_NO_SORT = 256¶
Disable ability to sort on this field (even if ImGuiTableFlags_Sortable is set on the table).
- imgui.TABLE_COLUMN_NO_SORT_ASCENDING = 512¶
Disable ability to sort in the ascending direction.
- imgui.TABLE_COLUMN_NO_SORT_DESCENDING = 1024¶
Disable ability to sort in the descending direction.
- imgui.TABLE_COLUMN_NO_HEADER_WIDTH = 2048¶
Disable header text width contribution to automatic column width.
- imgui.TABLE_COLUMN_PREFER_SORT_ASCENDING = 4096¶
Make the initial sort direction Ascending when first sorting on this column (default).
- imgui.TABLE_COLUMN_PREFER_SORT_DESCENDING = 8192¶
Make the initial sort direction Descending when first sorting on this column.
- imgui.TABLE_COLUMN_INDENT_ENABLE = 16384¶
Use current Indent value when entering cell (default for column 0).
- imgui.TABLE_COLUMN_INDENT_DISABLE = 32768¶
Ignore current Indent value when entering cell (default for columns > 0). Indentation changes _within_ the cell will still be honored.
- imgui.TABLE_COLUMN_IS_ENABLED = 1048576¶
# Output status flags, read-only via TableGetColumnFlags() Status: is enabled == not hidden by user/api (referred to as “Hide” in _DefaultHide and _NoHide) flags.
- imgui.TABLE_COLUMN_IS_VISIBLE = 2097152¶
is visible == is enabled AND not clipped by scrolling.
- Type:
Status
- imgui.TABLE_COLUMN_IS_SORTED = 4194304¶
is currently part of the sort specs
- Type:
Status
- imgui.TABLE_COLUMN_IS_HOVERED = 8388608¶
is hovered by mouse
- Type:
Status
- imgui.TABLE_ROW_NONE = 0¶
None
- imgui.TABLE_ROW_HEADERS = 1¶
Identify header row (set default background color + width of its contents accounted different for auto column width)
- imgui.TABLE_BACKGROUND_TARGET_NONE = 0¶
None
- imgui.TABLE_BACKGROUND_TARGET_ROW_BG0 = 1¶
Set row background color 0 (generally used for background, automatically set when ImGuiTableFlags_RowBg is used)
- imgui.TABLE_BACKGROUND_TARGET_ROW_BG1 = 2¶
Set row background color 1 (generally used for selection marking)
- imgui.TABLE_BACKGROUND_TARGET_CELL_BG = 3¶
Set cell background color (top-most color)
- imgui.FOCUS_CHILD_WINDOWS = 1¶
Return true if any children of the window is focused
- Type:
IsWindowFocused()
- imgui.FOCUS_ROOT_WINDOW = 2¶
Test from root window (top most parent of the current hierarchy)
- Type:
IsWindowFocused()
- imgui.FOCUS_ANY_WINDOW = 4¶
Return true if any window is focused
- Type:
IsWindowFocused()
- imgui.FOCUS_ROOT_AND_CHILD_WINDOWS = 3¶
imgui.FOCUS_CHILD_WINDOWS | imgui.FOCUS_ROOT_WINDOW
.- Type:
Shortcut
- imgui.HOVERED_NONE = 0¶
Return true if directly over the item/window, not obstructed by another window, not obstructed by an active popup or modal blocking inputs under them.
- imgui.HOVERED_CHILD_WINDOWS = 1¶
Return true if any children of the window is hovered
- Type:
IsWindowHovered() only
- imgui.HOVERED_ROOT_WINDOW = 2¶
Test from root window (top most parent of the current hierarchy)
- Type:
IsWindowHovered() only
- imgui.HOVERED_ANY_WINDOW = 4¶
Return true if any window is hovered
- Type:
IsWindowHovered() only
- imgui.HOVERED_ALLOW_WHEN_BLOCKED_BY_POPUP = 8¶
Return true even if a popup window is normally blocking access to this item/window
- imgui.HOVERED_ALLOW_WHEN_BLOCKED_BY_ACTIVE_ITEM = 32¶
Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns.
- imgui.HOVERED_ALLOW_WHEN_OVERLAPPED = 64¶
Return true even if the position is overlapped by another window
- imgui.HOVERED_RECT_ONLY = 104¶
imgui.HOVERED_ALLOW_WHEN_BLOCKED_BY_POPUP | imgui.HOVERED_ALLOW_WHEN_BLOCKED_BY_ACTIVE_ITEM | imgui.HOVERED_ALLOW_WHEN_OVERLAPPED
.- Type:
Shortcut
- imgui.HOVERED_ROOT_AND_CHILD_WINDOWS = 3¶
imgui.HOVERED_ROOT_WINDOW | imgui.HOVERED_CHILD_WINDOWS
.- Type:
Shortcut
- imgui.DRAG_DROP_SOURCE_NO_PREVIEW_TOOLTIP = 1¶
By default, a successful call to BeginDragDropSource opens a tooltip so you can display a preview or description of the source contents. This flag disable this behavior.
- imgui.DRAG_DROP_SOURCE_NO_DISABLE_HOVER = 2¶
By default, when dragging we clear data so that IsItemHovered() will return true, to avoid subsequent user code submitting tooltips. This flag disable this behavior so you can still call IsItemHovered() on the source item.
- imgui.DRAG_DROP_SOURCE_NO_HOLD_TO_OPEN_OTHERS = 4¶
Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item.
- imgui.DRAG_DROP_SOURCE_ALLOW_NULL_ID = 8¶
Allow items such as Text(), Image() that have no unique identifier to be used as drag source, by manufacturing a temporary identifier based on their window-relative position. This is extremely unusual within the dear imgui ecosystem and so we made it explicit.
- imgui.DRAG_DROP_SOURCE_EXTERN = 16¶
External source (from outside of imgui), won’t attempt to read current item/window info. Will always return true. Only one Extern source can be active simultaneously.
- imgui.DRAG_DROP_SOURCE_AUTO_EXPIRE_PAYLOAD = 32¶
Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged)
- imgui.DRAG_DROP_ACCEPT_BEFORE_DELIVERY = 1024¶
AcceptDragDropPayload() will returns true even before the mouse button is released. You can then call IsDelivery() to test if the payload needs to be delivered.
- imgui.DRAG_DROP_ACCEPT_NO_DRAW_DEFAULT_RECT = 2048¶
Do not draw the default highlight rectangle when hovering over target.
- imgui.DRAG_DROP_ACCEPT_PEEK_ONLY = 3072¶
For peeking ahead and inspecting the payload before delivery.
- imgui.DIRECTION_NONE = -1¶
Direction None
- imgui.DIRECTION_LEFT = 0¶
Direction Left
- imgui.DIRECTION_RIGHT = 1¶
Direction Right
- imgui.DIRECTION_UP = 2¶
Direction Up
- imgui.DIRECTION_DOWN = 3¶
Direction Down
- imgui.SORT_DIRECTION_ASCENDING = 1¶
Ascending = 0->9, A->Z etc.
- imgui.SORT_DIRECTION_DESCENDING = 2¶
Descending = 9->0, Z->A etc.
- imgui.MOUSE_CURSOR_TEXT_INPUT = 1¶
When hovering over InputText, etc.
- imgui.MOUSE_CURSOR_RESIZE_ALL = 2¶
Unused
- imgui.MOUSE_CURSOR_RESIZE_NS = 3¶
When hovering over an horizontal border
- imgui.MOUSE_CURSOR_RESIZE_EW = 4¶
When hovering over a vertical border or a column
- imgui.MOUSE_CURSOR_RESIZE_NESW = 5¶
When hovering over the bottom-left corner of a window
- imgui.MOUSE_CURSOR_RESIZE_NWSE = 6¶
When hovering over the bottom-right corner of a window
- imgui.MOUSE_CURSOR_HAND = 7¶
(Unused by imgui functions. Use for e.g. hyperlinks)
- imgui.INPUT_TEXT_CHARS_DECIMAL = 1¶
Allow
0123456789.+-*/
- imgui.INPUT_TEXT_CHARS_HEXADECIMAL = 2¶
Allow
0123456789ABCDEFabcdef
- imgui.INPUT_TEXT_CHARS_UPPERCASE = 4¶
Turn a..z into A..Z
- imgui.INPUT_TEXT_CHARS_NO_BLANK = 8¶
Filter out spaces, tabs
- imgui.INPUT_TEXT_AUTO_SELECT_ALL = 16¶
Select entire text when first taking mouse focus
- imgui.INPUT_TEXT_ENTER_RETURNS_TRUE = 32¶
Return ‘true’ when Enter is pressed (as opposed to when the value was modified)
- imgui.INPUT_TEXT_CALLBACK_COMPLETION = 64¶
Call user function on pressing TAB (for completion handling)
- imgui.INPUT_TEXT_CALLBACK_HISTORY = 128¶
Call user function on pressing Up/Down arrows (for history handling)
- imgui.INPUT_TEXT_CALLBACK_ALWAYS = 256¶
Call user function every time. User code may query cursor position, modify text buffer.
- imgui.INPUT_TEXT_CALLBACK_CHAR_FILTER = 512¶
Call user function to filter character. Modify data->EventChar to replace/filter input, or return 1 to discard character.
- imgui.INPUT_TEXT_ALLOW_TAB_INPUT = 1024¶
Pressing TAB input a ‘t’ character into the text field
- imgui.INPUT_TEXT_CTRL_ENTER_FOR_NEW_LINE = 2048¶
In multi-line mode, allow exiting edition by pressing Enter. Ctrl+Enter to add new line (by default adds new lines with Enter).
- imgui.INPUT_TEXT_NO_HORIZONTAL_SCROLL = 4096¶
Disable following the cursor horizontally
- imgui.INPUT_TEXT_ALWAYS_OVERWRITE = 8192¶
Overwrite mode
- imgui.INPUT_TEXT_ALWAYS_INSERT_MODE = 8192¶
OBSOLETED in 1.82 (from Mars 2021)
- imgui.INPUT_TEXT_READ_ONLY = 16384¶
Read-only mode
- imgui.INPUT_TEXT_PASSWORD = 32768¶
Password mode, display all characters as ‘*’
- imgui.INPUT_TEXT_NO_UNDO_REDO = 65536¶
Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call clear_active_id().
- imgui.DRAW_NONE = 0¶
None
- imgui.DRAW_CLOSED = 1¶
specify that shape should be closed (Important: this is always == 1 for legacy reason)
- Type:
path_stroke(), add_polyline()
- imgui.DRAW_ROUND_CORNERS_TOP_LEFT = 16¶
enable rounding top-left corner only (when rounding > 0.0f, we default to all corners). Was 0x01.
- Type:
add_rect(), add_rect_filled(), path_rect()
- imgui.DRAW_ROUND_CORNERS_TOP_RIGHT = 32¶
enable rounding top-right corner only (when rounding > 0.0f, we default to all corners). Was 0x02.
- Type:
add_rect(), add_rect_filled(), path_rect()
- imgui.DRAW_ROUND_CORNERS_BOTTOM_LEFT = 64¶
enable rounding bottom-left corner only (when rounding > 0.0f, we default to all corners). Was 0x04.
- Type:
add_rect(), add_rect_filled(), path_rect()
- imgui.DRAW_ROUND_CORNERS_BOTTOM_RIGHT = 128¶
enable rounding bottom-right corner only (when rounding > 0.0f, we default to all corners). Wax 0x08.
- Type:
add_rect(), add_rect_filled(), path_rect()
- imgui.DRAW_ROUND_CORNERS_NONE = 256¶
disable rounding on all corners (when rounding > 0.0f). This is NOT zero, NOT an implicit flag!
- Type:
add_rect(), add_rect_filled(), path_rect()
- imgui.DRAW_ROUND_CORNERS_TOP = 48¶
DRAW_ROUND_CORNERS_TOP_LEFT | DRAW_ROUND_CORNERS_TOP_RIGHT
- imgui.DRAW_ROUND_CORNERS_BOTTOM = 192¶
DRAW_ROUND_CORNERS_BOTTOM_LEFT | DRAW_ROUND_CORNERS_BOTTOM_RIGHT
- imgui.DRAW_ROUND_CORNERS_LEFT = 80¶
DRAW_ROUND_CORNERS_BOTTOM_LEFT | DRAW_ROUND_CORNERS_TOP_LEFT
- imgui.DRAW_ROUND_CORNERS_RIGHT = 160¶
DRAW_ROUND_CORNERS_BOTTOM_RIGHT | DRAW_ROUND_CORNERS_TOP_RIGHT
- imgui.DRAW_ROUND_CORNERS_ALL = 240¶
DRAW_ROUND_CORNERS_TOP_LEFT | DRAW_ROUND_CORNERS_TOP_RIGHT | DRAW_ROUND_CORNERS_BOTTOM_LEFT | DRAW_ROUND_CORNERS_BOTTOM_RIGHT
- imgui.VIEWPORT_FLAGS_NONE = 0¶
None
- imgui.VIEWPORT_FLAGS_IS_PLATFORM_WINDOW = 1¶
Represent a Platform Window
- imgui.VIEWPORT_FLAGS_IS_PLATFORM_MONITOR = 2¶
Represent a Platform Monitor (unused yet)
- imgui.VIEWPORT_FLAGS_OWNED_BY_APP = 4¶
is created/managed by the application (rather than a dear imgui backend)
- Type:
Platform Window