xref: /aosp_15_r20/external/mesa3d/src/imgui/imconfig.h (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1*61046927SAndroid Build Coastguard Worker //-----------------------------------------------------------------------------
2*61046927SAndroid Build Coastguard Worker // COMPILE-TIME OPTIONS FOR DEAR IMGUI
3*61046927SAndroid Build Coastguard Worker // Runtime options (clipboard callbacks, enabling various features, etc.) can generally be set via the ImGuiIO structure.
4*61046927SAndroid Build Coastguard Worker // You can use ImGui::SetAllocatorFunctions() before calling ImGui::CreateContext() to rewire memory allocation functions.
5*61046927SAndroid Build Coastguard Worker //-----------------------------------------------------------------------------
6*61046927SAndroid Build Coastguard Worker // 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*61046927SAndroid Build Coastguard Worker // B) or add configuration directives in your own file and compile with #define IMGUI_USER_CONFIG "myfilename.h"
8*61046927SAndroid Build Coastguard Worker // If you do so you need to make sure that configuration settings are defined consistently _everywhere_ dear imgui is used, which include
9*61046927SAndroid Build Coastguard Worker // 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*61046927SAndroid Build Coastguard Worker // Defining those options in imconfig.h will ensure every compilation unit gets to see the same data structure layouts.
11*61046927SAndroid Build Coastguard Worker // 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*61046927SAndroid Build Coastguard Worker //-----------------------------------------------------------------------------
13*61046927SAndroid Build Coastguard Worker 
14*61046927SAndroid Build Coastguard Worker #pragma once
15*61046927SAndroid Build Coastguard Worker 
16*61046927SAndroid Build Coastguard Worker // Have each embedded of ImGui define this symbol :
17*61046927SAndroid Build Coastguard Worker struct ImGuiContext;
18*61046927SAndroid Build Coastguard Worker extern thread_local ImGuiContext* __MesaImGui;
19*61046927SAndroid Build Coastguard Worker #define GImGui __MesaImGui
20*61046927SAndroid Build Coastguard Worker 
21*61046927SAndroid Build Coastguard Worker //---- Define assertion handler. Defaults to calling assert().
22*61046927SAndroid Build Coastguard Worker //#define IM_ASSERT(_EXPR)  MyAssert(_EXPR)
23*61046927SAndroid Build Coastguard Worker //#define IM_ASSERT(_EXPR)  ((void)(_EXPR))     // Disable asserts
24*61046927SAndroid Build Coastguard Worker 
25*61046927SAndroid Build Coastguard Worker //---- Define attributes of all API symbols declarations, e.g. for DLL under Windows.
26*61046927SAndroid Build Coastguard Worker //#define IMGUI_API __declspec( dllexport )
27*61046927SAndroid Build Coastguard Worker //#define IMGUI_API __declspec( dllimport )
28*61046927SAndroid Build Coastguard Worker 
29*61046927SAndroid Build Coastguard Worker //---- 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*61046927SAndroid Build Coastguard Worker //#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS
31*61046927SAndroid Build Coastguard Worker 
32*61046927SAndroid Build Coastguard Worker //---- Don't implement demo windows functionality (ShowDemoWindow()/ShowStyleEditor()/ShowUserGuide() methods will be empty)
33*61046927SAndroid Build Coastguard Worker //---- It is very strongly recommended to NOT disable the demo windows during development. Please read the comments in imgui_demo.cpp.
34*61046927SAndroid Build Coastguard Worker //#define IMGUI_DISABLE_DEMO_WINDOWS
35*61046927SAndroid Build Coastguard Worker 
36*61046927SAndroid Build Coastguard Worker //---- Don't implement some functions to reduce linkage requirements.
37*61046927SAndroid Build Coastguard Worker //#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*61046927SAndroid Build Coastguard Worker //#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS         // [Win32] Don't implement default IME handler. Won't use and link with ImmGetContext/ImmSetCompositionWindow.
39*61046927SAndroid Build Coastguard Worker //#define IMGUI_DISABLE_WIN32_FUNCTIONS                     // [Win32] Won't use and link with any Win32 function.
40*61046927SAndroid Build Coastguard Worker //#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*61046927SAndroid Build Coastguard Worker //#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*61046927SAndroid Build Coastguard Worker //#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*61046927SAndroid Build Coastguard Worker 
44*61046927SAndroid Build Coastguard Worker //---- Include imgui_user.h at the end of imgui.h as a convenience
45*61046927SAndroid Build Coastguard Worker //#define IMGUI_INCLUDE_IMGUI_USER_H
46*61046927SAndroid Build Coastguard Worker 
47*61046927SAndroid Build Coastguard Worker //---- Pack colors to BGRA8 instead of RGBA8 (to avoid converting from one to another)
48*61046927SAndroid Build Coastguard Worker //#define IMGUI_USE_BGRA_PACKED_COLOR
49*61046927SAndroid Build Coastguard Worker 
50*61046927SAndroid Build Coastguard Worker //---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version
51*61046927SAndroid Build Coastguard Worker // By default the embedded implementations are declared static and not available outside of imgui cpp files.
52*61046927SAndroid Build Coastguard Worker //#define IMGUI_STB_TRUETYPE_FILENAME   "my_folder/stb_truetype.h"
53*61046927SAndroid Build Coastguard Worker //#define IMGUI_STB_RECT_PACK_FILENAME  "my_folder/stb_rect_pack.h"
54*61046927SAndroid Build Coastguard Worker //#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION
55*61046927SAndroid Build Coastguard Worker //#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION
56*61046927SAndroid Build Coastguard Worker 
57*61046927SAndroid Build Coastguard Worker //---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4.
58*61046927SAndroid Build Coastguard Worker // This will be inlined as part of ImVec2 and ImVec4 class declarations.
59*61046927SAndroid Build Coastguard Worker /*
60*61046927SAndroid Build Coastguard Worker #define IM_VEC2_CLASS_EXTRA                                                 \
61*61046927SAndroid Build Coastguard Worker         ImVec2(const MyVec2& f) { x = f.x; y = f.y; }                       \
62*61046927SAndroid Build Coastguard Worker         operator MyVec2() const { return MyVec2(x,y); }
63*61046927SAndroid Build Coastguard Worker 
64*61046927SAndroid Build Coastguard Worker #define IM_VEC4_CLASS_EXTRA                                                 \
65*61046927SAndroid Build Coastguard Worker         ImVec4(const MyVec4& f) { x = f.x; y = f.y; z = f.z; w = f.w; }     \
66*61046927SAndroid Build Coastguard Worker         operator MyVec4() const { return MyVec4(x,y,z,w); }
67*61046927SAndroid Build Coastguard Worker */
68*61046927SAndroid Build Coastguard Worker 
69*61046927SAndroid Build Coastguard Worker //---- Use 32-bit vertex indices (default is 16-bit) to allow meshes with more than 64K vertices. Render function needs to support it.
70*61046927SAndroid Build Coastguard Worker //#define ImDrawIdx unsigned int
71*61046927SAndroid Build Coastguard Worker 
72*61046927SAndroid Build Coastguard Worker //---- Tip: You can add extra functions within the ImGui:: namespace, here or in your own headers files.
73*61046927SAndroid Build Coastguard Worker /*
74*61046927SAndroid Build Coastguard Worker namespace ImGui
75*61046927SAndroid Build Coastguard Worker {
76*61046927SAndroid Build Coastguard Worker     void MyFunction(const char* name, const MyMatrix44& v);
77*61046927SAndroid Build Coastguard Worker }
78*61046927SAndroid Build Coastguard Worker */
79