imgui.flag

Class ImGuiViewportFlags

java.lang.Object

imgui.flag.ImGuiViewportFlags

public final class ImGuiViewportFlags
extends java.lang.Object

Flags stored in ImGuiViewport::Flags, giving indications to the platform backends.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CanHostOtherWindows Viewport can host multiple imgui windows (secondary viewports are associated to a single window).
static int	IsFocused Platform Window: Window is focused (last call to Platform_GetWindowFocus() returned true)
static int	IsMinimized Platform Window: Window is minimized, can skip render.
static int	IsPlatformMonitor Represent a Platform Monitor (unused yet)
static int	IsPlatformWindow Represent a Platform Window
static int	NoAutoMerge Platform Window: Avoid merging this window into another host window.
static int	NoDecoration Platform Window: Disable platform decorations: title bar, borders, etc.
static int	NoFocusOnAppearing Platform Window: Don't take focus when created.
static int	NoFocusOnClick Platform Window: Don't take focus when clicked on.
static int	NoInputs Platform Window: Make mouse pass through so we can drag this window while peaking behind it.
static int	None Definition: 0
static int	NoRendererClear Platform Window: Renderer doesn't need to clear the framebuffer ahead (because we will fill it entirely).
static int	NoTaskBarIcon Platform Window: Disable platform task bar icon (generally set on popups/tooltips, or all windows if ImGuiConfigFlags_ViewportsNoTaskBarIcon is set)
static int	OwnedByApp Platform Window: Was created/managed by the user application? (rather than our backend)
static int	TopMost Platform Window: Display on top (for tooltips only).

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

Definition: 0

See Also:

Constant Field Values

IsPlatformWindow

public static final int IsPlatformWindow

Represent a Platform Window

Definition: 1 << 0

See Also:

Constant Field Values

IsPlatformMonitor

public static final int IsPlatformMonitor

Represent a Platform Monitor (unused yet)

Definition: 1 << 1

See Also:

Constant Field Values

OwnedByApp

public static final int OwnedByApp

Platform Window: Was created/managed by the user application? (rather than our backend)

Definition: 1 << 2

See Also:

Constant Field Values

NoDecoration

public static final int NoDecoration

Platform Window: Disable platform decorations: title bar, borders, etc. (generally set all windows, but if ImGuiConfigFlags_ViewportsDecoration is set we only set this on popups/tooltips)

Definition: 1 << 3

See Also:

Constant Field Values

NoTaskBarIcon

public static final int NoTaskBarIcon

Platform Window: Disable platform task bar icon (generally set on popups/tooltips, or all windows if ImGuiConfigFlags_ViewportsNoTaskBarIcon is set)

Definition: 1 << 4

See Also:

Constant Field Values

NoFocusOnAppearing

public static final int NoFocusOnAppearing

Platform Window: Don't take focus when created.

Definition: 1 << 5

See Also:

Constant Field Values

NoFocusOnClick

public static final int NoFocusOnClick

Platform Window: Don't take focus when clicked on.

Definition: 1 << 6

See Also:

Constant Field Values

NoInputs

public static final int NoInputs

Platform Window: Make mouse pass through so we can drag this window while peaking behind it.

Definition: 1 << 7

See Also:

Constant Field Values

NoRendererClear

public static final int NoRendererClear

Platform Window: Renderer doesn't need to clear the framebuffer ahead (because we will fill it entirely).

Definition: 1 << 8

See Also:

Constant Field Values

NoAutoMerge

public static final int NoAutoMerge

Platform Window: Avoid merging this window into another host window. This can only be set via ImGuiWindowClass viewport flags override (because we need to now ahead if we are going to create a viewport in the first place!).

Definition: 1 << 9

See Also:

Constant Field Values

TopMost

public static final int TopMost

Platform Window: Display on top (for tooltips only).

Definition: 1 << 10

See Also:

Constant Field Values

CanHostOtherWindows

public static final int CanHostOtherWindows

Viewport can host multiple imgui windows (secondary viewports are associated to a single window). // FIXME: In practice there's still probably code making the assumption that this is always and only on the MainViewport. Will fix once we add support for "no main viewport".

Definition: 1 << 11

See Also:

Constant Field Values

IsMinimized

public static final int IsMinimized

Platform Window: Window is minimized, can skip render. When minimized we tend to avoid using the viewport pos/size for clipping window or testing if they are contained in the viewport.

Definition: 1 << 12

See Also:

Constant Field Values

IsFocused

public static final int IsFocused

Platform Window: Window is focused (last call to Platform_GetWindowFocus() returned true)

Definition: 1 << 13

See Also:

Constant Field Values