imgui.flag

Class ImGuiConfigFlags

java.lang.Object

imgui.flag.ImGuiConfigFlags

public final class ImGuiConfigFlags
extends java.lang.Object

Configuration flags stored in io.ConfigFlags. Set by user/application.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DockingEnable [BETA] Docking Docking enable flags.
static int	DpiEnableScaleFonts [BETA: Don't use] FIXME-DPI: Request bitmap-scaled fonts to match DpiScale.
static int	DpiEnableScaleViewports [BETA: Don't use] FIXME-DPI: Reposition and resize imgui windows when the DpiScale of a viewport changed (mostly useful for the main viewport hosting other window).
static int	IsSRGB Application is SRGB-aware.
static int	IsTouchScreen Application is using a touch screen instead of a mouse.
static int	NavEnableGamepad Master gamepad navigation enable flag.
static int	NavEnableKeyboard Master keyboard navigation enable flag.
static int	NavEnableSetMousePos Instruct navigation to move the mouse cursor.
static int	NavNoCaptureKeyboard Instruct navigation to not set the io.WantCaptureKeyboard flag when io.NavActive is set.
static int	NoMouse Instruct imgui to clear mouse position/buttons in NewFrame().
static int	NoMouseCursorChange Instruct backend to not alter mouse cursor shape and visibility.
static int	None
static int	ViewportsEnable Viewport enable flags (require both ImGuiBackendFlags_PlatformHasViewports + ImGuiBackendFlags_RendererHasViewports set by the respective backends)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

None

public static final int None

See Also:

Constant Field Values

NavEnableKeyboard

public static final int NavEnableKeyboard

Master keyboard navigation enable flag. NewFrame() will automatically fill io.NavInputs[] based on io.KeysDown[].

See Also:

Constant Field Values

NavEnableGamepad

public static final int NavEnableGamepad

Master gamepad navigation enable flag. This is mostly to instruct your imgui backend to fill io.NavInputs[]. Backend also needs to set ImGuiBackendFlags_HasGamepad.

See Also:

Constant Field Values

NavEnableSetMousePos

public static final int NavEnableSetMousePos

Instruct navigation to move the mouse cursor. May be useful on TV/console systems where moving a virtual mouse is awkward. Will update io.MousePos and set io.WantSetMousePos=true. If enabled you MUST honor io.WantSetMousePos requests in your binding, otherwise ImGui will react as if the mouse is jumping around back and forth.

See Also:

Constant Field Values

NavNoCaptureKeyboard

public static final int NavNoCaptureKeyboard

Instruct navigation to not set the io.WantCaptureKeyboard flag when io.NavActive is set.

See Also:

Constant Field Values

NoMouse

public static final int NoMouse

Instruct imgui to clear mouse position/buttons in NewFrame(). This allows ignoring the mouse information set by the backend.

See Also:

Constant Field Values

NoMouseCursorChange

public static final int NoMouseCursorChange

Instruct backend to not alter mouse cursor shape and visibility. Use if the backend cursor changes are interfering with yours and you don't want to use SetMouseCursor() to change mouse cursor. You may want to honor requests from imgui by reading GetMouseCursor() yourself instead.

See Also:

Constant Field Values

DockingEnable

public static final int DockingEnable

[BETA] Docking Docking enable flags.

See Also:

Constant Field Values

ViewportsEnable

public static final int ViewportsEnable

Viewport enable flags (require both ImGuiBackendFlags_PlatformHasViewports + ImGuiBackendFlags_RendererHasViewports set by the respective backends)

See Also:

Constant Field Values

DpiEnableScaleViewports

public static final int DpiEnableScaleViewports

[BETA: Don't use] FIXME-DPI: Reposition and resize imgui windows when the DpiScale of a viewport changed (mostly useful for the main viewport hosting other window). Note that resizing the main window itself is up to your application.

See Also:

Constant Field Values

DpiEnableScaleFonts

public static final int DpiEnableScaleFonts

[BETA: Don't use] FIXME-DPI: Request bitmap-scaled fonts to match DpiScale. This is a very low-quality workaround. The correct way to handle DPI is _currently_ to replace the atlas and/or fonts in the Platform_OnChangedViewport callback, but this is all early work in progress.

See Also:

Constant Field Values

IsSRGB

public static final int IsSRGB

Application is SRGB-aware.

See Also:

Constant Field Values

IsTouchScreen

public static final int IsTouchScreen

Application is using a touch screen instead of a mouse.

See Also:

Constant Field Values