Difference between revisions of "ImGui.Core:text"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2020.9<br/>
 
'''Available since:''' Gideros 2020.9<br/>
−
'''Class:''' [[Dear ImGui]]<br/>
+
'''Class:''' [[ImGui]]<br/>
  
 
=== Description ===
 
=== Description ===
−
Sets the text to be displayed.
+
Sets some text to be displayed.
−
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
ImGui:text(text)
 
ImGui:text(text)
−
</source>
+
</syntaxhighlight>
  
 
=== Parameters ===
 
=== Parameters ===
Line 13: Line 13:
  
 
=== Example ===
 
=== Example ===
−
''' A text GUI element'''
+
<syntaxhighlight lang="lua">
−
<source lang="lua">
 
 
MyClass = Core.class(Sprite)
 
MyClass = Core.class(Sprite)
  
 
function MyClass:init()
 
function MyClass:init()
−
application:setBackgroundColor(0x111111)
 
−
-- imgui init
 
 
self.imgui = ImGui.new()
 
self.imgui = ImGui.new()
 
-- we create a variable to hold our window status
 
-- we create a variable to hold our window status
−
self.window01 = true
+
self.window01 = true -- window01 exists at start up
 
-- order
 
-- order
 
self:addChild(self.imgui)
 
self:addChild(self.imgui)
Line 34: Line 31:
 
self.imgui:newFrame(e)
 
self.imgui:newFrame(e)
 
-- 2 we build our GUI
 
-- 2 we build our GUI
−
if (self.window01) then -- if window exists
+
if self.window01 then -- is window01 existant?
−
local windowdrawn = false
+
local windowdrawn = false -- is window01 colapsed?
−
self.window01, windowdrawn = self.imgui:beginWindow(
+
self.window01, windowdrawn = self.imgui:beginWindow(
−
"Hello ImGui v"..ImGui._VERSION, -- window title
+
"Hello ImGui", -- window title
−
self.window01 -- is window expanded
+
self.window01 -- is window01 existant?
−
)
+
)
−
if (windowdrawn) then -- the variable is false when main window is collapsed
+
if windowdrawn then -- the variable is false when window01 is collapsed
−
self.imgui:text("Hello Dear ImGui!") -- we add a text element to our GUI
+
self.imgui:text("Hello Dear ImGui!") -- we add a text element to our GUI
−
end
+
end
−
self.imgui:endWindow()
+
self.imgui:endWindow()
 
end
 
end
 
self.imgui:endFrame()
 
self.imgui:endFrame()
Line 53: Line 50:
 
self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self)
 
self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self)
 
end
 
end
−
</source>
+
</syntaxhighlight>
  
 
{{ImGui}}
 
{{ImGui}}

Latest revision as of 15:29, 13 July 2023

Available since: Gideros 2020.9
Class: ImGui

Description

Sets some text to be displayed. 

ImGui:text(text)

Parameters

text: (string) the text to be displayed

Example

MyClass = Core.class(Sprite)

function MyClass:init()
	self.imgui = ImGui.new()
	-- we create a variable to hold our window status
	self.window01 = true -- window01 exists at start up
	-- order
	self:addChild(self.imgui)
	-- LISTENERS
	self:addEventListener("enterBegin", self.onTransitionInBegin, self)
end

-- LOOP
function MyClass:onEnterFrame(e)
	-- 1 we start ImGui
	self.imgui:newFrame(e)
	-- 2 we build our GUI
	if self.window01 then -- is window01 existant?
		local windowdrawn = false -- is window01 colapsed?
		self.window01, windowdrawn = self.imgui:beginWindow(
			"Hello ImGui", -- window title
			self.window01 -- is window01 existant?
		)
		if windowdrawn then -- the variable is false when window01 is collapsed
			self.imgui:text("Hello Dear ImGui!") -- we add a text element to our GUI
		end
		self.imgui:endWindow()
	end
	self.imgui:endFrame()
	self.imgui:render()
end

-- EVENT LISTENERS
function MyClass:onTransitionInBegin()
	self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self)
end



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