Contents¶
- Usage guide
- API reference
- imgui package
NONEALWAYSONCEFIRST_USE_EVERAPPEARINGKEY_TABKEY_LEFT_ARROWKEY_RIGHT_ARROWKEY_UP_ARROWKEY_DOWN_ARROWKEY_HOMEKEY_ENDKEY_INSERTKEY_DELETEKEY_BACKSPACEKEY_SPACEKEY_ENTERKEY_ESCAPEKEY_AKEY_CKEY_VKEY_XKEY_YKEY_ZNAV_INPUT_ACTIVATENAV_INPUT_CANCELNAV_INPUT_INPUTNAV_INPUT_MENUNAV_INPUT_DPAD_LEFTNAV_INPUT_L_STICK_LEFTNAV_INPUT_FOCUS_PREVNAV_INPUT_FOCUS_NEXTNAV_INPUT_TWEAK_SLOWNAV_INPUT_TWEAK_FASTSTYLE_ALPHASTYLE_WINDOW_PADDINGSTYLE_WINDOW_ROUNDINGSTYLE_WINDOW_BORDERSIZESTYLE_WINDOW_MIN_SIZESTYLE_WINDOW_TITLE_ALIGNSTYLE_CHILD_ROUNDINGSTYLE_CHILD_BORDERSIZESTYLE_POPUP_ROUNDINGSTYLE_POPUP_BORDERSIZESTYLE_FRAME_PADDINGSTYLE_FRAME_ROUNDINGSTYLE_FRAME_BORDERSIZESTYLE_ITEM_SPACINGSTYLE_ITEM_INNER_SPACINGSTYLE_INDENT_SPACINGSTYLE_CELL_PADDINGSTYLE_SCROLLBAR_SIZESTYLE_SCROLLBAR_ROUNDINGSTYLE_GRAB_MIN_SIZESTYLE_GRAB_ROUNDINGSTYLE_TAB_ROUNDINGSTYLE_BUTTON_TEXT_ALIGNSTYLE_SELECTABLE_TEXT_ALIGNBUTTON_MOUSE_BUTTON_LEFTBUTTON_MOUSE_BUTTON_RIGHTBUTTON_MOUSE_BUTTON_MIDDLEWINDOW_NO_TITLE_BARWINDOW_NO_RESIZEWINDOW_NO_MOVEWINDOW_NO_SCROLLBARWINDOW_NO_SCROLL_WITH_MOUSEWINDOW_NO_COLLAPSEWINDOW_ALWAYS_AUTO_RESIZEWINDOW_NO_BACKGROUNDWINDOW_NO_SAVED_SETTINGSWINDOW_NO_MOUSE_INPUTSWINDOW_MENU_BARWINDOW_HORIZONTAL_SCROLLING_BARWINDOW_NO_FOCUS_ON_APPEARINGWINDOW_NO_BRING_TO_FRONT_ON_FOCUSWINDOW_ALWAYS_VERTICAL_SCROLLBARWINDOW_ALWAYS_HORIZONTAL_SCROLLBARWINDOW_ALWAYS_USE_WINDOW_PADDINGWINDOW_NO_NAV_INPUTSWINDOW_NO_NAV_FOCUSWINDOW_UNSAVED_DOCUMENTWINDOW_NO_NAVWINDOW_NO_DECORATIONWINDOW_NO_INPUTSCOLOR_EDIT_NO_ALPHACOLOR_EDIT_NO_PICKERCOLOR_EDIT_NO_OPTIONSCOLOR_EDIT_NO_SMALL_PREVIEWCOLOR_EDIT_NO_INPUTSCOLOR_EDIT_NO_TOOLTIPCOLOR_EDIT_NO_LABELCOLOR_EDIT_NO_SIDE_PREVIEWCOLOR_EDIT_NO_DRAG_DROPCOLOR_EDIT_NO_BORDERCOLOR_EDIT_ALPHA_BARCOLOR_EDIT_ALPHA_PREVIEWCOLOR_EDIT_ALPHA_PREVIEW_HALFCOLOR_EDIT_HDRCOLOR_EDIT_DISPLAY_RGBCOLOR_EDIT_DISPLAY_HSVCOLOR_EDIT_DISPLAY_HEXCOLOR_EDIT_UINT8COLOR_EDIT_FLOATCOLOR_EDIT_PICKER_HUE_BARCOLOR_EDIT_PICKER_HUE_WHEELCOLOR_EDIT_INPUT_RGBCOLOR_EDIT_INPUT_HSVCOLOR_EDIT_DEFAULT_OPTIONSTREE_NODE_SELECTEDTREE_NODE_FRAMEDTREE_NODE_ALLOW_ITEM_OVERLAPTREE_NODE_NO_TREE_PUSH_ON_OPENTREE_NODE_NO_AUTO_OPEN_ON_LOGTREE_NODE_DEFAULT_OPENTREE_NODE_OPEN_ON_DOUBLE_CLICKTREE_NODE_OPEN_ON_ARROWTREE_NODE_LEAFTREE_NODE_BULLETTREE_NODE_FRAME_PADDINGTREE_NODE_SPAN_AVAILABLE_WIDTHTREE_NODE_SPAN_FULL_WIDTHTREE_NODE_NAV_LEFT_JUPS_BACK_HERETREE_NODE_COLLAPSING_HEADERSELECTABLE_DONT_CLOSE_POPUPSSELECTABLE_SPAN_ALL_COLUMNSSELECTABLE_ALLOW_DOUBLE_CLICKCOMBO_POPUP_ALIGN_LEFTCOMBO_HEIGHT_SMALLCOMBO_HEIGHT_REGULARCOMBO_HEIGHT_LARGECOMBO_HEIGHT_LARGESTCOMBO_NO_ARROW_BUTTONCOMBO_NO_PREVIEWCOMBO_HEIGHT_MASKTAB_BAR_REORDERABLETAB_BAR_AUTO_SELECT_NEW_TABSTAB_BAR_TAB_LIST_POPUP_BUTTONTAB_BAR_NO_CLOSE_WITH_MIDDLE_MOUSE_BUTTONTAB_BAR_NO_TAB_LIST_SCROLLING_BUTTONSTAB_BAR_NO_TOOLTIPTAB_BAR_FITTING_POLICY_RESIZE_DOWNTAB_BAR_FITTING_POLICY_SCROLLTAB_BAR_FITTING_POLICY_MASKTAB_BAR_FITTING_POLICY_DEFAULTTAB_ITEM_UNSAVED_DOCUMENTTAB_ITEM_SET_SELECTEDTAB_ITEM_NO_CLOSE_WITH_MIDDLE_MOUSE_BUTTONTAB_ITEM_NO_PUSH_IDTAB_ITEM_NO_TOOLTIPTAB_ITEM_NO_REORDERTAB_ITEM_LEADINGTAB_ITEM_TRAILINGTABLE_NONETABLE_RESIZABLETABLE_REORDERABLETABLE_HIDEABLETABLE_SORTABLETABLE_NO_SAVED_SETTINGSTABLE_CONTEXT_MENU_IN_BODYTABLE_ROW_BACKGROUNDTABLE_BORDERS_INNER_HORIZONTALTABLE_BORDERS_OUTER_HORIZONTALTABLE_BORDERS_INNER_VERTICALTABLE_BORDERS_OUTER_VERTICALTABLE_BORDERS_HORIZONTALTABLE_BORDERS_VERTICALTABLE_BORDERS_INNERTABLE_BORDERS_OUTERTABLE_BORDERSTABLE_NO_BORDERS_IN_BODYTABLE_NO_BORDERS_IN_BODY_UTIL_RESIZETABLE_SIZING_FIXED_FITTABLE_SIZING_FIXED_SAMETABLE_SIZING_STRETCH_PROPTABLE_SIZING_STRETCH_SAMETABLE_NO_HOST_EXTEND_XTABLE_NO_HOST_EXTEND_YTABLE_NO_KEEP_COLUMNS_VISIBLETABLE_PRECISE_WIDTHSTABLE_NO_CLIPTABLE_PAD_OUTER_XTABLE_NO_PAD_OUTER_XTABLE_NO_PAD_INNER_XTABLE_SCROLL_XTABLE_SCROLL_YTABLE_SORT_MULTITABLE_SORT_TRISTATETABLE_COLUMN_NONETABLE_COLUMN_DEFAULT_HIDETABLE_COLUMN_DEFAULT_SORTTABLE_COLUMN_WIDTH_STRETCHTABLE_COLUMN_WIDTH_FIXEDTABLE_COLUMN_NO_RESIZETABLE_COLUMN_NO_REORDERTABLE_COLUMN_NO_HIDETABLE_COLUMN_NO_CLIPTABLE_COLUMN_NO_SORTTABLE_COLUMN_NO_SORT_ASCENDINGTABLE_COLUMN_NO_SORT_DESCENDINGTABLE_COLUMN_NO_HEADER_WIDTHTABLE_COLUMN_PREFER_SORT_ASCENDINGTABLE_COLUMN_PREFER_SORT_DESCENDINGTABLE_COLUMN_INDENT_ENABLETABLE_COLUMN_INDENT_DISABLETABLE_COLUMN_IS_ENABLEDTABLE_COLUMN_IS_VISIBLETABLE_COLUMN_IS_SORTEDTABLE_COLUMN_IS_HOVEREDTABLE_ROW_NONETABLE_ROW_HEADERSTABLE_BACKGROUND_TARGET_NONETABLE_BACKGROUND_TARGET_ROW_BG0TABLE_BACKGROUND_TARGET_ROW_BG1TABLE_BACKGROUND_TARGET_CELL_BGFOCUS_CHILD_WINDOWSFOCUS_ROOT_WINDOWFOCUS_ANY_WINDOWFOCUS_ROOT_AND_CHILD_WINDOWSHOVERED_NONEHOVERED_CHILD_WINDOWSHOVERED_ROOT_WINDOWHOVERED_ANY_WINDOWHOVERED_ALLOW_WHEN_BLOCKED_BY_POPUPHOVERED_ALLOW_WHEN_BLOCKED_BY_ACTIVE_ITEMHOVERED_ALLOW_WHEN_OVERLAPPEDHOVERED_RECT_ONLYHOVERED_ROOT_AND_CHILD_WINDOWSDRAG_DROP_SOURCE_NO_PREVIEW_TOOLTIPDRAG_DROP_SOURCE_NO_DISABLE_HOVERDRAG_DROP_SOURCE_NO_HOLD_TO_OPEN_OTHERSDRAG_DROP_SOURCE_ALLOW_NULL_IDDRAG_DROP_SOURCE_EXTERNDRAG_DROP_SOURCE_AUTO_EXPIRE_PAYLOADDRAG_DROP_ACCEPT_BEFORE_DELIVERYDRAG_DROP_ACCEPT_NO_DRAW_DEFAULT_RECTDRAG_DROP_ACCEPT_PEEK_ONLYDIRECTION_NONEDIRECTION_LEFTDIRECTION_RIGHTDIRECTION_UPDIRECTION_DOWNSORT_DIRECTION_ASCENDINGSORT_DIRECTION_DESCENDINGMOUSE_CURSOR_TEXT_INPUTMOUSE_CURSOR_RESIZE_ALLMOUSE_CURSOR_RESIZE_NSMOUSE_CURSOR_RESIZE_EWMOUSE_CURSOR_RESIZE_NESWMOUSE_CURSOR_RESIZE_NWSEMOUSE_CURSOR_HANDINPUT_TEXT_CHARS_DECIMALINPUT_TEXT_CHARS_HEXADECIMALINPUT_TEXT_CHARS_UPPERCASEINPUT_TEXT_CHARS_NO_BLANKINPUT_TEXT_AUTO_SELECT_ALLINPUT_TEXT_ENTER_RETURNS_TRUEINPUT_TEXT_CALLBACK_COMPLETIONINPUT_TEXT_CALLBACK_HISTORYINPUT_TEXT_CALLBACK_ALWAYSINPUT_TEXT_CALLBACK_CHAR_FILTERINPUT_TEXT_ALLOW_TAB_INPUTINPUT_TEXT_CTRL_ENTER_FOR_NEW_LINEINPUT_TEXT_NO_HORIZONTAL_SCROLLINPUT_TEXT_ALWAYS_OVERWRITEINPUT_TEXT_ALWAYS_INSERT_MODEINPUT_TEXT_READ_ONLYINPUT_TEXT_PASSWORDINPUT_TEXT_NO_UNDO_REDODRAW_NONEDRAW_CLOSEDDRAW_ROUND_CORNERS_TOP_LEFTDRAW_ROUND_CORNERS_TOP_RIGHTDRAW_ROUND_CORNERS_BOTTOM_LEFTDRAW_ROUND_CORNERS_BOTTOM_RIGHTDRAW_ROUND_CORNERS_NONEDRAW_ROUND_CORNERS_TOPDRAW_ROUND_CORNERS_BOTTOMDRAW_ROUND_CORNERS_LEFTDRAW_ROUND_CORNERS_RIGHTDRAW_ROUND_CORNERS_ALLVIEWPORT_FLAGS_NONEVIEWPORT_FLAGS_IS_PLATFORM_WINDOWVIEWPORT_FLAGS_IS_PLATFORM_MONITORVIEWPORT_FLAGS_OWNED_BY_APP
- imgui.core module
_IO_FontAtlas_DrawList_StaticGlyphRangesFontConfigGlyphRangesGuiStyleImGuiErroraccept_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