|
|
@@ -27,7 +27,7 @@ Index of this file:
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
-// Configuration file with compile-time options (edit imconfig.h or define IMGUI_USER_CONFIG to your own filename)
|
|
|
+// Configuration file with compile-time options (edit imconfig.h or #define IMGUI_USER_CONFIG to your own filename)
|
|
|
#ifdef IMGUI_USER_CONFIG
|
|
|
#include IMGUI_USER_CONFIG
|
|
|
#endif
|
|
|
@@ -39,8 +39,9 @@ Index of this file:
|
|
|
// Header mess
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
|
|
-#include <float.h> // FLT_MAX
|
|
|
-#include <stdarg.h> // va_list
|
|
|
+// Includes
|
|
|
+#include <float.h> // FLT_MIN, FLT_MAX
|
|
|
+#include <stdarg.h> // va_list, va_start, va_end
|
|
|
#include <stddef.h> // ptrdiff_t, NULL
|
|
|
#include <string.h> // memset, memmove, memcpy, strlen, strchr, strcpy, strcmp
|
|
|
|
|
|
@@ -65,15 +66,14 @@ Index of this file:
|
|
|
#include <assert.h>
|
|
|
#define IM_ASSERT(_EXPR) assert(_EXPR) // You can override the default assert handler by editing imconfig.h
|
|
|
#endif
|
|
|
-
|
|
|
#if 0 // defined(__clang__) || defined(__GNUC__)
|
|
|
-#define IM_FMTARGS(FMT) __attribute__((format(printf, FMT, FMT+1))) // Apply printf-style warnings to user functions.
|
|
|
+#define IM_FMTARGS(FMT) __attribute__((format(printf, FMT, FMT+1))) // To apply printf-style warnings to our functions.
|
|
|
#define IM_FMTLIST(FMT) __attribute__((format(printf, FMT, 0)))
|
|
|
#else
|
|
|
#define IM_FMTARGS(FMT)
|
|
|
#define IM_FMTLIST(FMT)
|
|
|
#endif
|
|
|
-#define IM_ARRAYSIZE(_ARR) ((int)(sizeof(_ARR)/sizeof(*_ARR))) // Size of a static C-style array. Don't use on pointers!
|
|
|
+#define IM_ARRAYSIZE(_ARR) ((int)(sizeof(_ARR) / sizeof(*_ARR))) // Size of a static C-style array. Don't use on pointers!
|
|
|
#define IM_UNUSED(_VAR) ((void)_VAR) // Used to silence "unused variable warnings". Often useful as asserts may be stripped out from final builds.
|
|
|
#if (__cplusplus >= 201100)
|
|
|
#define IM_OFFSETOF(_TYPE,_MEMBER) offsetof(_TYPE, _MEMBER) // Offset of _MEMBER within _TYPE. Standardized as offsetof() in C++11
|
|
|
@@ -124,7 +124,7 @@ struct ImGuiTextBuffer; // Helper to hold and append into a text buf
|
|
|
struct ImGuiTextFilter; // Helper to parse and apply text filters (e.g. "aaaaa[,bbbb][,ccccc]")
|
|
|
|
|
|
// Typedefs and Enums/Flags (declared as int for compatibility with old C++, to allow using as flags and to not pollute the top of this file)
|
|
|
-// Use your programming IDE "Go to definition" facility on the names of the center columns to find the actual flags/enum lists.
|
|
|
+// Use your programming IDE "Go to definition" facility on the names in the central column below to find the actual flags/enum lists.
|
|
|
#ifndef ImTextureID
|
|
|
typedef void* ImTextureID; // User data to identify a texture (this is whatever to you want it to be! read the FAQ about ImTextureID in imgui.cpp)
|
|
|
#endif
|
|
|
@@ -158,7 +158,7 @@ typedef int (*ImGuiInputTextCallback)(ImGuiInputTextCallbackData *data);
|
|
|
typedef void (*ImGuiSizeCallback)(ImGuiSizeCallbackData* data);
|
|
|
|
|
|
// Scalar data types
|
|
|
-typedef signed char ImS8; // 8-bit signed integer == char
|
|
|
+typedef signed char ImS8; // 8-bit signed integer
|
|
|
typedef unsigned char ImU8; // 8-bit unsigned integer
|
|
|
typedef signed short ImS16; // 16-bit signed integer
|
|
|
typedef unsigned short ImU16; // 16-bit unsigned integer
|
|
|
@@ -202,14 +202,14 @@ struct ImVec4
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
// ImGui: Dear ImGui end-user API
|
|
|
-// (Inside a namespace so you can add extra functions in your own separate file. Please don't modify imgui.cpp/.h!)
|
|
|
+// (Inside a namespace so you can add extra functions in your own separate file. Please don't modify imgui source files!)
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
|
|
namespace ImGui
|
|
|
{
|
|
|
// Context creation and access
|
|
|
// Each context create its own ImFontAtlas by default. You may instance one yourself and pass it to CreateContext() to share a font atlas between imgui contexts.
|
|
|
- // All those functions are not reliant on the current context.
|
|
|
+ // None of those functions is reliant on the current context.
|
|
|
IMGUI_API ImGuiContext* CreateContext(ImFontAtlas* shared_font_atlas = NULL);
|
|
|
IMGUI_API void DestroyContext(ImGuiContext* ctx = NULL); // NULL = destroy current context
|
|
|
IMGUI_API ImGuiContext* GetCurrentContext();
|
|
|
@@ -246,8 +246,9 @@ namespace ImGui
|
|
|
// which clicking will set the boolean to false when clicked.
|
|
|
// - Begin() return false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting
|
|
|
// anything to the window. Always call a matching End() for each Begin() call, regardless of its return value!
|
|
|
- // [this is due to legacy reason and is inconsistent with most other functions such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc.
|
|
|
- // where the EndXXX call should only be called if the corresponding BeginXXX function returned true.]
|
|
|
+ // [Important: due to legacy reason, this is inconsistent with most other functions such as BeginMenu/EndMenu,
|
|
|
+ // BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding BeginXXX function
|
|
|
+ // returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.]
|
|
|
// - Note that the bottom of window stack always contains a window called "Debug".
|
|
|
IMGUI_API bool Begin(const char* name, bool* p_open = NULL, ImGuiWindowFlags flags = 0);
|
|
|
IMGUI_API void End();
|
|
|
@@ -256,13 +257,13 @@ namespace ImGui
|
|
|
// - Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window. Child windows can embed their own child.
|
|
|
// - For each independent axis of 'size': ==0.0f: use remaining host window size / >0.0f: fixed size / <0.0f: use remaining window size minus abs(size) / Each axis can use a different mode, e.g. ImVec2(0,400).
|
|
|
// - BeginChild() returns false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window.
|
|
|
- // Always call a matching EndChild() for each BeginChild() call, regardless of its return value [this is due to legacy reason and is inconsistent with most other functions such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding BeginXXX function returned true.]
|
|
|
+ // Always call a matching EndChild() for each BeginChild() call, regardless of its return value [as with Begin: this is due to legacy reason and inconsistent with most BeginXXX functions apart from the regular Begin() which behaves like BeginChild().]
|
|
|
IMGUI_API bool BeginChild(const char* str_id, const ImVec2& size = ImVec2(0,0), bool border = false, ImGuiWindowFlags flags = 0);
|
|
|
IMGUI_API bool BeginChild(ImGuiID id, const ImVec2& size = ImVec2(0,0), bool border = false, ImGuiWindowFlags flags = 0);
|
|
|
IMGUI_API void EndChild();
|
|
|
|
|
|
// Windows Utilities
|
|
|
- // - "current window" = the window we are appending into while inside a Begin()/End() block. "next window" = next window we will Begin() into.
|
|
|
+ // - 'current window' = the window we are appending into while inside a Begin()/End() block. 'next window' = next window we will Begin() into.
|
|
|
IMGUI_API bool IsWindowAppearing();
|
|
|
IMGUI_API bool IsWindowCollapsed();
|
|
|
IMGUI_API bool IsWindowFocused(ImGuiFocusedFlags flags=0); // is current window focused? or its root/child, depending on flags. see flags for options.
|
|
|
@@ -343,6 +344,7 @@ namespace ImGui
|
|
|
// Cursor / Layout
|
|
|
// - By "cursor" we mean the current output position.
|
|
|
// - The typical widget behavior is to output themselves at the current cursor position, then move the cursor one line down.
|
|
|
+ // - You can call SameLine() between widgets to undo the last carriage return and output at the right of the preceeding widget.
|
|
|
IMGUI_API void Separator(); // separator, generally horizontal. inside a menu bar or in horizontal layout mode, this becomes a vertical separator.
|
|
|
IMGUI_API void SameLine(float offset_from_start_x=0.0f, float spacing=-1.0f); // call between widgets or groups to layout them horizontally. X position given in window coordinates.
|
|
|
IMGUI_API void NewLine(); // undo a SameLine() or force a new line when in an horizontal-layout context.
|
|
|
@@ -384,8 +386,8 @@ namespace ImGui
|
|
|
IMGUI_API ImGuiID GetID(const void* ptr_id);
|
|
|
|
|
|
// Widgets: Text
|
|
|
- IMGUI_API void TextUnformatted(const char* text, const char* text_end = NULL); // raw text without formatting. Roughly equivalent to Text("%s", text) but: A) doesn't require null terminated string if 'text_end' is specified, B) it's faster, no memory copy is done, no buffer size limits, recommended for long chunks of text.
|
|
|
- IMGUI_API void Text(const char* fmt, ...) IM_FMTARGS(1); // simple formatted text
|
|
|
+ IMGUI_API void TextUnformatted(const char* text, const char* text_end = NULL); // raw text without formatting. Roughly equivalent to Text("%s", text) but: A) doesn't require null terminated string if 'text_end' is specified, B) it's faster, no memory copy is done, no buffer size limits, recommended for long chunks of text.
|
|
|
+ IMGUI_API void Text(const char* fmt, ...) IM_FMTARGS(1); // formatted text
|
|
|
IMGUI_API void TextV(const char* fmt, va_list args) IM_FMTLIST(1);
|
|
|
IMGUI_API void TextColored(const ImVec4& col, const char* fmt, ...) IM_FMTARGS(2); // shortcut for PushStyleColor(ImGuiCol_Text, col); Text(fmt, ...); PopStyleColor();
|
|
|
IMGUI_API void TextColoredV(const ImVec4& col, const char* fmt, va_list args) IM_FMTLIST(2);
|
|
|
@@ -400,6 +402,7 @@ namespace ImGui
|
|
|
|
|
|
// Widgets: Main
|
|
|
// - Most widgets return true when the value has been changed or when pressed/selected
|
|
|
+ // - You may also use one of the many IsItemXXX functions (e.g. IsItemActive, IsItemHovered, etc.) to query widget state.
|
|
|
IMGUI_API bool Button(const char* label, const ImVec2& size = ImVec2(0,0)); // button
|
|
|
IMGUI_API bool SmallButton(const char* label); // button with FramePadding=(0,0) to easily embed within text
|
|
|
IMGUI_API bool InvisibleButton(const char* str_id, const ImVec2& size); // button behavior without the visuals, frequently useful to build custom behaviors using the public api (along with IsItemActive, IsItemHovered, etc.)
|
|
|
@@ -414,7 +417,7 @@ namespace ImGui
|
|
|
IMGUI_API void Bullet(); // draw a small circle and keep the cursor on the same line. advance cursor x position by GetTreeNodeToLabelSpacing(), same distance that TreeNode() uses
|
|
|
|
|
|
// Widgets: Combo Box
|
|
|
- // - The new BeginCombo()/EndCombo() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() items.
|
|
|
+ // - The BeginCombo()/EndCombo() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() items.
|
|
|
// - The old Combo() api are helpers over BeginCombo()/EndCombo() which are kept available for convenience purpose.
|
|
|
IMGUI_API bool BeginCombo(const char* label, const char* preview_value, ImGuiComboFlags flags = 0);
|
|
|
IMGUI_API void EndCombo(); // only call EndCombo() if BeginCombo() returns true!
|
|
|
@@ -510,7 +513,7 @@ namespace ImGui
|
|
|
|
|
|
// Widgets: Selectables
|
|
|
// - A selectable highlights when hovered, and can display another color when selected.
|
|
|
- // - Neighbors selectable extend their highlight bounds in order to leave no gap between them.
|
|
|
+ // - Neighbors selectable extend their highlight bounds in order to leave no gap between them. This is so a series of selected Selectable appear contiguous.
|
|
|
IMGUI_API bool Selectable(const char* label, bool selected = false, ImGuiSelectableFlags flags = 0, const ImVec2& size = ImVec2(0,0)); // "bool selected" carry the selection state (read-only). Selectable() is clicked is returns true so you can modify your selection state. size.x==0.0: use remaining width, size.x>0.0: specify width. size.y==0.0: use label height, size.y>0.0: specify height
|
|
|
IMGUI_API bool Selectable(const char* label, bool* p_selected, ImGuiSelectableFlags flags = 0, const ImVec2& size = ImVec2(0,0)); // "bool* p_selected" point to the selection state (read-write), as a convenient helper.
|
|
|
|
|
|
@@ -536,16 +539,19 @@ namespace ImGui
|
|
|
IMGUI_API void Value(const char* prefix, float v, const char* float_format = NULL);
|
|
|
|
|
|
// Widgets: Menus
|
|
|
- IMGUI_API bool BeginMainMenuBar(); // create and append to a full screen menu-bar.
|
|
|
- IMGUI_API void EndMainMenuBar(); // only call EndMainMenuBar() if BeginMainMenuBar() returns true!
|
|
|
+ // - Use BeginMenuBar() on a window ImGuiWindowFlags_MenuBar to append to its menu bar.
|
|
|
+ // - Use BeginMainMenuBar() to create a menu bar at the top of the screen.
|
|
|
IMGUI_API bool BeginMenuBar(); // append to menu-bar of current window (requires ImGuiWindowFlags_MenuBar flag set on parent window).
|
|
|
IMGUI_API void EndMenuBar(); // only call EndMenuBar() if BeginMenuBar() returns true!
|
|
|
+ IMGUI_API bool BeginMainMenuBar(); // create and append to a full screen menu-bar.
|
|
|
+ IMGUI_API void EndMainMenuBar(); // only call EndMainMenuBar() if BeginMainMenuBar() returns true!
|
|
|
IMGUI_API bool BeginMenu(const char* label, bool enabled = true); // create a sub-menu entry. only call EndMenu() if this returns true!
|
|
|
IMGUI_API void EndMenu(); // only call EndMenu() if BeginMenu() returns true!
|
|
|
IMGUI_API bool MenuItem(const char* label, const char* shortcut = NULL, bool selected = false, bool enabled = true); // return true when activated. shortcuts are displayed for convenience but not processed by ImGui at the moment
|
|
|
IMGUI_API bool MenuItem(const char* label, const char* shortcut, bool* p_selected, bool enabled = true); // return true when activated + toggle (*p_selected) if p_selected != NULL
|
|
|
|
|
|
// Tooltips
|
|
|
+ // - Tooltip are windows following the mouse which do not take focus away.
|
|
|
IMGUI_API void BeginTooltip(); // begin/append a tooltip window. to create full-featured tooltip (with any kind of items).
|
|
|
IMGUI_API void EndTooltip();
|
|
|
IMGUI_API void SetTooltip(const char* fmt, ...) IM_FMTARGS(1); // set a text-only tooltip, typically use with ImGui::IsItemHovered(). override any previous call to SetTooltip().
|
|
|
@@ -557,7 +563,7 @@ namespace ImGui
|
|
|
// - Unless modal, they can be closed by clicking anywhere outside them, or by pressing ESCAPE.
|
|
|
// - Their visibility state (~bool) is held internally by imgui instead of being held by the programmer as we are used to with regular Begin() calls.
|
|
|
// User can manipulate the visibility state by calling OpenPopup().
|
|
|
- // (*) One can use IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup) to bypass it and detect hovering even when normally blocked by a popup.
|
|
|
+ // (*) You can use IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup) to bypass it and detect hovering even when normally blocked by a popup.
|
|
|
// Those three properties are connected. The library needs to hold their visibility state because it can close popups at any time.
|
|
|
IMGUI_API void OpenPopup(const char* str_id); // call to mark popup as open (don't call every frame!). popups are closed when user click outside, or if CloseCurrentPopup() is called within a BeginPopup()/EndPopup() block. By default, Selectable()/MenuItem() are calling CloseCurrentPopup(). Popup identifiers are relative to the current ID-stack (so OpenPopup and BeginPopup needs to be at the same level).
|
|
|
IMGUI_API bool BeginPopup(const char* str_id, ImGuiWindowFlags flags = 0); // return true if the popup is open, and you can start outputting to it. only call EndPopup() if BeginPopup() returns true!
|
|
|
@@ -573,6 +579,7 @@ namespace ImGui
|
|
|
// Columns
|
|
|
// - You can also use SameLine(pos_x) to mimic simplified columns.
|
|
|
// - The columns API is work-in-progress and rather lacking (columns are arguably the worst part of dear imgui at the moment!)
|
|
|
+ // - By end of the 2019 we will expose a new 'Table' api which will replace columns.
|
|
|
IMGUI_API void Columns(int count = 1, const char* id = NULL, bool border = true);
|
|
|
IMGUI_API void NextColumn(); // next column, defaults to current row or next row if the current row is finished
|
|
|
IMGUI_API int GetColumnIndex(); // get current column index
|
|
|
@@ -583,7 +590,6 @@ namespace ImGui
|
|
|
IMGUI_API int GetColumnsCount();
|
|
|
|
|
|
// Tab Bars, Tabs
|
|
|
- // [BETA API] API may evolve!
|
|
|
IMGUI_API bool BeginTabBar(const char* str_id, ImGuiTabBarFlags flags = 0); // create and append into a TabBar
|
|
|
IMGUI_API void EndTabBar(); // only call EndTabBar() if BeginTabBar() returns true!
|
|
|
IMGUI_API bool BeginTabItem(const char* label, bool* p_open = NULL, ImGuiTabItemFlags flags = 0);// create a Tab. Returns true if the Tab is selected.
|
|
|
@@ -951,12 +957,12 @@ enum ImGuiKey_
|
|
|
ImGuiKey_Enter,
|
|
|
ImGuiKey_Escape,
|
|
|
ImGuiKey_KeyPadEnter,
|
|
|
- ImGuiKey_A, // for text edit CTRL+A: select all
|
|
|
- ImGuiKey_C, // for text edit CTRL+C: copy
|
|
|
- ImGuiKey_V, // for text edit CTRL+V: paste
|
|
|
- ImGuiKey_X, // for text edit CTRL+X: cut
|
|
|
- ImGuiKey_Y, // for text edit CTRL+Y: redo
|
|
|
- ImGuiKey_Z, // for text edit CTRL+Z: undo
|
|
|
+ ImGuiKey_A, // for text edit CTRL+A: select all
|
|
|
+ ImGuiKey_C, // for text edit CTRL+C: copy
|
|
|
+ ImGuiKey_V, // for text edit CTRL+V: paste
|
|
|
+ ImGuiKey_X, // for text edit CTRL+X: cut
|
|
|
+ ImGuiKey_Y, // for text edit CTRL+Y: redo
|
|
|
+ ImGuiKey_Z, // for text edit CTRL+Z: undo
|
|
|
ImGuiKey_COUNT
|
|
|
};
|
|
|
|
|
|
@@ -1572,11 +1578,6 @@ namespace ImGui
|
|
|
static inline bool IsRootWindowOrAnyChildFocused() { return IsWindowFocused(ImGuiFocusedFlags_RootAndChildWindows); }
|
|
|
static inline void SetNextWindowContentWidth(float w) { SetNextWindowContentSize(ImVec2(w, 0.0f)); }
|
|
|
static inline float GetItemsLineHeightWithSpacing() { return GetFrameHeightWithSpacing(); }
|
|
|
- // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017)
|
|
|
- IMGUI_API bool Begin(const char* name, bool* p_open, const ImVec2& size_on_first_use, float bg_alpha_override = -1.0f, ImGuiWindowFlags flags = 0); // Use SetNextWindowSize(size, ImGuiCond_FirstUseEver) + SetNextWindowBgAlpha() instead.
|
|
|
- static inline bool IsRootWindowOrAnyChildHovered() { return IsWindowHovered(ImGuiHoveredFlags_RootAndChildWindows); }
|
|
|
- static inline void AlignFirstTextHeightToWidgets() { AlignTextToFramePadding(); }
|
|
|
- static inline void SetNextWindowPosCenter(ImGuiCond c=0) { ImGuiIO& io = GetIO(); SetNextWindowPos(ImVec2(io.DisplaySize.x * 0.5f, io.DisplaySize.y * 0.5f), c, ImVec2(0.5f, 0.5f)); }
|
|
|
}
|
|
|
typedef ImGuiInputTextCallback ImGuiTextEditCallback; // OBSOLETED in 1.63 (from Aug 2018): made the names consistent
|
|
|
typedef ImGuiInputTextCallbackData ImGuiTextEditCallbackData;
|
|
|
@@ -2224,10 +2225,6 @@ struct ImFont
|
|
|
IMGUI_API void AddGlyph(ImWchar c, float x0, float y0, float x1, float y1, float u0, float v0, float u1, float v1, float advance_x);
|
|
|
IMGUI_API void AddRemapChar(ImWchar dst, ImWchar src, bool overwrite_dst = true); // Makes 'dst' character/glyph points to 'src' character/glyph. Currently needs to be called AFTER fonts have been built.
|
|
|
IMGUI_API void SetFallbackChar(ImWchar c);
|
|
|
-
|
|
|
-#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
|
|
|
- typedef ImFontGlyph Glyph; // OBSOLETED in 1.52+
|
|
|
-#endif
|
|
|
};
|
|
|
|
|
|
#if defined(__clang__)
|
Бранимир Караџић