gh_imgui library

Description

gh_imgui is the module that manages the ImGui library and allows to draw widgets. Available in GeeXLab 0.17+. All possible constants are defined in {GeeXLab folder}/libs/lua/imgui.lua or in {GeeXLab folder}/libs/python/imgui.py

Number of functions: 335

1. gh_imgui.select_draw_list ()
2. gh_imgui.add_bezier_curve_to_drawlist ()
3. gh_imgui.add_circle_to_drawlist ()
4. gh_imgui.add_line_to_drawlist ()
5. gh_imgui.add_quad_to_drawlist ()
6. gh_imgui.add_rect_to_drawlist ()
7. gh_imgui.add_rect_filled_multicolor_to_drawlist ()
8. gh_imgui.add_triangle_to_drawlist ()
9. gh_imgui.add_font_from_buffer ()
10. gh_imgui.add_font_from_file ()
11. gh_imgui.add_font_from_zip_file ()
12. gh_imgui.begin_child ()
13. gh_imgui.button ()
14. gh_imgui.button_arrow ()
15. gh_imgui.calc_text_size ()
16. gh_imgui.checkbox ()
17. gh_imgui.collapsing_header ()
18. gh_imgui.color_edit_rgba ()
19. gh_imgui.color_edit_rgba_v2 ()
20. gh_imgui.color_picker_rgba ()
21. gh_imgui.color_picker_rgba_v2 ()
22. gh_imgui.column_get_offset ()
23. gh_imgui.column_get_width ()
24. gh_imgui.column_next ()
25. gh_imgui.column_set_offset ()
26. gh_imgui.column_set_width ()
27. gh_imgui.columns ()
28. gh_imgui.combo_box_add_item ()
29. gh_imgui.combo_box_create ()
30. gh_imgui.combo_box_draw ()
31. gh_imgui.combo_box_draw_v2 ()
32. gh_imgui.dummy ()
33. gh_imgui.end_child ()
34. gh_imgui.frame_begin ()
35. gh_imgui.frame_begin_v2 ()
36. gh_imgui.frame_end ()
37. gh_imgui.get_color ()
38. gh_imgui.get_content_region_available_width ()
39. gh_imgui.get_cur_font_display_offset ()
40. gh_imgui.get_cursor_pos ()
41. gh_imgui.get_cursor_screen_pos ()
42. gh_imgui.get_cursor_start_pos ()
43. gh_imgui.get_font_size ()
44. gh_imgui.get_item_rect ()
45. gh_imgui.get_scroll ()
46. gh_imgui.get_scroll_max ()
47. gh_imgui.get_text_line_heigh_with_spacing ()
48. gh_imgui.get_version ()
49. gh_imgui.get_window_pos ()
50. gh_imgui.get_window_pos_size ()
51. gh_imgui.get_window_size ()
52. gh_imgui.gizmo_begin_frame ()
53. gh_imgui.gizmo_decompose_matrix_to_components ()
54. gh_imgui.gizmo_enable ()
55. gh_imgui.gizmo_is_over ()
56. gh_imgui.gizmo_is_using ()
57. gh_imgui.gizmo_manipulate ()
58. gh_imgui.gizmo_set_rect ()
59. gh_imgui.group_begin ()
60. gh_imgui.group_end ()
61. gh_imgui.image ()
62. gh_imgui.image_button ()
63. gh_imgui.indent ()
64. gh_imgui.init ()
65. gh_imgui.input_text ()
66. gh_imgui.is_any_item_hovered ()
67. gh_imgui.is_any_window_hovered ()
68. gh_imgui.is_item_clicked ()
69. gh_imgui.is_item_hovered ()
70. gh_imgui.is_mouse_clicked ()
71. gh_imgui.is_window_hovered ()
72. gh_imgui.list_box_begin ()
73. gh_imgui.list_box_draw ()
74. gh_imgui.list_box_draw_v2 ()
75. gh_imgui.list_box_end ()
76. gh_imgui.list_clipping_begin ()
77. gh_imgui.list_clipping_end ()
78. gh_imgui.menu_begin ()
79. gh_imgui.menu_begin_bar ()
80. gh_imgui.menu_begin_main_bar ()
81. gh_imgui.menu_end ()
82. gh_imgui.menu_end_bar ()
83. gh_imgui.menu_end_main_bar ()
84. gh_imgui.menu_item ()
85. gh_imgui.plotline_create ()
86. gh_imgui.plotline_draw ()
87. gh_imgui.plotline_draw_v2 ()
88. gh_imgui.plotline_get_value1f ()
89. gh_imgui.plotline_set_value1f ()
90. gh_imgui.pop_font ()
91. gh_imgui.pop_item_width ()
92. gh_imgui.pop_style_color ()
93. gh_imgui.popup_begin ()
94. gh_imgui.popup_begin_context ()
95. gh_imgui.popup_end ()
96. gh_imgui.popup_open ()
97. gh_imgui.progress_bar ()
98. gh_imgui.set_font_glyph_offset ()
99. gh_imgui.push_font ()
100. gh_imgui.push_item_width ()
101. gh_imgui.push_style_color ()
102. gh_imgui.radio_button ()
103. gh_imgui.rebuild_all_fonts ()
104. gh_imgui.reset_default_font ()
105. gh_imgui.same_line ()
106. gh_imgui.selectable ()
107. gh_imgui.separator ()
108. gh_imgui.set_color ()
109. gh_imgui.set_cur_font_display_offset ()
110. gh_imgui.set_default_font ()
111. gh_imgui.set_frame_border_size ()
112. gh_imgui.set_rounding ()
113. gh_imgui.set_indent_spacing ()
114. gh_imgui.set_item_default_focus ()
115. gh_imgui.set_keyboard_focus_here ()
116. gh_imgui.set_next_item_width ()
117. gh_imgui.set_next_window_content_size ()
118. gh_imgui.set_scroll ()
119. gh_imgui.set_scroll_from_pos_y ()
120. gh_imgui.set_scroll_here_y ()
121. gh_imgui.set_style_colors ()
122. gh_imgui.set_tooltip ()
123. gh_imgui.set_window_border_size ()
124. gh_imgui.set_window_focus ()
125. gh_imgui.set_window_rounding ()
126. gh_imgui.show_demo_window ()
127. gh_imgui.show_metrics_window ()
128. gh_imgui.show_stack_tool_window ()
129. gh_imgui.show_test_window ()
130. gh_imgui.slider_1i ()
131. gh_imgui.slider_1i_v2 ()
132. gh_imgui.slider_1f ()
133. gh_imgui.slider_2f ()
134. gh_imgui.slider_3f ()
135. gh_imgui.slider_4f ()
136. gh_imgui.spacing ()
137. gh_imgui.bullet ()
138. gh_imgui.tab_bar_begin ()
139. gh_imgui.tab_bar_begin_v2 ()
140. gh_imgui.tab_bar_end ()
141. gh_imgui.tab_item_begin ()
142. gh_imgui.tab_item_begin_v2 ()
143. gh_imgui.tab_item_end ()
144. gh_imgui.terminate ()
145. gh_imgui.text ()
146. gh_imgui.text_rgba ()
147. gh_imgui.text_unformatted_v1 ()
148. gh_imgui.text_unformatted_v2 ()
149. gh_imgui.text_wrapped ()
150. gh_imgui.tree_node ()
151. gh_imgui.tree_node_ex ()
152. gh_imgui.tree_node_leaf ()
153. gh_imgui.tree_node_leaf_v2 ()
154. gh_imgui.tree_pop ()
155. gh_imgui.underline ()
156. gh_imgui.unindent ()
157. gh_imgui.url ()
158. gh_imgui.vslider_1f ()
159. gh_imgui.vslider_1i ()
160. gh_imgui.vslider_1i_v2 ()
161. gh_imgui.widget ()
162. gh_imgui.window_begin ()
163. gh_imgui.window_begin_v2 ()
164. gh_imgui.window_end ()
165. gh_imgui.imguizmoquat_gizmo3d_v1 ()
166. gh_imgui.imguizmoquat_gizmo3d_v2 ()
167. gh_imgui.imguizmoquat_gizmo3d_v3 ()
168. gh_imgui.set_item_spacing ()
169. gh_imgui.get_item_spacing ()
170. gh_imgui.imgui_plot_create ()
171. gh_imgui.plot_kill ()
172. gh_imgui.plot_draw ()
173. gh_imgui.plot_set_title ()
174. gh_imgui.plot_set_color ()
175. gh_imgui.plot_set_state ()
176. gh_imgui.plot_set_axis_param_bool ()
177. gh_imgui.plot_set_axis_param_int ()
178. gh_imgui.plot_set_axis_param_float ()
179. gh_imgui.plot_set_axis_label ()
180. gh_imgui.plot_set_axis_color ()
181. gh_imgui.plot_add_item ()
182. gh_imgui.plot_item_set_label ()
183. gh_imgui.plot_item_set_color ()
184. gh_imgui.plot_item_set_type ()
185. gh_imgui.plot_item_set_size ()
186. gh_imgui.plot_item_set_data_begin ()
187. gh_imgui.plot_item_add_data ()
188. gh_imgui.plot_item_get_data_size ()
189. gh_imgui.plot_item_clear_data ()
190. gh_imgui.plot_item_clear_data ()
191. gh_imgui.plot_item_set_data ()
192. gh_imgui.plot_item_roll_point ()
193. gh_imgui.plot_item_buffer_point ()
194. gh_imgui.plot_axis_scroll ()
195. gh_imgui.plot_is_hovered ()
196. gh_imgui.plot_get_mouse_position ()
197. gh_imgui.get_text_line_height ()
198. gh_imgui.get_text_line_height_with_spacing ()
199. gh_imgui.color_text_editor_create ()
200. gh_imgui.color_text_editor_kill ()
201. gh_imgui.color_text_editor_render ()
202. gh_imgui.color_text_editor_get_text ()
203. gh_imgui.color_text_editor_set_text ()
204. gh_imgui.color_text_editor_set_language ()
205. gh_imgui.color_text_editor_set_palette ()
206. gh_imgui.color_text_editor_set_property_bool ()
207. gh_imgui.color_text_editor_set_property_int ()
208. gh_imgui.color_text_editor_get_total_lines ()
209. gh_imgui.color_text_editor_get_selected_text ()
210. gh_imgui.color_text_editor_get_current_line_text ()
211. gh_imgui.color_text_editor_get_cursor_position ()
212. gh_imgui.color_text_editor_palette_set_color ()
213. gh_imgui.color_text_editor_palette_get_color ()
214. gh_imgui.color_text_editor_copy_paste_cut ()
215. gh_imgui.color_text_editor_selection ()
216. gh_imgui.color_text_editor_is_text_changed ()
217. gh_imgui.implot_create_dataplot ()
218. gh_imgui.implot_kill_dataplot ()
219. gh_imgui.implot_show_demo_window ()
220. gh_imgui.implot_begin_plot ()
221. gh_imgui.implot_end_plot ()
222. gh_imgui.implot_add_data ()
223. gh_imgui.implot_draw_plotline ()
224. gh_imgui.implot_draw_plotscatter ()
225. gh_imgui.implot_draw_plotshaded ()
226. gh_imgui.implot_draw_plotbars ()
227. gh_imgui.implot_set_next_plot_limits ()
228. gh_imgui.implot_push_style_color ()
229. gh_imgui.implot_pop_style_color ()
230. gh_imgui.implot_push_style_var_1f ()
231. gh_imgui.implot_push_style_var_1i ()
232. gh_imgui.implot_is_hovered ()
233. gh_imgui.implot_get_mouse_pos ()
234. gh_imgui.implot_push_colormap ()
235. gh_imgui.implot_pop_colormap ()
236. gh_imgui.implot_plottext ()
237. gh_imgui.get_item_rect_min ()
238. gh_imgui.get_item_rect_max ()
239. gh_imgui.push_clip_rect ()
240. gh_imgui.pop_clip_rect ()
241. gh_imgui.invisible_button ()
242. gh_imgui.fx_drawlist_coding_party_demo ()
243. gh_imgui.file_browser_init ()
244. gh_imgui.file_browser_set_title ()
245. gh_imgui.file_browser_set_current_directory ()
246. gh_imgui.file_browser_clear_type_filters ()
247. gh_imgui.file_browser_add_type_filter ()
248. gh_imgui.file_browser_open ()
249. gh_imgui.file_browser_close ()
250. gh_imgui.file_browser_display ()
251. gh_imgui.file_browser_has_selected ()
252. gh_imgui.file_browser_get_selected ()
253. gh_imgui.memory_editor_create ()
254. gh_imgui.memory_editor_kill ()
255. gh_imgui.memory_editor_resize ()
256. gh_imgui.memory_editor_draw_window ()
257. gh_imgui.memory_editor_draw_window ()
258. gh_imgui.memory_editor_set_value_1u8 ()
259. gh_imgui.memory_editor_set_data_from_texture ()
260. gh_imgui.memory_editor_read_data_from_file ()
261. gh_imgui.memory_editor_write_data_to_file ()
262. gh_imgui.memory_editor_read_data_from_buffer ()
263. gh_imgui.memory_editor_write_data_to_buffer ()
264. gh_imgui.set_next_window_size ()
265. gh_imgui.set_window_size ()
266. gh_imgui.set_next_window_size_constraints ()
267. gh_imgui.table_begin ()
268. gh_imgui.table_end ()
269. gh_imgui.table_set_column_enabled ()
270. gh_imgui.table_next_row ()
271. gh_imgui.table_next_row ()
272. gh_imgui.table_next_column ()
273. gh_imgui.table_set_column_index ()
274. gh_imgui.table_setup_column ()
275. gh_imgui.table_setup_scroll_freeze ()
276. gh_imgui.table_headers_row ()
277. gh_imgui.table_header ()
278. gh_imgui.table_get_column_count ()
279. gh_imgui.table_get_column_index ()
280. gh_imgui.table_get_row_index ()
281. gh_imgui.table_get_column_name ()
282. gh_imgui.table_get_column_flags ()
283. gh_imgui.table_set_bg_color ()
284. gh_imgui.begin_disabled ()
285. gh_imgui.end_disabled ()
286. gh_imgui.get_mouse_pos ()
287. gh_imgui.get_mouse_pos_on_opening_current_popup ()
288. gh_imgui.imnodes_begin_node_editor ()
289. gh_imgui.imnodes_end_node_editor ()
290. gh_imgui.imnodes_begin_node ()
291. gh_imgui.imnodes_end_node ()
292. gh_imgui.imnodes_begin_output_attribute ()
293. gh_imgui.imnodes_end_output_attribute ()
294. gh_imgui.imnodes_begin_input_attribute ()
295. gh_imgui.imnodes_end_output_attribute ()
296. gh_imgui.imnodes_begin_node_title_bar ()
297. gh_imgui.imnodes_end_node_title_bar ()
298. gh_imgui.imnodes_link ()
299. gh_imgui.imnodes_set_node_screen_space_pos ()
300. gh_imgui.imnodes_set_node_editor_space_pos ()
301. gh_imgui.imnodes_set_node_grid_space_pos ()
302. gh_imgui.imnodes_get_node_screen_space_pos ()
303. gh_imgui.imnodes_get_node_editor_space_pos ()
304. gh_imgui.imnodes_get_node_grid_space_pos ()
305. gh_imgui.imnodes_set_node_draggable ()
306. gh_imgui.imnodes_is_editor_hovered ()
307. gh_imgui.imnodes_is_node_hovered ()
308. gh_imgui.imnodes_is_link_hovered ()
309. gh_imgui.imnodes_is_pin_hovered ()
310. gh_imgui.imnodes_num_selected_nodes ()
311. gh_imgui.imnodes_read_selected_nodes ()
312. gh_imgui.imnodes_get_selected_node ()
313. gh_imgui.imnodes_num_selected_links ()
314. gh_imgui.imnodes_read_selected_links ()
315. gh_imgui.imnodes_get_selected_link ()
316. gh_imgui.imnodes_clear_nodes_selection ()
317. gh_imgui.imnodes_clear_links_selection ()
318. gh_imgui.imnodes_is_link_started ()
319. gh_imgui.imnodes_is_link_dropped ()
320. gh_imgui.imnodes_is_link_created ()
321. gh_imgui.imnodes_is_link_created_v2 ()
322. gh_imgui.imnodes_is_link_destroyed ()
323. gh_imgui.imnodes_push_color_style ()
324. gh_imgui.imnodes_pop_color_style ()
325. gh_imgui.imnodes_push_style_var ()
326. gh_imgui.imnodes_pop_style_var ()
327. gh_imgui.imnodes_select_node ()
328. gh_imgui.imnodes_clear_node_selection ()
329. gh_imgui.imnodes_is_node_selected ()
330. gh_imgui.imnodes_select_link ()
331. gh_imgui.imnodes_clear_link_selection ()
332. gh_imgui.imnodes_is_link_selected ()
333. gh_imgui.imnodes_minimap ()
334. gh_imgui.knob ()
335. gh_imgui.toggle ()

select_draw_list

Description

Select the draw list that will receive all draw commands. Default is DRAWLIST_WINDOW.

Syntax

Languages

Parameters

• draw_list [ENUM]: draw list type

Return Values

This function has no return value(s).

Code sample

IMGUI_DRAWLIST_WINDOW = 0
IMGUI_DRAWLIST_BACKGROUND = 1
IMGUI_DRAWLIST_FOREGROUND = 2

draw_list = IMGUI_DRAWLIST_WINDOW

gh_imgui.select_draw_list(draw_list)
			

add_bezier_curve_to_drawlist

Description

Adds a Bezier curve to the current drawlist.

Syntax

Languages

Parameters

• x0, y0 [REAL]: start position
• cp0x, cp0y [REAL]: control point 0
• cp1x, cp1y [REAL]: control point 1
• x1, y1 [REAL]: end position
• r, g, b, a [REAL]: RGBA color

Return Values

This function has no return value(s).

Code sample

gh_imgui.add_bezier_curve_to_drawlist(p0_x, p0_y, ctrl0_x, ctrl0_y, ctrl1_x, ctrl1_y, p1_x, p1_y, r, g, b, a)
			

add_circle_to_drawlist

Description

Adds a circle to the current drawlist.

Syntax

Languages

Parameters

• center_x, center_y [REAL]: position of the circle center
• radius [REAL]: radius of the circle
• r, g, b, a [REAL]: RGBA color
• line_thickness [REAL]: line thickness
• num_segments [INTEGER]: number of segments of the circle
• filled [INTEGER]: solid (1) or wireframe (0)

Return Values

This function has no return value(s).

Code sample

thickness = 2
num_segments = 20
filled = 1

gh_imgui.add_circle_to_drawlist(center_x, center_y, radius, r, g, b, a, thickness, num_segments, filled)
			

add_line_to_drawlist

Description

Adds a line to the current drawlist.

Syntax

Languages

Parameters

• x0, y0 [REAL]: start position
• x1, y1 [REAL]: end position
• r, g, b, a [REAL]: RGBA color

Return Values

This function has no return value(s).

Code sample

gh_imgui.add_line_to_drawlist(start_x, start_y, end_x, end_y, r, g, b, a)
			

add_quad_to_drawlist

Description

Adds a quad to the current drawlist.

Syntax

Languages

Parameters

• ax, ay [REAL]: position of the 1st point
• bx, by [REAL]: position of the 2nd point
• cx, cy [REAL]: position of the 3rd point
• dx, dy [REAL]: position of the 4th point
• r, g, b, a [REAL]: RGBA color
• thickness [REAL]: line thickness
• filled [INTEGER]: solid (1) or wireframe (0)

Return Values

This function has no return value(s).

Code sample

thickness = 2
filled = 1

gh_imgui.add_quad_to_drawlist(ax, ay, bx, by, cx, cy, dx, dy, r, g, b, a, thickness, filled)
			

add_rect_to_drawlist

Description

Adds a rectangle to the current drawlist.

Syntax

Languages

Parameters

• p_min_x, p_min_y [REAL]: position of the bottom_left corner
• p_max_x, p_max_y [REAL]: position of the top right corner
• r, g, b, a [REAL]: RGBA color
• rounding [REAL]: corner rounding
• thickness [REAL]: line thickness
• filled [INTEGER]: solid (1) or wireframe (0)

Return Values

This function has no return value(s).

Code sample

rounding = 0
thickness = 2
filled = 1

gh_imgui.add_rect_to_drawlist(p_min_x, p_min_y, p_max_x, p_max_y, r, g, b, a, rounding, thickness, filled)
			

add_rect_filled_multicolor_to_drawlist

Description

Adds a multi-colored rectangle to the current drawlist.

Syntax

Languages

Parameters

• p_min_x, p_min_y [REAL]: position of the bottom_left corner
• p_max_x, p_max_y [REAL]: position of the top right corner
• r0, g0, b0, a0 [REAL]: RGBA up-left
• r1, g1, b1, a1 [REAL]: RGBA up-right
• r2, g2, b2, a2 [REAL]: RGBA bottom-right
• r3, g3, b3, a3 [REAL]: RGBA bottom-left

Return Values

This function has no return value(s).

Code sample

gh_imgui.add_rect_filled_multicolor_to_drawlist(p_min_x, p_min_y, p_max_x, p_max_y, 
r0, g0, b0, a0,
r1, g1, b1, a1,
r2, g2, b2, a2,
r3, g3, b3, a3)
			

add_triangle_to_drawlist

Description

Adds a triangle to the current drawlist.

Syntax

Languages

Parameters

• p1x, p1y [REAL]: position of the first vertex
• p2x, p2y [REAL]: position of the second vertex
• p3x, p3y [REAL]: position of the third vertex
• r, g, b, a [REAL]: RGBA color
• thickness [REAL]: line thickness
• filled [INTEGER]: solid (1) or wireframe (0)

Return Values

This function has no return value(s).

Code sample

thickness = 2
filled = 1

gh_imgui.add_triangle_to_drawlist(p1x, p1y, p2x, p2y, p3x, p3y, r, g, b, a, thickness, filled)
			

add_font_from_buffer

Description

Adds a new font from a memory buffer.

Syntax

Languages

Parameters

• buff_ptr [POINTER]: pointer to the buffer
• buff_size [INTEGER]: size of the buffer in bytes
• font_size [INTEGER]: size of the font

Return Values

• font_id [ID]: font identifier

Code sample

filename = demo_dir .. "assets/arial.ttf"

buffer, buffer_size = gh_utils.file_buffer_create(filename)

font_id = gh_imgui.add_font_from_buffer(buffer, buffer_size, 24)

gh_utils.file_buffer_kill(buffer)
			

add_font_from_file

Description

Adds a new font to the ImGui engine.

Syntax

Languages

Parameters

• font_filename [STRING]: absolute path of the font file
• font_size [INTEGER]: size of the font

Return Values

• font_id [ID]: font identifier

Code sample

font_id = gh_imgui.add_font_from_file(font_filename, 24)
			

add_font_from_zip_file

Description

Adds a new font from a zip file to the ImGui engine.

Syntax

Languages

Parameters

• zip_filename [STRING]: absolute path of the zip file
• font_filename [STRING]: absolute path of the font file
• font_size [INTEGER]: size of the font

Return Values

• font_id [ID]: font identifier

Code sample

font_id = gh_imgui.add_font_from_zip_file(zip_filename, font_filename, 24)
			

begin_child

Description

Begins a scrolling region.

Syntax

Languages

Parameters

• label [STRING]: name of the button
• width, height [REAL]: size of the region
• border [BOOLEAN]: border: 1 (enabled) or 0 (disabled)
• flags [ENUM]: see window flags (ImGuiWindowFlags_xxx) in imgui.lua

Return Values

This function has no return value(s).

Code sample

gh_imgui.begin_child(label, w, h, border, flags)
			

button

Description

Create a button.

Syntax

Languages

Parameters

• label [STRING]: name of the button
• width, height [INTEGER]: width and height of the button

Return Values

• pressed [BOOLEAN]: pressed: 1 (true) or 0 (false)

Code sample

pressed = gh_imgui.button("Fire", 200, 20)
			

button_arrow

Description

Create a arrow shaped button.

Syntax

Languages

Parameters

• label [STRING]: name of the button
• direction [ENUM]: arrow direction: 0 (left), 1 (right), 2(up) and 3(down)

Return Values

• pressed [BOOLEAN]: pressed: 1 (true) or 0 (false)

Code sample

pressed = gh_imgui.button_arrow("Fire", 1)
			

calc_text_size

Description

Returns the size (width and height) of a string.

Syntax

Languages

Parameters

• text [STRING]: text

Return Values

• x, y [REAL]: size of the text

Code sample

x, y = gh_imgui.calc_text_size("Hello")
			

checkbox

Description

Create a checkbox.

Syntax

Languages

Parameters

• label [STRING]: name of the button
• current_state [BOOLEAN]: checked: 1 (true) or 0 (false)

Return Values

• checked [BOOLEAN]: checked: 1 (true) or 0 (false)

Code sample

checked = gh_imgui.checkbox("Wireframe", checked)
			

collapsing_header

Description

Creates an header that can be opened or closed.

Syntax

Languages

Parameters

• label [STRING]: name of the button
• flags [ENUM]: see ImGuiTreeNodeFlags_xxx flags in imgui.lua (GeeXLab lua libs)

Return Values

• opened [BOOLEAN]: 1 (opened) or 0 (closed)

Code sample

local flags = 0 -- default

if (gh_imgui.collapsing_header(label, flags) == 1) then
    ...
end
			

color_edit_rgba

Description

Displays a 4D slider with color picker.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• r0, b0, g0, a0 [REAL]: initial 4D value

Return Values

• r, g, b, a [REAL]: RGBA color value

Code sample

r, g, b, a = gh_imgui.color_edit_rgba("coloredit01", r0, b0, g0, a0)
			

color_edit_rgba_v2

Description

Displays a 4D slider with color picker.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• r0, b0, g0, a0 [REAL]: initial 4D value
• flags [ENUM]: ImGuiColorEditFlags_xxx options

Return Values

• r, g, b, a [REAL]: RGBA color value

Code sample

flags = ImGuiColorEditFlags_None

r, g, b, a = gh_imgui.color_edit_rgba_v2("coloredit01", r0, b0, g0, a0, flags)
			

color_picker_rgba

Description

Displays a color picker.

Syntax

Languages

Parameters

• label [STRING]: name of the color picker
• r0, b0, g0, a0 [REAL]: initial 4D value

Return Values

• r, g, b, a [REAL]: RGBA color value

Code sample

r, g, b, a = gh_imgui.color_picker_rgba("coloredit01", r0, b0, g0, a0)
			

color_picker_rgba_v2

Description

Displays a color picker.

Syntax

Languages

Parameters

• label [STRING]: name of the color picker
• r0, b0, g0, a0 [REAL]: initial 4D value
• flags [ENUM]: ImGuiColorEditFlags_xxx options

Return Values

• r, g, b, a [REAL]: RGBA color value

Code sample

flags = ImGuiColorEditFlags_None

r, g, b, a = gh_imgui.color_picker_rgba_v2("coloredit01", r0, b0, g0, a0, flags)
			

column_get_offset

Description

Gets the offset of a particular column.

Syntax

Languages

Parameters

• index [INTEGER]: column index

Return Values

• offset [REAL]: offset

Code sample

offset = gh_imgui.column_get_offset(index)
			

column_get_width

Description

Gets the width of a particular column.

Syntax

Languages

Parameters

• index [INTEGER]: column index

Return Values

• width [REAL]: width

Code sample

width = gh_imgui.column_get_width(index)
			

column_next

Description

Starts a new column.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.columns(2, 1)

-- display widgets
...

-- next column
gh_imgui.column_next()

-- display widgets
...

-- reset to default layout (one column)
gh_imgui.columns(1, 0)
			

column_set_offset

Description

Sets the offset of a particular column.

Syntax

Languages

Parameters

• index [INTEGER]: column index
• offset [REAL]: offset

Return Values

This function has no return value(s).

Code sample

gh_imgui.column_set_offset(index, width)
			

column_set_width

Description

Sets the width of a particular column.

Syntax

Languages

Parameters

• index [INTEGER]: column index
• width [REAL]: width

Return Values

This function has no return value(s).

Code sample

gh_imgui.column_set_width(index, width)
			

columns

Description

Starts/ends a column layout.

Syntax

Languages

Parameters

• num_columns [INTEGER]: number of columns
• border [INTEGER]: display column border ot not

Return Values

This function has no return value(s).

Code sample

gh_imgui.columns(2, 1)

-- display widgets
...

-- next column
gh_imgui.column_next()

-- display widgets
...

-- reset to default layout (one column)
gh_imgui.columns(1, 0)
			

combo_box_add_item

Description

Adds an item to a combo box.

Syntax

Languages

Parameters

• cb_id [ID]: combo box identifier
• item_label [STRING]: label of the item

Return Values

This function has no return value(s).

Code sample

gh_imgui.combo_box_add_item(cb_id, "Item1")
			

combo_box_create

Description

Creates a combo box. Must be called once (usually in an INIT script).

Syntax

Languages

Parameters

• label [STRING]: combo box label

Return Values

• cb_id [ID]: combo box identifier

Code sample

cb_id = gh_imgui.combo_box_create(label)
			

combo_box_draw

Description

Draws the combo box.

Syntax

Languages

Parameters

• cb_id [ID]: combo box identifier
• initial_selected_item [INTEGER]: index of the initial selected item

Return Values

• selected_item [INTEGER]: index of the current selected item

Code sample

selected_item = gh_imgui.combo_box_draw(cb_id, 0)
			

combo_box_draw_v2

Description

Draws the combo box.

Syntax

Languages

Parameters

• cb_id [ID]: combo box identifier
• initial_selected_item [INTEGER]: index of the initial selected item
• height_in_items [INTEGER]: height of the combo box in items

Return Values

• selected_item [INTEGER]: index of the current selected item

Code sample

selected_item = gh_imgui.combo_box_draw_v2(cb_id, 0, 10)
			

dummy

Description

Places an invisible widget (box). Useful for layout management.

Syntax

Languages

Parameters

• width, height [INTEGER]: dimensions of the box in pixels

Return Values

This function has no return value(s).

Code sample

gh_imgui.dummy(10, 5)
			

end_child

Description

End a scrolling region.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.end_child()
			

frame_begin

Description

Begins ImGui rendering. This is the first function to call in a FRAME script before any other gh_imgui functions.

Syntax

Languages

Parameters

• width, height [INTEGER]: size of the main 3D window (gh_window.getsize(0))
• mouse_x, mouse_y [INTEGER]: position of the mouse (gh_input.mouse_get_position())
• mouse_left_button, mouse_right_button [BOOLEAN]: state of mouse left and right buttons (gh_input.mouse_get_button_state())
• dt [REAL]: time step

Return Values

This function has no return value(s).

Code sample

gh_imgui.frame_begin(winW, winH, mouse_x, mouse_y, mouse_left_button, mouse_right_button, dt)
			

frame_begin_v2

Description

Begins ImGui rendering. This is the first function to call in a FRAME script before any other gh_imgui functions.

Syntax

Languages

Parameters

• width, height [INTEGER]: size of the main 3D window (gh_window.getsize(0))
• mouse_x, mouse_y [INTEGER]: position of the mouse (gh_input.mouse_get_position())
• mouse_left_button, mouse_right_button [BOOLEAN]: state of mouse left and right buttons (gh_input.mouse_get_button_state())
• mouse_wheel [INTEGER]: mouse wheel delta
• dt [REAL]: time step

Return Values

This function has no return value(s).

Code sample

gh_imgui.frame_begin_v2(winW, winH, mouse_x, mouse_y, mouse_left_button, mouse_right_button, mouse_wheel, dt)
			

frame_end

Description

Ends ImGui rendering. This is the last function to call in a FRAME script after other gh_imgui functions.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.frame_end()
			

get_color

Description

Gets the current color value.

Syntax

Languages

Parameters

• item_type [ENUM]: type of the widget (see values in the code sample)

Return Values

• r, g, b, a [REAL]: RGBA color value

Code sample

widget_type = IMGUI_BUTTON_COLOR

r, g, b, a = gh_imgui.get_color(widget_type)
			

get_content_region_available_width

Description

Returns the available width inside a window.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• width [REAL]: available width

Code sample

width = gh_imgui.get_content_region_available_width()
			

get_cur_font_display_offset

Description

Gets the x and y offset of the current font.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• x, y [REAL]: offsets

Code sample

x, y = gh_imgui.get_cur_font_display_offset()
			

get_cursor_pos

Description

Returns the position of the mouse cursor (cursor position in window coordinates, relative to window position).

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• x, y [REAL]: position

Code sample

x, y = gh_imgui.get_cursor_pos()
			

get_cursor_screen_pos

Description

Returns the position of the mouse cursor (cursor position in absolute screen coordinates [0 ; DisplaySize], useful for working with DrawList API).

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• x, y [REAL]: position

Code sample

x, y = gh_imgui.get_cursor_screen_pos()
			

get_cursor_start_pos

Description

Gets the initial cursor position in window coordinates.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• x, y [REAL]: cursor position

Code sample

x, y = gh_imgui.get_cursor_start_pos()
			

get_font_size

Description

Returns the size (height) of the font.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• size [REAL]: size

Code sample

size = gh_imgui.get_font_size()
			

get_item_rect

Description

Gets the size (bounding rectangle) of the current item.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• x, y, z, w [INTEGER]: size of the current item

Code sample

x, y, z, w = gh_imgui.get_item_rect()
			

get_scroll

Description

Gets the scrolling amount in X and Y [0..get_scroll_max()].

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• scroll_x, scroll_y [REAL]: scrolling values in X and Y

Code sample

scroll_x, scroll_y = gh_imgui.get_scroll()
			

get_scroll_max

Description

Gets the maximum scrolling amount in X and Y - X => ContentSize.X - WindowSize.X, Y => ContentSize.Y - WindowSize.Y

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• scroll_x, scroll_y [REAL]: scrolling values in X and Y

Code sample

scroll_x, scroll_y = gh_imgui.get_scroll_max()
			

get_text_line_heigh_with_spacing

Description

Distance in pixels between 2 consecutive lines of text

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• h [REAL]: height

Code sample

h = gh_imgui.get_text_line_heigh_with_spacing()
			

get_version

Description

Returns the version of ImGui.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• version [STRING]: ImGui version

Code sample

version_str = gh_imgui.get_version()
			

get_window_pos

Description

Returns the position of the current window.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• x, y [REAL]: position

Code sample

x, y = gh_imgui.get_window_pos()
			

get_window_pos_size

Description

Returns the position and size of the current window.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• x, y, width, height [REAL]: position and size

Code sample

x, y, width, height = gh_imgui.get_window_pos_size()
			

get_window_size

Description

Returns the size of the current window.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• width, height [REAL]: size

Code sample

width, height = gh_imgui.get_window_size()
			

gizmo_begin_frame

Description

Begins the gizmo rendering. Must be called right after frame_begin().

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.frame_begin(...)
gh_imgui.gizmo_begin_frame()
...
			

gizmo_decompose_matrix_to_components

Description

Gets the transformation matrix.

Syntax

Languages

Parameters

• obj_id [ID]: object identifier

Return Values

• tx,ty,tz, rx,ry,rz, sx,sy,sz [REAL]: translation vector, rotation vector and scale vector

Code sample

tx,ty,tz,  rx,ry,rz,  sx,sy,sz = gh_imgui.gizmo_decompose_matrix_to_components(obj_id)
			

gizmo_enable

Description

Enables or disables the gizmo.

Syntax

Languages

Parameters

• state [INTEGER]: 0 or 1

Return Values

This function has no return value(s).

Code sample

gh_imgui.gizmo_enable(1)
			

gizmo_is_over

Description

Is the mouse over the gizmo?

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• state [BOOLEAN]: 1 (yes) or 0 (no)

Code sample

is_over = gh_imgui.gizmo_is_over()
			

gizmo_is_using

Description

Is the mouse over the gizmo or is the gizmo in moving state?

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• state [BOOLEAN]: 1 (yes) or 0 (no)

Code sample

is_using = gh_imgui.gizmo_is_using()
			

gizmo_manipulate

Description

Applies the gizmo transformation to an object.

Syntax

Languages

Parameters

• cam_id [ID]: camera identifier
• obj_id [ID]: object identifier
• oper_type [ENUM]: operation type: 'translate', 'rotate' or 'scale'
• trans_mode [ENUM]: transformation mode: 'local' or 'world'

Return Values

This function has no return value(s).

Code sample

gh_imgui.gizmo_manipulate(cam_id, obj_id, "rotate", "local")
			

gizmo_set_rect

Description

Defines the gizmo viewport.

Syntax

Languages

Parameters

• x, y, width, height [INTEGER]: viewport size

Return Values

This function has no return value(s).

Code sample

gh_imgui.gizmo_set_rect(0, 0, winW, winH)
			

group_begin

Description

Starts a new group. All widgets in a group are seen as a single widget.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.group_begin()

-- display widgets
...

gh_imgui.group_end()
			

group_end

Description

Ends a group.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.group_begin()

-- display widgets
...

gh_imgui.group_end()
			

image

Description

Display a texture. Currently, this fonction works in OpenGL only.

Syntax

Languages

Parameters

• tex_id [ID]: texture identifier as returned by gh_texture.create_xxx() functions
• width, height [REAL]: image size

Return Values

This function has no return value(s).

Code sample

gh_imgui.image(tex0, 200, 200)
			

image_button

Description

Display a button with a texture. Currently, this fonction works in OpenGL only.

Syntax

Languages

Parameters

• tex_id [ID]: texture identifier as returned by gh_texture.create_xxx() functions
• width, height [REAL]: image size
• frame_padding [INTEGER]: frame padding

Return Values

This function has no return value(s).

Code sample

gh_imgui.image_button(tex0, 200, 200, 1)
			

indent

Description

Sets indent spacing.

Syntax

Languages

Parameters

• indent_w [REAL]: size

Return Values

This function has no return value(s).

Code sample

indent_w = 10.0
gh_imgui.indent(indent_w)
			

init

Description

Initialize the ImGui library. Must be called once in the INIT script.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• error [BOOLEAN]: 1 (success) or 0 (error)

Code sample

ret = gh_imgui.init()
			

input_text

Description

Allows to type a text.

Syntax

Languages

Parameters

• label [STRING]: name of the input field
• max_text_len [INTEGER]: max text lenght in bytes (4096 bytes is the default value if max_text_len is set to 0)
• initial_text [STRING]: initial text
• flags [ENUM]: ImGuiInputTextFlags_xxx options

Return Values

• state [BOOLEAN]: state (1 or 0). Useful with ImGuiInputTextFlags_EnterReturnsTrue
• text [STRING]: text

Code sample

flags = ImGuiInputTextFlags_None

text, state = gh_imgui.input_text("User name", 128, "", flags)
			

is_any_item_hovered

Description

Check if any item has been hovered by mouse.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• hovered [BOOLEAN]: hovered: 1 (true) or 0 (false)

Code sample

hovered = gh_imgui.is_any_item_hovered()
			

is_any_window_hovered

Description

Check if any window has been hovered by mouse.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• hovered [BOOLEAN]: hovered: 1 (true) or 0 (false)

Code sample

hovered = gh_imgui.is_any_window_hovered()
			

is_item_clicked

Description

Check if the current item has been clicked.

Syntax

Languages

Parameters

• mouse_button [ENUM]: left button (0) or right button (1)

Return Values

• clicked [BOOLEAN]: clicked: 1 (true) or 0 (false)

Code sample

clicked = gh_imgui.is_item_clicked(0)
			

is_item_hovered

Description

Check if the current item has been hovered by mouse.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• hovered [BOOLEAN]: hovered: 1 (true) or 0 (false)

Code sample

hovered = gh_imgui.is_item_hovered()
			

is_mouse_clicked

Description

Check if any window has been hovered by mouse.

Syntax

Languages

Parameters

• button [ENUM]: mouse button: 0 (left), 1 (right) or 2 (middle)

Return Values

• state [BOOLEAN]: clicked: 1 (true) or 0 (false)

Code sample

state = gh_imgui.is_mouse_clicked(button)
			

is_window_hovered

Description

Check if the current window has been hovered by mouse.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• hovered [BOOLEAN]: hovered: 1 (true) or 0 (false)

Code sample

hovered = gh_imgui.is_window_hovered()
			

list_box_begin

Description

Defines a list box header.

Syntax

Languages

Parameters

• cb_index [INTEGER]: combo box index
• w, h [REAL]: size of the list box

Return Values

• ret [BOOLEAN]: return code: 1 (success) or 0 (error)

Code sample

ret = gh_imgui.list_box_begin(cb_index, 0)
			

list_box_draw

Description

Draws a combo box as a list box.

Syntax

Languages

Parameters

• cb_id [ID]: combo box identifier
• initial_selected_item [INTEGER]: index of the initial selected item

Return Values

• selected_item [INTEGER]: index of the current selected item

Code sample

selected_item = gh_imgui.list_box_draw(cb_id, 0)
			

list_box_draw_v2

Description

Draws a combo box as a list box.

Syntax

Languages

Parameters

• cb_id [ID]: combo box identifier
• initial_selected_item [INTEGER]: index of the initial selected item
• height_in_items [INTEGER]: height of the list box in items

Return Values

• selected_item [INTEGER]: index of the current selected item

Code sample

selected_item = gh_imgui.list_box_draw_v2(cb_id, 0, 20)
			

list_box_end

Description

Ends a list box header.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.list_box_end()
			

list_clipping_begin

Description

Starts the list clipping. Allows to speed up rendering of very big lists.

Syntax

Languages

Parameters

• num_items [INTEGER]: number of items

Return Values

• start_item, end_item [INTEGER]: range coreved by the list clipper

Code sample

start_item, end_item = gh_imgui.list_clipping_begin(num_items)
			

list_clipping_end

Description

Ends the list clipping.

Syntax

Languages

Parameters

• num_items [INTEGER]: number of items
• start_item, end_item [INTEGER]: range coreved by the list clipper

Return Values

This function has no return value(s).

Code sample

gh_imgui.list_clipping_end(num_items, start_item, end_item)
			

menu_begin

Description

Begins a window menu.

Syntax

Languages

Parameters

• label [STRING]: menu label
• enabled [BOOLEAN]: menu: 1 (enabled) or 0 (disabled)

Return Values

• state [BOOLEAN]: 1 or 0 - only call menu_end() if this returns 1

Code sample

gh_imgui.menu_begin("File", 1)
			

menu_begin_bar

Description

Begins a window menu bar.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• state [BOOLEAN]: 1 or 0 - only call menu_end_bar() if this returns 1

Code sample

gh_imgui.menu_begin_bar()
			

menu_begin_main_bar

Description

Begins the main menu bar (fullscreen menu bar).

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• state [BOOLEAN]: 1 or 0 - only call menu_end_main_bar() if this returns 1

Code sample

gh_imgui.menu_begin_main_bar()
			

menu_end

Description

Ends a window menu.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.menu_end()
			

menu_end_bar

Description

Ends a window menu bar.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.menu_end_bar()
			

menu_end_main_bar

Description

Ends the main menu bar.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.menu_end_main_bar()
			

menu_item

Description

Adds an item to the current menu. Must be used between menu_begin() and menu_end().

Syntax

Languages

Parameters

• label [STRING]: menu label
• shortcut [STRING]: menu shortcut (not implemented) - set this value to ''
• selected [BOOLEAN]: menu selected: 1 (true) or 0 (false)
• enabled [BOOLEAN]: menu enabled: 1 (true) or 0 (false)

Return Values

• state [BOOLEAN]: clicked: 1 (true) or 0 (false)

Code sample

enabled = 1

gh_imgui.menu_item("Load a file", "", 0, enabled)
			

plotline_create

Description

Creates a plotline.

Syntax

Languages

Parameters

• label [STRING]: label
• num_points [INTEGER]: number of points in the plotline

Return Values

• index [INTEGER]: index of the new plotline

Code sample

plotline_index = gh_imgui.plotline_create("Curve", 1000)
			

plotline_draw

Description

Draws a plotline.

Syntax

Languages

Parameters

• index [INTEGER]: index of the plotline
• type [ENUM]: type: 1 (histogram) or 0 (line)
• overlay [STRING]: overlay text
• values_offset [INTEGER]: offset
• scale_min, scale_max [REAL]: minimal / maximal value
• graph_size_x, graph_size_y [REAL]: size of the graph

Return Values

This function has no return value(s).

Code sample

values_offset = 0
scale_min = 0
scale_max = 100
graph_size_x = 400
graph_size_y = 200

gh_imgui.plotline_draw(plotline_index, type, "overlay!", values_offset, scale_min, scale_max, graph_size_x, graph_size_y)
			

plotline_draw_v2

Description

Draws a plotline.

Syntax

Languages

Parameters

• index [INTEGER]: index of the plotline
• type [ENUM]: type: 1 (histogram) or 0 (line)
• overlay [STRING]: overlay text
• num_values [INTEGER]: number of values to draw
• values_offset [INTEGER]: offset
• scale_min, scale_max [REAL]: minimal / maximal value
• graph_size_x, graph_size_y [REAL]: size of the graph

Return Values

This function has no return value(s).

Code sample

values_offset = 0
values_count = 1000
scale_min = 0
scale_max = 100
graph_size_x = 400
graph_size_y = 200

gh_imgui.plotline_draw_v2(plotline_index, type, "overlay!", values_count, values_offset, scale_min, scale_max, graph_size_x, graph_size_y)
			

plotline_get_value1f

Description

Gets a value from the plotline.

Syntax

Languages

Parameters

• index [INTEGER]: index of the plotline
• value_index [INTEGER]: index of value in the plotline

Return Values

• x [REAL]: value

Code sample

x = gh_imgui.plotline_get_value1f(plotline_index, value_index)
			

plotline_set_value1f

Description

Sets a value in the plotline.

Syntax

Languages

Parameters

• index [INTEGER]: index of the plotline
• value_index [INTEGER]: index of value in the plotline
• x [REAL]: value

Return Values

This function has no return value(s).

Code sample

gh_imgui.plotline_set_value1f(plotline_index, value_index, x)
			

pop_font

Description

Restores the font saved by push_font().

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.pop_font()
			

pop_item_width

Description

Restore the width that has been changed by push_item_width().

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

local width = gh_imgui.get_content_region_available_width()

gh_imgui.push_item_width(width * 0.8)
...
gh_imgui.pop_item_width()
			

pop_style_color

Description

Restores a color saved with push_style_color().

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.pop_style_color()
			

popup_begin

Description

Begins a popup window. Click outside the popup to close it.

Syntax

Languages

Parameters

• label [STRING]: label

Return Values

• ret [BOOLEAN]: popup opened: 1 (true) or 0 (false)

Code sample

ret = gh_imgui.popup_begin("blabla")
			

popup_begin_context

Description

Begins a popup window.

Syntax

Languages

Parameters

• label [STRING]: label

Return Values

• ret [BOOLEAN]: popup opened: 1 (true) or 0 (false)

Code sample

ret = gh_imgui.popup_begin_context("blabla")
			

popup_end

Description

Ends a popup window. Call this function only if popup_begin_xxx() return 1 (the popup is opened).

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.popup_end()
			

popup_open

Description

Call to mark popup as open (don't call every frame!)

Syntax

Languages

Parameters

• label [STRING]: label

Return Values

This function has no return value(s).

Code sample

gh_imgui.popup_open("blabla")
			

progress_bar

Description

Displays a progress bar.

Syntax

Languages

Parameters

• fraction [REAL]: progression of the bar: from 0.0 to 1.0
• width, height [INTEGER]: size of the bar
• overlay [STRING]: overlay text

Return Values

This function has no return value(s).

Code sample

gh_imgui.progress_bar(0.45, width, height, overlay_str)
			

set_font_glyph_offset

Description

Allows to set an offset to each glyph of the font (default offset is 0,0). This can be useful with narrow buttons for example. set_font_glyph_offset() must be call before rebuild_all_fonts().

Syntax

Languages

Parameters

• font_id [ID]: font identifier
• x, y [INTEGER]: font offset

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_font_glyph_offset(font_id, 0, -2)
gh_imgui.rebuild_all_fonts()
			

push_font

Description

Saves the current font and makes a new font the current active font for next text rendering calls.

Syntax

Languages

Parameters

• font_id [ID]: font identifier

Return Values

This function has no return value(s).

Code sample

gh_imgui.push_font(font_id)
			

push_item_width

Description

Sets the width of next items. This width is valid until a call to pop_item_width().

Syntax

Languages

Parameters

• width [REAL]: width in pixels of next items

Return Values

This function has no return value(s).

Code sample

local width = gh_imgui.get_content_region_available_width()

gh_imgui.push_item_width(width * 0.8)
...
gh_imgui.pop_item_width()
			

push_style_color

Description

Sets a new color to a particular color element.

Syntax

Languages

Parameters

• item_type [ENUM]: type of the widget (see complete list in set_color() function)
• r, g, b, a [REAL]: new color

Return Values

This function has no return value(s).

Code sample

element_type = IMGUI_WINDOW_BG_COLOR

gh_imgui.push_style_color(element_type, r, g, b, a)
			

radio_button

Description

Display a radio button.

Syntax

Languages

Parameters

• name [STRING]: name
• active [BOOLEAN]: active state: 1 (true) or 0 (false)

Return Values

This function has no return value(s).

Code sample

gh_imgui.radio_button("radio button 1", 0)
gh_imgui.radio_button("radio button 2", 1)
gh_imgui.radio_button("radio button 3", 0)
			

rebuild_all_fonts

Description

Rebuild all fonts. Call this function once you have loaded some fonts with add_font_xxx().

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.rebuild_all_fonts()
			

reset_default_font

Description

Resets the default font used by ImGui.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.reset_default_font()
			

same_line

Description

Allows to group items horizontally.

Syntax

Languages

Parameters

• local_pos_x [REAL]: default value: 0.0
• spacing_w [REAL]: default value: -1.0

Return Values

This function has no return value(s).

Code sample

gh_imgui.same_line(local_pos_x, spacing_w)
			

selectable

Description

Allows to select texts in list / widgets.

Syntax

Languages

Parameters

• text [STRING]: label
• selected [BOOLEAN]: selected state: 1 (yes) or 0 (no)
• flags [ENUM]: ImGuiSelectableFlags_xxx options

Return Values

• ret [INTEGER]: state

Code sample

-- Possible flags
ImGuiSelectableFlags_None = 0
ImGuiSelectableFlags_DontClosePopups = 1 -- // Clicking this don't close parent popup window
ImGuiSelectableFlags_SpanAllColumns = 2 -- Selectable frame can span all columns (text will still fit in current column)
ImGuiSelectableFlags_AllowDoubleClick = 4 -- Generate press events on double clicks too
ImGuiSelectableFlags_Disabled = 8 -- Cannot be selected, display greyed out text

selected = 0
flags = ImGuiSelectableFlags_SpanAllColumns

ret = gh_imgui.selectable(text, selected, flags)
			

separator

Description

Adds an horizontal line (separator).

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.separator()
			

set_color

Description

Sets the color of the next widget.

Syntax

Languages

Parameters

• item_type [ENUM]: type of the widget (see values in the code sample)
• r, g, b, a [REAL]: RGBA color of the widget

Return Values

This function has no return value(s).

Code sample

IMGUI_WINDOW_BG_COLOR = 1
IMGUI_TITLE_BG_COLOR = 2
IMGUI_PLOTLINES_COLOR = 3
IMGUI_FRAME_BG_COLOR = 4
IMGUI_TITLE_BG_ACTIVE_COLOR = 5
IMGUI_TITLE_BG_COLLAPSED_COLOR = 6
IMGUI_PLOTHISTOGRAM_COLOR = 7
IMGUI_COMBO_BG_COLOR = 8
IMGUI_BUTTON_COLOR = 9
IMGUI_SEPARATOR_COLOR = 10
IMGUI_RESIZE_GRIP_COLOR = 11
IMGUI_PLOTLINE_HOVERED_COLOR = 12
IMGUI_PLOTHISTOGRAM_HOVERED_COLOR = 13
IMGUI_BUTTON_HOVERED_COLOR = 14
IMGUI_SEPARATOR_HOVERED_COLOR = 15
IMGUI_RESIZE_GRIP_HOVERED_COLOR = 16
IMGUI_HEADER_COLOR = 17
IMGUI_HEADER_HOVERED_COLOR = 18
IMGUI_SLIDER_GRAB_COLOR = 19
IMGUI_CHECK_MARK_COLOR = 20
IMGUI_SCROLLBAR_BG_COLOR = 21
IMGUI_SCROLLBAR_GRAB_COLOR = 22
IMGUI_SCROLLBAR_GRAB_HOVERED_COLOR = 23
IMGUI_TEXT_COLOR = 24
IMGUI_POPUP_BG_COLOR = 25
IMGUI_TEXT_DISABLED_COLOR = 26
IMGUI_CHILD_BG_COLOR = 27
IMGUI_BORDER_COLOR = 28
IMGUI_BORDER_SHADOW_COLOR = 29
IMGUI_FRAME_BG_HOVERED_COLOR = 30
IMGUI_FRAME_BG_ACTIVE_COLOR = 31
IMGUI_MENU_BAR_BG_COLOR = 32
IMGUI_SCROLLBAR_GRAB_ACTIVE_COLOR = 33
IMGUI_SLIDER_GRAB_ACTIVE_COLOR = 34
IMGUI_BUTTON_ACTIVE_COLOR = 35
IMGUI_HEADER_ACTIVE_COLOR = 36
IMGUI_SEPARATOR_ACTIVE_COLOR = 37
IMGUI_RESIZE_GRIP_ACTIVE_COLOR = 38
IMGUI_CLOSE_BUTTON_COLOR = 39
IMGUI_CLOSE_BUTTON_HOVERED_COLOR = 40
IMGUI_CLOSE_BUTTON_ACTIVE_COLOR = 41
IMGUI_PLOTLINES_HOVERED_COLOR = 42
IMGUI_TEXT_SELECTED_BG_COLOR = 43
IMGUI_MODAL_WINDOW_DARKENING_COLOR = 44
IMGUI_DRAG_DROP_TARGET_COLOR = 45
IMGUI_NAV_HIGHLIGHT_COLOR = 46
IMGUI_NAV_WINDOW_IN_HIGHLIGHT_COLOR = 47
IMGUI_MODAL_WINDOW_DIM_BG_COLOR = 48
IMGUI_TAB_COLOR = 49
IMGUI_TAB_HOVERED_COLOR = 50
IMGUI_TAB_ACTIVE_COLOR = 51
IMGUI_TAB_UNFOCUSED_COLOR = 52
IMGUI_TAB_UNFOCUSED_ACTIVE_COLOR = 53

widget_type = IMGUI_BUTTON_COLOR

gh_imgui.set_color(widget_type, r, g, b, a)
			

set_cur_font_display_offset

Description

Sets the x and y offset of the current font. Useful to adjust the vertical alignment of a text.

Syntax

Languages

Parameters

• x, y [REAL]: offsets

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_cur_font_display_offset(x, y)
			

set_default_font

Description

Sets the default font.

Syntax

Languages

Parameters

• font_id [ID]: font identifier

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_default_font(font_id)
			

set_frame_border_size

Description

Sets the size of the frame border.

Syntax

Languages

Parameters

• x [REAL]: size

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_frame_border_size(x)
			

set_rounding

Description

Sets the rounding of a particular element. A value of 0 means a squared corner.

Syntax

Languages

Parameters

• what [STRING]: name of the element: window, child, popup, frame, scrollbar, grab, tab
• x [REAL]: size

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_rounding("frame", x)
			

set_indent_spacing

Description

Sets the indent size.

Syntax

Languages

Parameters

• spacing [REAL]: indent spacing

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_indent_spacing(spacing)
			

set_item_default_focus

Description

Makes last item the default focused item of a window.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_item_default_focus()
			

set_keyboard_focus_here

Description

Focuses keyboard on the next widget. Use positive offset to access sub components of a multiple component widget. Use -1 to access previous widget.

Syntax

Languages

Parameters

• offset [INTEGER]: offset

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_keyboard_focus_here(offset)
			

set_next_item_width

Description

Sets the size of the next item.

Syntax

Languages

Parameters

• width [REAL]: item width

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_next_item_width(width)
			

set_next_window_content_size

Description

Sets the size of the window content.

Syntax

Languages

Parameters

• width, height [REAL]: size

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_next_window_content_size(width, height)
			

set_scroll

Description

Sets the scrolling amount in X and Y [0..get_scroll_max()].

Syntax

Languages

Parameters

• scroll_x, scroll_y [REAL]: scrolling values in X and Y

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_scroll(scroll_x, scroll_y)
			

set_scroll_from_pos_y

Description

Adjusts scrolling amount to make given position visible. Generally get_cursor_start_pos() + offset to compute a valid position.

Syntax

Languages

Parameters

• local_y [REAL]: local y
• center_y_ratio [REAL]: y ratio

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_scroll_from_pos_y(local_y, center_y_ratio)
			

set_scroll_here_y

Description

Adjusts scrolling amount to make current cursor position visible. center_y_ratio=0.0: top, 0.5: center, 1.0: bottom. When using to make a default/current item visible, consider using set_item_default_focus() instead.

Syntax

Languages

Parameters

• center_y_ratio [REAL]: y ratio

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_scroll_here_y(center_y_ratio)
			

set_style_colors

Description

Sets a built-in color style.

Syntax

Languages

Parameters

• style [ENUM]: name of the style

Return Values

This function has no return value(s).

Code sample

-- Available sytles:
"classic"
"dark"
"light"
"krosoft"
"maya"
"rayteak"
"fromhue"
"cherry"
"dark2"
"corporate_grey"

style_name = "classic"
gh_imgui.set_style_colors(style_name)
			

set_tooltip

Description

Sets a tooltip.

Syntax

Languages

Parameters

• caption [STRING]: tooltip text

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_tooltip("This is a tooltip!")
			

set_window_border_size

Description

Sets the size of the window border.

Syntax

Languages

Parameters

• x [REAL]: size

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_window_border_size(x)
			

set_window_focus

Description

Sets named window to be focused (front-most).

Syntax

Languages

Parameters

• name [STRING]: name of the window

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_window_focus(name)
			

set_window_rounding

Description

Sets the window corner rounding.

Syntax

Languages

Parameters

• x [REAL]: size

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_window_rounding(x)
			

show_demo_window

Description

Renders the ImGui demo window.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.show_demo_window()
			

show_metrics_window

Description

Display an ImGui built-in window that shows statistics about all windows. Call this function between frame_begin() and frame_end().

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.show_metrics_window()
			

show_stack_tool_window

Description

Display an ImGui built-in window that shows items unique IDs. Call this function between frame_begin() and frame_end().

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.show_stack_tool_window()
			

show_test_window

Description

Shows ImGui test window.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.frame_begin(winW, winH, mouse_x, mouse_y, mouse_left_button, mouse_right_button)

gh_imgui.show_test_window()

gh_imgui.frame_end()
			

slider_1i

Description

Displays a 1D slider with integer values.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• initial_value [INTEGER]: initial value
• v_min, v_max [INTEGER]: min / max value of the slider

Return Values

• value [INTEGER]: current value

Code sample

v = gh_imgui.slider_1i("slider01", initial_value, v_min, v_max)
			

slider_1i_v2

Description

Displays a 1D slider with integer values.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• initial_value [INTEGER]: initial value
• v_min, v_max [INTEGER]: min / max value of the slider
• flags [INTEGER]: ImGuiSliderFlags_xxxx flags

Return Values

• value [INTEGER]: current value

Code sample

ImGuiSliderFlags_None                   = 0
ImGuiSliderFlags_ClampOnInput           = 16
ImGuiSliderFlags_Logarithmic            = 32
ImGuiSliderFlags_NoRoundToFormat        = 64
ImGuiSliderFlags_NoInput                = 12
v = gh_imgui.slider_1i_v2("slider01", initial_value, v_min, v_max, ImGuiSliderFlags_None)
			

slider_1f

Description

Displays a 1D slider.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• initial_value [REAL]: initial value
• v_min, v_max [REAL]: min / max value of the slider
• power [REAL]: use power != 1.0 for logarithmic sliders

Return Values

• value [REAL]: current value

Code sample

v = gh_imgui.slider_1f("slider01", initial_value, v_min, v_max, 1.0)
			

slider_2f

Description

Displays a 2D slider.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• x0, y0 [REAL]: initial 2D value
• v_min, v_max [REAL]: min / max value of the slider
• power [REAL]: use power != 1.0 for logarithmic sliders

Return Values

• x, y [REAL]: current 2D value

Code sample

x, y = gh_imgui.slider_2f("slider04", x0, y0, v_min, v_max, 1.0)
			

slider_3f

Description

Displays a 3D slider.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• x0, y0, z0 [REAL]: initial 3D value
• v_min, v_max [REAL]: min / max value of the slider
• power [REAL]: use power != 1.0 for logarithmic sliders

Return Values

• x, y, z [REAL]: current 3D value

Code sample

x, y, z = gh_imgui.slider_3f("slider03", x0, y0, z0, v_min, v_max, 1.0)
			

slider_4f

Description

Displays a 4D slider.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• x0, y0, z0, w0 [REAL]: initial 4D value
• v_min, v_max [REAL]: min / max value of the slider
• power [REAL]: use power != 1.0 for logarithmic sliders

Return Values

• x, y, z, w [REAL]: current 4D value

Code sample

x, y, z, w = gh_imgui.slider_4f("slider02", x0, y0, z0, w0, v_min, v_max, 1.0)
			

spacing

Description

Adds a vertical space.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.spacing()
			

bullet

Description

Adds a bullet (for lists).

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.bullet()
			

tab_bar_begin

Description

Begins a tab bar.

Syntax

Languages

Parameters

• label [STRING]: label

Return Values

• is_opened [BOOLEAN]: 1 (true) or 0 (false)

Code sample

ret = gh_imgui.tab_bar_begin("tabbar01")
			

tab_bar_begin_v2

Description

Begins a tab bar.

Syntax

Languages

Parameters

• label [STRING]: label
• flags [ENUM]: ImGuiTabBarFlags_xxx options

Return Values

• is_opened [BOOLEAN]: 1 (true) or 0 (false)

Code sample

ImGuiTabBarFlags_None = 0,
ImGuiTabBarFlags_Reorderable = 1
ImGuiTabBarFlags_AutoSelectNewTabs = 2
ImGuiTabBarFlags_NoCloseWithMiddleMouseButton = 4
ImGuiTabBarFlags_NoTabListPopupButton = 8
ImGuiTabBarFlags_NoTabListScrollingButtons = 16
ImGuiTabBarFlags_NoTooltip = 32
ImGuiTabBarFlags_FittingPolicyResizeDown = 64
ImGuiTabBarFlags_FittingPolicyScroll = 128

ret = gh_imgui.tab_bar_begin_v2("tabbar01", ImGuiTabBarFlags_Reorderable)
			

tab_bar_end

Description

Ends a tab bar.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

ImGuiTabBarFlags_Reorderable = 1

if (gh_imgui.tab_bar_begin_v2("tabbar01", ImGuiTabBarFlags_Reorderable) == 1) then
    ...
    gh_imgui.tab_bar_end()
end
			

tab_item_begin

Description

Begins a tab bar item.

Syntax

Languages

Parameters

• label [STRING]: label
• show_tab [BOOLEAN]: 1 (show) or 0 (hide)
• flags [ENUM]: ImGuiTabItemFlags_xxx options

Return Values

• is_opened [BOOLEAN]: 1 (true) or 0 (false)

Code sample

flags = ImGuiTabItemFlags_None -- 0
show_tab = 1
if (gh_imgui.tab_bar_begin("tabbar01", show_tab, flags) == 1) then
    flags = 0

    if (gh_imgui.tab_item_begin("TAB1", 1, flags) == 1) then
        gh_imgui.text("This is the TAB1")
        gh_imgui.tab_item_end()
    end

    if (gh_imgui.tab_item_begin("TAB2", 0, flags) == 1) then
        gh_imgui.text("This is the TAB2")
        gh_imgui.tab_item_end()
    end

    gh_imgui.tab_bar_end()
end
			

tab_item_begin_v2

Description

Begins a tab bar item.

Syntax

Languages

Parameters

• label [STRING]: label
• flags [ENUM]: ImGuiTabItemFlags_xxx options

Return Values

• is_opened [BOOLEAN]: 1 (true) or 0 (false)

Code sample

if (gh_imgui.tab_bar_begin_v2("tabbar01", flags) == 1) then
    flags = 0

    if (gh_imgui.tab_item_begin("TAB1", 1, flags) == 1) then
        gh_imgui.text("This is the TAB1")
        gh_imgui.tab_item_end()
    end

    if (gh_imgui.tab_item_begin("TAB2", 1, flags) == 1) then
        gh_imgui.text("This is the TAB2")
        gh_imgui.tab_item_end()
    end

    gh_imgui.tab_bar_end()
end
			

tab_item_end

Description

Ends a tab bar item.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

flags = 0

if (gh_imgui.tab_bar_begin_v2("tabbar01", flags) == 1) then
    flags = 0

    if (gh_imgui.tab_item_begin("TAB1", 1, flags) == 1) then
        gh_imgui.text("This is the TAB1")
        gh_imgui.tab_item_end()
    end

    if (gh_imgui.tab_item_begin("TAB2", 1, flags) == 1) then
        gh_imgui.text("This is the TAB2")
        gh_imgui.tab_item_end()
    end

    gh_imgui.tab_bar_end()
end
			

terminate

Description

Terminates the ImGui library. Must be called once in the TERMINATE script.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.terminate()
			

text

Description

Displays a simple text.

Syntax

Languages

Parameters

• text [STRING]: text to display

Return Values

This function has no return value(s).

Code sample

gh_imgui.text("GeeXLab is powerful!")
			

text_rgba

Description

Displays a colored text.

Syntax

Languages

Parameters

• text [STRING]: text to display
• r, g, b, a [REAL]: color of the text

Return Values

This function has no return value(s).

Code sample

gh_imgui.text_rgba("GeeXLab is powerful!", 1.0, 1.0, 0.0, 1.0)
			

text_unformatted_v1

Description

Displays a raw text without formatting. Recommended for long chunks of text.

Syntax

Languages

Parameters

• text [STRING]: text to display

Return Values

This function has no return value(s).

Code sample

gh_imgui.text_unformatted_v1("GeeXLab is powerful!")
			

text_unformatted_v2

Description

Displays a raw text without formatting. Recommended for long chunks of text.

Syntax

Languages

Parameters

• text [STRING]: text to display
• text_end [STRING]: XX euh...

Return Values

This function has no return value(s).

Code sample

gh_imgui.text_unformatted_v2("GeeXLab is powerful!")
			

text_wrapped

Description

Displays a wrapped text.

Syntax

Languages

Parameters

• text [STRING]: text to display

Return Values

This function has no return value(s).

Code sample

gh_imgui.text_wrapped("GeeXLab is powerful!")
			

tree_node

Description

Starts a tree.

Syntax

Languages

Parameters

• label [STRING]: label

Return Values

• state [BOOLEAN]: tree opened: 1 (true) or 0 (false)

Code sample

node_open = gh_imgui.tree_node("Root")
if (node_open == 1) then
    gh_imgui.tree_node_leaf("Child 1")
    if (gh_imgui.is_item_clicked(mouse_button_left) == 1) then
        tree_selected_node_name = "Child 1"
    end
    gh_imgui.tree_pop()
end
			

tree_node_ex

Description

Starts a tree.

Syntax

Languages

Parameters

• label [STRING]: label
• flags [ENUM]: ImGuiTreeNodeFlags_xxx options

Return Values

• state [BOOLEAN]: tree opened: 1 (true) or 0 (false)

Code sample

flags = ImGuiTreeNodeFlags_Selected
node_open = gh_imgui.tree_node_ex("Root", flags)
if (node_open == 1) then
    gh_imgui.tree_node_leaf("Child 1")
    if (gh_imgui.is_item_clicked(mouse_button_left) == 1) then
        tree_selected_node_name = "Child 1"
    end
    gh_imgui.tree_pop()
end
			

tree_node_leaf

Description

Display a tree leaf.

Syntax

Languages

Parameters

• label [STRING]: label

Return Values

This function has no return value(s).

Code sample

node_open = gh_imgui.tree_node("Root")

if (node_open == 1) then
    gh_imgui.tree_node_leaf("Child 1")

    if (gh_imgui.is_item_clicked(mouse_button_left) == 1) then
        tree_selected_node_name = "Child 1"
    end

    gh_imgui.tree_pop()
end
			

tree_node_leaf_v2

Description

Display a tree leaf.

Syntax

Languages

Parameters

• label [STRING]: label
• flags [ENUM]: tree options - see ImGuiTreeNodeFlags_xxx constants in libs/lua/imgui.lua

Return Values

This function has no return value(s).

Code sample

node_open = gh_imgui.tree_node("Root")

if (node_open == 1) then
    local ImGuiTreeNodeFlags_Bullet = 512

    gh_imgui.tree_node_leaf_v2("Child 1", ImGuiTreeNodeFlags_Bullet)

    if (gh_imgui.is_item_clicked(mouse_button_left) == 1) then
        tree_selected_node_name = "Child 1"
    end

    gh_imgui.tree_pop()
end
			

tree_pop

Description

Ends a tree.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

node_open = gh_imgui.tree_node("Root")

if (node_open == 1) then
    gh_imgui.tree_node_leaf("Child 1")

    if (gh_imgui.is_item_clicked(mouse_button_left) == 1) then
        tree_selected_node_name = "Child 1"
    end

    gh_imgui.tree_pop()
end
			

underline

Description

Draw a colored line under the current item.

Syntax

Languages

Parameters

• r, g, b, a [REAL]: color

Return Values

This function has no return value(s).

Code sample

gh_imgui.underline(r, g, b, a)
			

unindent

Description

Sets unindent spacing.

Syntax

Languages

Parameters

• indent_w [REAL]: size

Return Values

This function has no return value(s).

Code sample

gh_imgui.unindent(indent_w)
			

url

Description

Draw a clickable url.

Syntax

Languages

Parameters

• link_caption [STRING]: caption
• link_url [STRING]: url (https://....) - Link can be empty to work like a button
• tooltip_text [STRING]: tool tip (can be empty)

Return Values

• clicked [INTEGER]: 1 if clicked, 0 otherwise.

Code sample

clicked = gh_imgui.url(link_caption, link_url, tooltip_text)
			

vslider_1f

Description

Displays a 1D vertical slider.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• width, height [REAL]: size of the slider
• initial_value [REAL]: initial value
• v_min, v_max [REAL]: min / max value of the slider
• power [REAL]: use power != 1.0 for logarithmic sliders

Return Values

• value [REAL]: current value

Code sample

v = gh_imgui.vslider_1f("vslider01", 20, 100, initial_value, v_min, v_max, 1.0)
			

vslider_1i

Description

Displays a 1D vertical slider with integer values.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• width, height [REAL]: size of the slider
• initial_value [INTEGER]: initial value
• v_min, v_max [INTEGER]: min / max value of the slider

Return Values

• value [INTEGER]: current value

Code sample

v = gh_imgui.vslider_1i("slider01", 20, 100, initial_value, v_min, v_max)
			

vslider_1i_v2

Description

Displays a 1D vertical slider with integer values.

Syntax

Languages

Parameters

• label [STRING]: name of the slider
• width, height [REAL]: size of the slider
• initial_value [INTEGER]: initial value
• v_min, v_max [INTEGER]: min / max value of the slider
• flags [INTEGER]: ImGuiSliderFlags_xxxx flags

Return Values

• value [INTEGER]: current value

Code sample

ImGuiSliderFlags_None                   = 0
ImGuiSliderFlags_ClampOnInput           = 16
ImGuiSliderFlags_Logarithmic            = 32
ImGuiSliderFlags_NoRoundToFormat        = 64
ImGuiSliderFlags_NoInput                = 128
v = gh_imgui.vslider_1i_v2("slider01", 20, 100, initial_value, v_min, v_max, ImGuiSliderFlags_None)
			

widget

Description

Adds a widget.

Syntax

Languages

Parameters

• widget_type [ENUM]: type of the widget

Return Values

This function has no return value(s).

Code sample

IMGUI_WIDGET_SEPARATOR = 1
IMGUI_WIDGET_SAME_LINE = 2
IMGUI_WIDGET_BULLET = 3
IMGUI_WIDGET_VERTICAL_SPACING = 4
IMGUI_WIDGET_NEW_LINE = 5

gh_imgui.widget(IMGUI_WIDGET_SEPARATOR)
			

window_begin

Description

Starts the rendering of a window.

Syntax

Languages

Parameters

• name [STRING]: name of the window
• width, height [REAL]: size of the window
• pos_x, pos_y [REAL]: position of the window
• win_flags [ENUM]: window options: set to 0 for default options. Options can be OR-ed.
• pos_flags [ENUM]: window position options: set to 4 for default options
• size_flags [ENUM]: window size options: set to 4 for default options

Return Values

• is_open [BOOLEAN]: window: 1 (opened) or 0 (collapsed)

Code sample

-- Window options
local window_default = 0
local window_no_resize = 2
local window_no_move = 4
local window_no_collapse = 32
local window_show_border = 128
local window_no_save_settings = 256

-- Position or size options
local pos_size_flag_always = 1 -- Always set the pos and/or size
local pos_size_flag_once = 2 -- Set the pos and/or size once per runtime session (only the first call with succeed)
local pos_size_flag_first_use_ever = 4 -- Set the pos and/or size if the window has no saved data (if doesn't exist in the .ini file)
local pos_size_flag_appearing = 8 -- Set the pos and/or size if the window is appearing after being hidden/inactive (or the first time)

-- window_flags = window_no_move | window_no_save_settings
window_flags = 0
pos_flags = pos_size_flag_first_use_ever
size_flags = pos_size_flag_first_use_ever

is_open = gh_imgui.window_begin("GeeXLab ImGui demo", 300, 200, 20, 20, window_flags, pos_flags, size_flags)
if (is_open == 1) then
    gh_imgui.text("GeeXLab is powerful!")
end

gh_imgui.window_end()
			

window_begin_v2

Description

Starts the rendering of a window. This window has a close button.

Syntax

Languages

Parameters

• name [STRING]: name of the window
• width, height [REAL]: size of the window
• pos_x, pos_y [REAL]: position of the window
• win_flags [ENUM]: window options: set to 0 for default options. Options can be OR-ed.
• pos_flags [ENUM]: window position options: set to 4 for default options
• size_flags [ENUM]: window size options: set to 4 for default options
• show_window [BOOLEAN]: initial open state of the window: 1 (show) or 0 (hide)

Return Values

• is_open, show_window [BOOLEAN]: is_open: 1 (window opened) or 0 (window collapsed) - show_window: 0 (the user has clicked on the close button)

Code sample

-- Window options
local window_default = 0
local window_no_resize = 2
local window_no_move = 4
local window_no_collapse = 32
local window_show_border = 128
local window_no_save_settings = 256

-- Position or size options
local pos_size_flag_always = 1 -- Always set the pos and/or size
local pos_size_flag_once = 2 -- Set the pos and/or size once per runtime session (only the first call with succeed)
local pos_size_flag_first_use_ever = 4 -- Set the pos and/or size if the window has no saved data (if doesn't exist in the .ini file)
local pos_size_flag_appearing = 8 -- Set the pos and/or size if the window is appearing after being hidden/inactive (or the first time)

-- window_flags = window_no_move | window_no_save_settings
window_flags = 0
pos_flags = pos_size_flag_first_use_ever
size_flags = pos_size_flag_first_use_ever

if (show_window == 1) then
    window_flags = 0
    show = show_window

    is_open, show_window = gh_imgui.window_begin_v2("GeeXLab information", 300, 200, 20, 20, window_flags, pos_flags, size_flags, show)
    if (is_open == 1) then
        gh_imgui.text("GeeXLab is powerful!")
    end

    gh_imgui.window_end()
end
			

window_end

Description

Stops the rendering of a window.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

window_flags = 0
gh_imgui.window_begin("GeeXLab information", 300, 200, 20, 20, window_flags)
gh_imgui.text("GeeXLab is powerful!")
gh_imgui.window_end()
			

imguizmoquat_gizmo3d_v1

Description

Rotates an object using a virtual trackball.

Syntax

Languages

Parameters

• label [STRING]: label of the gizmo
• size [REAL]: size of the item
• mode [INTEGER]: gizmo mode
• object_id [REAL]: object identifier

Return Values

This function has no return value(s).

Code sample

local mode3Axes = 1
local modeDirection = 2
local modeDirPlane = 4
local modeDual = 8
local modeMask = 15
local cubeAtOrigin = 16
local sphereAtOrigin = 32
local noSolidAtOrigin = 64
local modeFullAxes = 128
local axesModeMask = 240
gh_imgui.imguizmoquat_gizmo3d_v1("##gizmo01", 100.0, modeDirection + cubeAtOrigin, torus)
			

imguizmoquat_gizmo3d_v2

Description

Rotates a virtual trackball and returns the orientation quaternion.

Syntax

Languages

Parameters

• label [STRING]: label of the gizmo
• size [REAL]: size of the item
• mode [INTEGER]: gizmo mode
• q0x, q0y, q0z, q0w [REAL]: initial orientation quaternion

Return Values

• qx, qy, qz, qw [REAL]: orientation quaternion

Code sample

local mode3Axes = 1
local modeDirection = 2
local modeDirPlane = 4
local modeDual = 8
local modeMask = 15
local cubeAtOrigin = 16
local sphereAtOrigin = 32
local noSolidAtOrigin = 64
local modeFullAxes = 128
local axesModeMask = 240

q0 = {x=0, y=0, z=0, w=0}
qr = {x=0, y=0, z=0, w=0}

qr.x, qr.w, qr.z, qr.w = gh_imgui.imguizmoquat_gizmo3d_v2("##gizmo01", 100.0, modeDirection + cubeAtOrigin, q0.x, q0.y, q0.z, q0.w)
			

imguizmoquat_gizmo3d_v3

Description

Rotates a virtual trackball and returns the 4x4 orientation matrix.

Syntax

Languages

Parameters

• label [STRING]: label of the gizmo
• size [REAL]: size of the item
• mode [INTEGER]: gizmo mode
• q0x, q0y, q0z, q0w [REAL]: initial orientation quaternion

Return Values

• m0,m1,m2,m3,m4,m5,m6,m7,m8,m9,m10,m11,m12,m13,m14,m15 [REAL]: the 16 floats that make the 4x4 matrix

Code sample

local mode3Axes = 1
local modeDirection = 2
local modeDirPlane = 4
local modeDual = 8
local modeMask = 15
local cubeAtOrigin = 16
local sphereAtOrigin = 32
local noSolidAtOrigin = 64
local modeFullAxes = 128
local axesModeMask = 240

q0 = {x=0, y=0, z=0, w=0}

m0,m1,m2,m3,m4,m5,m6,m7,m8,m9,m10,m11,m12,m13,m14,m15 = gh_imgui.imguizmoquat_gizmo3d_v3("##gizmo01", 100.0, modeDirection + cubeAtOrigin, q0.x, q0.y, q0.z, q0.w)
			

set_item_spacing

Description

Sets the spacing between items.

Syntax

Languages

Parameters

• x, y [REAL]: spacing

Return Values

This function has no return value(s).

Code sample

gh_imgui.set_item_spacing(x, y)
			

get_item_spacing

Description

Gets the spacing between items.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• x, y [REAL]: spacing

Code sample

x, y = gh_imgui.get_item_spacing()
			

imgui_plot_create

Description

Creates a plotline.

Syntax

Languages

Parameters

• label [STRING]: name of the plotline

Return Values

• plot_id [ID]: plotline identifier

Code sample

plot_id = gh_imgui.imgui_plot_create("myPlotline")
			

plot_kill

Description

Destroys a plotline.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_kill(plot_id)
			

plot_draw

Description

Draws a plotline.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• label [STRING]: name of the plotline
• num_items [INTEGER]: number of lines to draw
• size_x, size_y [REAL]: plotline frame size

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_draw(plot_id, label, num_items, size_x, size_y)
			

plot_set_title

Description

Sets the title a plotline.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• title [STRING]: title of the plotline

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_set_title(plot_id, title)
			

plot_set_color

Description

Sets the color a of particular element of a plotline.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• what [STRING]: element name: 'frame', 'background', 'border'
• r, g, b, a [REAL]: RGBA color

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_set_color(plot_id, "background", 0.4, 0.4, 0.4, 0.85)
			

plot_set_state

Description

Sets the state a of particular element of a plotline.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• what [STRING]: element name: 'show_crosshairs', 'show_mouse_pos', 'show_legend'
• state [BOOLEAN]: 0 (disabled) or 1 (enabled)

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_set_state(plot_id, "show_crosshairs", state)
			

plot_set_axis_param_bool

Description

Sets the state a of particular element of an axis.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• axis [INTEGER]: X axis: 0 or Y axis: 1
• what [STRING]: element name: 'show_grid', 'show_tick_marks', 'show_tick_labels', 'adaptive', 'lock_max', 'lock_min', 'flip'
• state [BOOLEAN]: 0 (disabled) or 1 (enabled)

Return Values

This function has no return value(s).

Code sample

axis_x = 0			
axis_y = 1			
state = 1
gh_imgui.plot_set_axis_param_bool(plot_id, axis_x, "show_grid", state)
gh_imgui.plot_set_axis_param_bool(plot_id, axis_y, "show_grid", state)
			

plot_set_axis_param_int

Description

Sets the value a of particular element of an axis.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• axis [INTEGER]: X axis: 0 or Y axis: 1
• what [STRING]: element name: 'divisions', 'subdivisions'
• x [INTEGER]: value

Return Values

This function has no return value(s).

Code sample

axis_x = 0			
gh_imgui.plot_set_axis_param_int(plot_id, axis_x, "divisions", 10)
gh_imgui.plot_set_axis_param_int(plot_id, axis_x, "subdivisions", 4)
			

plot_set_axis_param_float

Description

Sets the value a of particular element of an axis.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• axis [INTEGER]: X axis: 0 or Y axis: 1
• what [STRING]: element name: 'minimum', 'maximum', 'zoom_rate'
• x [REAL]: value

Return Values

This function has no return value(s).

Code sample

axis_y = 1			
gh_imgui.plot_set_axis_param_float(plot_id, axis_y, "minimum", -10.0)
gh_imgui.plot_set_axis_param_bool(plot_id, axis_y, "minimum", 10.0)
			

plot_set_axis_label

Description

Sets the label of an axis.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• axis [INTEGER]: X axis: 0 or Y axis: 1
• label [STRING]: label

Return Values

This function has no return value(s).

Code sample

axis_y = 1			
gh_imgui.plot_set_axis_label(plot_id, axis_y, "Y axis")
			

plot_set_axis_color

Description

Sets the color of an axis.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• axis [INTEGER]: X axis: 0 or Y axis: 1
• r, g, b, a [REAL]: RGBA color

Return Values

This function has no return value(s).

Code sample

axis_y = 1			
gh_imgui.plot_set_axis_color(plot_id, axis_y, r, g, b, a)
			

plot_add_item

Description

Adds a new item (a line) to an existing plotline.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• label [STRING]: label
• type [INTEGER]: line: 0, scatter: 1, xbar: 2 or ybar: 3

Return Values

• item_index [INTEGER]: index of the new item

Code sample

type_line = 0
type_scatter = 1
type_xbar = 2
type_ybar = 3
item_index = gh_imgui.plot_add_item(plot_id, "myNewItem", type_line)
			

plot_item_set_label

Description

Sets a label of an item.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• label [STRING]: label

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_add_item(plot_id, item_index, "myItem")
			

plot_item_set_color

Description

Sets the color of an item.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• r, g, b, a [REAL]: RGBA color

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_set_color(plot_id, item_index, r, g, b, a)
			

plot_item_set_type

Description

Sets the type of an item.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• type [INTEGER]: line: 0, scatter: 1, xbar: 2 or ybar: 3

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_set_type(plot_id, item_index, type)
			

plot_item_set_size

Description

Sets the size (or tickness) of an item.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• size [REAL]: size (or tickness)

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_set_size(plot_id, item_index, 2.0)
			

plot_item_set_data_begin

Description

Sets the start offset.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• x [INTEGER]: offset

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_set_data_begin(plot_id, item_index, 0)
			

plot_item_add_data

Description

Adds data to an item.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• x, y [REAL]: data - these are the line values in Y and Y

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_add_data(plot_id, item_index, x, y)
			

plot_item_get_data_size

Description

Gets the data size of an item.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item

Return Values

• n [INTEGER]: data size

Code sample

n = gh_imgui.plot_item_get_data_size(plot_id, item_index)
			

plot_item_clear_data

Description

Clears all data of an item.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_clear_data(plot_id, item_index)
			

plot_item_clear_data

Description

Resize data of an item.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• n [INTEGER]: data size

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_resize_data(plot_id, item_index, n)
			

plot_item_set_data

Description

Sets data of an item.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• data_index [INTEGER]: index of the data
• x, y [REAL]: data - these are the line values in Y and Y

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_set_data(plot_id, item_index, , data_index, x, y)
			

plot_item_roll_point

Description

Adds a point to an item data set, clearing it every span seconds.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• x, y [REAL]: data - these are the line values in Y and Y
• span [REAL]: duration in seconds

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_roll_point(plot_id, item_index, x, y, span)
			

plot_item_buffer_point

Description

Pushes a point into an item data set as if it were a circular buffer of #max_points size.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• item_index [INTEGER]: index of the item
• x, y [REAL]: data - these are the line values in Y and Y
• max_points [INTEGER]: max number of points

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_item_buffer_point(plot_id, item_index, x, y, max_points)
			

plot_axis_scroll

Description

Call before rendering a plot to scroll the axis in time, displaying history seconds.

Syntax

Languages

Parameters

• plot_id [ID]: plotline identifier
• axis [INTEGER]: X axis: 0, Y axis: 1
• current_time [REAL]: current time
• history [REAL]: history seconds

Return Values

This function has no return value(s).

Code sample

gh_imgui.plot_axis_scroll(plot_id, axis, current_time, history)
			

plot_is_hovered

Description

Checks if a plotline is hovered by the mouse.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• state [INTEGER]: 1: hovered, 0: not hovered

Code sample

state = gh_imgui.plot_is_hovered()
			

plot_get_mouse_position

Description

Gets the mouse position related to the plotline.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• x, y [REAL]: mouse position

Code sample

x, y = gh_imgui.plot_get_mouse_position()
			

get_text_line_height

Description

Gets the current line height (font size).

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• h [REAL]: line height

Code sample

h = gh_imgui.get_text_line_height()
			

get_text_line_height_with_spacing

Description

Gets the distance in pixels between 2 consecutive lines of text.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• h [REAL]: line height

Code sample

h = gh_imgui.get_text_line_height_with_spacing()
			

color_text_editor_create

Description

Creates a new text editor widget.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

• te_id [ID]: text editor identifier

Code sample

te_id = gh_imgui.color_text_editor_create()
			

color_text_editor_kill

Description

Destroys a text editor.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_kill(te_id)
			

color_text_editor_render

Description

Draws a text editor.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• title [STRING]: title
• size_x, size_y [REAL]: frame size
• border [INTEGER]: border (1: yes, 0: no)

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_render(te_id, "Lua Editor", 400, 600, 0)
			

color_text_editor_get_text

Description

Gets the text of the editor.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier

Return Values

• text [STRING]: text

Code sample

text = gh_imgui.color_text_editor_get_text(te_id)
			

color_text_editor_set_text

Description

Sets the text of the editor.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• text [STRING]: text

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_set_text(te_id, text)
			

color_text_editor_set_language

Description

Sets a built-in language support.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• lang [STRING]: langaue: lua, glsl, hlsl, cpp, c, sql

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_set_language(te_id, "lua")
			

color_text_editor_set_palette

Description

Sets a color palette. Colors can also be modified with color_text_editor_palette_set_color().

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• pal [STRING]: palette: dark, light, retro_blue

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_set_palette(te_id, "dark")
			

color_text_editor_set_property_bool

Description

Sets a property boolean value.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• what [STRING]: property name: whitespaces, readonly, colorizer, handle_mouse_inputs, handle_keyboard_inputs
• x [INTEGER]: value

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_set_property_bool(te_id, "whitespaces", 1)
			

color_text_editor_set_property_int

Description

Sets a property integer value.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• what [STRING]: property name: tabsize
• x [INTEGER]: value

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_set_property_int(te_id, "tabsize", 2)
			

color_text_editor_get_total_lines

Description

Gets the current number of lines.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier

Return Values

• n [INTEGER]: number of lines

Code sample

n = gh_imgui.color_text_editor_get_total_lines(te_id)
			

color_text_editor_get_selected_text

Description

Gets the selected text.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier

Return Values

• text [STRING]: selected text

Code sample

text = gh_imgui.color_text_editor_get_selected_text(te_id)
			

color_text_editor_get_current_line_text

Description

Gets the current line.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier

Return Values

• line [STRING]: current line

Code sample

line = gh_imgui.color_text_editor_get_current_line_text(te_id)
			

color_text_editor_get_cursor_position

Description

Gets the cursor position.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier

Return Values

• x, y [INTEGER]: current cursor position

Code sample

x, y = gh_imgui.color_text_editor_get_cursor_position(te_id)
			

color_text_editor_palette_set_color

Description

Sets the color of a particular element.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• what [STRING]: element name: Default, Keyword, Number, String, Punctuation, Preprocessor, Identifier, KnownIdentifier, PreprocIdentifier, Comment, MultiLineComment, Background, Cursor, Selection, ErrorMarker, Breakpoint, LineNumber, CurrentLineFill, CurrentLineFillInactive, CurrentLineEdge, XT95Line
• r, g, b, a [REAL]: RGBA color

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_palette_set_color(te_id, "Background", r, g, b, a)
gh_imgui.color_text_editor_palette_set_color(te_id, "XT95Line", 0.2, 0.2, 0.2, 0.8)
			

color_text_editor_palette_get_color

Description

Gets the color of a particular element.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• what [STRING]: element name: Default, Keyword, Number, String, Punctuation, Preprocessor, Identifier, KnownIdentifier, PreprocIdentifier, Comment, MultiLineComment, Background, Cursor, Selection, ErrorMarker, Breakpoint, LineNumber, CurrentLineFill, CurrentLineFillInactive, CurrentLineEdge

Return Values

• r, g, b, a [REAL]: RGBA color

Code sample

r, g, b, a = gh_imgui.color_text_editor_palette_get_color(te_id, "Background")
			

color_text_editor_copy_paste_cut

Description

Performs a copy, paste or cut operation.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• what [STRING]: operation: copy, paste or cut

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_copy_paste_cut(te_id, "copy")
			

color_text_editor_selection

Description

Starts or ends text selection.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier
• what [STRING]: operation: start, end or clear

Return Values

This function has no return value(s).

Code sample

gh_imgui.color_text_editor_selection(te_id, "start")
			

color_text_editor_is_text_changed

Description

Allows to know the if text has changed.

Syntax

Languages

Parameters

• te_id [ID]: text editor identifier

Return Values

• x [INTEGER]: 1 if text changed, 0 if not.

Code sample

x = gh_imgui.color_text_editor_is_text_changed(te_id)
			

implot_create_dataplot

Description

Creates a plot data set. This data set will be used with implot_begin_plot() and implot_end_plot() to draw a plot.

Syntax

Languages

Parameters

• max_points [INTEGER]: max number of points of the data plot. Can be 0

Return Values

• plotid [INTEGER]: plot identifier.

Code sample

plotid = gh_imgui.implot_create_dataplot(max_points)
			

implot_kill_dataplot

Description

Destroy a plot data set.

Syntax

Languages

Parameters

• plotid [INTEGER]: plot identifier.

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_kill_dataplot(plotid)
			

implot_show_demo_window

Description

Displays the official ImPlot demo.

Syntax

Languages

Parameters

• show_window [INTEGER]:

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_show_demo_window(show_window)
			

implot_begin_plot

Description

Begins the rendering of one or several plots.

Syntax

Languages

Parameters

• label [STRING]: plot label.
• x_label [STRING]: X axis label.
• y_label [STRING]: y axis label.
• label [STRING]: plot label.
• x, y [REAL]: plot size.
• flags [INTEGER]: plot flags/options.
• x_flags [INTEGER]: X axis flags/options.
• y_flags [INTEGER]: Y axis flags/options.
• y2_flags [INTEGER]: Y axis additional flags/options.
• y3_flags [INTEGER]: Y axis additional flags/options.

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_begin_plot(label, x_label, y_label, x_size, y_size, flags, x_flags, y_flags, y2_flags, y3_flags)

gh_imguiimplot_draw_plotline(plotid0, ...)
gh_imguiimplot_draw_plotline(plotid1, ...)

gh_imgui.implot_end_plot()
			

implot_end_plot

Description

Ends plot rendering.

Syntax

Languages

Parameters

This function has no input parameter(s).

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_end_plot()
			

implot_add_data

Description

Adds data to a plot. If the plot has been created with max_points greater than zero, data is stored in a circular buffer otherwise in a regular (endless) buffer.

Syntax

Languages

Parameters

• plotid [INTEGER]: plot identifier.
• x, y [REAL]: plot data.

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_add_data(plotid, x, y)
			

implot_draw_plotline

Description

Draws a plot data set.

Syntax

Languages

Parameters

• plotid [INTEGER]: plot identifier.
• label [STRING]: plot data label.
• count [INTEGER]: number of points to draw.
• offset [INTEGER]: plot data offset.

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_draw_plotline(plotid, label, count, offset)
			

implot_draw_plotscatter

Description

Draws a plot data set.

Syntax

Languages

Parameters

• plotid [INTEGER]: plot identifier.
• label [STRING]: plot data label.
• count [INTEGER]: number of points to draw.
• offset [INTEGER]: plot data offset.

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_draw_plotscatter(plotid, label, count, offset)
			

implot_draw_plotshaded

Description

Draws a plot data set.

Syntax

Languages

Parameters

• plotid [INTEGER]: plot identifier.
• label [STRING]: plot data label.
• count [INTEGER]: number of points to draw.
• offset [INTEGER]: plot data offset.

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_draw_plotshaded(plotid, label, count, offset)
			

implot_draw_plotbars

Description

Draws a plot data set.

Syntax

Languages

Parameters

• plotid [INTEGER]: plot identifier.
• label [STRING]: plot data label.
• count [INTEGER]: number of points to draw.
• offset [INTEGER]: plot data offset.
• size [REAL]: size.
• vertical [INTEGER]: vertical (1) or hozizontal (0) bars.

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_draw_plotbars(plotid, label, count, offset, size, vertical)
			

implot_set_next_plot_limits

Description

Sets the limits (X and Y axis) of the next plot.

Syntax

Languages

Parameters

• x_min [INTEGER]: min limit in a X axis.
• x_max [INTEGER]: max limit in a X axis.
• y_min [INTEGER]: min limit in a Y axis.
• y_max [INTEGER]: max limit in a Y axis.
• cond [INTEGER]:

Return Values

This function has no return value(s).

Code sample

ImGuiCond_None          = 0
ImGuiCond_Always        = 1
ImGuiCond_Once          = 2
ImGuiCond_FirstUseEver  = 4
ImGuiCond_Appearing     = 8

gh_imgui.implot_set_next_plot_limits(x-10, x, -10, 30, ImGuiCond_Always)
			

implot_push_style_color

Description

Saves the current color and pushes a new color.

Syntax

Languages

Parameters

• color_index [INTEGER]: index (identifier) of the color.
• r, g, b, a [REAL]: RGBA color.

Return Values

This function has no return value(s).

Code sample

ImPlotCol_Line = 0
ImPlotCol_Fill = 1
ImPlotCol_MarkerOutline = 2
ImPlotCol_MarkerFill = 3
ImPlotCol_ErrorBar = 4
ImPlotCol_FrameBg = 5
ImPlotCol_PlotBg = 6
ImPlotCol_PlotBorder = 7
ImPlotCol_XAxis = 8
ImPlotCol_YAxis = 9
ImPlotCol_YAxis2 = 10
ImPlotCol_YAxis3 = 11
ImPlotCol_Selection = 12
ImPlotCol_Query = 13

gh_imgui.implot_push_style_color(ImPlotCol_Line, r, g, b, a)
gh_imgui.implot_draw_plotline(plotid1, "MouseX", max_size, offset)
gh_imgui.implot_pop_style_color(1)
			

implot_pop_style_color

Description

Restores a color

Syntax

Languages

Parameters

• count [INTEGER]: number of colors to restore (default: 1).

Return Values

This function has no return value(s).

Code sample

gh_imgui.implot_push_style_color(ImPlotCol_Line, r, g, b, a)
gh_imgui.implot_draw_plotline(plotid1, "MouseX", max_size, offset)
gh_imgui.implot_pop_style_color(1)
			

implot_push_style_var_1f

Description

Saves a property and pushes a new one

Syntax

Languages

Parameters

• var_id [INTEGER]: variable identifier.
• x [REAL]: value.

Return Values

This function has no return value(s).

Code sample

ImPlotStyleVar_LineWeight = 0
ImPlotStyleVar_Marker = 1
ImPlotStyleVar_MarkerSize = 2
ImPlotStyleVar_MarkerWeight = 3
ImPlotStyleVar_FillAlpha = 4
ImPlotStyleVar_ErrorBarSize = 5
ImPlotStyleVar_ErrorBarWeight = 6
ImPlotStyleVar_DigitalBitHeight = 7
ImPlotStyleVar_DigitalBitGap = 8

gh_imgui.implot_push_style_var_1i(ImPlotStyleVar_FillAlpha, 0.5)
gh_imgui.implot_draw_plotline(plotid1, "MouseX", max_size, offset)
gh_imgui.implot_pop_style_var(1)