| 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 | // #define IM_ASSERT(_EXPR) MyAssert(_EXPR) |
|---|
| 20 | // #define IM_ASSERT(_EXPR) ((void)(_EXPR)) // Disable asserts |
|---|
| 21 | |
|---|
| 22 | //---- Define attributes of all API symbols declarations, e.g. for DLL under Windows |
|---|
| 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 | // - 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 |
|---|
| 29 | |
|---|
| 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 | // #define IMGUI_DISABLE_OBSOLETE_KEYIO // 1.87+ disable legacy io.KeyMap[]+io.KeysDown[] in favor io.AddKeyEvent(). This is automatically done by 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 io.PlatformOpenInShellFn() 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_SSE // Disable use of SSE intrinsics even if available |
|---|
| 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 | |
|---|
| 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. |
|---|
| 59 | // #define IMGUI_INCLUDE_IMGUI_USER_H |
|---|
| 60 | // #define IMGUI_USER_H_FILENAME "my_folder/my_imgui_user.h" |
|---|
| 61 | |
|---|
| 62 | //---- Pack colors to BGRA8 instead of RGBA8 (to avoid converting from one to another) |
|---|
| 63 | // #define IMGUI_USE_BGRA_PACKED_COLOR |
|---|
| 64 | |
|---|
| 65 | //---- 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...) |
|---|
| 66 | // #define IMGUI_USE_WCHAR32 |
|---|
| 67 | |
|---|
| 68 | //---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version |
|---|
| 69 | // By default the embedded implementations are declared static and not available outside of Dear ImGui sources files. |
|---|
| 70 | // #define IMGUI_STB_TRUETYPE_FILENAME "my_folder/stb_truetype.h" |
|---|
| 71 | // #define IMGUI_STB_RECT_PACK_FILENAME "my_folder/stb_rect_pack.h" |
|---|
| 72 | // #define IMGUI_STB_SPRINTF_FILENAME "my_folder/stb_sprintf.h" // only used if IMGUI_USE_STB_SPRINTF is defined. |
|---|
| 73 | // #define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION |
|---|
| 74 | // #define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION |
|---|
| 75 | // #define IMGUI_DISABLE_STB_SPRINTF_IMPLEMENTATION // only disabled if IMGUI_USE_STB_SPRINTF is defined. |
|---|
| 76 | |
|---|
| 77 | //---- Use stb_sprintf.h for a faster implementation of vsnprintf instead of the one from libc (unless IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS is defined) |
|---|
| 78 | // 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. |
|---|
| 79 | // #define IMGUI_USE_STB_SPRINTF |
|---|
| 80 | |
|---|
| 81 | //---- Use FreeType to build and rasterize the font atlas (instead of stb_truetype which is embedded by default in Dear ImGui) |
|---|
| 82 | // 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). |
|---|
| 83 | // On Windows you may use vcpkg with 'vcpkg install freetype --triplet=x64-windows' + 'vcpkg integrate install'. |
|---|
| 84 | // #define IMGUI_ENABLE_FREETYPE |
|---|
| 85 | |
|---|
| 86 | //---- Use FreeType+lunasvg library to render OpenType SVG fonts (SVGinOT) |
|---|
| 87 | // Requires lunasvg headers to be available in the include path + program to be linked with the lunasvg library (not provided). |
|---|
| 88 | // Only works in combination with IMGUI_ENABLE_FREETYPE. |
|---|
| 89 | // (implementation is based on Freetype's rsvg-port.c which is licensed under CeCILL-C Free Software License Agreement) |
|---|
| 90 | // #define IMGUI_ENABLE_FREETYPE_LUNASVG |
|---|
| 91 | |
|---|
| 92 | //---- Use stb_truetype to build and rasterize the font atlas (default) |
|---|
| 93 | // The only purpose of this define is if you want force compilation of the stb_truetype backend ALONG with the FreeType backend. |
|---|
| 94 | // #define IMGUI_ENABLE_STB_TRUETYPE |
|---|
| 95 | |
|---|
| 96 | //---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4. |
|---|
| 97 | // This will be inlined as part of ImVec2 and ImVec4 class declarations. |
|---|
| 98 | /* |
|---|
| 99 | #define IM_VEC2_CLASS_EXTRA \ |
|---|
| 100 | constexpr ImVec2(const MyVec2& f) : x(f.x), y(f.y) {} \ |
|---|
| 101 | operator MyVec2() const { return MyVec2(x,y); } |
|---|
| 102 | |
|---|
| 103 | #define IM_VEC4_CLASS_EXTRA \ |
|---|
| 104 | constexpr ImVec4(const MyVec4& f) : x(f.x), y(f.y), z(f.z), w(f.w) {} \ |
|---|
| 105 | operator MyVec4() const { return MyVec4(x,y,z,w); } |
|---|
| 106 | */ |
|---|
| 107 | //---- ...Or use Dear ImGui's own very basic math operators. |
|---|
| 108 | // #define IMGUI_DEFINE_MATH_OPERATORS |
|---|
| 109 | |
|---|
| 110 | //---- Use 32-bit vertex indices (default is 16-bit) is one way to allow large meshes with more than 64K vertices. |
|---|
| 111 | // Your renderer backend will need to support it (most example renderer backends support both 16/32-bit indices). |
|---|
| 112 | // Another way to allow large meshes while keeping 16-bit indices is to handle ImDrawCmd::VtxOffset in your renderer. |
|---|
| 113 | // Read about ImGuiBackendFlags_RendererHasVtxOffset for details. |
|---|
| 114 | // #define ImDrawIdx unsigned int |
|---|
| 115 | |
|---|
| 116 | //---- Override ImDrawCallback signature (will need to modify renderer backends accordingly) |
|---|
| 117 | // struct ImDrawList; |
|---|
| 118 | // struct ImDrawCmd; |
|---|
| 119 | // typedef void (*MyImDrawCallback)(const ImDrawList* draw_list, const ImDrawCmd* cmd, void* my_renderer_user_data); |
|---|
| 120 | // #define ImDrawCallback MyImDrawCallback |
|---|
| 121 | |
|---|
| 122 | //---- Debug Tools: Macro to break in Debugger (we provide a default implementation of this in the codebase) |
|---|
| 123 | // (use 'Metrics->Tools->Item Picker' to pick widgets with the mouse and break into them for easy debugging.) |
|---|
| 124 | // #define IM_DEBUG_BREAK IM_ASSERT(0) |
|---|
| 125 | // #define IM_DEBUG_BREAK __debugbreak() |
|---|
| 126 | |
|---|
| 127 | //---- Debug Tools: Enable slower asserts |
|---|
| 128 | // #define IMGUI_DEBUG_PARANOID |
|---|
| 129 | |
|---|
| 130 | //---- Tip: You can add extra functions within the ImGui:: namespace from anywhere (e.g. your own sources/header files) |
|---|
| 131 | /* |
|---|
| 132 | namespace ImGui |
|---|
| 133 | { |
|---|
| 134 | void MyFunction(const char* name, MyMatrix44* mtx); |
|---|
| 135 | } |
|---|
| 136 | */ |
|---|
| 137 | |
|---|
