imconfig.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  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/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 Dear 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. #pragma once
  14. //---- Define assertion handler. Defaults to calling assert().
  15. //#define IM_ASSERT(_EXPR) MyAssert(_EXPR)
  16. //#define IM_ASSERT(_EXPR) ((void)(_EXPR)) // Disable asserts
  17. //---- Define attributes of all API symbols declarations, e.g. for DLL under Windows
  18. // 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.
  19. //#define IMGUI_API __declspec( dllexport )
  20. //#define IMGUI_API __declspec( dllimport )
  21. //---- Don't define obsolete functions/enums names. Consider enabling from time to time after updating to avoid using soon-to-be obsolete function/names.
  22. //#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS
  23. //---- Don't implement demo windows functionality (ShowDemoWindow()/ShowStyleEditor()/ShowUserGuide() methods will be empty)
  24. // It is very strongly recommended to NOT disable the demo windows during development. Please read the comments in imgui_demo.cpp.
  25. //#define IMGUI_DISABLE_DEMO_WINDOWS
  26. //#define IMGUI_DISABLE_METRICS_WINDOW
  27. //---- Don't implement some functions to reduce linkage requirements.
  28. //#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS // [Win32] Don't implement default clipboard handler. Won't use and link with OpenClipboard/GetClipboardData/CloseClipboard etc.
  29. //#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS // [Win32] Don't implement default IME handler. Won't use and link with ImmGetContext/ImmSetCompositionWindow.
  30. //#define IMGUI_DISABLE_WIN32_FUNCTIONS // [Win32] Won't use and link with any Win32 function (clipboard, ime).
  31. //#define IMGUI_ENABLE_OSX_DEFAULT_CLIPBOARD_FUNCTIONS // [OSX] Implement default OSX clipboard handler (need to link with '-framework ApplicationServices').
  32. //#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.
  33. //#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.
  34. //#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().
  35. //---- Include imgui_user.h at the end of imgui.h as a convenience
  36. //#define IMGUI_INCLUDE_IMGUI_USER_H
  37. //---- Pack colors to BGRA8 instead of RGBA8 (to avoid converting from one to another)
  38. //#define IMGUI_USE_BGRA_PACKED_COLOR
  39. //---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version
  40. // By default the embedded implementations are declared static and not available outside of imgui cpp files.
  41. //#define IMGUI_STB_TRUETYPE_FILENAME "my_folder/stb_truetype.h"
  42. //#define IMGUI_STB_RECT_PACK_FILENAME "my_folder/stb_rect_pack.h"
  43. //#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION
  44. //#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION
  45. //---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4.
  46. // This will be inlined as part of ImVec2 and ImVec4 class declarations.
  47. /*
  48. #define IM_VEC2_CLASS_EXTRA \
  49. ImVec2(const MyVec2& f) { x = f.x; y = f.y; } \
  50. operator MyVec2() const { return MyVec2(x,y); }
  51. #define IM_VEC4_CLASS_EXTRA \
  52. ImVec4(const MyVec4& f) { x = f.x; y = f.y; z = f.z; w = f.w; } \
  53. operator MyVec4() const { return MyVec4(x,y,z,w); }
  54. */
  55. //---- Using 32-bits vertex indices (default is 16-bits) is one way to allow large meshes with more than 64K vertices.
  56. // Your renderer back-end will need to support it (most example renderer back-ends support both 16/32-bits indices).
  57. // Another way to allow large meshes while keeping 16-bits indices is to handle ImDrawCmd::VtxOffset in your renderer.
  58. // Read about ImGuiBackendFlags_RendererHasVtxOffset for details.
  59. //#define ImDrawIdx unsigned int
  60. //---- Override ImDrawCallback signature (will need to modify renderer back-ends accordingly)
  61. //struct ImDrawList;
  62. //struct ImDrawCmd;
  63. //typedef void (*MyImDrawCallback)(const ImDrawList* draw_list, const ImDrawCmd* cmd, void* my_renderer_user_data);
  64. //#define ImDrawCallback MyImDrawCallback
  65. //---- Debug Tools
  66. // Use 'Metrics->Tools->Item Picker' to pick widgets with the mouse and break into them for easy debugging.
  67. //#define IM_DEBUG_BREAK IM_ASSERT(0)
  68. //#define IM_DEBUG_BREAK __debugbreak()
  69. // Have the Item Picker break in the ItemAdd() function instead of ItemHoverable() - which is earlier in the code, will catch a few extra items, allow picking items other than Hovered one.
  70. // This adds a small runtime cost which is why it is not enabled by default.
  71. //#define IMGUI_DEBUG_TOOL_ITEM_PICKER_EX
  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. */