diff --git a/docs/CHANGELOG.txt b/docs/CHANGELOG.txt index 12b3a9a21..cb924e667 100644 --- a/docs/CHANGELOG.txt +++ b/docs/CHANGELOG.txt @@ -38,6 +38,7 @@ Breaking Changes: Other Changes: +- Clarified and improved the source code sectioning in all files (easier to search or browse sections). - Nav: Removed the [Beta] tag from various descriptions of the gamepad/keyboard navigation system. Although it is not perfect and will keep being improved, it is fairly functional and used by many. (#787) - Fixed a build issue with non-Cygwin GCC under Windows. diff --git a/imgui.cpp b/imgui.cpp index 43d45c529..ce788aae5 100644 --- a/imgui.cpp +++ b/imgui.cpp @@ -22,12 +22,15 @@ Index of this file: DOCUMENTATION + - MISSION STATEMENT - END-USER GUIDE - PROGRAMMER GUIDE (read me!) - Read first - How to update to a newer version of Dear ImGui - Getting started with integrating Dear ImGui in your code/engine + - This is how a simple application may look like (2 variations) + - This is how a simple rendering function may look like - Using gamepad/keyboard navigation controls - API BREAKING CHANGES (read me when you update!) - FREQUENTLY ASKED QUESTIONS (FAQ), TIPS @@ -44,31 +47,35 @@ DOCUMENTATION - I integrated Dear ImGui in my engine and some elements are clipping or disappearing when I move windows around.. - How can I help? -CODE -- Forward Declarations -- Context and Memory Allocators -- User facing structures (ImGuiStyle, ImGuiIO) -- Helper/Utilities (ImXXX functions, Color functions) -- ImGuiStorage -- ImGuiTextFilter -- ImGuiTextBuffer -- ImGuiListClipper -- Render Helpers -- Main Code (most of the code! lots of stuff, needs tidying up) -- Tooltips -- Popups -- Navigation -- Columns -- Drag and Drop -- Logging -- Settings -- Platform Dependent Helpers -- Metrics/Debug window +CODE +(search for "[SECTION]" in the code to find them) + +// [SECTION] FORWARD DECLARATIONS +// [SECTION] CONTEXT AND MEMORY ALLOCATORS +// [SECTION] MAIN USER FACING STRUCTURES (ImGuiStyle, ImGuiIO) +// [SECTION] MISC HELPER/UTILITIES (Maths, String, Format, Hash, File functions) +// [SECTION] MISC HELPER/UTILITIES (ImText* functions) +// [SECTION] MISC HELPER/UTILITIES (Color functions) +// [SECTION] ImGuiStorage +// [SECTION] ImGuiTextFilter +// [SECTION] ImGuiTextBuffer +// [SECTION] ImGuiListClipper +// [SECTION] RENDER HELPERS +// [SECTION] MAIN CODE (most of the code! lots of stuff, needs tidying up!) +// [SECTION] TOOLTIPS +// [SECTION] POPUPS +// [SECTION] KEYBOARD/GAMEPAD NAVIGATION +// [SECTION] COLUMNS +// [SECTION] DRAG AND DROP +// [SECTION] LOGGING/CAPTURING +// [SECTION] SETTINGS +// [SECTION] PLATFORM DEPENDENT HELPERS +// [SECTION] METRICS/DEBUG WINDOW */ //----------------------------------------------------------------------------- -// Documentation +// DOCUMENTATION //----------------------------------------------------------------------------- /* @@ -883,7 +890,7 @@ static const float NAV_WINDOWING_HIGHLIGHT_DELAY = 0.20f; // Time before the h static const float NAV_WINDOWING_LIST_APPEAR_DELAY = 0.15f; // Time before the window list starts to appear //------------------------------------------------------------------------- -// Forward Declarations +// [SECTION] FORWARD DECLARATIONS //------------------------------------------------------------------------- static void SetCurrentWindow(ImGuiWindow* window); @@ -934,7 +941,7 @@ static void UpdateManualResize(ImGuiWindow* window, const ImVec2& si } //----------------------------------------------------------------------------- -// Context and Memory Allocators +// [SECTION] CONTEXT AND MEMORY ALLOCATORS //----------------------------------------------------------------------------- // Current context pointer. Implicitly used by all ImGui functions. Always assumed to be != NULL. @@ -963,7 +970,7 @@ static void (*GImAllocatorFreeFunc)(void* ptr, void* user_data) = FreeWrapper; static void* GImAllocatorUserData = NULL; //----------------------------------------------------------------------------- -// User facing main structures +// [SECTION] MAIN USER FACING STRUCTURES (ImGuiStyle, ImGuiIO) //----------------------------------------------------------------------------- ImGuiStyle::ImGuiStyle() @@ -1108,7 +1115,7 @@ void ImGuiIO::AddInputCharactersUTF8(const char* utf8_chars) } //----------------------------------------------------------------------------- -// HELPERS/UTILITIES +// [SECTION] MISC HELPER/UTILITIES (Maths, String, Format, Hash, File functions) //----------------------------------------------------------------------------- ImVec2 ImLineClosestPoint(const ImVec2& a, const ImVec2& b, const ImVec2& p) @@ -1385,7 +1392,7 @@ void* ImFileLoadToMemory(const char* filename, const char* file_open_mode, size_ } //----------------------------------------------------------------------------- -// HELPERS/UTILITIES (ImText* helpers) +// [SECTION] MISC HELPERS/UTILITIES (ImText* functions) //----------------------------------------------------------------------------- // Convert UTF-8 to 32-bits character, process single character input. @@ -1568,7 +1575,8 @@ int ImTextCountUtf8BytesFromStr(const ImWchar* in_text, const ImWchar* in_text_e } //----------------------------------------------------------------------------- -// COLOR FUNCTIONS +// [SECTION] MISC HELPER/UTILTIES (Color functions) +// Note: The Convert functions are early design which are not consistent with other API. //----------------------------------------------------------------------------- ImVec4 ImGui::ColorConvertU32ToFloat4(ImU32 in) @@ -1675,7 +1683,7 @@ ImU32 ImGui::GetColorU32(ImU32 col) } //----------------------------------------------------------------------------- -// ImGuiStorage +// [SECTION] ImGuiStorage // Helper: Key->value storage //----------------------------------------------------------------------------- @@ -1824,7 +1832,7 @@ void ImGuiStorage::SetAllInt(int v) } //----------------------------------------------------------------------------- -// ImGuiTextFilter +// [SECTION] ImGuiTextFilter //----------------------------------------------------------------------------- // Helper: Parse and apply text filters. In format "aaaaa[,bbbb][,ccccc]" @@ -1928,7 +1936,7 @@ bool ImGuiTextFilter::PassFilter(const char* text, const char* text_end) const } //----------------------------------------------------------------------------- -// ImGuiTextBuffer +// [SECTION] ImGuiTextBuffer //----------------------------------------------------------------------------- // On some platform vsnprintf() takes va_list by reference and modifies it. @@ -1976,7 +1984,8 @@ void ImGuiTextBuffer::appendf(const char* fmt, ...) } //----------------------------------------------------------------------------- -// ImGuiListClipper +// [SECTION] ImGuiListClipper +// This is currently not as flexible/powerful as it should be, needs some rework (see TODO) //----------------------------------------------------------------------------- static void SetCursorPosYAndSetupDummyPrevLine(float pos_y, float line_height) @@ -2060,8 +2069,8 @@ bool ImGuiListClipper::Step() } //----------------------------------------------------------------------------- -// RENDER HELPERS -// Those [Internal] functions are a terrible mess - their signature and behavior will change. +// [SECTION] RENDER HELPERS +// Those (internal) functions are currently quite a legacy mess - their signature and behavior will change. // Also see imgui_draw.cpp for some more which have been reworked to not rely on ImGui:: state. //----------------------------------------------------------------------------- @@ -2280,8 +2289,7 @@ void ImGui::RenderNavHighlight(const ImRect& bb, ImGuiID id, ImGuiNavHighlightFl } //----------------------------------------------------------------------------- -// MAIN CODE -// (this category is still too large and badly ordered, needs some tidying up) +// [SECTION] MAIN CODE (most of the code! lots of stuff, needs tidying up!) //----------------------------------------------------------------------------- // ImGuiWindow is mostly a dumb struct. It merely has a constructor and a few helper methods @@ -2731,8 +2739,6 @@ float ImGui::CalcWrapWidthForPos(const ImVec2& pos, float wrap_pos_x) return ImMax(wrap_pos_x - pos.x, 1.0f); } -//----------------------------------------------------------------------------- - void* ImGui::MemAlloc(size_t size) { if (ImGuiContext* ctx = GImGui) @@ -6076,7 +6082,6 @@ ImGuiID ImGui::GetID(const void* ptr_id) return GImGui->CurrentWindow->GetID(ptr_id); } - bool ImGui::IsRectVisible(const ImVec2& size) { ImGuiWindow* window = GetCurrentWindowRead(); @@ -6200,7 +6205,7 @@ void ImGui::Unindent(float indent_w) } //----------------------------------------------------------------------------- -// TOOLTIPS +// [SECTION] TOOLTIPS //----------------------------------------------------------------------------- void ImGui::BeginTooltip() @@ -6269,7 +6274,7 @@ void ImGui::SetTooltip(const char* fmt, ...) } //----------------------------------------------------------------------------- -// POPUPS +// [SECTION] POPUPS //----------------------------------------------------------------------------- bool ImGui::IsPopupOpen(ImGuiID id) @@ -6636,7 +6641,7 @@ ImVec2 ImGui::FindBestWindowPosForPopup(ImGuiWindow* window) } //----------------------------------------------------------------------------- -// NAVIGATION +// [SECTION] KEYBOARD/GAMEPAD NAVIGATION //----------------------------------------------------------------------------- ImGuiDir ImGetDirQuadrantFromDelta(float dx, float dy) @@ -7631,7 +7636,8 @@ void ImGui::NavUpdateWindowingList() } //----------------------------------------------------------------------------- -// COLUMNS +// [SECTION] COLUMNS +// In the current version, Columns are very weak. Needs to be replaced with a more full-featured system. //----------------------------------------------------------------------------- void ImGui::NextColumn() @@ -7953,7 +7959,7 @@ void ImGui::Columns(int columns_count, const char* id, bool border) } //----------------------------------------------------------------------------- -// DRAG AND DROP +// [SECTION] DRAG AND DROP //----------------------------------------------------------------------------- void ImGui::ClearDragDrop() @@ -8240,7 +8246,7 @@ void ImGui::EndDragDropTarget() } //----------------------------------------------------------------------------- -// LOGGING +// [SECTION] LOGGING/CAPTURING //----------------------------------------------------------------------------- // Pass text data straight to log (without being displayed) @@ -8420,7 +8426,7 @@ void ImGui::LogButtons() } //----------------------------------------------------------------------------- -// SETTINGS +// [SECTION] SETTINGS //----------------------------------------------------------------------------- void ImGui::MarkIniSettingsDirty() @@ -8632,7 +8638,7 @@ static void SettingsHandlerWindow_WriteAll(ImGuiContext* imgui_ctx, ImGuiSetting } //----------------------------------------------------------------------------- -// PLATFORM DEPENDENT HELPERS +// [SECTION] PLATFORM DEPENDENT HELPERS //----------------------------------------------------------------------------- #if defined(_WIN32) && !defined(_WINDOWS_) && (!defined(IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS) || !defined(IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS)) @@ -8748,7 +8754,7 @@ static void ImeSetInputScreenPosFn_DefaultImpl(int, int) {} #endif //----------------------------------------------------------------------------- -// METRICS/DEBUG WINDOW +// [SECTION] METRICS/DEBUG WINDOW //----------------------------------------------------------------------------- void ImGui::ShowMetricsWindow(bool* p_open) diff --git a/imgui_demo.cpp b/imgui_demo.cpp index c4147844e..9da9fb194 100644 --- a/imgui_demo.cpp +++ b/imgui_demo.cpp @@ -18,6 +18,27 @@ // It also happens to be a convenient way of storing simple UI related information as long as your function doesn't need to be reentrant or used in threads. // This might be a pattern you occasionally want to use in your code, but most of the real data you would be editing is likely to be stored outside your functions. +/* + +Index of this file: + +// [SECTION] Forward Declarations, Helpers +// [SECTION] Demo Window / ShowDemoWindow() +// [SECTION] Style Editor / ShowStyleEditor() +// [SECTION] Example App: Main Menu Bar / ShowExampleAppMainMenuBar() +// [SECTION] Example App: Debug Console / ShowExampleAppConsole() +// [SECTION] Example App: Debug Log / ShowExampleAppLog() +// [SECTION] Example App: Simple Layout / ShowExampleAppLayout() +// [SECTION] Example App: Property Editor / ShowExampleAppPropertyEditor() +// [SECTION] Example App: Long Text / ShowExampleAppLongText() +// [SECTION] Example App: Auto Resize / ShowExampleAppAutoResize() +// [SECTION] Example App: Constrained Resize / ShowExampleAppConstrainedResize() +// [SECTION] Example App: Simple Overlay / ShowExampleAppSimpleOverlay() +// [SECTION] Example App: Manipulating Window Titles / ShowExampleAppWindowTitles() +// [SECTION] Example App: Custom Rendering using ImDrawList API / ShowExampleAppCustomRendering() + +*/ + #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS) #define _CRT_SECURE_NO_WARNINGS #endif @@ -67,7 +88,7 @@ #define IM_MAX(_A,_B) (((_A) >= (_B)) ? (_A) : (_B)) //----------------------------------------------------------------------------- -// DEMO CODE +// [SECTION] Forward Declarations, Helpers //----------------------------------------------------------------------------- #if !defined(IMGUI_DISABLE_OBSOLETE_FUNCTIONS) && defined(IMGUI_DISABLE_TEST_WINDOWS) && !defined(IMGUI_DISABLE_DEMO_WINDOWS) // Obsolete name since 1.53, TEST->DEMO @@ -127,6 +148,10 @@ void ImGui::ShowUserGuide() ImGui::Unindent(); } +//----------------------------------------------------------------------------- +// [SECTION] Demo Window / ShowDemoWindow() +//----------------------------------------------------------------------------- + // Demonstrate most Dear ImGui features (this is big function!) // You may execute this function to experiment with the UI and understand what it does. You may then search for keywords in the code when you are interested by a specific feature. void ImGui::ShowDemoWindow(bool* p_open) @@ -2363,6 +2388,10 @@ void ImGui::ShowDemoWindow(bool* p_open) ImGui::End(); } +//----------------------------------------------------------------------------- +// [SECTION] Style Editor / ShowStyleEditor() +//----------------------------------------------------------------------------- + // Demo helper function to select among default colors. See ShowStyleEditor() for more advanced options. // Here we use the simplified Combo() api that packs items into a single literal string. Useful for quick combo boxes where the choices are known locally. bool ImGui::ShowStyleSelector(const char* label) @@ -2626,7 +2655,7 @@ void ImGui::ShowStyleEditor(ImGuiStyle* ref) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: MAIN MENU BAR +// [SECTION] Example App: Main Menu Bar / ShowExampleAppMainMenuBar() //----------------------------------------------------------------------------- // Demonstrate creating a fullscreen menu bar and populating it. @@ -2719,10 +2748,10 @@ static void ShowExampleMenuFile() } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: CONSOLE +// [SECTION] Example App: Debug Console / ShowExampleAppConsole() //----------------------------------------------------------------------------- -// Demonstrating creating a simple console window, with scrolling, filtering, completion and history. +// Demonstrate creating a simple console window, with scrolling, filtering, completion and history. // For the console example, here we are using a more C++ like approach of declaring a class to hold the data and the functions. struct ExampleAppConsole { @@ -3032,7 +3061,7 @@ static void ShowExampleAppConsole(bool* p_open) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: LOG +// [SECTION] Example App: Debug Log / ShowExampleAppLog() //----------------------------------------------------------------------------- // Usage: @@ -3122,7 +3151,7 @@ static void ShowExampleAppLog(bool* p_open) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: SIMPLE LAYOUT +// [SECTION] Example App: Simple Layout / ShowExampleAppLayout() //----------------------------------------------------------------------------- // Demonstrate create a window with multiple child windows. @@ -3170,7 +3199,7 @@ static void ShowExampleAppLayout(bool* p_open) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: PROPERTY EDITOR +// [SECTION] Example App: Property Editor / ShowExampleAppPropertyEditor() //----------------------------------------------------------------------------- // Demonstrate create a simple property editor. @@ -3243,7 +3272,7 @@ static void ShowExampleAppPropertyEditor(bool* p_open) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: LONG TEXT +// [SECTION] Example App: Long Text / ShowExampleAppLongText() //----------------------------------------------------------------------------- // Demonstrate/test rendering huge amount of text, and the incidence of clipping. @@ -3301,7 +3330,7 @@ static void ShowExampleAppLongText(bool* p_open) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: AUTO RESIZE +// [SECTION] Example App: Auto Resize / ShowExampleAppAutoResize() //----------------------------------------------------------------------------- // Demonstrate creating a window which gets auto-resized according to its content. @@ -3322,7 +3351,7 @@ static void ShowExampleAppAutoResize(bool* p_open) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: CONSTRAINED RESIZE +// [SECTION] Example App: Constrained Resize / ShowExampleAppConstrainedResize() //----------------------------------------------------------------------------- // Demonstrate creating a window with custom resize constraints. @@ -3373,7 +3402,7 @@ static void ShowExampleAppConstrainedResize(bool* p_open) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: SIMPLE OVERLAY +// [SECTION] Example App: Simple Overlay / ShowExampleAppSimpleOverlay() //----------------------------------------------------------------------------- // Demonstrate creating a simple static window with no decoration + a context-menu to choose which corner of the screen to use. @@ -3409,7 +3438,7 @@ static void ShowExampleAppSimpleOverlay(bool* p_open) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: WINDOW TITLES +// [SECTION] Example App: Manipulating Window Titles / ShowExampleAppWindowTitles() //----------------------------------------------------------------------------- // Demonstrate using "##" and "###" in identifiers to manipulate ID generation. @@ -3440,7 +3469,7 @@ static void ShowExampleAppWindowTitles(bool*) } //----------------------------------------------------------------------------- -// EXAMPLE APP CODE: CUSTOM RENDERING +// [SECTION] Example App: Custom Rendering using ImDrawList API / ShowExampleAppCustomRendering() //----------------------------------------------------------------------------- // Demonstrate using the low-level ImDrawList to draw custom shapes. diff --git a/imgui_draw.cpp b/imgui_draw.cpp index dd2e00aaf..aab827cba 100644 --- a/imgui_draw.cpp +++ b/imgui_draw.cpp @@ -4,16 +4,19 @@ /* Index of this file: -- Cruft for stb_truetype/stb_rectpack implementation -- Style functions (default style) -- ImDrawList -- ImDrawData -- ShadeVertsXXX helpers functions -- ImFontConfig -- ImFontAtlas -- ImFont -- Internal Render Helpers -- Default font data + +// [SECTION] STB libraries implementation +// [SECTION] Style functions +// [SECTION] ImDrawList +// [SECTION] ImDrawData +// [SECTION] Helpers ShadeVertsXXX functions +// [SECTION] ImFontConfig +// [SECTION] ImFontAtlas +// [SECTION] ImFontAtlas glyph ranges helpers + GlyphRangesBuilder +// [SECTION] ImFont +// [SECTION] Internal Render Helpers +// [SECTION] Decompression code +// [SECTION] Default font data (ProggyClean.ttf) */ @@ -72,7 +75,7 @@ Index of this file: #endif //------------------------------------------------------------------------- -// STB libraries implementation +// [SECTION] STB libraries implementation //------------------------------------------------------------------------- // Compile time options: @@ -161,7 +164,7 @@ using namespace IMGUI_STB_NAMESPACE; #endif //----------------------------------------------------------------------------- -// Style functions +// [SECTION] Style functions //----------------------------------------------------------------------------- void ImGui::StyleColorsDark(ImGuiStyle* dst) @@ -316,7 +319,7 @@ void ImGui::StyleColorsLight(ImGuiStyle* dst) } //----------------------------------------------------------------------------- -// ImDrawListData +// ImDrawList //----------------------------------------------------------------------------- ImDrawListSharedData::ImDrawListSharedData() @@ -334,10 +337,6 @@ ImDrawListSharedData::ImDrawListSharedData() } } -//----------------------------------------------------------------------------- -// ImDrawList -//----------------------------------------------------------------------------- - void ImDrawList::Clear() { CmdBuffer.resize(0); @@ -1227,7 +1226,7 @@ void ImDrawList::AddImageRounded(ImTextureID user_texture_id, const ImVec2& a, c } //----------------------------------------------------------------------------- -// ImDrawData +// [SECTION] ImDrawData //----------------------------------------------------------------------------- // For backward compatibility: convert all buffers from indexed to de-indexed, in case you cannot render indexed. Note: this is slow and most likely a waste of resources. Always prefer indexed rendering! @@ -1264,7 +1263,7 @@ void ImDrawData::ScaleClipRects(const ImVec2& scale) } //----------------------------------------------------------------------------- -// Shade functions +// [SECTION] Helpers ShadeVertsXXX functions //----------------------------------------------------------------------------- // Generic linear color gradient, write to RGB fields, leave A untouched. @@ -1311,7 +1310,7 @@ void ImGui::ShadeVertsLinearUV(ImDrawList* draw_list, int vert_start_idx, int ve } //----------------------------------------------------------------------------- -// ImFontConfig +// [SECTION] ImFontConfig //----------------------------------------------------------------------------- ImFontConfig::ImFontConfig() @@ -1337,7 +1336,7 @@ ImFontConfig::ImFontConfig() } //----------------------------------------------------------------------------- -// ImFontAtlas +// [SECTION] ImFontAtlas //----------------------------------------------------------------------------- // A work of art lies ahead! (. = white layer, X = black layer, others are blank) @@ -2074,6 +2073,10 @@ static void UnpackAccumulativeOffsetsIntoRanges(int base_codepoint, const short* out_ranges[0] = 0; } +//------------------------------------------------------------------------- +// [SECTION] ImFontAtlas glyph ranges helpers + GlyphRangesBuilder +//------------------------------------------------------------------------- + const ImWchar* ImFontAtlas::GetGlyphRangesChineseSimplifiedCommon() { // Store 2500 regularly used characters for Simplified Chinese. @@ -2223,10 +2226,6 @@ const ImWchar* ImFontAtlas::GetGlyphRangesThai() return &ranges[0]; } -//----------------------------------------------------------------------------- -// ImFontAtlas::GlyphRangesBuilder -//----------------------------------------------------------------------------- - void ImFontAtlas::GlyphRangesBuilder::AddText(const char* text, const char* text_end) { while (text_end ? (text < text_end) : *text) @@ -2262,7 +2261,7 @@ void ImFontAtlas::GlyphRangesBuilder::BuildRanges(ImVector* out_ranges) } //----------------------------------------------------------------------------- -// ImFont +// [SECTION] ImFont //----------------------------------------------------------------------------- ImFont::ImFont() @@ -2813,12 +2812,12 @@ void ImFont::RenderText(ImDrawList* draw_list, float size, ImVec2 pos, ImU32 col } //----------------------------------------------------------------------------- -// Internals Render Helpers +// [SECTION] Internal Render Helpers // (progressively moved from imgui.cpp to here when they are redesigned to stop accessing ImGui global state) //----------------------------------------------------------------------------- -// RenderMouseCursor() -// RenderArrowPointingAt() -// RenderRectFilledRangeH() +// - RenderMouseCursor() +// - RenderArrowPointingAt() +// - RenderRectFilledRangeH() //----------------------------------------------------------------------------- void ImGui::RenderMouseCursor(ImDrawList* draw_list, ImVec2 pos, float scale, ImGuiMouseCursor mouse_cursor) @@ -2927,8 +2926,9 @@ void ImGui::RenderRectFilledRangeH(ImDrawList* draw_list, const ImRect& rect, Im draw_list->PathFillConvex(col); } + //----------------------------------------------------------------------------- -// DEFAULT FONT DATA +// [SECTION] Decompression code //----------------------------------------------------------------------------- // Compressed with stb_compress() then converted to a C array and encoded as base85. // Use the program in misc/fonts/binary_to_compressed_c.cpp to create the array from a TTF file. @@ -3047,6 +3047,8 @@ static unsigned int stb_decompress(unsigned char *output, const unsigned char *i } } +//----------------------------------------------------------------------------- +// [SECTION] Default font data (ProggyClean.ttf) //----------------------------------------------------------------------------- // ProggyClean.ttf // Copyright (c) 2004, 2005 Tristan Grimmer diff --git a/imgui_widgets.cpp b/imgui_widgets.cpp index 6e0428dbd..6230eabca 100644 --- a/imgui_widgets.cpp +++ b/imgui_widgets.cpp @@ -4,22 +4,24 @@ /* Index of this file: -- Widgets: Text, etc. -- Widgets: Button, Image, Checkbox, RadioButton, ProgressBar, Bullet, etc. -- Widgets: Low-level Layout helpers: Spacing, Dummy, NewLine, Separator, etc. -- Widgets: ComboBox -- Data Type and Data Formatting Helpers -- Widgets: DragScalar, DragFloat, DragInt, etc. -- Widgets: SliderScalar, SliderFloat, SliderInt, etc. -- Widgets: InputScalar, InputFloat, InputInt, etc. -- Widgets: InputText, InputTextMultiline -- Widgets: ColorEdit, ColorPicker, ColorButton, etc. -- Widgets: TreeNode, TreePush, TreePop, etc. -- Widgets: Selectable -- Widgets: ListBox -- Widgets: PlotLines, PlotHistogram -- Widgets: Value -- Widgets: MenuItem, BeginMenu, EndMenu, etc. + +// [SECTION] Forward Declarations +// [SECTION] Widgets: Text, etc. +// [SECTION] Widgets: Main (Button, Image, Checkbox, RadioButton, ProgressBar, Bullet, etc.) +// [SECTION] Widgets: Low-level Layout helpers (Spacing, Dummy, NewLine, Separator, etc.) +// [SECTION] Widgets: ComboBox +// [SECTION] Data Type and Data Formatting Helpers +// [SECTION] Widgets: DragScalar, DragFloat, DragInt, etc. +// [SECTION] Widgets: SliderScalar, SliderFloat, SliderInt, etc. +// [SECTION] Widgets: InputScalar, InputFloat, InputInt, etc. +// [SECTION] Widgets: InputText, InputTextMultiline +// [SECTION] Widgets: ColorEdit, ColorPicker, ColorButton, etc. +// [SECTION] Widgets: TreeNode, CollapsingHeader, etc. +// [SECTION] Widgets: Selectable +// [SECTION] Widgets: ListBox +// [SECTION] Widgets: PlotLines, PlotHistogram +// [SECTION] Widgets: Value helpers +// [SECTION] Widgets: MenuItem, BeginMenu, EndMenu, etc. */ @@ -81,7 +83,7 @@ static const ImU64 IM_U64_MAX = (2ULL * 9223372036854775807LL + 1); #endif //------------------------------------------------------------------------- -// Forward Declarations +// [SECTION] Forward Declarations //------------------------------------------------------------------------- // Data Type helpers @@ -95,7 +97,8 @@ static int InputTextCalcTextLenAndLineCount(const char* text_begin, static ImVec2 InputTextCalcTextSizeW(const ImWchar* text_begin, const ImWchar* text_end, const ImWchar** remaining = NULL, ImVec2* out_offset = NULL, bool stop_on_new_line = false); //------------------------------------------------------------------------- -// WIDGETS: Text +// [SECTION] Widgets: Text, etc. +//------------------------------------------------------------------------- // - TextUnformatted() // - Text() // - TextV() @@ -350,7 +353,8 @@ void ImGui::BulletTextV(const char* fmt, va_list args) } //------------------------------------------------------------------------- -// WIDGETS: Main +// [SECTION] Widgets: Main +//------------------------------------------------------------------------- // - ButtonBehavior() [Internal] // - Button() // - SmallButton() @@ -1053,7 +1057,8 @@ void ImGui::Bullet() } //------------------------------------------------------------------------- -// WIDGETS: Low-level Layout helpers +// [SECTION] Widgets: Low-level Layout helpers +//------------------------------------------------------------------------- // - Spacing() // - Dummy() // - NewLine() @@ -1235,7 +1240,8 @@ bool ImGui::SplitterBehavior(const ImRect& bb, ImGuiID id, ImGuiAxis axis, float //------------------------------------------------------------------------- -// WIDGETS: Combo Box +// [SECTION] Widgets: Combo Box +//------------------------------------------------------------------------- // - BeginCombo() // - EndCombo() // - Combo() @@ -1449,7 +1455,8 @@ bool ImGui::Combo(const char* label, int* current_item, const char* items_separa } //------------------------------------------------------------------------- -// WIDGETS: Data Type and Data Formatting Helpers [Internal] +// [SECTION] Data Type and Data Formatting Helpers [Internal] +//------------------------------------------------------------------------- // - PatchFormatStringFloatToInt() // - DataTypeFormatString() // - DataTypeApplyOp() @@ -1678,7 +1685,8 @@ TYPE ImGui::RoundScalarWithFormatT(const char* format, ImGuiDataType data_type, } //------------------------------------------------------------------------- -// WIDGETS: Drags +// [SECTION] Widgets: DragScalar, DragFloat, DragInt, etc. +//------------------------------------------------------------------------- // - DragBehaviorT<>() [Internal] // - DragBehavior() [Internal] // - DragScalar() @@ -2015,7 +2023,8 @@ bool ImGui::DragIntRange2(const char* label, int* v_current_min, int* v_current_ } //------------------------------------------------------------------------- -// WIDGETS: Sliders +// [SECTION] Widgets: SliderScalar, SliderFloat, SliderInt, etc. +//------------------------------------------------------------------------- // - SliderBehaviorT<>() [Internal] // - SliderBehavior() [Internal] // - SliderScalar() @@ -2479,11 +2488,12 @@ bool ImGui::VSliderInt(const char* label, const ImVec2& size, int* v, int v_min, } //------------------------------------------------------------------------- -// WIDGETS: Inputs (_excepted InputText_) -// - ImParseFormatFindStart() -// - ImParseFormatFindEnd() -// - ImParseFormatTrimDecorations() -// - ImParseFormatPrecision() +// [SECTION] Widgets: InputScalar, InputFloat, InputInt, etc. +//------------------------------------------------------------------------- +// - ImParseFormatFindStart() [Internal] +// - ImParseFormatFindEnd() [Internal] +// - ImParseFormatTrimDecorations() [Internal] +// - ImParseFormatPrecision() [Internal] // - InputScalarAsWidgetReplacement() [Internal] // - InputScalar() // - InputScalarN() @@ -2776,7 +2786,8 @@ bool ImGui::InputDouble(const char* label, double* v, double step, double step_f } //------------------------------------------------------------------------- -// WIDGETS: InputText +// [SECTION] Widgets: InputText, InputTextMultiline +//------------------------------------------------------------------------- // - InputText() // - InputTextMultiline() // - InputTextEx() [Internal] @@ -3750,7 +3761,8 @@ bool ImGui::InputTextEx(const char* label, char* buf, int buf_size, const ImVec2 } //------------------------------------------------------------------------- -// WIDGETS: Color Editor / Picker +// [SECTION] Widgets: ColorEdit, ColorPicker, ColorButton, etc. +//------------------------------------------------------------------------- // - ColorEdit3() // - ColorEdit4() // - ColorPicker3() @@ -4550,7 +4562,8 @@ void ImGui::ColorPickerOptionsPopup(const float* ref_col, ImGuiColorEditFlags fl } //------------------------------------------------------------------------- -// WIDGETS: Trees +// [SECTION] Widgets: TreeNode, CollapsingHeader, etc. +//------------------------------------------------------------------------- // - TreeNode() // - TreeNodeV() // - TreeNodeEx() @@ -4943,7 +4956,8 @@ bool ImGui::CollapsingHeader(const char* label, bool* p_open, ImGuiTreeNodeFlags } //------------------------------------------------------------------------- -// WIDGETS: Selectables +// [SECTION] Widgets: Selectable +//------------------------------------------------------------------------- // - Selectable() //------------------------------------------------------------------------- @@ -5051,7 +5065,8 @@ bool ImGui::Selectable(const char* label, bool* p_selected, ImGuiSelectableFlags } //------------------------------------------------------------------------- -// WIDGETS: List Box +// [SECTION] Widgets: ListBox +//------------------------------------------------------------------------- // - ListBox() // - ListBoxHeader() // - ListBoxFooter() @@ -5160,7 +5175,8 @@ bool ImGui::ListBox(const char* label, int* current_item, bool (*items_getter)(v } //------------------------------------------------------------------------- -// WIDGETS: Data Plotting +// [SECTION] Widgets: PlotLines, PlotHistogram +//------------------------------------------------------------------------- // - PlotEx() [Internal] // - PlotLines() // - PlotHistogram() @@ -5314,7 +5330,9 @@ void ImGui::PlotHistogram(const char* label, float (*values_getter)(void* data, } //------------------------------------------------------------------------- -// WIDGETS: Value() helpers +// [SECTION] Widgets: Value helpers +// Those is not very useful, legacy API. +//------------------------------------------------------------------------- // - Value() //------------------------------------------------------------------------- @@ -5348,8 +5366,9 @@ void ImGui::Value(const char* prefix, float v, const char* float_format) } //------------------------------------------------------------------------- -// WIDGETS: Menus -// - ImGuiMenuColumns +// [SECTION] MenuItem, BeginMenu, EndMenu, etc. +//------------------------------------------------------------------------- +// - ImGuiMenuColumns [Internal] // - BeginMainMenuBar() // - EndMainMenuBar() // - BeginMenuBar()