ImGuiIO

Static Members #

Queue a new key down/up event. Key should be "translated" (as in, generally ImGuiKey_A matches the key end-user would use to emit an 'A' character)

Queue a new key down/up event for analog values (e.g. ImGuiKey_Gamepad_ values). Dead-zones should be handled by the backend.

Queue a mouse position update. Use -FLT_MAX,-FLT_MAX to signify no mouse (e.g. app not focused and not hovered)

Queue a mouse button change

Queue a mouse wheel update. wheel_y<0: scroll down, wheel_y>0: scroll up, wheel_x<0: scroll right, wheel_x>0: scroll left.

Queue a mouse source change (Mouse/TouchScreen/Pen)

Queue a mouse hovered viewport. Requires backend to set ImGuiBackendFlags_HasMouseHoveredViewport to call this (for multi-viewport support).

Queue a gain/loss of focus for the application (generally based on OS/platform focus of your window)

Queue a new character input

Queue a new character input from a UTF-16 character, it can be a surrogate

Queue a new characters input from a UTF-8 string

[Optional] Specify index for legacy <1.87 IsKeyXXX() functions with native indices + specify native keycode, scancode.

Implied native_legacy_index = -1

Set master flag for accepting key/mouse/text events (default to true). Useful if you have native dialog boxes that are interrupting your application loop/refresh, and you want to disable events being queued while your app is frozen.

Clear all incoming events.

Clear current keyboard/gamepad state + current frame text input buffer. Equivalent to releasing all keys/buttons.

Clear current mouse state.

Instance Members #

= 0 // See ImGuiConfigFlags_ enum. Set by user/application. Keyboard/Gamepad navigation options, etc.

= 0 // See ImGuiBackendFlags_ enum. Set by backend (imgui_impl_xxx files or custom backend) to communicate features supported by the backend.

// Main display size, in pixels (== GetMainViewport()->Size). May change every frame.

= (1, 1) // Main display density. For retina display where window coordinates are different from framebuffer coordinates. This will affect font density + will end up in ImDrawData::FramebufferScale.

= 1.0f/60.0f // Time elapsed since last frame, in seconds. May change every frame.

= 5.0f // Minimum time between saving positions/sizes to .ini file, in seconds.

= "imgui.ini" // Path to .ini file (important: default "imgui.ini" is relative to current working dir!). Set NULL to disable automatic .ini loading/saving or if you want to manually call LoadIniSettingsXXX() / SaveIniSettingsXXX() functions.

= "imgui_log.txt"// Path to .log file (default parameter to ImGui::LogToFile when no file is specified).

= NULL // Store your own data.

// Font atlas: load, rasterize and pack one or more fonts into a single texture.

= NULL // Font to use on NewFrame(). Use NULL to uses Fonts->Fonts[0].

= false // Allow user scaling text of individual window with Ctrl+Wheel.

= false // Swap Activate<>Cancel (A<>B) buttons, matching typical "Nintendo/Japanese style" gamepad layout.

= false // Directional/tabbing navigation teleports the mouse cursor. May be useful on TV/console systems where moving a virtual mouse is difficult. Will update io.MousePos and set io.WantSetMousePos=true.

= true // Sets io.WantCaptureKeyboard when io.NavActive is set.

= true // Pressing Escape can clear focused item + navigation id/highlight. Set to false if you want to always keep highlight on.

= false // Pressing Escape can clear focused window as well (super set of io.ConfigNavEscapeClearFocusItem).

= true // Using directional navigation key makes the cursor visible. Mouse click hides the cursor.

= false // Navigation cursor is always visible.

= false // Simplified docking mode: disable window splitting, so docking is limited to merging multiple windows together into tab-bars.

= false // Simplified docking mode: disable window merging into a same tab-bar, so docking is limited to splitting windows.

= false // Enable docking with holding Shift key (reduce visual noise, allows dropping in wider space)

= false // [BETA] [FIXME: This currently creates regression with auto-sizing and general overhead] Make every single floating window display within a docking node.

= false // [BETA] Make window or viewport transparent when docking and only display docking boxes on the target viewport. Useful if rendering of multiple viewport cannot be synced. Best used with ConfigViewportsNoAutoMerge.

= false; // Set to make all floating imgui windows always create their own viewport. Otherwise, they are merged into the main host viewports when overlapping it. May also set ImGuiViewportFlags_NoAutoMerge on individual viewport.

= false // Disable default OS task bar icon flag for secondary viewports. When a viewport doesn't want a task bar icon, ImGuiViewportFlags_NoTaskBarIcon will be set on it.

= true // Disable default OS window decoration flag for secondary viewports. When a viewport doesn't want window decorations, ImGuiViewportFlags_NoDecoration will be set on it. Enabling decoration can create subsequent issues at OS levels (e.g. minimum window size).

= true // Disable setting OS window parent to main viewport by default. The platform backend is expected to honor viewport->ParentViewportID to setup a parent/child relationship between the OS windows (supported if ImGuiBackendFlags_HasParentViewport is set). When parented: child windows always appear in front of their parent. Set to false if you want viewports to automatically be parent of main viewport, otherwise all viewports will be top-level OS windows. Parent/child relationship may be set on a per-window basis using ImGuiWindowClass.

= true // When a platform window is focused (e.g. using Alt+Tab, clicking Platform Title Bar), apply corresponding focus on imgui windows (may clear focus/active id from imgui windows location in other platform windows). In principle this is better enabled but we provide an opt-out, because some Linux window managers tend to eagerly focus windows (e.g. on mouse hover, or even a simple window pos/size change).

= false // [EXPERIMENTAL] Automatically overwrite style.FontScaleDpi when Monitor DPI changes. This will scale fonts but NOT scale sizes/padding for now.

= false // [EXPERIMENTAL] Scale Dear ImGui and Platform Windows when Monitor DPI changes.

= false // Request ImGui to draw a mouse cursor for you (if you are on a platform without a mouse cursor). Cannot be easily renamed to 'io.ConfigXXX' because this is frequently used by backend implementations.

= defined(APPLE) // Swap Cmd<>Ctrl keys + OS X style text editing cursor movement using Alt instead of Ctrl, Shortcuts using Cmd/Super instead of Ctrl, Line/Text Start and End using Cmd+Arrows instead of Home/End, Double click selects by word instead of selecting whole text, Multi-selection in lists uses Cmd/Super instead of Ctrl.

= true // Enable input queue trickling: some types of events submitted during the same frame (e.g. button down + up) will be spread over multiple frames, improving interactions with low framerates.

= true // Enable blinking cursor (optional as some users consider it to be distracting).

= false // [BETA] Pressing Enter will reactivate item and select all text (single-line only).

= false // [BETA] Enable turning DragXXX widgets into text input with a simple mouse click-release (without moving). Not desirable on devices without a keyboard.

= true // Enable resizing of windows from their edges and from the lower-left corner. This requires ImGuiBackendFlags_HasMouseCursors for better mouse cursor feedback. (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)

= false // Enable allowing to move windows only when clicking on their title bar. Does not apply to windows without a title bar.

= false // [EXPERIMENTAL] Ctrl+C copy the contents of focused window into the clipboard. Experimental because: (1) has known issues with nested Begin/End pairs (2) text output quality varies (3) text output is in submission order rather than spatial order.

= true // Enable scrolling page by page when clicking outside the scrollbar grab. When disabled, always scroll to clicked location. When enabled, Shift+Click scrolls to clicked location.

= 60.0f // Timer (in seconds) to free transient windows/tables memory buffers when unused. Set to -1.0f to disable.

= 0.30f // Time for a double-click, in seconds.

= 6.0f // Distance threshold to stay in to validate a double-click, in pixels.

= 6.0f // Distance threshold before considering we are dragging.

= 0.275f // When holding a key/button, time before it starts repeating, in seconds (for buttons in Repeat mode, etc.).

= 0.050f // When holding a key/button, rate at which it repeats, in seconds.

= true // Enable error recovery support. Some errors won't be detected and lead to direct crashes if recovery is disabled.

= true // Enable asserts on recoverable error. By default call IM_ASSERT() when returning from a failing IM_ASSERT_USER_ERROR()

= true // Enable debug log output on recoverable errors.

= true // Enable tooltip on recoverable errors. The tooltip include a way to enable asserts if they were disabled.

= false // Enable various tools calling IM_DEBUG_BREAK().

= true // Highlight and show an error message popup when multiple items have conflicting identifiers.

=true // Show "Item Picker" button in aforementioned popup.

= false // First-time calls to Begin()/BeginChild() will return false. NEEDS TO BE SET AT APPLICATION BOOT TIME if you don't want to miss windows.

= false // Some calls to Begin()/BeginChild() will return false. Will cycle through window depths then repeat. Suggested use: add "io.ConfigDebugBeginReturnValue = io.KeyShift" in your main loop then occasionally press SHIFT. Windows should be flickering while running.

= false // Ignore io.AddFocusEvent(false), consequently not calling io.ClearInputKeys()/io.ClearInputMouse() in input processing.

= false // Save .ini data with extra comments (particularly helpful for Docking, but makes saving slower)

= NULL

= NULL

= NULL // User data for platform backend

= NULL // User data for renderer backend

= NULL // User data for non C++ programming language backend

Set when Dear ImGui will use mouse inputs, in this case do not dispatch them to your main game/application (either way, always pass on mouse inputs to imgui). (e.g. unclicked mouse is hovering over an imgui window, widget is active, mouse was clicked over an imgui window, etc.).

Set when Dear ImGui will use keyboard inputs, in this case do not dispatch them to your main game/application (either way, always pass keyboard inputs to imgui). (e.g. InputText active, or an imgui window is focused and navigation is enabled, etc.).

Mobile/console: when set, you may display an on-screen keyboard. This is set by Dear ImGui when it wants textual keyboard input to happen (e.g. when a InputText widget is active).

MousePos has been altered, backend should reposition mouse on next frame. Rarely used! Set only when io.ConfigNavMoveSetMousePos is enabled.

When manual .ini load/save is active (io.IniFilename == NULL), this will be set to notify your application that you can call SaveIniSettingsToMemory() and save yourself. Important: clear io.WantSaveIniSettings yourself after saving!

Keyboard/Gamepad navigation is currently allowed (will handle ImGuiKey_NavXXX events) = a window is focused and it doesn't use the ImGuiWindowFlags_NoNavInputs flag.

Keyboard/Gamepad navigation highlight is visible and allowed (will handle ImGuiKey_NavXXX events).

Estimate of application framerate (rolling average over 60 frames, based on io.DeltaTime), in frame per second. Solely for convenience. Slow applications may not want to use a moving average or may want to reset underlying buffers occasionally.

Vertices output during last call to Render()

Indices output during last call to Render() = number of triangles * 3

Number of visible windows

Number of active windows

Mouse delta. Note that this is zero if either current or previous position are invalid (-FLT_MAX,-FLT_MAX), so a disappearing/reappearing mouse won't have a huge delta.

Parent UI context (needs to be set explicitly by parent).

Mouse position, in pixels. Set to ImVec2(-FLT_MAX, -FLT_MAX) if mouse is unavailable (on another screen, etc.)

Mouse wheel Vertical: 1 unit scrolls about 5 lines text. >0 scrolls Up, <0 scrolls Down. Hold Shift to turn vertical scroll into horizontal scroll.

Mouse wheel Horizontal. >0 scrolls Left, <0 scrolls Right. Most users don't have a mouse with a horizontal wheel, may not be filled by all backends.

Mouse actual input peripheral (Mouse/TouchScreen/Pen).

(Optional) Modify using io.AddMouseViewportEvent(). With multi-viewports: viewport the OS mouse is hovering. If possible IGNORING viewports with the ImGuiViewportFlags_NoInputs flag is much better (few backends can handle that). Set io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport if you can provide this info. If you don't imgui will infer the value using the rectangles and last focused time of the viewports it knows about (ignoring other OS windows).

Keyboard modifier down: Ctrl (non-macOS), Cmd (macOS)

Keyboard modifier down: Shift

Keyboard modifier down: Alt

Keyboard modifier down: Windows/Super (non-macOS), Ctrl (macOS)

Key mods flags (any of ImGuiMod_Ctrl/ImGuiMod_Shift/ImGuiMod_Alt/ImGuiMod_Super flags, same as io.KeyCtrl/KeyShift/KeyAlt/KeySuper but merged into flags). Read-only, updated by NewFrame()

Alternative to WantCaptureMouse: (WantCaptureMouse == true && WantCaptureMouseUnlessPopupClose == false) when a click over void is expected to close a popup.

Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)

On a non-Mac system, holding Shift requests WheelY to perform the equivalent of a WheelX event. On a Mac system this is already enforced by the system.

(OSX) Set to true when the current click was a Ctrl+Click that spawned a simulated right click

Touch/Pen pressure (0.0f to 1.0f, should be >0.0f only when MouseDown[0] == true). Helper storage currently unused by Dear ImGui.

Only modify via AddFocusEvent()

Only modify via SetAppAcceptingEvents()

For AddInputCharacterUTF16()

Queue of characters input (obtained by platform backend). Fill using AddInputCharacter() helper.

Metadata #