public final class ImGuiIO extends ImGuiStruct
ptr
Constructor and Description |
---|
ImGuiIO(long ptr) |
Modifier and Type | Method and Description |
---|---|
void |
addBackendFlags(int flags)
See ImGuiBackendFlags enum.
|
void |
addConfigFlags(int flags)
See ImGuiConfigFlags enum.
|
void |
addFocusEvent(boolean focused)
Queue a gain/loss of focus for the application (generally based on OS/platform focus of your window)
|
void |
addInputCharacter(int c)
Queue new character input.
|
void |
addInputCharactersUTF8(java.lang.String str)
Queue new characters input from an UTF-8 string.
|
void |
addInputCharacterUTF16(short c)
Queue new character input from an UTF-16 character, it can be a surrogate
|
void |
addKeyAnalogEvent(int key,
boolean down,
float v)
Queue a new key down/up event for analog values (e.g.
|
void |
addKeyEvent(int key,
boolean down)
Queue a new key down/up event.
|
void |
addMouseButtonEvent(int button,
boolean down)
Queue a mouse button change
|
void |
addMousePosEvent(float x,
float y)
Queue a mouse position update.
|
void |
addMouseViewportEvent(int id)
Queue a mouse hovered viewport.
|
void |
addMouseWheelEvent(float whX,
float whY)
Queue a mouse wheel update
|
void |
clearInputCharacters()
[Internal] Clear the text input buffer manually
|
void |
clearInputKeys()
[Internal] Release all keys
|
boolean |
getAppFocusLost() |
int |
getBackendFlags()
See ImGuiBackendFlags enum.
|
java.lang.String |
getBackendPlatformName()
Optional: Platform backend name (informational only! will be displayed in About Window) + User data for backend/wrappers to store their own stuff.
|
java.lang.String |
getBackendRendererName() |
short |
getBackendUsingLegacyKeyArrays()
-1: unknown, 0: using AddKeyEvent(), 1: using legacy io.KeysDown[]
|
boolean |
getBackendUsingLegacyNavInputArray()
0: using AddKeyAnalogEvent(), 1: writing to legacy io.NavInputs[] directly
|
boolean |
getConfigDockingAlwaysTabBar() |
boolean |
getConfigDockingNoSplit()
Simplified docking mode: disable window splitting, so docking is limited to merging multiple windows together into tab-bars.
|
boolean |
getConfigDockingTransparentPayload()
Make window or viewport transparent when docking and only display docking boxes on the target viewport.
|
boolean |
getConfigDockingWithShift()
Enable docking with holding Shift key (reduce visual noise, allows dropping in wider space)
|
boolean |
getConfigDragClickToInputText()
[BETA] Enable turning DragXXX widgets into text input with a simple mouse click-release (without moving).
|
int |
getConfigFlags()
See ImGuiConfigFlags enum.
|
boolean |
getConfigInputTextCursorBlink()
Set to false to disable blinking cursor, for users who consider it distracting.
|
boolean |
getConfigInputTrickleEventQueue()
Enable input queue trickling: some types of events submitted during the same frame (e.g.
|
boolean |
getConfigMacOSXBehaviors()
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
|
boolean |
getConfigMemoryCompactTimer()
[Timer (in seconds) to free transient windows/tables memory buffers when unused.
|
boolean |
getConfigViewportsNoAutoMerge()
Set to make all floating imgui windows always create their own viewport.
|
boolean |
getConfigViewportsNoDecoration()
Disable default OS window decoration flag for secondary viewports.
|
boolean |
getConfigViewportsNoDefaultParent()
Disable default OS parenting to main viewport for secondary viewports.
|
boolean |
getConfigViewportsNoTaskBarIcon()
Disable default OS task bar icon flag for secondary viewports.
|
boolean |
getConfigWindowsMoveFromTitleBarOnly()
Enable allowing to move windows only when clicking on their title bar.
|
boolean |
getConfigWindowsResizeFromEdges()
Enable resizing of windows from their edges and from the lower-left corner.
|
float |
getDeltaTime()
Time elapsed since last frame, in seconds.
|
ImVec2 |
getDisplayFramebufferScale()
For retina display or other situations where window coordinates are different from framebuffer coordinates.
|
void |
getDisplayFramebufferScale(ImVec2 dst)
For retina display or other situations where window coordinates are different from framebuffer coordinates.
|
float |
getDisplayFramebufferScaleX()
For retina display or other situations where window coordinates are different from framebuffer coordinates.
|
float |
getDisplayFramebufferScaleY()
For retina display or other situations where window coordinates are different from framebuffer coordinates.
|
ImVec2 |
getDisplaySize()
Main display size, in pixels (generally ==
GetMainViewport()->Size ) |
void |
getDisplaySize(ImVec2 dst)
Main display size, in pixels (generally ==
GetMainViewport()->Size ) |
float |
getDisplaySizeX()
Main display size, in pixels (generally ==
GetMainViewport()->Size ) |
float |
getDisplaySizeY()
Main display size, in pixels (generally ==
GetMainViewport()->Size ) |
boolean |
getFontAllowUserScaling()
Allow user scaling text of individual window with CTRL+Wheel.
|
ImFont |
getFontDefault()
Font to use on NewFrame().
|
float |
getFontGlobalScale()
Global scale all fonts
|
ImFontAtlas |
getFonts()
Font atlas: load, rasterize and pack one or more fonts into a single texture.
|
float |
getFramerate()
Application framerate estimate, in frame per second.
|
java.lang.String |
getIniFilename()
Path to .ini file.
|
float |
getIniSavingRate()
Minimum time between saving positions/sizes to .ini file, in seconds.
|
short |
getInputQueueSurrogate()
For AddInputCharacterUTF16
|
boolean |
getKeyAlt()
Keyboard modifier pressed: Alt
|
boolean |
getKeyCtrl()
Keyboard modifier pressed: Control
|
int[] |
getKeyMap()
Deprecated.
|
int |
getKeyMap(int idx)
Deprecated.
|
int |
getKeyMods()
Key mods flags (same as io.KeyCtrl/KeyShift/KeyAlt/KeySuper but merged into flags), updated by NewFrame()
|
int |
getKeyModsPrev()
Key mods flags (from previous frame)
|
float |
getKeyRepeatDelay()
When holding a key/button, time before it starts repeating, in seconds (for buttons in Repeat mode, etc.).
|
float |
getKeyRepeatRate()
When holding a key/button, rate at which it repeats, in seconds.
|
ImGuiKeyData[] |
getKeysData()
Key state for all known keys.
|
boolean[] |
getKeysDown()
Deprecated.
|
boolean |
getKeysDown(int idx)
Deprecated.
|
boolean |
getKeyShift()
Keyboard modifier pressed: Shift
|
boolean |
getKeySuper()
Keyboard modifier pressed: Cmd/Super/Windows
|
java.lang.String |
getLogFilename()
Path to .log file (default parameter to ImGui::LogToFile when no file is specified).
|
int |
getMetricsActiveAllocations()
Number of active allocations, updated by MemAlloc/MemFree based on current context.
|
int |
getMetricsActiveWindows()
Number of active windows
|
int |
getMetricsRenderIndices()
Indices output during last call to Render() = number of triangles * 3
|
int |
getMetricsRenderVertices()
Vertices output during last call to Render()
|
int |
getMetricsRenderWindows()
Number of visible windows
|
boolean[] |
getMouseClicked()
Mouse button went from !Down to Down (same as MouseClickedCount[x] != 0)
|
boolean |
getMouseClicked(int idx)
Mouse button went from !Down to Down (same as MouseClickedCount[x] != 0)
|
int[] |
getMouseClickedCount()
== 0 (not clicked), == 1 (same as MouseClicked[]), == 2 (double-clicked), == 3 (triple-clicked) etc.
|
int |
getMouseClickedCount(int idx)
== 0 (not clicked), == 1 (same as MouseClicked[]), == 2 (double-clicked), == 3 (triple-clicked) etc.
|
int[] |
getMouseClickedLastCount()
Count successive number of clicks.
|
int |
getMouseClickedLastCount(int idx)
Count successive number of clicks.
|
ImVec2[] |
getMouseClickedPos()
Position at time of clicking.
|
double[] |
getMouseClickedTime()
Time of last click (used to figure out double-click)
|
double |
getMouseClickedTime(int idx)
Time of last click (used to figure out double-click)
|
ImVec2 |
getMouseDelta()
Mouse delta.
|
void |
getMouseDelta(ImVec2 dst)
Mouse delta.
|
float |
getMouseDeltaX()
Mouse delta.
|
float |
getMouseDeltaY()
Mouse delta.
|
boolean[] |
getMouseDoubleClicked()
Has mouse button been double-clicked? (same as MouseClickedCount[x] == 2)
|
boolean |
getMouseDoubleClicked(int idx)
Has mouse button been double-clicked? (same as MouseClickedCount[x] == 2)
|
float |
getMouseDoubleClickMaxDist()
Distance threshold to stay in to validate a double-click, in pixels.
|
float |
getMouseDoubleClickTime()
Time for a double-click, in seconds.
|
boolean[] |
getMouseDown()
Mouse buttons: 0=left, 1=right, 2=middle + extras (ImGuiMouseButton_COUNT == 5).
|
boolean |
getMouseDown(int idx)
Mouse buttons: 0=left, 1=right, 2=middle + extras (ImGuiMouseButton_COUNT == 5).
|
float[] |
getMouseDownDuration()
Duration the mouse button has been down (0.0f == just clicked)
|
float |
getMouseDownDuration(int idx)
Duration the mouse button has been down (0.0f == just clicked)
|
float[] |
getMouseDownDurationPrev()
Previous time the mouse button has been down
|
float |
getMouseDownDurationPrev(int idx)
Previous time the mouse button has been down
|
boolean[] |
getMouseDownOwned()
Track if button was clicked inside a dear imgui window or over void blocked by a popup.
|
boolean |
getMouseDownOwned(int idx)
Track if button was clicked inside a dear imgui window or over void blocked by a popup.
|
boolean[] |
getMouseDownOwnedUnlessPopupClose()
Track if button was clicked inside a dear imgui window.
|
boolean |
getMouseDownOwnedUnlessPopupClose(int idx)
Track if button was clicked inside a dear imgui window.
|
ImVec2[] |
getMouseDragMaxDistanceAbs()
Maximum distance, absolute, on each axis, of how much mouse has traveled from the clicking point
|
float[] |
getMouseDragMaxDistanceSqr()
Squared maximum distance of how much mouse has traveled from the clicking point
|
float |
getMouseDragMaxDistanceSqr(int idx)
Squared maximum distance of how much mouse has traveled from the clicking point
|
float |
getMouseDragThreshold()
Distance threshold before considering we are dragging.
|
boolean |
getMouseDrawCursor()
Request ImGui to draw a mouse cursor for you (if you are on a platform without a mouse cursor).
|
int |
getMouseHoveredViewport()
(Optional) When using multiple viewports: viewport the OS mouse cursor is hovering _IGNORING_ viewports with the ImGuiViewportFlags_NoInputs flag,
and _REGARDLESS_ of whether another viewport is focused.
|
ImVec2 |
getMousePos()
Mouse position, in pixels.
|
void |
getMousePos(ImVec2 dst)
Mouse position, in pixels.
|
ImVec2 |
getMousePosPrev()
Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)
|
void |
getMousePosPrev(ImVec2 dst)
Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)
|
float |
getMousePosPrevX()
Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)
|
float |
getMousePosPrevY()
Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)
|
float |
getMousePosX()
Mouse position, in pixels.
|
float |
getMousePosY()
Mouse position, in pixels.
|
boolean[] |
getMouseReleased()
Mouse button went from Down to !Down
|
boolean |
getMouseReleased(int idx)
Mouse button went from Down to !Down
|
float |
getMouseWheel()
Mouse wheel Vertical: 1 unit scrolls about 5 lines text.
|
float |
getMouseWheelH()
Mouse wheel Horizontal.
|
boolean |
getNavActive()
Keyboard/Gamepad navigation is currently allowed (will handle ImGuiKey_NavXXX events) = a window is focused
and it doesn't use the ImGuiWindowFlags_NoNavInputs flag.
|
float[] |
getNavInputs()
Gamepad inputs.
|
float |
getNavInputs(int idx)
Gamepad inputs.
|
float[] |
getNavInputsDownDuration() |
float |
getNavInputsDownDuration(int idx) |
float[] |
getNavInputsDownDurationPrev() |
float |
getNavInputsDownDurationPrev(int idx) |
boolean |
getNavVisible()
Keyboard/Gamepad navigation is visible and allowed (will handle ImGuiKey_NavXXX events).
|
float |
getPenPressure()
Touch/Pen pressure (0.0f to 1.0f, should be
> 0.0f only when MouseDown[0] == true). |
boolean |
getWantCaptureKeyboard()
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).
|
boolean |
getWantCaptureMouse()
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).
|
boolean |
getWantCaptureMouseUnlessPopupClose()
Alternative to WantCaptureMouse: (WantCaptureMouse == true
&& WantCaptureMouseUnlessPopupClose == false) when a click over void is expected to close a popup. |
boolean |
getWantSaveIniSettings()
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.
|
boolean |
getWantSetMousePos()
MousePos has been altered, backend should reposition mouse on next frame.
|
boolean |
getWantTextInput()
Mobile/console: when set, you may display an on-screen keyboard.
|
boolean |
hasBackendFlags(int flags)
See ImGuiBackendFlags enum.
|
boolean |
hasConfigFlags(int flags)
See ImGuiConfigFlags enum.
|
void |
removeBackendFlags(int flags)
See ImGuiBackendFlags enum.
|
void |
removeConfigFlags(int flags)
See ImGuiConfigFlags enum.
|
void |
setAppFocusLost(boolean value) |
void |
setBackendFlags(int value)
See ImGuiBackendFlags enum.
|
void |
setBackendPlatformName(java.lang.String value)
Optional: Platform backend name (informational only! will be displayed in About Window) + User data for backend/wrappers to store their own stuff.
|
void |
setBackendRendererName(java.lang.String value) |
void |
setBackendUsingLegacyKeyArrays(short value)
-1: unknown, 0: using AddKeyEvent(), 1: using legacy io.KeysDown[]
|
void |
setBackendUsingLegacyNavInputArray(boolean value)
0: using AddKeyAnalogEvent(), 1: writing to legacy io.NavInputs[] directly
|
void |
setConfigDockingAlwaysTabBar(boolean value) |
void |
setConfigDockingNoSplit(boolean value)
Simplified docking mode: disable window splitting, so docking is limited to merging multiple windows together into tab-bars.
|
void |
setConfigDockingTransparentPayload(boolean value)
Make window or viewport transparent when docking and only display docking boxes on the target viewport.
|
void |
setConfigDockingWithShift(boolean value)
Enable docking with holding Shift key (reduce visual noise, allows dropping in wider space)
|
void |
setConfigDragClickToInputText(boolean value)
[BETA] Enable turning DragXXX widgets into text input with a simple mouse click-release (without moving).
|
void |
setConfigFlags(int value)
See ImGuiConfigFlags enum.
|
void |
setConfigInputTextCursorBlink(boolean value)
Set to false to disable blinking cursor, for users who consider it distracting.
|
void |
setConfigInputTrickleEventQueue(boolean value)
Enable input queue trickling: some types of events submitted during the same frame (e.g.
|
void |
setConfigMacOSXBehaviors(boolean value)
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
|
void |
setConfigMemoryCompactTimer(boolean value)
[Timer (in seconds) to free transient windows/tables memory buffers when unused.
|
void |
setConfigViewportsNoAutoMerge(boolean value)
Set to make all floating imgui windows always create their own viewport.
|
void |
setConfigViewportsNoDecoration(boolean value)
Disable default OS window decoration flag for secondary viewports.
|
void |
setConfigViewportsNoDefaultParent(boolean value)
Disable default OS parenting to main viewport for secondary viewports.
|
void |
setConfigViewportsNoTaskBarIcon(boolean value)
Disable default OS task bar icon flag for secondary viewports.
|
void |
setConfigWindowsMoveFromTitleBarOnly(boolean value)
Enable allowing to move windows only when clicking on their title bar.
|
void |
setConfigWindowsResizeFromEdges(boolean value)
Enable resizing of windows from their edges and from the lower-left corner.
|
void |
setDeltaTime(float value)
Time elapsed since last frame, in seconds.
|
void |
setDisplayFramebufferScale(float valueX,
float valueY)
For retina display or other situations where window coordinates are different from framebuffer coordinates.
|
void |
setDisplayFramebufferScale(ImVec2 value)
For retina display or other situations where window coordinates are different from framebuffer coordinates.
|
void |
setDisplaySize(float valueX,
float valueY)
Main display size, in pixels (generally ==
GetMainViewport()->Size ) |
void |
setDisplaySize(ImVec2 value)
Main display size, in pixels (generally ==
GetMainViewport()->Size ) |
void |
setFontAllowUserScaling(boolean value)
Allow user scaling text of individual window with CTRL+Wheel.
|
void |
setFontDefault(ImFont value)
Font to use on NewFrame().
|
void |
setFontGlobalScale(float value)
Global scale all fonts
|
void |
setFonts(ImFontAtlas value)
Font atlas: load, rasterize and pack one or more fonts into a single texture.
|
void |
setFramerate(float value)
Application framerate estimate, in frame per second.
|
void |
setGetClipboardTextFn(ImStrSupplier getClipboardTextCallback) |
void |
setIniFilename(java.lang.String value)
Path to .ini file.
|
void |
setIniSavingRate(float value)
Minimum time between saving positions/sizes to .ini file, in seconds.
|
void |
setInputQueueSurrogate(short value)
For AddInputCharacterUTF16
|
void |
setKeyAlt(boolean value)
Keyboard modifier pressed: Alt
|
void |
setKeyCtrl(boolean value)
Keyboard modifier pressed: Control
|
void |
setKeyEventNativeData(int key,
int nativeKeycode,
int nativeScancode)
[Optional] Specify index for legacy before 1.87 IsKeyXXX() functions with native indices + specify native keycode, scancode.
|
void |
setKeyEventNativeData(int key,
int nativeKeycode,
int nativeScancode,
int nativeLegacyIndex)
[Optional] Specify index for legacy before 1.87 IsKeyXXX() functions with native indices + specify native keycode, scancode.
|
void |
setKeyMap(int[] value)
Deprecated.
|
void |
setKeyMap(int idx,
int value)
Deprecated.
|
void |
setKeyMods(int value)
Key mods flags (same as io.KeyCtrl/KeyShift/KeyAlt/KeySuper but merged into flags), updated by NewFrame()
|
void |
setKeyModsPrev(int value)
Key mods flags (from previous frame)
|
void |
setKeyRepeatDelay(float value)
When holding a key/button, time before it starts repeating, in seconds (for buttons in Repeat mode, etc.).
|
void |
setKeyRepeatRate(float value)
When holding a key/button, rate at which it repeats, in seconds.
|
void |
setKeysData(ImGuiKeyData[] value)
Key state for all known keys.
|
void |
setKeysDown(boolean[] value)
Deprecated.
|
void |
setKeysDown(int idx,
boolean value)
Deprecated.
|
void |
setKeyShift(boolean value)
Keyboard modifier pressed: Shift
|
void |
setKeySuper(boolean value)
Keyboard modifier pressed: Cmd/Super/Windows
|
void |
setLogFilename(java.lang.String value)
Path to .log file (default parameter to ImGui::LogToFile when no file is specified).
|
void |
setMetricsActiveAllocations(int value)
Number of active allocations, updated by MemAlloc/MemFree based on current context.
|
void |
setMetricsActiveWindows(int value)
Number of active windows
|
void |
setMetricsRenderIndices(int value)
Indices output during last call to Render() = number of triangles * 3
|
void |
setMetricsRenderVertices(int value)
Vertices output during last call to Render()
|
void |
setMetricsRenderWindows(int value)
Number of visible windows
|
void |
setMouseClicked(boolean[] value)
Mouse button went from !Down to Down (same as MouseClickedCount[x] != 0)
|
void |
setMouseClicked(int idx,
boolean value)
Mouse button went from !Down to Down (same as MouseClickedCount[x] != 0)
|
void |
setMouseClickedCount(int[] value)
== 0 (not clicked), == 1 (same as MouseClicked[]), == 2 (double-clicked), == 3 (triple-clicked) etc.
|
void |
setMouseClickedCount(int idx,
int value)
== 0 (not clicked), == 1 (same as MouseClicked[]), == 2 (double-clicked), == 3 (triple-clicked) etc.
|
void |
setMouseClickedLastCount(int[] value)
Count successive number of clicks.
|
void |
setMouseClickedLastCount(int idx,
int value)
Count successive number of clicks.
|
void |
setMouseClickedPos(ImVec2[] value)
Position at time of clicking.
|
void |
setMouseClickedTime(double[] value)
Time of last click (used to figure out double-click)
|
void |
setMouseClickedTime(int idx,
double value)
Time of last click (used to figure out double-click)
|
void |
setMouseDelta(float valueX,
float valueY)
Mouse delta.
|
void |
setMouseDelta(ImVec2 value)
Mouse delta.
|
void |
setMouseDoubleClicked(boolean[] value)
Has mouse button been double-clicked? (same as MouseClickedCount[x] == 2)
|
void |
setMouseDoubleClicked(int idx,
boolean value)
Has mouse button been double-clicked? (same as MouseClickedCount[x] == 2)
|
void |
setMouseDoubleClickMaxDist(float value)
Distance threshold to stay in to validate a double-click, in pixels.
|
void |
setMouseDoubleClickTime(float value)
Time for a double-click, in seconds.
|
void |
setMouseDown(boolean[] value)
Mouse buttons: 0=left, 1=right, 2=middle + extras (ImGuiMouseButton_COUNT == 5).
|
void |
setMouseDown(int idx,
boolean value)
Mouse buttons: 0=left, 1=right, 2=middle + extras (ImGuiMouseButton_COUNT == 5).
|
void |
setMouseDownDuration(float[] value)
Duration the mouse button has been down (0.0f == just clicked)
|
void |
setMouseDownDuration(int idx,
float value)
Duration the mouse button has been down (0.0f == just clicked)
|
void |
setMouseDownDurationPrev(float[] value)
Previous time the mouse button has been down
|
void |
setMouseDownDurationPrev(int idx,
float value)
Previous time the mouse button has been down
|
void |
setMouseDownOwned(boolean[] value)
Track if button was clicked inside a dear imgui window or over void blocked by a popup.
|
void |
setMouseDownOwned(int idx,
boolean value)
Track if button was clicked inside a dear imgui window or over void blocked by a popup.
|
void |
setMouseDownOwnedUnlessPopupClose(boolean[] value)
Track if button was clicked inside a dear imgui window.
|
void |
setMouseDownOwnedUnlessPopupClose(int idx,
boolean value)
Track if button was clicked inside a dear imgui window.
|
void |
setMouseDragMaxDistanceAbs(ImVec2[] value)
Maximum distance, absolute, on each axis, of how much mouse has traveled from the clicking point
|
void |
setMouseDragMaxDistanceSqr(float[] value)
Squared maximum distance of how much mouse has traveled from the clicking point
|
void |
setMouseDragMaxDistanceSqr(int idx,
float value)
Squared maximum distance of how much mouse has traveled from the clicking point
|
void |
setMouseDragThreshold(float value)
Distance threshold before considering we are dragging.
|
void |
setMouseDrawCursor(boolean value)
Request ImGui to draw a mouse cursor for you (if you are on a platform without a mouse cursor).
|
void |
setMouseHoveredViewport(int value)
(Optional) When using multiple viewports: viewport the OS mouse cursor is hovering _IGNORING_ viewports with the ImGuiViewportFlags_NoInputs flag,
and _REGARDLESS_ of whether another viewport is focused.
|
void |
setMousePos(float valueX,
float valueY)
Mouse position, in pixels.
|
void |
setMousePos(ImVec2 value)
Mouse position, in pixels.
|
void |
setMousePosPrev(float valueX,
float valueY)
Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)
|
void |
setMousePosPrev(ImVec2 value)
Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid)
|
void |
setMouseReleased(boolean[] value)
Mouse button went from Down to !Down
|
void |
setMouseReleased(int idx,
boolean value)
Mouse button went from Down to !Down
|
void |
setMouseWheel(float value)
Mouse wheel Vertical: 1 unit scrolls about 5 lines text.
|
void |
setMouseWheelH(float value)
Mouse wheel Horizontal.
|
void |
setNavActive(boolean value)
Keyboard/Gamepad navigation is currently allowed (will handle ImGuiKey_NavXXX events) = a window is focused
and it doesn't use the ImGuiWindowFlags_NoNavInputs flag.
|
void |
setNavInputs(float[] value)
Gamepad inputs.
|
void |
setNavInputs(int idx,
float value)
Gamepad inputs.
|
void |
setNavInputsDownDuration(float[] value) |
void |
setNavInputsDownDuration(int idx,
float value) |
void |
setNavInputsDownDurationPrev(float[] value) |
void |
setNavInputsDownDurationPrev(int idx,
float value) |
void |
setNavVisible(boolean value)
Keyboard/Gamepad navigation is visible and allowed (will handle ImGuiKey_NavXXX events).
|
void |
setPenPressure(float value)
Touch/Pen pressure (0.0f to 1.0f, should be
> 0.0f only when MouseDown[0] == true). |
void |
setSetClipboardTextFn(ImStrConsumer setClipboardTextCallback) |
void |
setWantCaptureKeyboard(boolean value)
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).
|
void |
setWantCaptureMouse(boolean value)
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).
|
void |
setWantCaptureMouseUnlessPopupClose(boolean value)
Alternative to WantCaptureMouse: (WantCaptureMouse == true
&& WantCaptureMouseUnlessPopupClose == false) when a click over void is expected to close a popup. |
void |
setWantSaveIniSettings(boolean value)
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.
|
void |
setWantSetMousePos(boolean value)
MousePos has been altered, backend should reposition mouse on next frame.
|
void |
setWantTextInput(boolean value)
Mobile/console: when set, you may display an on-screen keyboard.
|
isNotValidPtr, isValidPtr
public int getConfigFlags()
public void setConfigFlags(int value)
public void addConfigFlags(int flags)
public void removeConfigFlags(int flags)
public boolean hasConfigFlags(int flags)
public int getBackendFlags()
public void setBackendFlags(int value)
public void addBackendFlags(int flags)
public void removeBackendFlags(int flags)
public boolean hasBackendFlags(int flags)
public ImVec2 getDisplaySize()
GetMainViewport()->Size
)public float getDisplaySizeX()
GetMainViewport()->Size
)public float getDisplaySizeY()
GetMainViewport()->Size
)public void getDisplaySize(ImVec2 dst)
GetMainViewport()->Size
)public void setDisplaySize(ImVec2 value)
GetMainViewport()->Size
)public void setDisplaySize(float valueX, float valueY)
GetMainViewport()->Size
)public float getDeltaTime()
public void setDeltaTime(float value)
public float getIniSavingRate()
public void setIniSavingRate(float value)
public java.lang.String getIniFilename()
public void setIniFilename(java.lang.String value)
public java.lang.String getLogFilename()
public void setLogFilename(java.lang.String value)
public float getMouseDoubleClickTime()
public void setMouseDoubleClickTime(float value)
public float getMouseDoubleClickMaxDist()
public void setMouseDoubleClickMaxDist(float value)
public float getMouseDragThreshold()
public void setMouseDragThreshold(float value)
public float getKeyRepeatDelay()
public void setKeyRepeatDelay(float value)
public float getKeyRepeatRate()
public void setKeyRepeatRate(float value)
public ImFontAtlas getFonts()
public void setFonts(ImFontAtlas value)
public float getFontGlobalScale()
public void setFontGlobalScale(float value)
public boolean getFontAllowUserScaling()
public void setFontAllowUserScaling(boolean value)
public ImFont getFontDefault()
->
Fonts[0].public void setFontDefault(ImFont value)
->
Fonts[0].public ImVec2 getDisplayFramebufferScale()
public float getDisplayFramebufferScaleX()
public float getDisplayFramebufferScaleY()
public void getDisplayFramebufferScale(ImVec2 dst)
public void setDisplayFramebufferScale(ImVec2 value)
public void setDisplayFramebufferScale(float valueX, float valueY)
public boolean getConfigDockingNoSplit()
public void setConfigDockingNoSplit(boolean value)
public boolean getConfigDockingWithShift()
public void setConfigDockingWithShift(boolean value)
public boolean getConfigDockingAlwaysTabBar()
public void setConfigDockingAlwaysTabBar(boolean value)
public boolean getConfigDockingTransparentPayload()
public void setConfigDockingTransparentPayload(boolean value)
public boolean getConfigViewportsNoAutoMerge()
public void setConfigViewportsNoAutoMerge(boolean value)
public boolean getConfigViewportsNoTaskBarIcon()
public void setConfigViewportsNoTaskBarIcon(boolean value)
public boolean getConfigViewportsNoDecoration()
public void setConfigViewportsNoDecoration(boolean value)
public boolean getConfigViewportsNoDefaultParent()
<main_viewport>
, expecting the platform backend to setup a parent/child relationship between the OS windows (some backend may ignore this). Set to true if you want the default to be 0, then all viewports will be top-level OS windows.public void setConfigViewportsNoDefaultParent(boolean value)
<main_viewport>
, expecting the platform backend to setup a parent/child relationship between the OS windows (some backend may ignore this). Set to true if you want the default to be 0, then all viewports will be top-level OS windows.public boolean getMouseDrawCursor()
public void setMouseDrawCursor(boolean value)
public boolean getConfigMacOSXBehaviors()
public void setConfigMacOSXBehaviors(boolean value)
public boolean getConfigInputTrickleEventQueue()
public void setConfigInputTrickleEventQueue(boolean value)
public boolean getConfigInputTextCursorBlink()
public void setConfigInputTextCursorBlink(boolean value)
public boolean getConfigDragClickToInputText()
public void setConfigDragClickToInputText(boolean value)
public boolean getConfigWindowsResizeFromEdges()
&
ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
(This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)public void setConfigWindowsResizeFromEdges(boolean value)
&
ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
(This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)public boolean getConfigWindowsMoveFromTitleBarOnly()
public void setConfigWindowsMoveFromTitleBarOnly(boolean value)
public boolean getConfigMemoryCompactTimer()
public void setConfigMemoryCompactTimer(boolean value)
public java.lang.String getBackendPlatformName()
public void setBackendPlatformName(java.lang.String value)
public java.lang.String getBackendRendererName()
public void setBackendRendererName(java.lang.String value)
public void setSetClipboardTextFn(ImStrConsumer setClipboardTextCallback)
public void setGetClipboardTextFn(ImStrSupplier getClipboardTextCallback)
public void addKeyEvent(int key, boolean down)
public void addKeyAnalogEvent(int key, boolean down, float v)
public void addMousePosEvent(float x, float y)
public void addMouseButtonEvent(int button, boolean down)
public void addMouseWheelEvent(float whX, float whY)
public void addMouseViewportEvent(int id)
public void addFocusEvent(boolean focused)
public void addInputCharacter(int c)
public void addInputCharacterUTF16(short c)
public void addInputCharactersUTF8(java.lang.String str)
public void clearInputCharacters()
public void clearInputKeys()
public void setKeyEventNativeData(int key, int nativeKeycode, int nativeScancode)
public void setKeyEventNativeData(int key, int nativeKeycode, int nativeScancode, int nativeLegacyIndex)
public boolean getWantCaptureMouse()
public void setWantCaptureMouse(boolean value)
public boolean getWantCaptureKeyboard()
public void setWantCaptureKeyboard(boolean value)
public boolean getWantTextInput()
public void setWantTextInput(boolean value)
public boolean getWantSetMousePos()
public void setWantSetMousePos(boolean value)
public boolean getWantSaveIniSettings()
public void setWantSaveIniSettings(boolean value)
public boolean getNavActive()
public void setNavActive(boolean value)
public boolean getNavVisible()
public void setNavVisible(boolean value)
public float getFramerate()
public void setFramerate(float value)
public int getMetricsRenderVertices()
public void setMetricsRenderVertices(int value)
public int getMetricsRenderIndices()
public void setMetricsRenderIndices(int value)
public int getMetricsRenderWindows()
public void setMetricsRenderWindows(int value)
public int getMetricsActiveWindows()
public void setMetricsActiveWindows(int value)
public int getMetricsActiveAllocations()
public void setMetricsActiveAllocations(int value)
public ImVec2 getMouseDelta()
public float getMouseDeltaX()
public float getMouseDeltaY()
public void getMouseDelta(ImVec2 dst)
public void setMouseDelta(ImVec2 value)
public void setMouseDelta(float valueX, float valueY)
@Deprecated public int[] getKeyMap()
@Deprecated public int getKeyMap(int idx)
@Deprecated public void setKeyMap(int[] value)
@Deprecated public void setKeyMap(int idx, int value)
@Deprecated public boolean[] getKeysDown()
@Deprecated public boolean getKeysDown(int idx)
@Deprecated public void setKeysDown(boolean[] value)
@Deprecated public void setKeysDown(int idx, boolean value)
public ImVec2 getMousePos()
public float getMousePosX()
public float getMousePosY()
public void getMousePos(ImVec2 dst)
public void setMousePos(ImVec2 value)
public void setMousePos(float valueX, float valueY)
public boolean[] getMouseDown()
public boolean getMouseDown(int idx)
public void setMouseDown(boolean[] value)
public void setMouseDown(int idx, boolean value)
public float getMouseWheel()
public void setMouseWheel(float value)
public float getMouseWheelH()
public void setMouseWheelH(float value)
public int getMouseHoveredViewport()
public void setMouseHoveredViewport(int value)
public boolean getKeyCtrl()
public void setKeyCtrl(boolean value)
public boolean getKeyShift()
public void setKeyShift(boolean value)
public boolean getKeyAlt()
public void setKeyAlt(boolean value)
public boolean getKeySuper()
public void setKeySuper(boolean value)
public float[] getNavInputs()
public float getNavInputs(int idx)
public void setNavInputs(float[] value)
public void setNavInputs(int idx, float value)
public int getKeyMods()
public void setKeyMods(int value)
public int getKeyModsPrev()
public void setKeyModsPrev(int value)
public ImGuiKeyData[] getKeysData()
public void setKeysData(ImGuiKeyData[] value)
public boolean getWantCaptureMouseUnlessPopupClose()
&&
WantCaptureMouseUnlessPopupClose == false) when a click over void is expected to close a popup.public void setWantCaptureMouseUnlessPopupClose(boolean value)
&&
WantCaptureMouseUnlessPopupClose == false) when a click over void is expected to close a popup.public ImVec2 getMousePosPrev()
public float getMousePosPrevX()
public float getMousePosPrevY()
public void getMousePosPrev(ImVec2 dst)
public void setMousePosPrev(ImVec2 value)
public void setMousePosPrev(float valueX, float valueY)
public ImVec2[] getMouseClickedPos()
public void setMouseClickedPos(ImVec2[] value)
public double[] getMouseClickedTime()
public double getMouseClickedTime(int idx)
public void setMouseClickedTime(double[] value)
public void setMouseClickedTime(int idx, double value)
public boolean[] getMouseClicked()
public boolean getMouseClicked(int idx)
public void setMouseClicked(boolean[] value)
public void setMouseClicked(int idx, boolean value)
public boolean[] getMouseDoubleClicked()
public boolean getMouseDoubleClicked(int idx)
public void setMouseDoubleClicked(boolean[] value)
public void setMouseDoubleClicked(int idx, boolean value)
public int[] getMouseClickedCount()
public int getMouseClickedCount(int idx)
public void setMouseClickedCount(int[] value)
public void setMouseClickedCount(int idx, int value)
public int[] getMouseClickedLastCount()
public int getMouseClickedLastCount(int idx)
public void setMouseClickedLastCount(int[] value)
public void setMouseClickedLastCount(int idx, int value)
public boolean[] getMouseReleased()
public boolean getMouseReleased(int idx)
public void setMouseReleased(boolean[] value)
public void setMouseReleased(int idx, boolean value)
public boolean[] getMouseDownOwned()
public boolean getMouseDownOwned(int idx)
public void setMouseDownOwned(boolean[] value)
public void setMouseDownOwned(int idx, boolean value)
public boolean[] getMouseDownOwnedUnlessPopupClose()
public boolean getMouseDownOwnedUnlessPopupClose(int idx)
public void setMouseDownOwnedUnlessPopupClose(boolean[] value)
public void setMouseDownOwnedUnlessPopupClose(int idx, boolean value)
public float[] getMouseDownDuration()
public float getMouseDownDuration(int idx)
public void setMouseDownDuration(float[] value)
public void setMouseDownDuration(int idx, float value)
public float[] getMouseDownDurationPrev()
public float getMouseDownDurationPrev(int idx)
public void setMouseDownDurationPrev(float[] value)
public void setMouseDownDurationPrev(int idx, float value)
public ImVec2[] getMouseDragMaxDistanceAbs()
public void setMouseDragMaxDistanceAbs(ImVec2[] value)
public float[] getMouseDragMaxDistanceSqr()
public float getMouseDragMaxDistanceSqr(int idx)
public void setMouseDragMaxDistanceSqr(float[] value)
public void setMouseDragMaxDistanceSqr(int idx, float value)
public float[] getNavInputsDownDuration()
public float getNavInputsDownDuration(int idx)
public void setNavInputsDownDuration(float[] value)
public void setNavInputsDownDuration(int idx, float value)
public float[] getNavInputsDownDurationPrev()
public float getNavInputsDownDurationPrev(int idx)
public void setNavInputsDownDurationPrev(float[] value)
public void setNavInputsDownDurationPrev(int idx, float value)
public float getPenPressure()
>
0.0f only when MouseDown[0] == true). Helper storage currently unused by Dear ImGui.public void setPenPressure(float value)
>
0.0f only when MouseDown[0] == true). Helper storage currently unused by Dear ImGui.public boolean getAppFocusLost()
public void setAppFocusLost(boolean value)
public short getBackendUsingLegacyKeyArrays()
public void setBackendUsingLegacyKeyArrays(short value)
public boolean getBackendUsingLegacyNavInputArray()
public void setBackendUsingLegacyNavInputArray(boolean value)
public short getInputQueueSurrogate()
public void setInputQueueSurrogate(short value)