|
| 1 | +//----------------------------------------------------------------------------- |
| 2 | +// COMPILE-TIME OPTIONS FOR DEAR IMGUI |
| 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 files 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 | +// 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 ) |
| 28 | + |
| 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 | + |
| 32 | +//---- Disable all of Dear ImGui or don't implement standard windows. |
| 33 | +// It is very strongly recommended to NOT disable the demo windows during development. Please read comments in imgui_demo.cpp. |
| 34 | +//#define IMGUI_DISABLE // Disable everything: all headers and source files will be empty. |
| 35 | +//#define IMGUI_DISABLE_DEMO_WINDOWS // Disable demo windows: ShowDemoWindow()/ShowStyleEditor() will be empty. Not recommended. |
| 36 | +//#define IMGUI_DISABLE_METRICS_WINDOW // Disable metrics/debugger and other debug tools: ShowMetricsWindow() and ShowStackToolWindow() will be empty. |
| 37 | + |
| 38 | +//---- Don't implement some functions to reduce linkage requirements. |
| 39 | +//#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) |
| 40 | +//#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) |
| 41 | +//#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) |
| 42 | +//#define IMGUI_DISABLE_WIN32_FUNCTIONS // [Win32] Won't use and link with any Win32 function (clipboard, ime). |
| 43 | +//#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). |
| 44 | +//#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) |
| 45 | +//#define IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS // Don't implement ImFabs/ImSqrt/ImPow/ImFmod/ImCos/ImSin/ImAcos/ImAtan2 so you can implement them yourself. |
| 46 | +//#define IMGUI_DISABLE_FILE_FUNCTIONS // Don't implement ImFileOpen/ImFileClose/ImFileRead/ImFileWrite and ImFileHandle at all (replace them with dummies) |
| 47 | +//#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. |
| 48 | +//#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(). |
| 49 | +//#define IMGUI_DISABLE_SSE // Disable use of SSE intrinsics even if available |
| 50 | + |
| 51 | +//---- Include imgui_user.h at the end of imgui.h as a convenience |
| 52 | +//#define IMGUI_INCLUDE_IMGUI_USER_H |
| 53 | + |
| 54 | +//---- Pack colors to BGRA8 instead of RGBA8 (to avoid converting from one to another) |
| 55 | +//#define IMGUI_USE_BGRA_PACKED_COLOR |
| 56 | + |
| 57 | +//---- 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...) |
| 58 | +//#define IMGUI_USE_WCHAR32 |
| 59 | + |
| 60 | +//---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version |
| 61 | +// By default the embedded implementations are declared static and not available outside of Dear ImGui sources files. |
| 62 | +//#define IMGUI_STB_TRUETYPE_FILENAME "my_folder/stb_truetype.h" |
| 63 | +//#define IMGUI_STB_RECT_PACK_FILENAME "my_folder/stb_rect_pack.h" |
| 64 | +//#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION |
| 65 | +//#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION |
| 66 | + |
| 67 | +//---- Use stb_printf's faster implementation of vsnprintf instead of the one from libc (unless IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS is defined) |
| 68 | +// Requires 'stb_sprintf.h' to be available in the include path. 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. |
| 69 | +// #define IMGUI_USE_STB_SPRINTF |
| 70 | + |
| 71 | +//---- Use FreeType to build and rasterize the font atlas (instead of stb_truetype which is embedded by default in Dear ImGui) |
| 72 | +// 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). |
| 73 | +// On Windows you may use vcpkg with 'vcpkg install freetype --triplet=x64-windows' + 'vcpkg integrate install'. |
| 74 | +//#define IMGUI_ENABLE_FREETYPE |
| 75 | + |
| 76 | +//---- Use stb_truetype to build and rasterize the font atlas (default) |
| 77 | +// The only purpose of this define is if you want force compilation of the stb_truetype backend ALONG with the FreeType backend. |
| 78 | +//#define IMGUI_ENABLE_STB_TRUETYPE |
| 79 | + |
| 80 | +//---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4. |
| 81 | +// This will be inlined as part of ImVec2 and ImVec4 class declarations. |
| 82 | +/* |
| 83 | +#define IM_VEC2_CLASS_EXTRA \ |
| 84 | + ImVec2(const MyVec2& f) { x = f.x; y = f.y; } \ |
| 85 | + operator MyVec2() const { return MyVec2(x,y); } |
| 86 | +
|
| 87 | +#define IM_VEC4_CLASS_EXTRA \ |
| 88 | + ImVec4(const MyVec4& f) { x = f.x; y = f.y; z = f.z; w = f.w; } \ |
| 89 | + operator MyVec4() const { return MyVec4(x,y,z,w); } |
| 90 | +*/ |
| 91 | + |
| 92 | +//---- Use 32-bit vertex indices (default is 16-bit) is one way to allow large meshes with more than 64K vertices. |
| 93 | +// Your renderer backend will need to support it (most example renderer backends support both 16/32-bit indices). |
| 94 | +// Another way to allow large meshes while keeping 16-bit indices is to handle ImDrawCmd::VtxOffset in your renderer. |
| 95 | +// Read about ImGuiBackendFlags_RendererHasVtxOffset for details. |
| 96 | +//#define ImDrawIdx unsigned int |
| 97 | + |
| 98 | +//---- Override ImDrawCallback signature (will need to modify renderer backends accordingly) |
| 99 | +//struct ImDrawList; |
| 100 | +//struct ImDrawCmd; |
| 101 | +//typedef void (*MyImDrawCallback)(const ImDrawList* draw_list, const ImDrawCmd* cmd, void* my_renderer_user_data); |
| 102 | +//#define ImDrawCallback MyImDrawCallback |
| 103 | + |
| 104 | +//---- Debug Tools: Macro to break in Debugger |
| 105 | +// (use 'Metrics->Tools->Item Picker' to pick widgets with the mouse and break into them for easy debugging.) |
| 106 | +//#define IM_DEBUG_BREAK IM_ASSERT(0) |
| 107 | +//#define IM_DEBUG_BREAK __debugbreak() |
| 108 | + |
| 109 | +//---- Debug Tools: Have the Item Picker break in the ItemAdd() function instead of ItemHoverable(), |
| 110 | +// (which comes earlier in the code, will catch a few extra items, allow picking items other than Hovered one.) |
| 111 | +// This adds a small runtime cost which is why it is not enabled by default. |
| 112 | +//#define IMGUI_DEBUG_TOOL_ITEM_PICKER_EX |
| 113 | + |
| 114 | +//---- Debug Tools: Enable slower asserts |
| 115 | +//#define IMGUI_DEBUG_PARANOID |
| 116 | + |
| 117 | +//---- Tip: You can add extra functions within the ImGui:: namespace, here or in your own headers files. |
| 118 | +/* |
| 119 | +namespace ImGui |
| 120 | +{ |
| 121 | + void MyFunction(const char* name, const MyMatrix44& v); |
| 122 | +} |
| 123 | +*/ |
0 commit comments