imgui.flag

Class ImGuiChildFlags

java.lang.Object

imgui.flag.ImGuiChildFlags

public final class ImGuiChildFlags
extends java.lang.Object

Flags for ImGui::BeginChild() (Legacy: bit 0 must always correspond to ImGuiChildFlags_Border to be backward compatible with old API using 'bool border = false'. About using AutoResizeX/AutoResizeY flags: - May be combined with SetNextWindowSizeConstraints() to set a min/max size for each axis (see Demo->Child->Auto-resize with Constraints). - Size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing. - This allows BeginChild() to return false when not within boundaries (e.g. when scrolling), which is more optimal. BUT it won't update its auto-size while clipped. While not perfect, it is a better default behavior as the always-on performance gain is more valuable than the occasional "resizing after becoming visible again" glitch. - You may also use ImGuiChildFlags_AlwaysAutoResize to force an update even when child window is not in view. HOWEVER PLEASE UNDERSTAND THAT DOING SO WILL PREVENT BeginChild() FROM EVER RETURNING FALSE, disabling benefits of coarse clipping.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AlwaysAutoResize Combined with AutoResizeX/AutoResizeY.
static int	AlwaysUseWindowPadding Pad with style.WindowPadding even if no border are drawn (no padding by default for non-bordered child windows because it makes more sense)
static int	AutoResizeX Enable auto-resizing width.
static int	AutoResizeY Enable auto-resizing height.
static int	Border Show an outer border and enable WindowPadding.
static int	FrameStyle Style the child window like a framed item: use FrameBg, FrameRounding, FrameBorderSize, FramePadding instead of ChildBg, ChildRounding, ChildBorderSize, WindowPadding.
static int	NavFlattened Share focus scope, allow gamepad/keyboard navigation to cross over parent border to this child or between sibling child windows.
static int	None Definition: 0
static int	ResizeX Allow resize from right border (layout direction).
static int	ResizeY Allow resize from bottom border (layout direction).

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

Border

public static final int Border

Show an outer border and enable WindowPadding. (IMPORTANT: this is always == 1 == true for legacy reason)

Definition: 1 << 0

See Also:

Constant Field Values

AlwaysUseWindowPadding

public static final int AlwaysUseWindowPadding

Pad with style.WindowPadding even if no border are drawn (no padding by default for non-bordered child windows because it makes more sense)

Definition: 1 << 1

See Also:

Constant Field Values

ResizeX

public static final int ResizeX

Allow resize from right border (layout direction). Enable .ini saving (unless ImGuiWindowFlags_NoSavedSettings passed to window flags)

Definition: 1 << 2

See Also:

Constant Field Values

ResizeY

public static final int ResizeY

Allow resize from bottom border (layout direction). "

Definition: 1 << 3

See Also:

Constant Field Values

AutoResizeX

public static final int AutoResizeX

Enable auto-resizing width. Read "IMPORTANT: Size measurement" details above.

Definition: 1 << 4

See Also:

Constant Field Values

AutoResizeY

public static final int AutoResizeY

Enable auto-resizing height. Read "IMPORTANT: Size measurement" details above.

Definition: 1 << 5

See Also:

Constant Field Values

AlwaysAutoResize

public static final int AlwaysAutoResize

Combined with AutoResizeX/AutoResizeY. Always measure size even when child is hidden, always return true, always disable clipping optimization! NOT RECOMMENDED.

Definition: 1 << 6

See Also:

Constant Field Values

FrameStyle

public static final int FrameStyle

Style the child window like a framed item: use FrameBg, FrameRounding, FrameBorderSize, FramePadding instead of ChildBg, ChildRounding, ChildBorderSize, WindowPadding.

Definition: 1 << 7

See Also:

Constant Field Values

NavFlattened

public static final int NavFlattened

Share focus scope, allow gamepad/keyboard navigation to cross over parent border to this child or between sibling child windows.

Definition: 1 << 8

See Also:

Constant Field Values