upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/src/imgui/imconfig.h
diff options
context:
space:
mode:
authorbitflash-coin <bookofshamers@outlook.com>2026-08-04 06:34:32 -0700
committerbitflash-coin <bookofshamers@outlook.com>2026-08-04 06:34:32 -0700
commit5ce650382352c1503f40abf08129ada69402af55 (patch)
tree6a18198901f1e2c4933f1ac53c9365eec512bf63 /src/imgui/imconfig.h
parentf34113291da7e5e3dc7d2468d4f9c212c05c584b (diff)
public commit
Diffstat (limited to 'src/imgui/imconfig.h')
-rw-r--r--src/imgui/imconfig.h150
1 files changed, 150 insertions, 0 deletions
diff --git a/src/imgui/imconfig.h b/src/imgui/imconfig.h
new file mode 100644
index 0000000..b40db38
--- /dev/null
+++ b/src/imgui/imconfig.h
@@ -0,0 +1,150 @@
1//-----------------------------------------------------------------------------
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.
13//-----------------------------------------------------------------------------
14
15#pragma once
16
17//---- Define assertion handler. Defaults to calling assert().
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_TIME_FUNCTIONS // Don't setup default platform_io.Platform_SessionDate value using time(), localtime_r().
47//#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("")).
48//#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)
49//#define IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS // Don't implement ImFabs/ImSqrt/ImPow/ImFmod/ImCos/ImSin/ImAcos/ImAtan2 so you can implement them yourself.
50//#define IMGUI_DISABLE_FILE_FUNCTIONS // Don't implement ImFileOpen/ImFileClose/ImFileRead/ImFileWrite and ImFileHandle at all (replace them with dummies)
51//#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.
52//#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().
53//#define IMGUI_DISABLE_DEFAULT_FONT // Disable default embedded fonts (ProggyClean + ProggyForever). Remove ~9 KB + ~14 KB from output binary. AddFontDefaultXXX() functions will assert.
54//#define IMGUI_DISABLE_DEFAULT_FONT_BITMAP // Disable default embedded bitmap font (ProggyClean). Remove ~9 KB from output binary. AddFontDefaultBitmap() will assert.
55//#define IMGUI_DISABLE_DEFAULT_FONT_VECTOR // Disable default embedded vector font (ProggyForever), Remove ~14 KB from output binary. AddFontDefaultVector() will assert.
56//#define IMGUI_DISABLE_SSE // Disable use of SSE intrinsics even if available
57
58//---- Enable Test Engine / Automation features.
59//#define IMGUI_ENABLE_TEST_ENGINE // Enable imgui_test_engine hooks. Generally set automatically by include "imgui_te_imconfig.h", see Test Engine for details.
60
61//---- Include imgui_user.h at the end of imgui.h as a convenience
62// May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included.
63//#define IMGUI_INCLUDE_IMGUI_USER_H
64//#define IMGUI_USER_H_FILENAME "my_folder/my_imgui_user.h"
65
66//---- Pack vertex colors as BGRA8 instead of RGBA8 (to avoid converting from one to another). Need dedicated backend support.
67//#define IMGUI_USE_BGRA_PACKED_COLOR
68
69//---- Use legacy CRC32-adler tables (used before 1.91.6), in order to preserve old .ini data that you cannot afford to invalidate.
70//#define IMGUI_USE_LEGACY_CRC32_ADLER
71
72//---- 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...)
73//#define IMGUI_USE_WCHAR32
74
75//---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version
76// By default the embedded implementations are declared static and not available outside of Dear ImGui sources files.
77//#define IMGUI_STB_TRUETYPE_FILENAME "my_folder/stb_truetype.h"
78//#define IMGUI_STB_RECT_PACK_FILENAME "my_folder/stb_rect_pack.h"
79//#define IMGUI_STB_SPRINTF_FILENAME "my_folder/stb_sprintf.h" // only used if IMGUI_USE_STB_SPRINTF is defined.
80//#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION
81//#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION
82//#define IMGUI_DISABLE_STB_SPRINTF_IMPLEMENTATION // only disabled if IMGUI_USE_STB_SPRINTF is defined.
83
84//---- Use stb_sprintf.h for a faster implementation of vsnprintf instead of the one from libc (unless IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS is defined)
85// 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.
86//#define IMGUI_USE_STB_SPRINTF
87
88//---- Use FreeType to build and rasterize the font atlas (instead of stb_truetype which is embedded by default in Dear ImGui)
89// 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).
90// Note that imgui_freetype.cpp may be used _without_ this define, if you manually call ImFontAtlas::SetFontLoader(). The define is simply a convenience.
91// On Windows you may use vcpkg with 'vcpkg install freetype --triplet=x64-windows' + 'vcpkg integrate install'.
92//#define IMGUI_ENABLE_FREETYPE
93
94//---- Use FreeType + plutosvg or lunasvg to render OpenType SVG fonts (SVGinOT)
95// Only works in combination with IMGUI_ENABLE_FREETYPE.
96// - 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.
97// - Both require headers to be available in the include path + program to be linked with the library code (not provided).
98// - (note: lunasvg implementation is based on Freetype's rsvg-port.c which is licensed under CeCILL-C Free Software License Agreement)
99//#define IMGUI_ENABLE_FREETYPE_PLUTOSVG
100//#define IMGUI_ENABLE_FREETYPE_LUNASVG
101
102//---- Use stb_truetype to build and rasterize the font atlas (default)
103// The only purpose of this define is if you want force compilation of the stb_truetype backend ALONG with the FreeType backend.
104//#define IMGUI_ENABLE_STB_TRUETYPE
105
106//---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4.
107// This will be inlined as part of ImVec2 and ImVec4 class declarations.
108/*
109#define IM_VEC2_CLASS_EXTRA \
110 constexpr ImVec2(const MyVec2& f) : x(f.x), y(f.y) {} \
111 operator MyVec2() const { return MyVec2(x,y); }
112
113#define IM_VEC4_CLASS_EXTRA \
114 constexpr ImVec4(const MyVec4& f) : x(f.x), y(f.y), z(f.z), w(f.w) {} \
115 operator MyVec4() const { return MyVec4(x,y,z,w); }
116*/
117//---- ...Or use Dear ImGui's own very basic math operators.
118//#define IMGUI_DEFINE_MATH_OPERATORS
119
120//---- Use 32-bit vertex indices (default is 16-bit) is one way to allow large meshes with more than 64K vertices.
121// Your renderer backend will need to support it (most example renderer backends support both 16/32-bit indices).
122// Another way to allow large meshes while keeping 16-bit indices is to handle ImDrawCmd::VtxOffset in your renderer.
123// Read about ImGuiBackendFlags_RendererHasVtxOffset for details.
124//#define ImDrawIdx unsigned int
125
126//---- Override ImDrawCallback signature (will need to modify renderer backends accordingly)
127//struct ImDrawList;
128//struct ImDrawCmd;
129//typedef void (*MyImDrawCallback)(const ImDrawList* draw_list, const ImDrawCmd* cmd, void* my_renderer_user_data);
130//#define ImDrawCallback MyImDrawCallback
131
132//---- Debug Tools: Macro to break in Debugger (we provide a default implementation of this in the codebase)
133// (use 'Metrics->Tools->Item Picker' to pick widgets with the mouse and break into them for easy debugging.)
134//#define IM_DEBUG_BREAK IM_ASSERT(0)
135//#define IM_DEBUG_BREAK __debugbreak()
136
137//---- Debug Tools: Enable highlight ID conflicts _before_ hovering items. When io.ConfigDebugHighlightIdConflicts is set.
138// (THIS WILL SLOW DOWN DEAR IMGUI. Only use occasionally and disable after use)
139//#define IMGUI_DEBUG_HIGHLIGHT_ALL_ID_CONFLICTS
140
141//---- Debug Tools: Enable slower asserts
142//#define IMGUI_DEBUG_PARANOID
143
144//---- Tip: You can add extra functions within the ImGui:: namespace from anywhere (e.g. your own sources/header files)
145/*
146namespace ImGui
147{
148 void MyFunction(const char* name, MyMatrix44* mtx);
149}
150*/