|
|
@@ -2,13 +2,13 @@
|
|
|
// (main code and documentation)
|
|
|
|
|
|
// Help:
|
|
|
-// - Read FAQ at http://dearimgui.org/faq
|
|
|
+// - Read FAQ at http://dearimgui.com/faq
|
|
|
// - Newcomers, read 'Programmer guide' below for notes on how to setup Dear ImGui in your codebase.
|
|
|
// - Call and read ImGui::ShowDemoWindow() in imgui_demo.cpp. All applications in examples/ are doing that.
|
|
|
// Read imgui.cpp for details, links and comments.
|
|
|
|
|
|
// Resources:
|
|
|
-// - FAQ http://dearimgui.org/faq
|
|
|
+// - FAQ http://dearimgui.com/faq
|
|
|
// - Homepage & latest https://github.com/ocornut/imgui
|
|
|
// - Releases & changelog https://github.com/ocornut/imgui/releases
|
|
|
// - Gallery https://github.com/ocornut/imgui/issues/5886 (please post your screenshots/video there!)
|
|
|
@@ -48,7 +48,7 @@ DOCUMENTATION
|
|
|
- HOW A SIMPLE RENDERING FUNCTION MAY LOOK LIKE
|
|
|
- API BREAKING CHANGES (read me when you update!)
|
|
|
- FREQUENTLY ASKED QUESTIONS (FAQ)
|
|
|
- - Read all answers online: https://www.dearimgui.org/faq, or in docs/FAQ.md (with a Markdown viewer)
|
|
|
+ - Read all answers online: https://www.dearimgui.com/faq, or in docs/FAQ.md (with a Markdown viewer)
|
|
|
|
|
|
CODE
|
|
|
(search for "[SECTION]" in the code to find them)
|
|
|
@@ -160,7 +160,7 @@ CODE
|
|
|
- GAMEPAD CONTROLS
|
|
|
- Enable with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
|
|
|
- Particularly useful to use Dear ImGui on a console system (e.g. PlayStation, Switch, Xbox) without a mouse!
|
|
|
- - Download controller mapping PNG/PSD at http://dearimgui.org/controls_sheets
|
|
|
+ - Download controller mapping PNG/PSD at http://dearimgui.com/controls_sheets
|
|
|
- Backend support: backend needs to:
|
|
|
- Set 'io.BackendFlags |= ImGuiBackendFlags_HasGamepad' + call io.AddKeyEvent/AddKeyAnalogEvent() with ImGuiKey_Gamepad_XXX keys.
|
|
|
- For analog values (0.0f to 1.0f), backend is responsible to handling a dead-zone and rescaling inputs accordingly.
|
|
|
@@ -791,7 +791,7 @@ CODE
|
|
|
================================
|
|
|
|
|
|
Read all answers online:
|
|
|
- https://www.dearimgui.org/faq or https://github.com/ocornut/imgui/blob/master/docs/FAQ.md (same url)
|
|
|
+ https://www.dearimgui.com/faq or https://github.com/ocornut/imgui/blob/master/docs/FAQ.md (same url)
|
|
|
Read all answers locally (with a text editor or ideally a Markdown viewer):
|
|
|
docs/FAQ.md
|
|
|
Some answers are copied down here to facilitate searching in code.
|
|
|
@@ -815,7 +815,7 @@ CODE
|
|
|
Q: What is this library called?
|
|
|
Q: Which version should I get?
|
|
|
>> This library is called "Dear ImGui", please don't call it "ImGui" :)
|
|
|
- >> See https://www.dearimgui.org/faq for details.
|
|
|
+ >> See https://www.dearimgui.com/faq for details.
|
|
|
|
|
|
Q&A: Integration
|
|
|
================
|
|
|
@@ -825,14 +825,14 @@ CODE
|
|
|
|
|
|
Q: How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application?
|
|
|
A: You should read the 'io.WantCaptureMouse', 'io.WantCaptureKeyboard' and 'io.WantTextInput' flags!
|
|
|
- >> See https://www.dearimgui.org/faq for a fully detailed answer. You really want to read this.
|
|
|
+ >> See https://www.dearimgui.com/faq for a fully detailed answer. You really want to read this.
|
|
|
|
|
|
Q. How can I enable keyboard controls?
|
|
|
Q: How can I use this without a mouse, without a keyboard or without a screen? (gamepad, input share, remote display)
|
|
|
Q: I integrated Dear ImGui in my engine and little squares are showing instead of text...
|
|
|
Q: I integrated Dear ImGui in my engine and some elements are clipping or disappearing when I move windows around...
|
|
|
Q: I integrated Dear ImGui in my engine and some elements are displaying outside their expected windows boundaries...
|
|
|
- >> See https://www.dearimgui.org/faq
|
|
|
+ >> See https://www.dearimgui.com/faq
|
|
|
|
|
|
Q&A: Usage
|
|
|
----------
|
|
|
@@ -846,7 +846,7 @@ CODE
|
|
|
Q: How can I use my own math types instead of ImVec2/ImVec4?
|
|
|
Q: How can I interact with standard C++ types (such as std::string and std::vector)?
|
|
|
Q: How can I display custom shapes? (using low-level ImDrawList API)
|
|
|
- >> See https://www.dearimgui.org/faq
|
|
|
+ >> See https://www.dearimgui.com/faq
|
|
|
|
|
|
Q&A: Fonts, Text
|
|
|
================
|
|
|
@@ -856,7 +856,7 @@ CODE
|
|
|
Q: How can I easily use icons in my application?
|
|
|
Q: How can I load multiple fonts?
|
|
|
Q: How can I display and input non-Latin characters such as Chinese, Japanese, Korean, Cyrillic?
|
|
|
- >> See https://www.dearimgui.org/faq and https://github.com/ocornut/imgui/edit/master/docs/FONTS.md
|
|
|
+ >> See https://www.dearimgui.com/faq and https://github.com/ocornut/imgui/edit/master/docs/FONTS.md
|
|
|
|
|
|
Q&A: Concerns
|
|
|
=============
|
|
|
@@ -865,7 +865,7 @@ CODE
|
|
|
Q: Can you create elaborate/serious tools with Dear ImGui?
|
|
|
Q: Can you reskin the look of Dear ImGui?
|
|
|
Q: Why using C++ (as opposed to C)?
|
|
|
- >> See https://www.dearimgui.org/faq
|
|
|
+ >> See https://www.dearimgui.com/faq
|
|
|
|
|
|
Q&A: Community
|
|
|
==============
|
|
|
@@ -1282,6 +1282,7 @@ ImGuiIO::ImGuiIO()
|
|
|
// Input (NB: we already have memset zero the entire structure!)
|
|
|
MousePos = ImVec2(-FLT_MAX, -FLT_MAX);
|
|
|
MousePosPrev = ImVec2(-FLT_MAX, -FLT_MAX);
|
|
|
+ MouseSource = ImGuiMouseSource_Mouse;
|
|
|
MouseDragThreshold = 6.0f;
|
|
|
for (int i = 0; i < IM_ARRAYSIZE(MouseDownDuration); i++) MouseDownDuration[i] = MouseDownDurationPrev[i] = -1.0f;
|
|
|
for (int i = 0; i < IM_ARRAYSIZE(KeysData); i++) { KeysData[i].DownDuration = KeysData[i].DownDurationPrev = -1.0f; }
|
|
|
@@ -1508,6 +1509,7 @@ void ImGuiIO::AddMousePosEvent(float x, float y)
|
|
|
e.Source = ImGuiInputSource_Mouse;
|
|
|
e.MousePos.PosX = pos.x;
|
|
|
e.MousePos.PosY = pos.y;
|
|
|
+ e.MouseWheel.MouseSource = g.InputEventsNextMouseSource;
|
|
|
g.InputEventsQueue.push_back(e);
|
|
|
}
|
|
|
|
|
|
@@ -1530,6 +1532,7 @@ void ImGuiIO::AddMouseButtonEvent(int mouse_button, bool down)
|
|
|
e.Source = ImGuiInputSource_Mouse;
|
|
|
e.MouseButton.Button = mouse_button;
|
|
|
e.MouseButton.Down = down;
|
|
|
+ e.MouseWheel.MouseSource = g.InputEventsNextMouseSource;
|
|
|
g.InputEventsQueue.push_back(e);
|
|
|
}
|
|
|
|
|
|
@@ -1548,9 +1551,19 @@ void ImGuiIO::AddMouseWheelEvent(float wheel_x, float wheel_y)
|
|
|
e.Source = ImGuiInputSource_Mouse;
|
|
|
e.MouseWheel.WheelX = wheel_x;
|
|
|
e.MouseWheel.WheelY = wheel_y;
|
|
|
+ e.MouseWheel.MouseSource = g.InputEventsNextMouseSource;
|
|
|
g.InputEventsQueue.push_back(e);
|
|
|
}
|
|
|
|
|
|
+// This is not a real event, the data is latched in order to be stored in actual Mouse events.
|
|
|
+// This is so that duplicate events (e.g. Windows sending extraneous WM_MOUSEMOVE) gets filtered and are not leading to actual source changes.
|
|
|
+void ImGuiIO::AddMouseSourceEvent(ImGuiMouseSource source)
|
|
|
+{
|
|
|
+ IM_ASSERT(Ctx != NULL);
|
|
|
+ ImGuiContext& g = *Ctx;
|
|
|
+ g.InputEventsNextMouseSource = source;
|
|
|
+}
|
|
|
+
|
|
|
void ImGuiIO::AddMouseViewportEvent(ImGuiID viewport_id)
|
|
|
{
|
|
|
IM_ASSERT(Ctx != NULL);
|
|
|
@@ -9267,12 +9280,18 @@ static const char* GetInputSourceName(ImGuiInputSource source)
|
|
|
IM_ASSERT(IM_ARRAYSIZE(input_source_names) == ImGuiInputSource_COUNT && source >= 0 && source < ImGuiInputSource_COUNT);
|
|
|
return input_source_names[source];
|
|
|
}
|
|
|
+static const char* GetMouseSourceName(ImGuiMouseSource source)
|
|
|
+{
|
|
|
+ const char* mouse_source_names[] = { "Mouse", "TouchScreen", "Pen" };
|
|
|
+ IM_ASSERT(IM_ARRAYSIZE(mouse_source_names) == ImGuiMouseSource_COUNT && source >= 0 && source < ImGuiMouseSource_COUNT);
|
|
|
+ return mouse_source_names[source];
|
|
|
+}
|
|
|
static void DebugPrintInputEvent(const char* prefix, const ImGuiInputEvent* e)
|
|
|
{
|
|
|
ImGuiContext& g = *GImGui;
|
|
|
- if (e->Type == ImGuiInputEventType_MousePos) { if (e->MousePos.PosX == -FLT_MAX && e->MousePos.PosY == -FLT_MAX) IMGUI_DEBUG_LOG_IO("%s: MousePos (-FLT_MAX, -FLT_MAX)\n", prefix); else IMGUI_DEBUG_LOG_IO("%s: MousePos (%.1f, %.1f)\n", prefix, e->MousePos.PosX, e->MousePos.PosY); return; }
|
|
|
- if (e->Type == ImGuiInputEventType_MouseButton) { IMGUI_DEBUG_LOG_IO("%s: MouseButton %d %s\n", prefix, e->MouseButton.Button, e->MouseButton.Down ? "Down" : "Up"); return; }
|
|
|
- if (e->Type == ImGuiInputEventType_MouseWheel) { IMGUI_DEBUG_LOG_IO("%s: MouseWheel (%.3f, %.3f)\n", prefix, e->MouseWheel.WheelX, e->MouseWheel.WheelY); return; }
|
|
|
+ if (e->Type == ImGuiInputEventType_MousePos) { if (e->MousePos.PosX == -FLT_MAX && e->MousePos.PosY == -FLT_MAX) IMGUI_DEBUG_LOG_IO("%s: MousePos (-FLT_MAX, -FLT_MAX)\n", prefix); else IMGUI_DEBUG_LOG_IO("%s: MousePos (%.1f, %.1f) (%s)\n", prefix, e->MousePos.PosX, e->MousePos.PosY, GetMouseSourceName(e->MouseWheel.MouseSource)); return; }
|
|
|
+ if (e->Type == ImGuiInputEventType_MouseButton) { IMGUI_DEBUG_LOG_IO("%s: MouseButton %d %s (%s)\n", prefix, e->MouseButton.Button, e->MouseButton.Down ? "Down" : "Up", GetMouseSourceName(e->MouseWheel.MouseSource)); return; }
|
|
|
+ if (e->Type == ImGuiInputEventType_MouseWheel) { IMGUI_DEBUG_LOG_IO("%s: MouseWheel (%.3f, %.3f) (%s)\n", prefix, e->MouseWheel.WheelX, e->MouseWheel.WheelY, GetMouseSourceName(e->MouseWheel.MouseSource)); return; }
|
|
|
if (e->Type == ImGuiInputEventType_MouseViewport){IMGUI_DEBUG_LOG_IO("%s: MouseViewport (0x%08X)\n", prefix, e->MouseViewport.HoveredViewportID); return; }
|
|
|
if (e->Type == ImGuiInputEventType_Key) { IMGUI_DEBUG_LOG_IO("%s: Key \"%s\" %s\n", prefix, ImGui::GetKeyName(e->Key.Key), e->Key.Down ? "Down" : "Up"); return; }
|
|
|
if (e->Type == ImGuiInputEventType_Text) { IMGUI_DEBUG_LOG_IO("%s: Text: %c (U+%08X)\n", prefix, e->Text.Char, e->Text.Char); return; }
|
|
|
@@ -9309,6 +9328,7 @@ void ImGui::UpdateInputEvents(bool trickle_fast_inputs)
|
|
|
if (trickle_fast_inputs && (mouse_button_changed != 0 || mouse_wheeled || key_changed || text_inputted))
|
|
|
break;
|
|
|
io.MousePos = event_pos;
|
|
|
+ io.MouseSource = e->MousePos.MouseSource;
|
|
|
mouse_moved = true;
|
|
|
}
|
|
|
else if (e->Type == ImGuiInputEventType_MouseButton)
|
|
|
@@ -9318,7 +9338,10 @@ void ImGui::UpdateInputEvents(bool trickle_fast_inputs)
|
|
|
IM_ASSERT(button >= 0 && button < ImGuiMouseButton_COUNT);
|
|
|
if (trickle_fast_inputs && ((mouse_button_changed & (1 << button)) || mouse_wheeled))
|
|
|
break;
|
|
|
+ if (trickle_fast_inputs && e->MouseButton.MouseSource == ImGuiMouseSource_TouchScreen && mouse_moved) // #2702: TouchScreen have no initial hover.
|
|
|
+ break;
|
|
|
io.MouseDown[button] = e->MouseButton.Down;
|
|
|
+ io.MouseSource = e->MouseButton.MouseSource;
|
|
|
mouse_button_changed |= (1 << button);
|
|
|
}
|
|
|
else if (e->Type == ImGuiInputEventType_MouseWheel)
|
|
|
@@ -9328,6 +9351,7 @@ void ImGui::UpdateInputEvents(bool trickle_fast_inputs)
|
|
|
break;
|
|
|
io.MouseWheelH += e->MouseWheel.WheelX;
|
|
|
io.MouseWheel += e->MouseWheel.WheelY;
|
|
|
+ io.MouseSource = e->MouseWheel.MouseSource;
|
|
|
mouse_wheeled = true;
|
|
|
}
|
|
|
else if (e->Type == ImGuiInputEventType_MouseViewport)
|
|
|
@@ -9957,7 +9981,7 @@ bool ImGui::ItemAdd(const ImRect& bb, ImGuiID id, const ImRect* nav_bb_arg, ImGu
|
|
|
|
|
|
// [DEBUG] People keep stumbling on this problem and using "" as identifier in the root of a window instead of "##something".
|
|
|
// Empty identifier are valid and useful in a small amount of cases, but 99.9% of the time you want to use "##something".
|
|
|
- // READ THE FAQ: https://dearimgui.org/faq
|
|
|
+ // READ THE FAQ: https://dearimgui.com/faq
|
|
|
IM_ASSERT(id != window->ID && "Cannot have an empty ID at the root of a window. If you need an empty label, use ## and read the FAQ about how the ID Stack works!");
|
|
|
}
|
|
|
g.NextItemData.Flags = ImGuiNextItemDataFlags_None;
|
|
|
@@ -19314,6 +19338,7 @@ void ImGui::ShowMetricsWindow(bool* p_open)
|
|
|
Text("Mouse clicked:"); for (int i = 0; i < count; i++) if (IsMouseClicked(i)) { SameLine(); Text("b%d (%d)", i, io.MouseClickedCount[i]); }
|
|
|
Text("Mouse released:"); for (int i = 0; i < count; i++) if (IsMouseReleased(i)) { SameLine(); Text("b%d", i); }
|
|
|
Text("Mouse wheel: %.1f", io.MouseWheel);
|
|
|
+ Text("Mouse source: %s", GetMouseSourceName(io.MouseSource));
|
|
|
Text("Pen Pressure: %.1f", io.PenPressure); // Note: currently unused
|
|
|
Unindent();
|
|
|
}
|
ocornut