API Reference / IGI / igiBeginEx

igiBeginEx

Opens a window with a starting position and size, and flags. Takes title (The window's title), x (Left edge the first time the window appears (-1 = ImGui chooses)), y (Top edge the first time (-1 = ImGui chooses)), w (Width the first time (0 = ImGui chooses)), h (Height the first time (0 = ImGui chooses)), flags (IGI_WINDOW_* flags added together, or 0). Returns: 1 if the window's contents are showing, 0 if it is folded up.

IGI

Parameters & Returns

Parameters

title String
x Int
y Int
w Int
h Int
flags Int

Returns

Int

Quick Summary

Opens a window with a starting position and size, and flags. Takes title (The window's title), x (Left edge the first time the window appears (-1 = ImGui chooses)), y (Top edge the first time (-1 = ImGui chooses)), w (Width the first time (0 = ImGui chooses)), h (Height the first time (0 = ImGui chooses)), flags (IGI_WINDOW_* flags added together, or 0). Returns: 1 if the window's contents are showing, 0 if it is folded up.

Technical Exegesis...

Opens a window with a starting position and size, and flags. The position and size are only used the first time the window appears, so the user can move it afterwards; to place it every frame use igiSetNextWindowPos first. Flags: IGI_WINDOW_NOTITLEBAR, NORESIZE, NOMOVE, NOSCROLLBAR, NOCOLLAPSE, AUTORESIZE (fits its contents), NOBACKGROUND, NOMOUSEINPUTS (clicks pass through to the game), MENUBAR (for igiBeginMenuBar), HORIZONTALSCROLLBAR and CLOSEBOX (an X in the title bar - see igiWindowIsOpen).

Example

Example.bam 
igiBeginEx("Inventory", 20, 40, 300, 400, IGI_WINDOW_CLOSEBOX + IGI_WINDOW_NOCOLLAPSE)
If Not igiWindowIsOpen() Then showInventory = False
; ...
igiEnd()
Since: 1.2e Status: Stable
← Back to IGI