|
1 | 1 | //----------------------------------------------------------------------------- |
2 | | -// COMPILE-TIME OPTIONS FOR DEAR IMGUI |
| 2 | +// DEAR IMGUI COMPILE-TIME OPTIONS |
3 | 3 | // Runtime options (clipboard callbacks, enabling various features, etc.) can generally be set via the ImGuiIO structure. |
4 | 4 | // You can use ImGui::SetAllocatorFunctions() before calling ImGui::CreateContext() to rewire memory allocation functions. |
5 | 5 | //----------------------------------------------------------------------------- |
|
9 | 9 | // You need to make sure that configuration settings are defined consistently _everywhere_ Dear ImGui is used, which include the imgui*.cpp |
10 | 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 | 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 files to verify that the data structures your files are using are matching the ones imgui.cpp is using. |
| 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 | 13 | //----------------------------------------------------------------------------- |
14 | 14 |
|
15 | 15 | #pragma once |
|
21 | 21 |
|
22 | 22 | //---- Define attributes of all API symbols declarations, e.g. for DLL under Windows |
23 | 23 | // 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. |
24 | | -// DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions() |
25 | | -// for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for more details. |
26 | | -//#define IMGUI_API __declspec( dllexport ) |
27 | | -//#define IMGUI_API __declspec( dllimport ) |
| 24 | +// - Windows DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions() |
| 25 | +// for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for more details. |
| 26 | +//#define IMGUI_API __declspec(dllexport) // MSVC Windows: DLL export |
| 27 | +//#define IMGUI_API __declspec(dllimport) // MSVC Windows: DLL import |
| 28 | +//#define IMGUI_API __attribute__((visibility("default"))) // GCC/Clang: override visibility when set is hidden |
28 | 29 |
|
29 | | -//---- Don't define obsolete functions/enums/behaviors. Consider enabling from time to time after updating to avoid using soon-to-be obsolete function/names. |
30 | | -#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS |
31 | | -#define IMGUI_DISABLE_OBSOLETE_KEYIO // 1.87: disable legacy io.KeyMap[]+io.KeysDown[] in favor io.AddKeyEvent(). This will be folded into IMGUI_DISABLE_OBSOLETE_FUNCTIONS in a few versions. |
| 30 | +//---- Don't define obsolete functions/enums/behaviors. Consider enabling from time to time after updating to clean your code of obsolete function/names. |
| 31 | +//#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS |
32 | 32 |
|
33 | 33 | //---- Disable all of Dear ImGui or don't implement standard windows/tools. |
34 | 34 | // 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. |
35 | 35 | //#define IMGUI_DISABLE // Disable everything: all headers and source files will be empty. |
36 | 36 | //#define IMGUI_DISABLE_DEMO_WINDOWS // Disable demo windows: ShowDemoWindow()/ShowStyleEditor() will be empty. |
37 | | -//#define IMGUI_DISABLE_DEBUG_TOOLS // Disable metrics/debugger and other debug tools: ShowMetricsWindow(), ShowDebugLogWindow() and ShowStackToolWindow() will be empty (this was called IMGUI_DISABLE_METRICS_WINDOW before 1.88). |
| 37 | +//#define IMGUI_DISABLE_DEBUG_TOOLS // Disable metrics/debugger and other debug tools: ShowMetricsWindow(), ShowDebugLogWindow() and ShowIDStackToolWindow() will be empty. |
38 | 38 |
|
39 | 39 | //---- Don't implement some functions to reduce linkage requirements. |
40 | 40 | //#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) |
41 | 41 | //#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) |
42 | 42 | //#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) |
43 | | -//#define IMGUI_DISABLE_WIN32_FUNCTIONS // [Win32] Won't use and link with any Win32 function (clipboard, ime). |
| 43 | +//#define IMGUI_DISABLE_WIN32_FUNCTIONS // [Win32] Won't use and link with any Win32 function (clipboard, IME). |
44 | 44 | //#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). |
| 45 | +//#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("")). |
45 | 46 | //#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) |
46 | 47 | //#define IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS // Don't implement ImFabs/ImSqrt/ImPow/ImFmod/ImCos/ImSin/ImAcos/ImAtan2 so you can implement them yourself. |
47 | 48 | //#define IMGUI_DISABLE_FILE_FUNCTIONS // Don't implement ImFileOpen/ImFileClose/ImFileRead/ImFileWrite and ImFileHandle at all (replace them with dummies) |
48 | 49 | //#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. |
49 | 50 | //#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(). |
| 51 | +//#define IMGUI_DISABLE_DEFAULT_FONT // Disable default embedded font (ProggyClean.ttf), remove ~9.5 KB from output binary. AddFontDefault() will assert. |
50 | 52 | //#define IMGUI_DISABLE_SSE // Disable use of SSE intrinsics even if available |
51 | 53 |
|
| 54 | +//---- Enable Test Engine / Automation features. |
| 55 | +//#define IMGUI_ENABLE_TEST_ENGINE // Enable imgui_test_engine hooks. Generally set automatically by include "imgui_te_config.h", see Test Engine for details. |
| 56 | + |
52 | 57 | //---- Include imgui_user.h at the end of imgui.h as a convenience |
| 58 | +// May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included. |
53 | 59 | //#define IMGUI_INCLUDE_IMGUI_USER_H |
| 60 | +//#define IMGUI_USER_H_FILENAME "my_folder/my_imgui_user.h" |
54 | 61 |
|
55 | | -//---- Pack colors to BGRA8 instead of RGBA8 (to avoid converting from one to another) |
| 62 | +//---- Pack vertex colors as BGRA8 instead of RGBA8 (to avoid converting from one to another). Need dedicated backend support. |
56 | 63 | //#define IMGUI_USE_BGRA_PACKED_COLOR |
57 | 64 |
|
58 | | -//---- 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...) |
| 65 | +//---- Use legacy CRC32-adler tables (used before 1.91.6), in order to preserve old .ini data that you cannot afford to invalidate. |
| 66 | +//#define IMGUI_USE_LEGACY_CRC32_ADLER |
| 67 | + |
| 68 | +//---- 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...) |
59 | 69 | //#define IMGUI_USE_WCHAR32 |
60 | 70 |
|
61 | 71 | //---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version |
62 | 72 | // By default the embedded implementations are declared static and not available outside of Dear ImGui sources files. |
63 | 73 | //#define IMGUI_STB_TRUETYPE_FILENAME "my_folder/stb_truetype.h" |
64 | 74 | //#define IMGUI_STB_RECT_PACK_FILENAME "my_folder/stb_rect_pack.h" |
65 | | -//#define IMGUI_STB_SPRINTF_FILENAME "my_folder/stb_sprintf.h" // only used if enabled |
| 75 | +//#define IMGUI_STB_SPRINTF_FILENAME "my_folder/stb_sprintf.h" // only used if IMGUI_USE_STB_SPRINTF is defined. |
66 | 76 | //#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION |
67 | 77 | //#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION |
| 78 | +//#define IMGUI_DISABLE_STB_SPRINTF_IMPLEMENTATION // only disabled if IMGUI_USE_STB_SPRINTF is defined. |
68 | 79 |
|
69 | 80 | //---- Use stb_sprintf.h for a faster implementation of vsnprintf instead of the one from libc (unless IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS is defined) |
70 | 81 | // 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. |
|
75 | 86 | // On Windows you may use vcpkg with 'vcpkg install freetype --triplet=x64-windows' + 'vcpkg integrate install'. |
76 | 87 | //#define IMGUI_ENABLE_FREETYPE |
77 | 88 |
|
| 89 | +//---- Use FreeType + plutosvg or lunasvg to render OpenType SVG fonts (SVGinOT) |
| 90 | +// Only works in combination with IMGUI_ENABLE_FREETYPE. |
| 91 | +// - 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. |
| 92 | +// - Both require headers to be available in the include path + program to be linked with the library code (not provided). |
| 93 | +// - (note: lunasvg implementation is based on Freetype's rsvg-port.c which is licensed under CeCILL-C Free Software License Agreement) |
| 94 | +//#define IMGUI_ENABLE_FREETYPE_PLUTOSVG |
| 95 | +//#define IMGUI_ENABLE_FREETYPE_LUNASVG |
| 96 | + |
78 | 97 | //---- Use stb_truetype to build and rasterize the font atlas (default) |
79 | 98 | // The only purpose of this define is if you want force compilation of the stb_truetype backend ALONG with the FreeType backend. |
80 | 99 | //#define IMGUI_ENABLE_STB_TRUETYPE |
|
105 | 124 | //typedef void (*MyImDrawCallback)(const ImDrawList* draw_list, const ImDrawCmd* cmd, void* my_renderer_user_data); |
106 | 125 | //#define ImDrawCallback MyImDrawCallback |
107 | 126 |
|
108 | | -//---- Debug Tools: Macro to break in Debugger |
| 127 | +//---- Debug Tools: Macro to break in Debugger (we provide a default implementation of this in the codebase) |
109 | 128 | // (use 'Metrics->Tools->Item Picker' to pick widgets with the mouse and break into them for easy debugging.) |
110 | 129 | //#define IM_DEBUG_BREAK IM_ASSERT(0) |
111 | 130 | //#define IM_DEBUG_BREAK __debugbreak() |
112 | 131 |
|
113 | 132 | //---- Debug Tools: Enable slower asserts |
114 | 133 | //#define IMGUI_DEBUG_PARANOID |
115 | 134 |
|
116 | | -//---- Tip: You can add extra functions within the ImGui:: namespace, here or in your own headers files. |
| 135 | +//---- Tip: You can add extra functions within the ImGui:: namespace from anywhere (e.g. your own sources/header files) |
117 | 136 | /* |
118 | 137 | namespace ImGui |
119 | 138 | { |
120 | | - void MyFunction(const char* name, const MyMatrix44& v); |
| 139 | + void MyFunction(const char* name, MyMatrix44* mtx); |
121 | 140 | } |
122 | 141 | */ |
0 commit comments