Contents¶
- Usage guide
- API reference
- imgui package
NONE
ALWAYS
ONCE
FIRST_USE_EVER
APPEARING
KEY_TAB
KEY_LEFT_ARROW
KEY_RIGHT_ARROW
KEY_UP_ARROW
KEY_DOWN_ARROW
KEY_HOME
KEY_END
KEY_INSERT
KEY_DELETE
KEY_BACKSPACE
KEY_SPACE
KEY_ENTER
KEY_ESCAPE
KEY_A
KEY_C
KEY_V
KEY_X
KEY_Y
KEY_Z
NAV_INPUT_ACTIVATE
NAV_INPUT_CANCEL
NAV_INPUT_INPUT
NAV_INPUT_MENU
NAV_INPUT_DPAD_LEFT
NAV_INPUT_L_STICK_LEFT
NAV_INPUT_FOCUS_PREV
NAV_INPUT_FOCUS_NEXT
NAV_INPUT_TWEAK_SLOW
NAV_INPUT_TWEAK_FAST
STYLE_ALPHA
STYLE_WINDOW_PADDING
STYLE_WINDOW_ROUNDING
STYLE_WINDOW_BORDERSIZE
STYLE_WINDOW_MIN_SIZE
STYLE_WINDOW_TITLE_ALIGN
STYLE_CHILD_ROUNDING
STYLE_CHILD_BORDERSIZE
STYLE_POPUP_ROUNDING
STYLE_POPUP_BORDERSIZE
STYLE_FRAME_PADDING
STYLE_FRAME_ROUNDING
STYLE_FRAME_BORDERSIZE
STYLE_ITEM_SPACING
STYLE_ITEM_INNER_SPACING
STYLE_INDENT_SPACING
STYLE_CELL_PADDING
STYLE_SCROLLBAR_SIZE
STYLE_SCROLLBAR_ROUNDING
STYLE_GRAB_MIN_SIZE
STYLE_GRAB_ROUNDING
STYLE_TAB_ROUNDING
STYLE_BUTTON_TEXT_ALIGN
STYLE_SELECTABLE_TEXT_ALIGN
BUTTON_MOUSE_BUTTON_LEFT
BUTTON_MOUSE_BUTTON_RIGHT
BUTTON_MOUSE_BUTTON_MIDDLE
WINDOW_NO_TITLE_BAR
WINDOW_NO_RESIZE
WINDOW_NO_MOVE
WINDOW_NO_SCROLLBAR
WINDOW_NO_SCROLL_WITH_MOUSE
WINDOW_NO_COLLAPSE
WINDOW_ALWAYS_AUTO_RESIZE
WINDOW_NO_BACKGROUND
WINDOW_NO_SAVED_SETTINGS
WINDOW_NO_MOUSE_INPUTS
WINDOW_MENU_BAR
WINDOW_HORIZONTAL_SCROLLING_BAR
WINDOW_NO_FOCUS_ON_APPEARING
WINDOW_NO_BRING_TO_FRONT_ON_FOCUS
WINDOW_ALWAYS_VERTICAL_SCROLLBAR
WINDOW_ALWAYS_HORIZONTAL_SCROLLBAR
WINDOW_ALWAYS_USE_WINDOW_PADDING
WINDOW_NO_NAV_INPUTS
WINDOW_NO_NAV_FOCUS
WINDOW_UNSAVED_DOCUMENT
WINDOW_NO_NAV
WINDOW_NO_DECORATION
WINDOW_NO_INPUTS
COLOR_EDIT_NO_ALPHA
COLOR_EDIT_NO_PICKER
COLOR_EDIT_NO_OPTIONS
COLOR_EDIT_NO_SMALL_PREVIEW
COLOR_EDIT_NO_INPUTS
COLOR_EDIT_NO_TOOLTIP
COLOR_EDIT_NO_LABEL
COLOR_EDIT_NO_SIDE_PREVIEW
COLOR_EDIT_NO_DRAG_DROP
COLOR_EDIT_NO_BORDER
COLOR_EDIT_ALPHA_BAR
COLOR_EDIT_ALPHA_PREVIEW
COLOR_EDIT_ALPHA_PREVIEW_HALF
COLOR_EDIT_HDR
COLOR_EDIT_DISPLAY_RGB
COLOR_EDIT_DISPLAY_HSV
COLOR_EDIT_DISPLAY_HEX
COLOR_EDIT_UINT8
COLOR_EDIT_FLOAT
COLOR_EDIT_PICKER_HUE_BAR
COLOR_EDIT_PICKER_HUE_WHEEL
COLOR_EDIT_INPUT_RGB
COLOR_EDIT_INPUT_HSV
COLOR_EDIT_DEFAULT_OPTIONS
TREE_NODE_SELECTED
TREE_NODE_FRAMED
TREE_NODE_ALLOW_ITEM_OVERLAP
TREE_NODE_NO_TREE_PUSH_ON_OPEN
TREE_NODE_NO_AUTO_OPEN_ON_LOG
TREE_NODE_DEFAULT_OPEN
TREE_NODE_OPEN_ON_DOUBLE_CLICK
TREE_NODE_OPEN_ON_ARROW
TREE_NODE_LEAF
TREE_NODE_BULLET
TREE_NODE_FRAME_PADDING
TREE_NODE_SPAN_AVAILABLE_WIDTH
TREE_NODE_SPAN_FULL_WIDTH
TREE_NODE_NAV_LEFT_JUPS_BACK_HERE
TREE_NODE_COLLAPSING_HEADER
SELECTABLE_DONT_CLOSE_POPUPS
SELECTABLE_SPAN_ALL_COLUMNS
SELECTABLE_ALLOW_DOUBLE_CLICK
COMBO_POPUP_ALIGN_LEFT
COMBO_HEIGHT_SMALL
COMBO_HEIGHT_REGULAR
COMBO_HEIGHT_LARGE
COMBO_HEIGHT_LARGEST
COMBO_NO_ARROW_BUTTON
COMBO_NO_PREVIEW
COMBO_HEIGHT_MASK
TAB_BAR_REORDERABLE
TAB_BAR_AUTO_SELECT_NEW_TABS
TAB_BAR_TAB_LIST_POPUP_BUTTON
TAB_BAR_NO_CLOSE_WITH_MIDDLE_MOUSE_BUTTON
TAB_BAR_NO_TAB_LIST_SCROLLING_BUTTONS
TAB_BAR_NO_TOOLTIP
TAB_BAR_FITTING_POLICY_RESIZE_DOWN
TAB_BAR_FITTING_POLICY_SCROLL
TAB_BAR_FITTING_POLICY_MASK
TAB_BAR_FITTING_POLICY_DEFAULT
TAB_ITEM_UNSAVED_DOCUMENT
TAB_ITEM_SET_SELECTED
TAB_ITEM_NO_CLOSE_WITH_MIDDLE_MOUSE_BUTTON
TAB_ITEM_NO_PUSH_ID
TAB_ITEM_NO_TOOLTIP
TAB_ITEM_NO_REORDER
TAB_ITEM_LEADING
TAB_ITEM_TRAILING
TABLE_NONE
TABLE_RESIZABLE
TABLE_REORDERABLE
TABLE_HIDEABLE
TABLE_SORTABLE
TABLE_NO_SAVED_SETTINGS
TABLE_CONTEXT_MENU_IN_BODY
TABLE_ROW_BACKGROUND
TABLE_BORDERS_INNER_HORIZONTAL
TABLE_BORDERS_OUTER_HORIZONTAL
TABLE_BORDERS_INNER_VERTICAL
TABLE_BORDERS_OUTER_VERTICAL
TABLE_BORDERS_HORIZONTAL
TABLE_BORDERS_VERTICAL
TABLE_BORDERS_INNER
TABLE_BORDERS_OUTER
TABLE_BORDERS
TABLE_NO_BORDERS_IN_BODY
TABLE_NO_BORDERS_IN_BODY_UTIL_RESIZE
TABLE_SIZING_FIXED_FIT
TABLE_SIZING_FIXED_SAME
TABLE_SIZING_STRETCH_PROP
TABLE_SIZING_STRETCH_SAME
TABLE_NO_HOST_EXTEND_X
TABLE_NO_HOST_EXTEND_Y
TABLE_NO_KEEP_COLUMNS_VISIBLE
TABLE_PRECISE_WIDTHS
TABLE_NO_CLIP
TABLE_PAD_OUTER_X
TABLE_NO_PAD_OUTER_X
TABLE_NO_PAD_INNER_X
TABLE_SCROLL_X
TABLE_SCROLL_Y
TABLE_SORT_MULTI
TABLE_SORT_TRISTATE
TABLE_COLUMN_NONE
TABLE_COLUMN_DEFAULT_HIDE
TABLE_COLUMN_DEFAULT_SORT
TABLE_COLUMN_WIDTH_STRETCH
TABLE_COLUMN_WIDTH_FIXED
TABLE_COLUMN_NO_RESIZE
TABLE_COLUMN_NO_REORDER
TABLE_COLUMN_NO_HIDE
TABLE_COLUMN_NO_CLIP
TABLE_COLUMN_NO_SORT
TABLE_COLUMN_NO_SORT_ASCENDING
TABLE_COLUMN_NO_SORT_DESCENDING
TABLE_COLUMN_NO_HEADER_WIDTH
TABLE_COLUMN_PREFER_SORT_ASCENDING
TABLE_COLUMN_PREFER_SORT_DESCENDING
TABLE_COLUMN_INDENT_ENABLE
TABLE_COLUMN_INDENT_DISABLE
TABLE_COLUMN_IS_ENABLED
TABLE_COLUMN_IS_VISIBLE
TABLE_COLUMN_IS_SORTED
TABLE_COLUMN_IS_HOVERED
TABLE_ROW_NONE
TABLE_ROW_HEADERS
TABLE_BACKGROUND_TARGET_NONE
TABLE_BACKGROUND_TARGET_ROW_BG0
TABLE_BACKGROUND_TARGET_ROW_BG1
TABLE_BACKGROUND_TARGET_CELL_BG
FOCUS_CHILD_WINDOWS
FOCUS_ROOT_WINDOW
FOCUS_ANY_WINDOW
FOCUS_ROOT_AND_CHILD_WINDOWS
HOVERED_NONE
HOVERED_CHILD_WINDOWS
HOVERED_ROOT_WINDOW
HOVERED_ANY_WINDOW
HOVERED_ALLOW_WHEN_BLOCKED_BY_POPUP
HOVERED_ALLOW_WHEN_BLOCKED_BY_ACTIVE_ITEM
HOVERED_ALLOW_WHEN_OVERLAPPED
HOVERED_RECT_ONLY
HOVERED_ROOT_AND_CHILD_WINDOWS
DRAG_DROP_SOURCE_NO_PREVIEW_TOOLTIP
DRAG_DROP_SOURCE_NO_DISABLE_HOVER
DRAG_DROP_SOURCE_NO_HOLD_TO_OPEN_OTHERS
DRAG_DROP_SOURCE_ALLOW_NULL_ID
DRAG_DROP_SOURCE_EXTERN
DRAG_DROP_SOURCE_AUTO_EXPIRE_PAYLOAD
DRAG_DROP_ACCEPT_BEFORE_DELIVERY
DRAG_DROP_ACCEPT_NO_DRAW_DEFAULT_RECT
DRAG_DROP_ACCEPT_PEEK_ONLY
DIRECTION_NONE
DIRECTION_LEFT
DIRECTION_RIGHT
DIRECTION_UP
DIRECTION_DOWN
SORT_DIRECTION_ASCENDING
SORT_DIRECTION_DESCENDING
MOUSE_CURSOR_TEXT_INPUT
MOUSE_CURSOR_RESIZE_ALL
MOUSE_CURSOR_RESIZE_NS
MOUSE_CURSOR_RESIZE_EW
MOUSE_CURSOR_RESIZE_NESW
MOUSE_CURSOR_RESIZE_NWSE
MOUSE_CURSOR_HAND
INPUT_TEXT_CHARS_DECIMAL
INPUT_TEXT_CHARS_HEXADECIMAL
INPUT_TEXT_CHARS_UPPERCASE
INPUT_TEXT_CHARS_NO_BLANK
INPUT_TEXT_AUTO_SELECT_ALL
INPUT_TEXT_ENTER_RETURNS_TRUE
INPUT_TEXT_CALLBACK_COMPLETION
INPUT_TEXT_CALLBACK_HISTORY
INPUT_TEXT_CALLBACK_ALWAYS
INPUT_TEXT_CALLBACK_CHAR_FILTER
INPUT_TEXT_ALLOW_TAB_INPUT
INPUT_TEXT_CTRL_ENTER_FOR_NEW_LINE
INPUT_TEXT_NO_HORIZONTAL_SCROLL
INPUT_TEXT_ALWAYS_OVERWRITE
INPUT_TEXT_ALWAYS_INSERT_MODE
INPUT_TEXT_READ_ONLY
INPUT_TEXT_PASSWORD
INPUT_TEXT_NO_UNDO_REDO
DRAW_NONE
DRAW_CLOSED
DRAW_ROUND_CORNERS_TOP_LEFT
DRAW_ROUND_CORNERS_TOP_RIGHT
DRAW_ROUND_CORNERS_BOTTOM_LEFT
DRAW_ROUND_CORNERS_BOTTOM_RIGHT
DRAW_ROUND_CORNERS_NONE
DRAW_ROUND_CORNERS_TOP
DRAW_ROUND_CORNERS_BOTTOM
DRAW_ROUND_CORNERS_LEFT
DRAW_ROUND_CORNERS_RIGHT
DRAW_ROUND_CORNERS_ALL
VIEWPORT_FLAGS_NONE
VIEWPORT_FLAGS_IS_PLATFORM_WINDOW
VIEWPORT_FLAGS_IS_PLATFORM_MONITOR
VIEWPORT_FLAGS_OWNED_BY_APP
- imgui.core module
_IO
_FontAtlas
_DrawList
_StaticGlyphRanges
FontConfig
GlyphRanges
GuiStyle
ImGuiError
accept_drag_drop_payload()
align_text_to_frame_padding()
arrow_button()
begin()
begin_child()
begin_combo()
begin_drag_drop_source()
begin_drag_drop_target()
begin_group()
begin_list_box()
begin_main_menu_bar()
begin_menu()
begin_menu_bar()
begin_popup()
begin_popup_context_item()
begin_popup_context_void()
begin_popup_context_window()
begin_popup_modal()
begin_tab_bar()
begin_tab_item()
begin_table()
begin_tooltip()
bullet()
bullet_text()
button()
calc_text_size()
calculate_item_width()
capture_mouse_from_app()
checkbox()
checkbox_flags()
close_current_popup()
collapsing_header()
color_button()
color_convert_float4_to_u32()
color_convert_hsv_to_rgb()
color_convert_rgb_to_hsv()
color_convert_u32_to_float4()
color_edit3()
color_edit4()
columns()
combo()
create_context()
destroy_context()
drag_float()
drag_float2()
drag_float3()
drag_float4()
drag_float_range2()
drag_int()
drag_int2()
drag_int3()
drag_int4()
drag_int_range2()
drag_scalar()
drag_scalar_N()
dummy()
end()
end_child()
end_combo()
end_drag_drop_source()
end_drag_drop_target()
end_frame()
end_group()
end_list_box()
end_main_menu_bar()
end_menu()
end_menu_bar()
end_popup()
end_tab_bar()
end_tab_item()
end_table()
end_tooltip()
get_background_draw_list()
get_clipboard_text()
get_color_u32()
get_color_u32_idx()
get_color_u32_rgba()
get_column_index()
get_column_offset()
get_column_width()
get_columns_count()
get_content_region_available()
get_content_region_available_width()
get_content_region_max()
get_current_context()
get_cursor_pos()
get_cursor_pos_x()
get_cursor_pos_y()
get_cursor_position()
get_cursor_screen_pos()
get_cursor_screen_position()
get_cursor_start_pos()
get_cursor_start_position()
get_drag_drop_payload()
get_draw_data()
get_font_size()
get_font_tex_uv_white_pixel()
get_foreground_draw_list()
get_frame_height()
get_frame_height_with_spacing()
get_io()
get_item_rect_max()
get_item_rect_min()
get_item_rect_size()
get_key_index()
get_main_viewport()
get_mouse_cursor()
get_mouse_drag_delta()
get_mouse_pos()
get_mouse_position()
get_overlay_draw_list()
get_scroll_max_x()
get_scroll_max_y()
get_scroll_x()
get_scroll_y()
get_style()
get_style_color_name()
get_style_color_vec_4()
get_text_line_height()
get_text_line_height_with_spacing()
get_time()
get_tree_node_to_label_spacing()
get_version()
get_window_content_region_max()
get_window_content_region_min()
get_window_content_region_width()
get_window_draw_list()
get_window_height()
get_window_position()
get_window_size()
get_window_width()
image()
image_button()
indent()
input_double()
input_float()
input_float2()
input_float3()
input_float4()
input_int()
input_int2()
input_int3()
input_int4()
input_scalar()
input_scalar_N()
input_text()
input_text_multiline()
input_text_with_hint()
invisible_button()
is_any_item_active()
is_any_item_focused()
is_any_item_hovered()
is_item_activated()
is_item_active()
is_item_clicked()
is_item_deactivated()
is_item_deactivated_after_edit()
is_item_edited()
is_item_focused()
is_item_hovered()
is_item_toggled_open()
is_item_visible()
is_key_down()
is_key_pressed()
is_mouse_clicked()
is_mouse_double_clicked()
is_mouse_down()
is_mouse_dragging()
is_mouse_hovering_rect()
is_mouse_released()
is_popup_open()
is_rect_visible()
is_window_appearing()
is_window_collapsed()
is_window_focused()
is_window_hovered()
label_text()
listbox()
listbox_footer()
listbox_header()
load_ini_settings_from_disk()
load_ini_settings_from_memory()
menu_item()
new_frame()
new_line()
next_column()
open_popup()
open_popup_on_item_click()
plot_histogram()
plot_lines()
pop_allow_keyboard_focus()
pop_button_repeat()
pop_clip_rect()
pop_font()
pop_id()
pop_item_width()
pop_style_color()
pop_style_var()
pop_text_wrap_pos()
pop_text_wrap_position()
progress_bar()
push_allow_keyboard_focus()
push_button_repeat()
push_clip_rect()
push_font()
push_id()
push_item_width()
push_style_color()
push_style_var()
push_text_wrap_pos()
push_text_wrap_position()
radio_button()
render()
reset_mouse_drag_delta()
same_line()
save_ini_settings_to_disk()
save_ini_settings_to_memory()
selectable()
separator()
set_clipboard_text()
set_column_offset()
set_column_width()
set_current_context()
set_cursor_pos()
set_cursor_pos_x()
set_cursor_pos_y()
set_cursor_position()
set_cursor_screen_pos()
set_cursor_screen_position()
set_drag_drop_payload()
set_item_allow_overlap()
set_item_default_focus()
set_keyboard_focus_here()
set_mouse_cursor()
set_next_item_open()
set_next_item_width()
set_next_window_bg_alpha()
set_next_window_collapsed()
set_next_window_content_size()
set_next_window_focus()
set_next_window_position()
set_next_window_size()
set_next_window_size_constraints()
set_scroll_from_pos_x()
set_scroll_from_pos_y()
set_scroll_here_x()
set_scroll_here_y()
set_scroll_x()
set_scroll_y()
set_tab_item_closed()
set_tooltip()
set_window_collapsed()
set_window_collapsed_labeled()
set_window_focus()
set_window_focus_labeled()
set_window_font_scale()
set_window_position()
set_window_position_labeled()
set_window_size()
set_window_size_named()
show_about_window()
show_demo_window()
show_font_selector()
show_metrics_window()
show_style_editor()
show_style_selector()
show_test_window()
show_user_guide()
slider_angle()
slider_float()
slider_float2()
slider_float3()
slider_float4()
slider_int()
slider_int2()
slider_int3()
slider_int4()
slider_scalar()
slider_scalar_N()
small_button()
spacing()
style_colors_classic()
style_colors_dark()
style_colors_light()
tab_item_button()
table_get_column_count()
table_get_column_flags()
table_get_column_index()
table_get_column_name()
table_get_row_index()
table_get_sort_specs()
table_header()
table_headers_row()
table_next_column()
table_next_row()
table_set_background_color()
table_set_column_index()
table_setup_column()
table_setup_scroll_freeze()
text()
text_colored()
text_disabled()
text_unformatted()
text_wrapped()
tree_node()
tree_pop()
unindent()
v_slider_float()
v_slider_int()
v_slider_scalar()
- imgui.extra module
- imgui.integrations subpackage
- imgui.internal module
- imgui package