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 //---- Define assertion handler. Defaults to calling assert().
  17 //#define IM_ASSERT(_EXPR)  MyAssert(_EXPR)
  18 //#define IM_ASSERT(_EXPR)  ((void)(_EXPR))     // Disable asserts
  19
  20 //---- Define attributes of all API symbols declarations, e.g. for DLL under Windows.
  21 //#define IMGUI_API __declspec( dllexport )
  22 //#define IMGUI_API __declspec( dllimport )
  23
  24 //---- Don't define obsolete functions/enums names. Consider enabling from time to time after updating to avoid using soon-to-be obsolete function/names.
  25 //#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS
  26
  27 //---- Don't implement demo windows functionality (ShowDemoWindow()/ShowStyleEditor()/ShowUserGuide() methods will be empty)
  28 //---- It is very strongly recommended to NOT disable the demo windows during development. Please read the comments in imgui_demo.cpp.
  29 //#define IMGUI_DISABLE_DEMO_WINDOWS
  30
  31 //---- Don't implement some functions to reduce linkage requirements.
  32 //#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS   // [Win32] Don't implement default clipboard handler. Won't use and link with OpenClipboard/GetClipboardData/CloseClipboard etc.
  33 //#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS         // [Win32] Don't implement default IME handler. Won't use and link with ImmGetContext/ImmSetCompositionWindow.
  34 //#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.
  35 //#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.
  36 //#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().
  37
  38 //---- Include imgui_user.h at the end of imgui.h as a convenience
  39 //#define IMGUI_INCLUDE_IMGUI_USER_H
  40
  41 //---- Pack colors to BGRA8 instead of RGBA8 (to avoid converting from one to another)
  42 //#define IMGUI_USE_BGRA_PACKED_COLOR
  43
  44 //---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version
  45 // By default the embedded implementations are declared static and not available outside of imgui cpp files.
  46 //#define IMGUI_STB_TRUETYPE_FILENAME   "my_folder/stb_truetype.h"
  47 //#define IMGUI_STB_RECT_PACK_FILENAME  "my_folder/stb_rect_pack.h"
  48 //#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION
  49 //#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION
  50
  51 //---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4.
  52 // This will be inlined as part of ImVec2 and ImVec4 class declarations.
  53 /*
  54 #define IM_VEC2_CLASS_EXTRA                                                 \
  55         ImVec2(const MyVec2& f) { x = f.x; y = f.y; }                       \
  56         operator MyVec2() const { return MyVec2(x,y); }
  57
  58 #define IM_VEC4_CLASS_EXTRA                                                 \
  59         ImVec4(const MyVec4& f) { x = f.x; y = f.y; z = f.z; w = f.w; }     \
  60         operator MyVec4() const { return MyVec4(x,y,z,w); }
  61 */
  62
  63 //---- Use 32-bit vertex indices (default is 16-bit) to allow meshes with more than 64K vertices. Render function needs to support it.
  64 //#define ImDrawIdx unsigned int
  65
  66 //---- Tip: You can add extra functions within the ImGui:: namespace, here or in your own headers files.
  67 /*
  68 namespace ImGui
  69 {
  70     void MyFunction(const char* name, const MyMatrix44& v);
  71 }
  72 */