imgui package

imgui.ALWAYS = 1

Set the variable always

imgui.ONCE = 2

Only set the variable on the first call per runtime session

imgui.FIRST_USE_EVER = 4

Only set the variable if the window doesn’t exist in the .ini file

imgui.APPEARING = 8

Only set the variable if the window is appearing after being 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 = 15

for text edit CTRL+A – select all

imgui.KEY_C = 16

for text edit CTRL+C – copy

imgui.KEY_V = 17

for text edit CTRL+V – paste

imgui.KEY_X = 18

for text edit CTRL+X – cut

imgui.KEY_Y = 19

for text edit CTRL+Y – redo

imgui.KEY_Z = 20

for text edit CTRL+Z – undo

imgui.STYLE_ALPHA = 0

associated type – float.

imgui.STYLE_WINDOW_PADDING = 1

associated type – Vec2.

imgui.STYLE_WINDOW_ROUNDING = 2

associated type – float.

imgui.STYLE_WINDOW_BORDERSIZE = 3

associated type – float.

imgui.STYLE_WINDOW_MIN_SIZE = 4

associated type – Vec2.

imgui.STYLE_WINDOW_TITLE_ALIGN = 5

associated type – Vec2.

imgui.STYLE_CHILD_ROUNDING = 6

associated type – float.

imgui.STYLE_CHILD_BORDERSIZE = 7

associated type – float.

imgui.STYLE_POPUP_ROUNDING = 8

associated type – float.

imgui.STYLE_POPUP_BORDERSIZE = 9

associated type – float.

imgui.STYLE_FRAME_PADDING = 10

associated type – Vec2.

imgui.STYLE_FRAME_ROUNDING = 11

associated type – float.

imgui.STYLE_FRAME_BORDERSIZE = 12

associated type – float.

imgui.STYLE_ITEM_SPACING = 13

associated type – Vec2.

imgui.STYLE_ITEM_INNER_SPACING = 14

associated type – Vec2.

imgui.STYLE_INDENT_SPACING = 15

associated type – float.

imgui.STYLE_SCROLLBAR_SIZE = 16

associated type – float.

imgui.STYLE_SCROLLBAR_ROUNDING = 17

associated type – float.

imgui.STYLE_GRAB_MIN_SIZE = 18

associated type – float.

imgui.STYLE_GRAB_ROUNDING = 19

associated type – float.

imgui.STYLE_BUTTON_TEXT_ALIGN = 20

associated type – flags ImGuiAlign_*.

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

imgui.WINDOW_NO_SCROLL_WITH_MOUSE = 16

Disable user vertically scrolling with mouse wheel.

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_SAVED_SETTINGS = 256

Never load/save settings in .ini file.

imgui.WINDOW_NO_INPUTS = 512

Disable catching mouse or keyboard inputs.

imgui.WINDOW_MENU_BAR = 1024

Has a menu-bar.

imgui.WINDOW_HORIZONTAL_SCROLLING_BAR = 2048

Allow horizontal scrollbar to appear (off by default).

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 programatically 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.TREE_NODE_SELECTED = 1

Draw as selected

imgui.TREE_NODE_FRAMED = 2

Full colored frame (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. for imgui.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_COLLAPSING_HEADER = 26

Shortcut – imgui.TREE_NODE_FRAMED | imgui.TREE_NODE_NO_AUTO_OPEN_ON_LOG.

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

Max ~4 items visible. Tip – If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo()

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

Shortcut – imgui.COMBO_HEIGHT_SMALL | imgui.COMBO_HEIGHT_REGULAR | imgui.COMBO_HEIGHT_LARGE | imgui.COMBO_HEIGHT_LARGEST.

imgui.FOCUS_CHILD_WINDOWS = 1

IsWindowFocused() – Return true if any children of the window is focused

imgui.FOCUS_ROOT_WINDOW = 2

IsWindowFocused() – Test from root window (top most parent of the current hierarchy)

imgui.FOCUS_ANY_WINDOW = 4

IsWindowFocused() – Return true if any window is focused

imgui.FOCUS_ROOT_AND_CHILD_WINDOWS = 3

Shortcut – imgui.FOCUS_CHILD_WINDOWS | imgui.FOCUS_ROOT_WINDOW.

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

IsWindowHovered() only – Return true if any children of the window is hovered

imgui.HOVERED_ROOT_WINDOW = 2

IsWindowHovered() only – Test from root window (top most parent of the current hierarchy)

imgui.HOVERED_ANY_WINDOW = 4

IsWindowHovered() only – Return true if any window is hovered

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

Shortcut – imgui.HOVERED_ALLOW_WHEN_BLOCKED_BY_POPUP | imgui.HOVERED_ALLOW_WHEN_BLOCKED_BY_ACTIVE_ITEM | imgui.HOVERED_ALLOW_WHEN_OVERLAPPED.

imgui.HOVERED_ROOT_AND_CHILD_WINDOWS = 3

Shortcut – imgui.HOVERED_ROOT_WINDOW | imgui.HOVERED_CHILD_WINDOWS.

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.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.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_INSERT_MODE = 8192

Insert mode

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

class imgui.Vec2(x, y)

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

x

Alias for field number 0

y

Alias for field number 1

class imgui.Vec4(x, y, z, w)

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

w

Alias for field number 3

x

Alias for field number 0

y

Alias for field number 1

z

Alias for field number 2