public final class ImGuiIO
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
void |
addInputCharacter(int c)
Queue new character input.
|
void |
addInputCharactersUTF8(java.lang.String str)
Queue new characters input from an UTF-8 string.
|
void |
clearInputCharacters()
Clear the text input buffer manually.
|
int |
getBackendFlags()
See ImGuiBackendFlags enum.
|
java.lang.String |
getBackendPlatformName()
Optional: Platform back-end name (informational only! will be displayed in About Window) + User data for back-end/wrappers to store their own stuff.
|
java.lang.String |
getBackendRendererName()
Optional: Renderer back-end name (informational only! will be displayed in About Window) + User data for back-end/wrappers to store their own stuff.
|
int |
getConfigFlags()
See ImGuiConfigFlags enum.
|
boolean |
getConfigInputTextCursorBlink()
Set to false to disable blinking cursor, for users who consider it distracting.
|
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 (was called io.OptMacOSXBehaviors prior to 1.63)
|
float |
getConfigWindowsMemoryCompactTimer()
[BETA] Compact window memory usage when unused.
|
boolean |
getConfigWindowsMoveFromTitleBarOnly()
[BETA] Set to true to only allow moving windows when clicked+dragged from the 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.
|
void |
getDisplayFramebufferScale(ImVec2 dstImVec2)
For retina display or other situations where window coordinates are different from framebuffer coordinates.
|
void |
getDisplaySize(ImVec2 dstImVec2)
Main display size, in pixels.
|
boolean |
getFontAllowUserScaling()
Allow user scaling text of individual window with CTRL+Wheel.
|
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 estimation, 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.
|
boolean |
getKeyAlt()
Keyboard modifier pressed: Alt
|
boolean |
getKeyCtrl()
Keyboard modifier pressed: Control
|
int |
getKeyMap(int idx)
Map of indices into the KeysDown[512] entries array which represent your "native" keyboard state.
|
void |
getKeyMap(int[] buff)
Map of indices into the KeysDown[512] entries array which represent your "native" keyboard state.
|
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.
|
void |
getKeysDown(boolean[] buff)
Keyboard keys that are pressed (ideally left in the "native" order your engine has access to keyboard keys, so you can use your own defines/enums for keys).
|
boolean |
getKeysDown(int idx)
Keyboard keys that are pressed (ideally left in the "native" order your engine has access to keyboard keys, so you can use your own defines/enums for keys).
|
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
|
void |
getMouseDelta(ImVec2 dstImVec2)
Mouse delta.
|
float |
getMouseDoubleClickMaxDist()
Distance threshold to stay in to validate a double-click, in pixels.
|
float |
getMouseDoubleClickTime()
Time for a double-click, in seconds.
|
void |
getMouseDown(boolean[] buff)
Mouse buttons: 0=left, 1=right, 2=middle + extras.
|
boolean |
getMouseDown(int idx)
Mouse buttons: 0=left, 1=right, 2=middle + extras.
|
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).
|
void |
getMousePos(ImVec2 dstImVec2)
Mouse position, in pixels.
|
float |
getMouseWheel()
Mouse wheel Vertical: 1 unit scrolls about 5 lines text.
|
float |
getMouseWheelH()
Mouse wheel Horizontal.
|
boolean |
getNavActive()
Directional navigation is currently allowed (will handle ImGuiKey_NavXXX events) = a window is focused and it doesn't use the ImGuiWindowFlags_NoNavInputs flag.
|
boolean |
getNavVisible()
Directional navigation is visible and allowed (will handle ImGuiKey_NavXXX events).
|
boolean |
getWantCaptureKeyboard()
When io.WantCaptureKeyboard is true, imgui will use the keyboard inputs, do not dispatch them to your main game/application (in both cases, always pass keyboard inputs to imgui).
|
boolean |
getWantCaptureMouse()
When io.WantCaptureMouse is true, imgui will use the mouse inputs, do not dispatch them to your main game/application (in both cases, always pass on mouse inputs to imgui).
|
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, back-end should reposition mouse on next frame.
|
boolean |
getWantTextInput()
Mobile/console: when io.WantTextInput is true, you may display an on-screen keyboard.
|
void |
setBackendFlags(int backendFlags)
See ImGuiBackendFlags enum.
|
void |
setBackendPlatformName(java.lang.String backendPlatformName)
Optional: Platform back-end name (informational only! will be displayed in About Window) + User data for back-end/wrappers to store their own stuff.
|
void |
setBackendRendererName(java.lang.String backendRendererName)
Optional: Renderer back-end name (informational only! will be displayed in About Window) + User data for back-end/wrappers to store their own stuff.
|
void |
setConfigFlags(int configFlags)
See ImGuiConfigFlags enum.
|
void |
setConfigInputTextCursorBlink(boolean configInputTextCursorBlink)
Set to false to disable blinking cursor, for users who consider it distracting.
|
void |
setConfigMacOSXBehaviors(boolean configMacOSXBehaviors)
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 (was called io.OptMacOSXBehaviors prior to 1.63)
|
void |
setConfigWindowsMemoryCompactTimer(float configWindowsMemoryCompactTimer)
[BETA] Compact window memory usage when unused.
|
void |
setConfigWindowsMoveFromTitleBarOnly(boolean configWindowsMoveFromTitleBarOnly)
[BETA] Set to true to only allow moving windows when clicked+dragged from the title bar.
|
void |
setConfigWindowsResizeFromEdges(boolean configWindowsResizeFromEdges)
Enable resizing of windows from their edges and from the lower-left corner.
|
void |
setDeltaTime(float deltaTime)
Time elapsed since last frame, in seconds.
|
void |
setDisplayFramebufferScale(float x,
float y)
For retina display or other situations where window coordinates are different from framebuffer coordinates.
|
void |
setDisplaySize(float x,
float y)
Main display size, in pixels.
|
void |
setFontAllowUserScaling(boolean fontAllowUserScaling)
Allow user scaling text of individual window with CTRL+Wheel.
|
void |
setFontDefault(ImFont fontDefault) |
void |
setFontGlobalScale(float fontGlobalScale)
Global scale all fonts
|
void |
setFonts(ImFontAtlas imFontAtlas)
Font atlas: load, rasterize and pack one or more fonts into a single texture.
|
void |
setFramerate(float framerate)
Application framerate estimation, in frame per second.
|
void |
setGetClipboardTextFn(ImStrSupplier getClipboardTextCallback) |
void |
setIniFilename(java.lang.String iniFilename)
Path to .ini file.
|
void |
setIniSavingRate(float iniSavingRate)
Minimum time between saving positions/sizes to .ini file, in seconds.
|
void |
setKeyAlt(boolean value)
Keyboard modifier pressed: Alt
|
void |
setKeyCtrl(boolean value)
Keyboard modifier pressed: Control
|
void |
setKeyMap(int[] keyMap)
Map of indices into the KeysDown[512] entries array which represent your "native" keyboard state.
|
void |
setKeyMap(int idx,
int code)
Map of indices into the KeysDown[512] entries array which represent your "native" keyboard state.
|
void |
setKeyRepeatDelay(float keyRepeatDelay)
When holding a key/button, time before it starts repeating, in seconds (for buttons in Repeat mode, etc.).
|
void |
setKeyRepeatRate(float keyRepeatRate)
When holding a key/button, rate at which it repeats, in seconds.
|
void |
setKeysDown(boolean[] keysDown)
Keyboard keys that are pressed (ideally left in the "native" order your engine has access to keyboard keys, so you can use your own defines/enums for keys).
|
void |
setKeysDown(int idx,
boolean pressed)
Keyboard keys that are pressed (ideally left in the "native" order your engine has access to keyboard keys, so you can use your own defines/enums for keys).
|
void |
setKeyShift(boolean value)
Keyboard modifier pressed: Shift
|
void |
setKeySuper(boolean value)
Keyboard modifier pressed: Cmd/Super/Windows
|
void |
setLogFilename(java.lang.String logFilename)
Path to .log file (default parameter to ImGui::LogToFile when no file is specified).
|
void |
setMetricsActiveAllocations(int metricsActiveAllocations)
Number of active allocations, updated by MemAlloc/MemFree based on current context.
|
void |
setMetricsActiveWindows(int metricsActiveWindows)
Number of active windows
|
void |
setMetricsRenderIndices(int metricsRenderIndices)
Indices output during last call to Render() = number of triangles * 3
|
void |
setMetricsRenderVertices(int metricsRenderVertices)
Vertices output during last call to Render()
|
void |
setMetricsRenderWindows(int metricsRenderWindows)
Number of visible windows
|
void |
setMouseDelta(float x,
float y)
Mouse delta.
|
void |
setMouseDoubleClickMaxDist(float mouseDoubleClickMaxDist)
Distance threshold to stay in to validate a double-click, in pixels.
|
void |
setMouseDoubleClickTime(float mouseDoubleClickTime)
Time for a double-click, in seconds.
|
void |
setMouseDown(boolean[] mouseDown)
Mouse buttons: 0=left, 1=right, 2=middle + extras.
|
void |
setMouseDown(int idx,
boolean down)
Mouse buttons: 0=left, 1=right, 2=middle + extras.
|
void |
setMouseDragThreshold(float mouseDragThreshold)
Distance threshold before considering we are dragging.
|
void |
setMouseDrawCursor(boolean mouseDrawCursor)
Request ImGui to draw a mouse cursor for you (if you are on a platform without a mouse cursor).
|
void |
setMousePos(float x,
float y)
Mouse position, in pixels.
|
void |
setMouseWheel(float mouseDeltaY)
Mouse wheel Vertical: 1 unit scrolls about 5 lines text.
|
void |
setMouseWheelH(float mouseDeltaX)
Mouse wheel Horizontal.
|
void |
setNavActive(boolean navActive)
Directional navigation is currently allowed (will handle ImGuiKey_NavXXX events) = a window is focused and it doesn't use the ImGuiWindowFlags_NoNavInputs flag.
|
void |
setNavVisible(boolean navVisible)
Directional navigation is visible and allowed (will handle ImGuiKey_NavXXX events).
|
void |
setSetClipboardTextFn(ImStrConsumer setClipboardTextCallback) |
void |
setWantCaptureKeyboard(boolean wantCaptureKeyboard)
When io.WantCaptureKeyboard is true, imgui will use the keyboard inputs, do not dispatch them to your main game/application (in both cases, always pass keyboard inputs to imgui).
|
void |
setWantCaptureMouse(boolean wantCaptureMouse)
When io.WantCaptureMouse is true, imgui will use the mouse inputs, do not dispatch them to your main game/application (in both cases, always pass on mouse inputs to imgui).
|
void |
setWantSaveIniSettings(boolean wantSaveIniSettings)
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 wantSetMousePos)
MousePos has been altered, back-end should reposition mouse on next frame.
|
void |
setWantTextInput(boolean wantTextInput)
Mobile/console: when io.WantTextInput is true, you may display an on-screen keyboard.
|
public int getConfigFlags()
public void setConfigFlags(int configFlags)
public int getBackendFlags()
public void setBackendFlags(int backendFlags)
public float getIniSavingRate()
public void setIniSavingRate(float iniSavingRate)
public java.lang.String getIniFilename()
public void setIniFilename(java.lang.String iniFilename)
public java.lang.String getLogFilename()
public void setLogFilename(java.lang.String logFilename)
public float getMouseDoubleClickTime()
public void setMouseDoubleClickTime(float mouseDoubleClickTime)
public float getMouseDoubleClickMaxDist()
public void setMouseDoubleClickMaxDist(float mouseDoubleClickMaxDist)
public float getMouseDragThreshold()
public void setMouseDragThreshold(float mouseDragThreshold)
public void getKeyMap(int[] buff)
public int getKeyMap(int idx)
public void setKeyMap(int idx, int code)
public void setKeyMap(int[] keyMap)
public float getKeyRepeatDelay()
public void setKeyRepeatDelay(float keyRepeatDelay)
public float getKeyRepeatRate()
public void setKeyRepeatRate(float keyRepeatRate)
public ImFontAtlas getFonts()
public void setFonts(ImFontAtlas imFontAtlas)
BINDING NOTICE: You SHOULD manually destroy previously used ImFontAtlas.
public float getFontGlobalScale()
public void setFontGlobalScale(float fontGlobalScale)
public boolean getFontAllowUserScaling()
public void setFontAllowUserScaling(boolean fontAllowUserScaling)
public void setFontDefault(ImFont fontDefault)
public boolean getMouseDrawCursor()
public void setMouseDrawCursor(boolean mouseDrawCursor)
public boolean getConfigMacOSXBehaviors()
public void setConfigMacOSXBehaviors(boolean configMacOSXBehaviors)
public boolean getConfigInputTextCursorBlink()
public void setConfigInputTextCursorBlink(boolean configInputTextCursorBlink)
public boolean getConfigWindowsResizeFromEdges()
public void setConfigWindowsResizeFromEdges(boolean configWindowsResizeFromEdges)
public boolean getConfigWindowsMoveFromTitleBarOnly()
public void setConfigWindowsMoveFromTitleBarOnly(boolean configWindowsMoveFromTitleBarOnly)
public float getConfigWindowsMemoryCompactTimer()
public void setConfigWindowsMemoryCompactTimer(float configWindowsMemoryCompactTimer)
public java.lang.String getBackendPlatformName()
public void setBackendPlatformName(java.lang.String backendPlatformName)
public java.lang.String getBackendRendererName()
public void setBackendRendererName(java.lang.String backendRendererName)
public void setSetClipboardTextFn(ImStrConsumer setClipboardTextCallback)
public void setGetClipboardTextFn(ImStrSupplier getClipboardTextCallback)
public void getDisplaySize(ImVec2 dstImVec2)
BINDING NOTICE: This should be a "Config" part, but since those values may be different for every frame I don't see how it is possible to set them only once.
public void setDisplaySize(float x, float y)
BINDING NOTICE: This should be a "Config" part, but since those values may be different for every frame I don't see how it is possible to set them only once.
public void getDisplayFramebufferScale(ImVec2 dstImVec2)
BINDING NOTICE: This should be a "Config" part, but since those values may be different for every frame I don't see how it is possible to set them only once.
public void setDisplayFramebufferScale(float x, float y)
BINDING NOTICE: This should be a "Config" part, but since those values may be different for every frame I don't see how it is possible to set them only once.
public float getDeltaTime()
BINDING NOTICE: Same as for DisplaySize. This should be modified every frame.
public void setDeltaTime(float deltaTime)
BINDING NOTICE: Same as for DisplaySize. This should be modified every frame.
public void getMousePos(ImVec2 dstImVec2)
public void setMousePos(float x, float y)
public void getMouseDown(boolean[] buff)
public boolean getMouseDown(int idx)
public void setMouseDown(int idx, boolean down)
public void setMouseDown(boolean[] mouseDown)
public float getMouseWheel()
public void setMouseWheel(float mouseDeltaY)
public float getMouseWheelH()
public void setMouseWheelH(float mouseDeltaX)
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 void getKeysDown(boolean[] buff)
public boolean getKeysDown(int idx)
public void setKeysDown(int idx, boolean pressed)
public void setKeysDown(boolean[] keysDown)
public boolean getWantCaptureMouse()
public void setWantCaptureMouse(boolean wantCaptureMouse)
public boolean getWantCaptureKeyboard()
public void setWantCaptureKeyboard(boolean wantCaptureKeyboard)
public boolean getWantTextInput()
public void setWantTextInput(boolean wantTextInput)
public boolean getWantSetMousePos()
public void setWantSetMousePos(boolean wantSetMousePos)
public boolean getWantSaveIniSettings()
public void setWantSaveIniSettings(boolean wantSaveIniSettings)
public boolean getNavActive()
public void setNavActive(boolean navActive)
public boolean getNavVisible()
public void setNavVisible(boolean navVisible)
public float getFramerate()
public void setFramerate(float framerate)
public int getMetricsRenderVertices()
public void setMetricsRenderVertices(int metricsRenderVertices)
public int getMetricsRenderIndices()
public void setMetricsRenderIndices(int metricsRenderIndices)
public int getMetricsRenderWindows()
public void setMetricsRenderWindows(int metricsRenderWindows)
public int getMetricsActiveWindows()
public void setMetricsActiveWindows(int metricsActiveWindows)
public int getMetricsActiveAllocations()
public void setMetricsActiveAllocations(int metricsActiveAllocations)
public void getMouseDelta(ImVec2 dstImVec2)
public void setMouseDelta(float x, float y)
public void addInputCharacter(int c)
public void addInputCharactersUTF8(java.lang.String str)
public void clearInputCharacters()