Difference between revisions of "ImGui.Core:beginTable"

From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2020.9<br/> '''Class:''' ImGui<br/> === Description === Pushes a table to the stack and starts appending to it. <syntaxhighlight...")
 
m
 
Line 4: Line 4:
  
 
=== Description ===
 
=== Description ===
Pushes a table to the stack and starts appending to it.
+
Pushes a Table to the stack and starts appending to it.
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
(bool) = ImGui:beginTable(id,column [,flag=0,outer_w=0,outer_h=0,inner_width=0])
 
(bool) = ImGui:beginTable(id,column [,flag=0,outer_w=0,outer_h=0,inner_width=0])
Line 12: Line 12:
  
 
=== Parameters ===
 
=== Parameters ===
'''id''': (string) the Table unique id<br/>
+
'''id''': (string) the table unique id<br/>
 
'''column ''': (number) the number of columns in the table (starts at 1)<br/>
 
'''column ''': (number) the number of columns in the table (starts at 1)<br/>
 
'''flag''': (number) any of the ImGui.TableFlags flags, see '''[[ImGui.CONST.TableFlags|ImGui.TableFlags]]'''<br/>
 
'''flag''': (number) any of the ImGui.TableFlags flags, see '''[[ImGui.CONST.TableFlags|ImGui.TableFlags]]'''<br/>
Line 20: Line 20:
  
 
=== Return values ===
 
=== Return values ===
'''Returns''': (bool) whether the Table is collapsed or expanded<br/>
+
'''Returns''': (bool) whether the table is collapsed or expanded<br/>
  
 
=== Example ===
 
=== Example ===

Latest revision as of 04:48, 12 October 2023

Available since: Gideros 2020.9
Class: ImGui

Description

Pushes a Table to the stack and starts appending to it.

(bool) = ImGui:beginTable(id,column [,flag=0,outer_w=0,outer_h=0,inner_width=0])

note: parameters between [] are optional parameters with their default values

Parameters

id: (string) the table unique id
column : (number) the number of columns in the table (starts at 1)
flag: (number) any of the ImGui.TableFlags flags, see ImGui.TableFlags
outer_w: (number) outer with of the table
outer_h: (number) outer height of the table
inner_width: (number) inner width of the table

Return values

Returns: (bool) whether the table is collapsed or expanded

Example

require "ImGui"

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

function onEnterFrame(e)
	imgui:newFrame(e.deltaTime)
	if imgui:beginTable("list", 3) then -- a 3 columns table
		imgui:tableSetupColumn("One") -- column 1 title
		imgui:tableSetupColumn("Two") -- column 2 title
		imgui:tableSetupColumn("Three") -- column 3 title
		imgui:tableHeadersRow() -- add titles to the Table
		for row = 0, 8 do
			imgui:tableNextRow()
			for column = 0, 3-1 do -- index starts at 0
				imgui:tableSetColumnIndex(column)
				imgui:text(("R%d C%d"):format(row, column))
			end
		end
		imgui:endTable()
	end
	imgui:render()
	imgui:endFrame()
end

stage:addEventListener(Event.ENTER_FRAME, onEnterFrame)