Difference between revisions of "ImGui.Core:beginWindow"

From GiderosMobile
Line 8: Line 8:
 
(bool) (bool) = ImGui:beginWindow(name,open,flags)
 
(bool) (bool) = ImGui:beginWindow(name,open,flags)
 
</source>
 
</source>
 +
 +
'''note''': if ''open'' is nil then only the first boolean is returned
  
 
=== Parameters ===
 
=== Parameters ===
Line 26: Line 28:
  
 
local window01 = true -- the starting state of window01 (collapsed, expanded), with a close button
 
local window01 = true -- the starting state of window01 (collapsed, expanded), with a close button
−
local window02 = true -- the starting state of window02 (collapsed, expanded), without a close button
+
local window02 = true -- the starting state of window02 (collapsed, expanded), with no close button
 
local window03 = true -- the starting state of window03 (collapsed, expanded), with no title bar
 
local window03 = true -- the starting state of window03 (collapsed, expanded), with no title bar
  
Line 34: Line 36:
  
 
-- 2 we add a child window and build our GUI
 
-- 2 we add a child window and build our GUI
−
if window01 then -- if window exists
+
if window01 then -- is window expanded?
 
local windowdrawn = false
 
local windowdrawn = false
 
window01, windowdrawn = imgui:beginWindow( -- with close button
 
window01, windowdrawn = imgui:beginWindow( -- with close button
 
"Hello ImGui v"..ImGui._VERSION, -- window title
 
"Hello ImGui v"..ImGui._VERSION, -- window title
−
window01 -- is window expanded
+
window01 -- is window expanded?
 
)
 
)
 
if windowdrawn then -- the variable is false when main window is collapsed
 
if windowdrawn then -- the variable is false when main window is collapsed
Line 45: Line 47:
 
-- ...
 
-- ...
 
end
 
end
−
imgui:endWindow()
 
 
end
 
end
  
−
window02 = imgui:beginWindow("Window02") -- without close button
+
window02 = imgui:beginWindow("Window02") -- no close button
 
if window02 then
 
if window02 then
 
imgui:text("I am a text in window02")
 
imgui:text("I am a text in window02")
Line 55: Line 56:
 
end
 
end
  
−
if window03 then -- if window exists
+
window03 = imgui:beginWindow(
−
local windowdrawn = false
+
0,
−
window03, windowdrawn = imgui:beginWindow(
+
nil, -- no close button
−
0,
+
ImGui.WindowFlags_NoTitleBar -- no title bar
−
nil,
+
)
−
ImGui.WindowFlags_NoTitleBar
+
if window03 then -- if window is expanded
−
)
+
imgui:text("This is an ImGui text.") -- we add a text element to our GUI
−
if windowdrawn then -- the variable is false when window is collapsed
+
imgui:textColored("This is a colored text.", 0xff00ff, 1)
−
imgui:text("This is an ImGui text.") -- we add a text element to our GUI
+
-- ...
−
imgui:textColored("This is a colored text.", 0xff00ff, 1)
 
−
-- ...
 
−
end
 
−
imgui:endWindow()
 
 
end
 
end
  

Revision as of 21:55, 25 March 2021

Available since: Gideros 2020.9
Class: ImGui

Description

Pushes window to the stack and starts appending to it. 

(bool) (bool) = ImGui:beginWindow(name,open,flags)

note: if open is nil then only the first boolean is returned

Parameters

name: (string) the window title to be displayed
open: (bool) the status of the window, true=opened, false=closed, nil=no close button on window
flags: (string) any of the ImGui Window flags, see ImGui Constants - Window Flags

Return values

Returns: (bool) whether the window is collapsed or expanded
Returns: (bool) the status of the window, true=opened, false=closed, nil=non closeable window

Example

require "ImGui"

local imgui = ImGui.new()
stage:addChild(imgui)

local window01 = true -- the starting state of window01 (collapsed, expanded), with a close button
local window02 = true -- the starting state of window02 (collapsed, expanded), with no close button
local window03 = true -- the starting state of window03 (collapsed, expanded), with no title bar

function onEnterFrame(e)
	-- 1 we start ImGui
	imgui:newFrame(e)

	-- 2 we add a child window and build our GUI
	if window01 then -- is window expanded?
		local windowdrawn = false
		window01, windowdrawn = imgui:beginWindow( -- with close button
			"Hello ImGui v"..ImGui._VERSION, -- window title
			window01 -- is window expanded?
		)
		if windowdrawn then -- the variable is false when main window is collapsed
			imgui:text("This is an ImGui text.") -- we add a text element to our GUI
			imgui:textColored("This is a colored text.", 0xff00ff, 1)
			-- ...
		end
	end

	window02 = imgui:beginWindow("Window02") -- no close button
	if window02 then
		imgui:text("I am a text in window02")
		print(e.deltaTime) -- test
		-- ...
	end

	window03 = imgui:beginWindow(
		0,
		nil, -- no close button
		ImGui.WindowFlags_NoTitleBar -- no title bar
	)
	if window03 then -- if window is expanded
		imgui:text("This is an ImGui text.") -- we add a text element to our GUI
		imgui:textColored("This is a colored text.", 0xff00ff, 1)
		-- ...
	end

	-- 3 we end the frame and render to screen
	imgui:endFrame()
	imgui:render()
end

stage:addEventListener(Event.ENTER_FRAME, onEnterFrame)



Retrieved from ‘https://wiki.gideros.rocks/index.php?title=ImGui.Core:beginWindow&oldid=17742’