Skip to content

Commit 7cd0042

Browse files
gpx1000gpx1000
committed
With thanks from Omar of DearImGUI, updated the tutorial to the latest version of ImGUI, and updated the source code in line with his comments relayed in issue KhronosGroup#321
Remove stb_rect_pack.h and stb_textedit.h from imgui directory Delete unused STB library headers from attachments/simple_engine/imgui. These files are not required for the current ImGui integration.
1 parent bc6f001 commit 7cd0042

19 files changed

Lines changed: 54746 additions & 26564 deletions

‎attachments/simple_engine/CMakeLists.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@ set(SOURCES_COMMON
145145
imgui_system.cpp
146146
imgui/imgui.cpp
147147
imgui/imgui_draw.cpp
148+
imgui/imgui_tables.cpp
149+
imgui/imgui_widgets.cpp
148150
vulkan_device.cpp
149151
pipeline.cpp
150152
descriptor_manager.cpp

‎attachments/simple_engine/imgui/LICENSE.txt‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2014-2026 Omar Cornut
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎attachments/simple_engine/imgui/imconfig.h‎

Lines changed: 126 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,149 @@
11
//-----------------------------------------------------------------------------
2-
// USER IMPLEMENTATION
3-
// This file contains compile-time options for ImGui.
4-
// Other options (memory allocation overrides, callbacks, etc.) can be set at runtime via the ImGuiIO structure - ImGui::GetIO().
2+
// DEAR IMGUI COMPILE-TIME OPTIONS
3+
// Runtime options (clipboard callbacks, enabling various features, etc.) can generally be set via the ImGuiIO structure.
4+
// You can use ImGui::SetAllocatorFunctions() before calling ImGui::CreateContext() to rewire memory allocation functions.
5+
//-----------------------------------------------------------------------------
6+
// A) You may edit imconfig.h (and not overwrite it when updating Dear ImGui, or maintain a patch/rebased branch with your modifications to it)
7+
// B) or '#define IMGUI_USER_CONFIG "my_imgui_config.h"' in your project and then add directives in your own file without touching this template.
8+
//-----------------------------------------------------------------------------
9+
// You need to make sure that configuration settings are defined consistently _everywhere_ Dear ImGui is used, which include the imgui*.cpp
10+
// files but also _any_ of your code that uses Dear ImGui. This is because some compile-time options have an affect on data structures.
11+
// Defining those options in imconfig.h will ensure every compilation unit gets to see the same data structure layouts.
12+
// Call IMGUI_CHECKVERSION() from your .cpp file to verify that the data structures your files are using are matching the ones imgui.cpp is using.
513
//-----------------------------------------------------------------------------
614

715
#pragma once
816

917
//---- Define assertion handler. Defaults to calling assert().
10-
// #define IM_ASSERT(_EXPR) MyAssert(_EXPR)
18+
// - If your macro uses multiple statements, make sure is enclosed in a 'do { .. } while (0)' block so it can be used as a single statement.
19+
// - Compiling with NDEBUG will usually strip out assert() to nothing, which is NOT recommended because we use asserts to notify of programmer mistakes.
20+
//#define IM_ASSERT(_EXPR) MyAssert(_EXPR)
21+
//#define IM_ASSERT(_EXPR) ((void)(_EXPR)) // Disable asserts
22+
23+
//---- Define attributes of all API symbols declarations, e.g. for DLL under Windows
24+
// Using Dear ImGui via a shared library is not recommended, because of function call overhead and because we don't guarantee backward nor forward ABI compatibility.
25+
// - Windows DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions()
26+
// for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for more details.
27+
//#define IMGUI_API __declspec(dllexport) // MSVC Windows: DLL export
28+
//#define IMGUI_API __declspec(dllimport) // MSVC Windows: DLL import
29+
//#define IMGUI_API __attribute__((visibility("default"))) // GCC/Clang: override visibility when set is hidden
30+
31+
//---- Don't define obsolete functions/enums/behaviors. Consider enabling from time to time after updating to clean your code of obsolete function/names.
32+
//#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS
33+
34+
//---- Disable all of Dear ImGui or don't implement standard windows/tools.
35+
// It is very strongly recommended to NOT disable the demo windows and debug tool during development. They are extremely useful in day to day work. Please read comments in imgui_demo.cpp.
36+
//#define IMGUI_DISABLE // Disable everything: all headers and source files will be empty.
37+
//#define IMGUI_DISABLE_DEMO_WINDOWS // Disable demo windows: ShowDemoWindow()/ShowStyleEditor() will be empty.
38+
//#define IMGUI_DISABLE_DEBUG_TOOLS // Disable metrics/debugger and other debug tools: ShowMetricsWindow(), ShowDebugLogWindow() and ShowIDStackToolWindow() will be empty.
39+
40+
//---- Don't implement some functions to reduce linkage requirements.
41+
//#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS // [Win32] Don't implement default clipboard handler. Won't use and link with OpenClipboard/GetClipboardData/CloseClipboard etc. (user32.lib/.a, kernel32.lib/.a)
42+
//#define IMGUI_ENABLE_WIN32_DEFAULT_IME_FUNCTIONS // [Win32] [Default with Visual Studio] Implement default IME handler (require imm32.lib/.a, auto-link for Visual Studio, -limm32 on command-line for MinGW)
43+
//#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS // [Win32] [Default with non-Visual Studio compilers] Don't implement default IME handler (won't require imm32.lib/.a)
44+
//#define IMGUI_DISABLE_WIN32_FUNCTIONS // [Win32] Won't use and link with any Win32 function (clipboard, IME).
45+
//#define IMGUI_ENABLE_OSX_DEFAULT_CLIPBOARD_FUNCTIONS // [OSX] Implement default OSX clipboard handler (need to link with '-framework ApplicationServices', this is why this is not the default).
46+
//#define IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS // Don't implement default platform_io.Platform_OpenInShellFn() handler (Win32: ShellExecute(), require shell32.lib/.a, Mac/Linux: use system("")).
47+
//#define IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS // Don't implement ImFormatString/ImFormatStringV so you can implement them yourself (e.g. if you don't want to link with vsnprintf)
48+
//#define IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS // Don't implement ImFabs/ImSqrt/ImPow/ImFmod/ImCos/ImSin/ImAcos/ImAtan2 so you can implement them yourself.
49+
//#define IMGUI_DISABLE_FILE_FUNCTIONS // Don't implement ImFileOpen/ImFileClose/ImFileRead/ImFileWrite and ImFileHandle at all (replace them with dummies)
50+
//#define IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS // Don't implement ImFileOpen/ImFileClose/ImFileRead/ImFileWrite and ImFileHandle so you can implement them yourself if you don't want to link with fopen/fclose/fread/fwrite. This will also disable the LogToTTY() function.
51+
//#define IMGUI_DISABLE_DEFAULT_ALLOCATORS // Don't implement default allocators calling malloc()/free() to avoid linking with them. You will need to call ImGui::SetAllocatorFunctions().
52+
//#define IMGUI_DISABLE_DEFAULT_FONT // Disable default embedded fonts (ProggyClean + ProggyForever). Remove ~9 KB + ~14 KB from output binary. AddFontDefaultXXX() functions will assert.
53+
//#define IMGUI_DISABLE_DEFAULT_FONT_BITMAP // Disable default embedded bitmap font (ProggyClean). Remove ~9 KB from output binary. AddFontDefaultBitmap() will assert.
54+
//#define IMGUI_DISABLE_DEFAULT_FONT_VECTOR // Disable default embedded vector font (ProggyForever), Remove ~14 KB from output binary. AddFontDefaultVector() will assert.
55+
//#define IMGUI_DISABLE_SSE // Disable use of SSE intrinsics even if available
56+
57+
//---- Enable Test Engine / Automation features.
58+
//#define IMGUI_ENABLE_TEST_ENGINE // Enable imgui_test_engine hooks. Generally set automatically by include "imgui_te_config.h", see Test Engine for details.
59+
60+
//---- Include imgui_user.h at the end of imgui.h as a convenience
61+
// May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included.
62+
//#define IMGUI_INCLUDE_IMGUI_USER_H
63+
//#define IMGUI_USER_H_FILENAME "my_folder/my_imgui_user.h"
1164

12-
//---- Define attributes of all API symbols declarations, e.g. for DLL under Windows.
13-
// #define IMGUI_API __declspec( dllexport )
14-
// #define IMGUI_API __declspec( dllimport )
65+
//---- Pack vertex colors as BGRA8 instead of RGBA8 (to avoid converting from one to another). Need dedicated backend support.
66+
//#define IMGUI_USE_BGRA_PACKED_COLOR
1567

16-
//---- Include imgui_user.h at the end of imgui.h
17-
// #define IMGUI_INCLUDE_IMGUI_USER_H
68+
//---- Use legacy CRC32-adler tables (used before 1.91.6), in order to preserve old .ini data that you cannot afford to invalidate.
69+
//#define IMGUI_USE_LEGACY_CRC32_ADLER
1870

19-
//---- Don't implement default handlers for Windows (so as not to link with OpenClipboard() and others Win32 functions)
20-
// #define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCS
21-
// #define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCS
71+
//---- Use 32-bit for ImWchar (default is 16-bit) to support Unicode planes 1-16. (e.g. point beyond 0xFFFF like emoticons, dingbats, symbols, shapes, ancient languages, etc...)
72+
//#define IMGUI_USE_WCHAR32
2273

23-
//---- Don't implement help and test window functionality (ShowUserGuide()/ShowStyleEditor()/ShowTestWindow() methods will be empty)
24-
// #define IMGUI_DISABLE_TEST_WINDOWS
74+
//---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version
75+
// By default the embedded implementations are declared static and not available outside of Dear ImGui sources files.
76+
//#define IMGUI_STB_TRUETYPE_FILENAME "my_folder/stb_truetype.h"
77+
//#define IMGUI_STB_RECT_PACK_FILENAME "my_folder/stb_rect_pack.h"
78+
//#define IMGUI_STB_SPRINTF_FILENAME "my_folder/stb_sprintf.h" // only used if IMGUI_USE_STB_SPRINTF is defined.
79+
//#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION
80+
//#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION
81+
//#define IMGUI_DISABLE_STB_SPRINTF_IMPLEMENTATION // only disabled if IMGUI_USE_STB_SPRINTF is defined.
2582

26-
//---- Don't define obsolete functions names
27-
// #define IMGUI_DISABLE_OBSOLETE_FUNCTIONS
83+
//---- Use stb_sprintf.h for a faster implementation of vsnprintf instead of the one from libc (unless IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS is defined)
84+
// Compatibility checks of arguments and formats done by clang and GCC will be disabled in order to support the extra formats provided by stb_sprintf.h.
85+
//#define IMGUI_USE_STB_SPRINTF
2886

29-
//---- Implement STB libraries in a namespace to avoid conflicts
30-
// #define IMGUI_STB_NAMESPACE ImGuiStb
87+
//---- Use FreeType to build and rasterize the font atlas (instead of stb_truetype which is embedded by default in Dear ImGui)
88+
// Requires FreeType headers to be available in the include path. Requires program to be compiled with 'misc/freetype/imgui_freetype.cpp' (in this repository) + the FreeType library (not provided).
89+
// Note that imgui_freetype.cpp may be used _without_ this define, if you manually call ImFontAtlas::SetFontLoader(). The define is simply a convenience.
90+
// On Windows you may use vcpkg with 'vcpkg install freetype --triplet=x64-windows' + 'vcpkg integrate install'.
91+
//#define IMGUI_ENABLE_FREETYPE
3192

32-
//---- Define constructor and implicit cast operators to convert back<>forth from your math types and ImVec2/ImVec4.
93+
//---- Use FreeType + plutosvg or lunasvg to render OpenType SVG fonts (SVGinOT)
94+
// Only works in combination with IMGUI_ENABLE_FREETYPE.
95+
// - plutosvg is currently easier to install, as e.g. it is part of vcpkg. It will support more fonts and may load them faster. See misc/freetype/README for instructions.
96+
// - Both require headers to be available in the include path + program to be linked with the library code (not provided).
97+
// - (note: lunasvg implementation is based on Freetype's rsvg-port.c which is licensed under CeCILL-C Free Software License Agreement)
98+
//#define IMGUI_ENABLE_FREETYPE_PLUTOSVG
99+
//#define IMGUI_ENABLE_FREETYPE_LUNASVG
100+
101+
//---- Use stb_truetype to build and rasterize the font atlas (default)
102+
// The only purpose of this define is if you want force compilation of the stb_truetype backend ALONG with the FreeType backend.
103+
//#define IMGUI_ENABLE_STB_TRUETYPE
104+
105+
//---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4.
106+
// This will be inlined as part of ImVec2 and ImVec4 class declarations.
33107
/*
34-
#define IM_VEC2_CLASS_EXTRA \
35-
ImVec2(const MyVec2& f) { x = f.x; y = f.y; } \
108+
#define IM_VEC2_CLASS_EXTRA \
109+
constexpr ImVec2(const MyVec2& f) : x(f.x), y(f.y) {} \
36110
operator MyVec2() const { return MyVec2(x,y); }
37111
38-
#define IM_VEC4_CLASS_EXTRA \
39-
ImVec4(const MyVec4& f) { x = f.x; y = f.y; z = f.z; w = f.w; } \
112+
#define IM_VEC4_CLASS_EXTRA \
113+
constexpr ImVec4(const MyVec4& f) : x(f.x), y(f.y), z(f.z), w(f.w) {} \
40114
operator MyVec4() const { return MyVec4(x,y,z,w); }
41115
*/
116+
//---- ...Or use Dear ImGui's own very basic math operators.
117+
//#define IMGUI_DEFINE_MATH_OPERATORS
118+
119+
//---- Use 32-bit vertex indices (default is 16-bit) is one way to allow large meshes with more than 64K vertices.
120+
// Your renderer backend will need to support it (most example renderer backends support both 16/32-bit indices).
121+
// Another way to allow large meshes while keeping 16-bit indices is to handle ImDrawCmd::VtxOffset in your renderer.
122+
// Read about ImGuiBackendFlags_RendererHasVtxOffset for details.
123+
//#define ImDrawIdx unsigned int
124+
125+
//---- Override ImDrawCallback signature (will need to modify renderer backends accordingly)
126+
//struct ImDrawList;
127+
//struct ImDrawCmd;
128+
//typedef void (*MyImDrawCallback)(const ImDrawList* draw_list, const ImDrawCmd* cmd, void* my_renderer_user_data);
129+
//#define ImDrawCallback MyImDrawCallback
42130

43-
//---- Tip: You can add extra functions within the ImGui:: namespace, here or in your own headers files.
44-
//---- e.g. create variants of the ImGui::Value() helper for your low-level math types, or your own widgets/helpers.
131+
//---- Debug Tools: Macro to break in Debugger (we provide a default implementation of this in the codebase)
132+
// (use 'Metrics->Tools->Item Picker' to pick widgets with the mouse and break into them for easy debugging.)
133+
//#define IM_DEBUG_BREAK IM_ASSERT(0)
134+
//#define IM_DEBUG_BREAK __debugbreak()
135+
136+
//---- Debug Tools: Enable highlight ID conflicts _before_ hovering items. When io.ConfigDebugHighlightIdConflicts is set.
137+
// (THIS WILL SLOW DOWN DEAR IMGUI. Only use occasionally and disable after use)
138+
//#define IMGUI_DEBUG_HIGHLIGHT_ALL_ID_CONFLICTS
139+
140+
//---- Debug Tools: Enable slower asserts
141+
//#define IMGUI_DEBUG_PARANOID
142+
143+
//---- Tip: You can add extra functions within the ImGui:: namespace from anywhere (e.g. your own sources/header files)
45144
/*
46145
namespace ImGui
47146
{
48-
void Value(const char* prefix, const MyMatrix44& v, const char* float_format = NULL);
147+
void MyFunction(const char* name, MyMatrix44* mtx);
49148
}
50-
*/
149+
*/

0 commit comments

Comments
 (0)