Difference between revisions of "ImGui.Core"
Line 156: | Line 156: | ||
ImGui._VERSION<br/><!--GIDEROSCST:ImGui._VERSION--> | ImGui._VERSION<br/><!--GIDEROSCST:ImGui._VERSION--> | ||
− | ''' | + | '''Backend Flags''' [[ImGui.CONST.BackendFlags]]<br/> |
'''Col Flags''' [[ImGui.CONST.Col]]<br/> | '''Col Flags''' [[ImGui.CONST.Col]]<br/> | ||
+ | '''ColorEdit Flags''' [[ImGui.CONST.ColorEditFlags]]<br/> | ||
+ | '''Combo Flags''' [[ImGui.CONST.ComboFlags]]<br/> | ||
+ | '''Cond''' [[ImGui.CONST.Cond]]<br/> | ||
+ | '''Config Flags''' [[ImGui.CONST.ConfigFlags]]<br/> | ||
+ | '''Corner Flags''' [[ImGui.CONST.CornerFlags]]<br/> | ||
+ | '''Data Type''' [[ImGui.CONST.DataType]]<br/> | ||
+ | '''Dir''' [[ImGui.CONST.Dir]]<br/> | ||
+ | '''DragDrop Flags''' [[ImGui.CONST.DragDropFlags]]<br/> | ||
'''Focused Flags''' [[ImGui.CONST.FocusedFlags]]<br/> | '''Focused Flags''' [[ImGui.CONST.FocusedFlags]]<br/> | ||
− | ''' | + | '''Glyph Ranges''' [[ImGui.CONST.GlyphRanges]]<br/> |
'''Hovered Flags''' [[ImGui.CONST.HoveredFlags]]<br/> | '''Hovered Flags''' [[ImGui.CONST.HoveredFlags]]<br/> | ||
'''InputText Flags''' [[ImGui.CONST.InputTextFlags]]<br/> | '''InputText Flags''' [[ImGui.CONST.InputTextFlags]]<br/> | ||
+ | '''Item Flags''' [[ImGui.CONST.ItemFlags]]<br/> | ||
+ | '''Mouse Button''' [[ImGui.CONST.MouseButton]]<br/> | ||
+ | '''Mouse Cursor''' [[ImGui.CONST.MouseCursor]]<br/> | ||
'''Nav Input''' [[ImGui.CONST.NavInput]]<br/> | '''Nav Input''' [[ImGui.CONST.NavInput]]<br/> | ||
+ | '''Popup Flags''' [[ImGui.CONST.PopupFlags]]<br/> | ||
+ | '''Selectable Flags''' [[ImGui.CONST.SelectableFlags]]<br/> | ||
+ | '''Slider Flags''' [[ImGui.CONST.SliderFlags]]<br/> | ||
+ | '''Sort Direction''' [[ImGui.CONST.SortDirection]]<br/> | ||
+ | '''Style Var''' [[ImGui.CONST.StyleVar]]<br/> | ||
'''TabBar Flags''' [[ImGui.CONST.TabBarFlags]]<br/> | '''TabBar Flags''' [[ImGui.CONST.TabBarFlags]]<br/> | ||
+ | '''TabItem Flags''' [[ImGui.CONST.TabItemFlags]]<br/> | ||
+ | '''Table Flags''' [[ImGui.CONST.TableFlags]]<br/> | ||
+ | '''TableBg Target''' [[ImGui.CONST.TableBgTarget]]<br/> | ||
+ | '''TableColumn Flags''' [[ImGui.CONST.TableColumnFlags]]<br/> | ||
+ | '''TableRow Flags''' [[ImGui.CONST.TableRowFlags]]<br/> | ||
+ | '''TE''' [[ImGui.CONST.TE]]<br/> | ||
'''TreeNode Flags''' [[ImGui.CONST.TreeNodeFlags]]<br/> | '''TreeNode Flags''' [[ImGui.CONST.TreeNodeFlags]]<br/> | ||
− | ''' | + | '''Window Flags''' [[ImGui.CONST.WindowFlags]]<br/> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
---- | ---- | ||
'''[[Dear ImGui]]''' | '''[[Dear ImGui]]''' |
Revision as of 12:25, 3 April 2021
Supported platforms:
Available since: Gideros 2020.9
Description
This is the ImGui main class.
PLEASE NOTE THE DOCUMENTATION IS WORK IN PROGRESS
Widgets: Color Editor/Picker * tip: the ColorEdit* functions have a little color square that can be left-clicked to open a picker, and right-clicked to open an option menu * Note that in C++ a 'float v[X]' function argument is the _same_ as 'float* v', the array syntax is just a way to document the number of elements that are expected to be accessible. * You can pass the address of a first float element out of a contiguous structure, e.g. &myvector.x
Widgets: Input with Keyboard * If you want to use InputText() with std::string or any custom dynamic string type, see misc/cpp/imgui_stdlib.h and comments in imgui_demo.cpp. * Most of the ImGuiInputTextFlags flags are only useful for InputText() and not for InputFloatX, InputIntX, InputDouble etc.
Widgets: Regular Sliders * CTRL+Click on any slider to turn them into an input box. Manually input values aren't clamped and can go off-bounds. * Adjust format string to decorate the value with a prefix, a suffix, or adapt the editing and display precision e.g. "%.3f" -> 1.234; "%5.2f secs" -> 01.23 secs; "Biscuit: %.0f" -> Biscuit: 1; etc. * Format string may also be set to NULL or use the default format ("%f" or "%d"). If you get a warning converting a float to ImGuiSliderFlags, read https://github.com/ocornut/imgui/issues/3361
Widgets: Drag Sliders * CTRL+Click on any drag box to turn them into an input box. Manually input values aren't clamped and can go off-bounds. * For all the Float2/Float3/Float4/Int2/Int3/Int4 versions of every functions, note that a 'float v[X]' function argument is the same as 'float* v', the array syntax is just a way to document the number of elements that are expected to be accessible. You can pass address of your first element out of a contiguous set, e.g. &myvector.x * Adjust format string to decorate the value with a prefix, a suffix, or adapt the editing and display precision e.g. "%.3f" -> 1.234; "%5.2f secs" -> 01.23 secs; "Biscuit: %.0f" -> Biscuit: 1; etc. * Format string may also be set to NULL or use the default format ("%f" or "%d"). * Speed are per-pixel of mouse movement (v_speed=0.2f: mouse needs to move by 5 pixels to increase value by 1). For gamepad/keyboard navigation, minimum speed is Max(v_speed, minimum_step_at_given_precision). * Use v_min < v_max to clamp edits to given limits. Note that CTRL+Click manual input can override those limits. * Use v_max = FLT_MAX / INT_MAX etc to avoid clamping to a maximum, same with v_min = -FLT_MAX / INT_MIN to avoid clamping to a minimum. * We use the same sets of flags for DragXXX() and SliderXXX() functions as the features are the same and it makes it easier to swap them.
MethodsImGui.new initializes ImGui ImGui:arrowButton displays an ImGui arrow button ImGui:setColorEditOptions sets the color edit options flag ImGui:setDarkStyle sets a dark color style |
EventsImGui.KeyChar ConstantsImGui._VERSION Backend Flags ImGui.CONST.BackendFlags |