src/imgui/imconfig.h

   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 imgui, or maintain a patch/branch with your modifications to imconfig.h)
   7 // B) or add configuration directives in your own file and compile with #define IMGUI_USER_CONFIG "myfilename.h"
   8 // If you do so you need to make sure that configuration settings are defined consistently _everywhere_ dear imgui is used, which include
   9 // the imgui*.cpp files but also _any_ of your code that uses imgui. This is because some compile-time options have an affect on data structures.
  10 // Defining those options in imconfig.h will ensure every compilation unit gets to see the same data structure layouts.
  11 // 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 //-----------------------------------------------------------------------------
  13
  14 #pragma once
  15
  16 // Have each embedded of ImGui define this symbol :
  17 struct ImGuiContext;
  18 extern thread_local ImGuiContext* __MesaImGui;
  19 #define GImGui __MesaImGui
  20
  21 //---- Define assertion handler. Defaults to calling assert().
  22 //#define IM_ASSERT(_EXPR)  MyAssert(_EXPR)
  23 //#define IM_ASSERT(_EXPR)  ((void)(_EXPR))     // Disable asserts
  24
  25 //---- Define attributes of all API symbols declarations, e.g. for DLL under Windows.
  26 //#define IMGUI_API __declspec( dllexport )
  27 //#define IMGUI_API __declspec( dllimport )
  28
  29 //---- Don't define obsolete functions/enums names. 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 //---- Don't implement demo windows functionality (ShowDemoWindow()/ShowStyleEditor()/ShowUserGuide() methods will be empty)
  33 //---- It is very strongly recommended to NOT disable the demo windows during development. Please read the comments in imgui_demo.cpp.
  34 //#define IMGUI_DISABLE_DEMO_WINDOWS
  35
  36 //---- Don't implement some functions to reduce linkage requirements.
  37 //#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS   // [Win32] Don't implement default clipboard handler. Won't use and link with OpenClipboard/GetClipboardData/CloseClipboard etc.
  38 //#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS         // [Win32] Don't implement default IME handler. Won't use and link with ImmGetContext/ImmSetCompositionWindow.
  39 //#define IMGUI_DISABLE_WIN32_FUNCTIONS                     // [Win32] Won't use and link with any Win32 function.
  40 //#define IMGUI_DISABLE_FORMAT_STRING_FUNCTIONS             // Don't implement ImFormatString/ImFormatStringV so you can implement them yourself if you don't want to link with vsnprintf.
  41 //#define IMGUI_DISABLE_MATH_FUNCTIONS                      // Don't implement ImFabs/ImSqrt/ImPow/ImFmod/ImCos/ImSin/ImAcos/ImAtan2 wrapper so you can implement them yourself. Declare your prototypes in imconfig.h.
  42 //#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().
  43
  44 //---- Include imgui_user.h at the end of imgui.h as a convenience
  45 //#define IMGUI_INCLUDE_IMGUI_USER_H
  46
  47 //---- Pack colors to BGRA8 instead of RGBA8 (to avoid converting from one to another)
  48 //#define IMGUI_USE_BGRA_PACKED_COLOR
  49
  50 //---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version
  51 // By default the embedded implementations are declared static and not available outside of imgui cpp files.
  52 //#define IMGUI_STB_TRUETYPE_FILENAME   "my_folder/stb_truetype.h"
  53 //#define IMGUI_STB_RECT_PACK_FILENAME  "my_folder/stb_rect_pack.h"
  54 //#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION
  55 //#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION
  56
  57 //---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4.
  58 // This will be inlined as part of ImVec2 and ImVec4 class declarations.
  59 /*
  60 #define IM_VEC2_CLASS_EXTRA                                                 \
  61         ImVec2(const MyVec2& f) { x = f.x; y = f.y; }                       \
  62         operator MyVec2() const { return MyVec2(x,y); }
  63
  64 #define IM_VEC4_CLASS_EXTRA                                                 \
  65         ImVec4(const MyVec4& f) { x = f.x; y = f.y; z = f.z; w = f.w; }     \
  66         operator MyVec4() const { return MyVec4(x,y,z,w); }
  67 */
  68
  69 //---- Use 32-bit vertex indices (default is 16-bit) to allow meshes with more than 64K vertices. Render function needs to support it.
  70 //#define ImDrawIdx unsigned int
  71
  72 //---- Tip: You can add extra functions within the ImGui:: namespace, here or in your own headers files.
  73 /*
  74 namespace ImGui
  75 {
  76     void MyFunction(const char* name, const MyMatrix44& v);
  77 }
  78 */