Difference between revisions of "ImGui.Core"
Line 79: | Line 79: | ||
[[ImGui.Core:showStyleSelector|ImGui:showStyleSelector]] ''adds a style selector block (not a window)''<br/><!--GIDEROSMTD:ImGui:showStyleSelector(style) adds a style selector block (not a window)--> | [[ImGui.Core:showStyleSelector|ImGui:showStyleSelector]] ''adds a style selector block (not a window)''<br/><!--GIDEROSMTD:ImGui:showStyleSelector(style) adds a style selector block (not a window)--> | ||
[[ImGui.Core:showUserGuide|ImGui:showUserGuide]] ''adds basic help/info block (not a window)''<br/><!--GIDEROSMTD:ImGui:showUserGuide() adds basic help/info block (not a window)--> | [[ImGui.Core:showUserGuide|ImGui:showUserGuide]] ''adds basic help/info block (not a window)''<br/><!--GIDEROSMTD:ImGui:showUserGuide() adds basic help/info block (not a window)--> | ||
− | |||
[[ImGui.Core:sliderAngle|ImGui:sliderAngle]] ''displays an ImGui regular angle slider''<br/><!--GIDEROSMTD:ImGui:sliderAngle(label, valueInRad, [min_degrees=-360, max_degrees=360, formatString="%.0f deg", ImGuiSliderFlags=0]) displays an ImGui regular angle slider--> | [[ImGui.Core:sliderAngle|ImGui:sliderAngle]] ''displays an ImGui regular angle slider''<br/><!--GIDEROSMTD:ImGui:sliderAngle(label, valueInRad, [min_degrees=-360, max_degrees=360, formatString="%.0f deg", ImGuiSliderFlags=0]) displays an ImGui regular angle slider--> | ||
[[ImGui.Core:sliderFloat|ImGui:sliderFloat]] ''displays an ImGui regular float slider''<br/><!--GIDEROSMTD:ImGui:sliderFloat(label, value, [min = 0, max = 0, formatString = "%.3f", ImGuiSliderFlags = 0]) displays an ImGui regular float slider--> | [[ImGui.Core:sliderFloat|ImGui:sliderFloat]] ''displays an ImGui regular float slider''<br/><!--GIDEROSMTD:ImGui:sliderFloat(label, value, [min = 0, max = 0, formatString = "%.3f", ImGuiSliderFlags = 0]) displays an ImGui regular float slider--> | ||
Line 85: | Line 84: | ||
[[ImGui.Core:sliderFloat3|ImGui:sliderFloat3]] ''displays 3 ImGui regular float sliders''<br/><!--GIDEROSMTD:ImGui:sliderFloat3(label, value1, value2, value3, [min=0, max=0, formatString="%.3f", ImGuiSliderFlags=0]) displays 3 ImGui regular float sliders--> | [[ImGui.Core:sliderFloat3|ImGui:sliderFloat3]] ''displays 3 ImGui regular float sliders''<br/><!--GIDEROSMTD:ImGui:sliderFloat3(label, value1, value2, value3, [min=0, max=0, formatString="%.3f", ImGuiSliderFlags=0]) displays 3 ImGui regular float sliders--> | ||
[[ImGui.Core:sliderFloat4|ImGui:sliderFloat4]] ''displays 4 ImGui regular float sliders''<br/><!--GIDEROSMTD:ImGui:sliderFloat4(label, value1, value2, value3, value4, [min=0, max=0, formatString="%.3f", ImGuiSliderFlags=0]) displays 4 ImGui regular float sliders--> | [[ImGui.Core:sliderFloat4|ImGui:sliderFloat4]] ''displays 4 ImGui regular float sliders''<br/><!--GIDEROSMTD:ImGui:sliderFloat4(label, value1, value2, value3, value4, [min=0, max=0, formatString="%.3f", ImGuiSliderFlags=0]) displays 4 ImGui regular float sliders--> | ||
+ | |||
+ | [[ImGui.Core:sliderInt|ImGui:sliderInt]] ''displays an ImGui regular int slider''<br/><!--GIDEROSMTD:ImGui:sliderInt(label, value, [min = 0, max = 0, formatString = "%d", ImGuiSliderFlags = 0]) displays an ImGui regular int slider--> | ||
+ | [[ImGui.Core:sliderInt2|ImGui:sliderInt2]] ''displays 2 ImGui regular int sliders''<br/><!--GIDEROSMTD:ImGui:sliderInt2(label, value1, value2, [min=0, max=0, formatString="%d", ImGuiSliderFlags=0]) displays 2 ImGui regular int sliders--> | ||
+ | [[ImGui.Core:sliderInt3|ImGui:sliderInt3]] ''displays 3 ImGui regular int sliders''<br/><!--GIDEROSMTD:ImGui:sliderInt3(label, value1, value2, value3, [min=0, max=0, formatString="%d", ImGuiSliderFlags=0]) displays 3 ImGui regular int sliders--> | ||
+ | [[ImGui.Core:sliderInt4|ImGui:sliderInt4]] ''displays 4 ImGui regular int sliders''<br/><!--GIDEROSMTD:ImGui:sliderInt4(label, value1, value2, value3, value4, [min=0, max=0, formatString="%d", ImGuiSliderFlags=0]) displays 4 ImGui regular int sliders--> | ||
[[ImGui.Core:smallButton|ImGui:smallButton]] ''displays an ImGui small button''<br/><!--GIDEROSMTD:ImGui:smallButton(string) displays an ImGui small button--> | [[ImGui.Core:smallButton|ImGui:smallButton]] ''displays an ImGui small button''<br/><!--GIDEROSMTD:ImGui:smallButton(string) displays an ImGui small button--> |
Revision as of 06:25, 29 March 2021
Supported platforms:
Available since: Gideros 2020.9
Description
This is the ImGui main class.
PLEASE NOTE THE DOCUMENTATION IS WORK IN PROGRESS
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:sliderInt displays an ImGui regular int slider ImGui:smallButton displays an ImGui small button |
EventsImGui.KeyChar ConstantsImGui._VERSION Window Flags Col Flags |