|
1 | 1 | //----------------------------------------------------------------------------- |
2 | | -// USER IMPLEMENTATION |
3 | | -// This file contains compile-time options for ImGui. |
4 | | -// Other options (memory allocation overrides, callbacks, etc.) can be set at runtime via the ImGuiIO structure - ImGui::GetIO(). |
| 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. |
5 | 12 | //----------------------------------------------------------------------------- |
6 | 13 |
|
7 | 14 | #pragma once |
8 | 15 |
|
9 | 16 | //---- Define assertion handler. Defaults to calling assert(). |
10 | 17 | //#define IM_ASSERT(_EXPR) MyAssert(_EXPR) |
| 18 | +//#define IM_ASSERT(_EXPR) ((void)(_EXPR)) // Disable asserts |
11 | 19 |
|
12 | 20 | //---- Define attributes of all API symbols declarations, e.g. for DLL under Windows. |
13 | 21 | //#define IMGUI_API __declspec( dllexport ) |
14 | 22 | //#define IMGUI_API __declspec( dllimport ) |
15 | 23 |
|
16 | | -//---- Include imgui_user.h at the end of imgui.h |
17 | | -//#define IMGUI_INCLUDE_IMGUI_USER_H |
| 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 |
18 | 26 |
|
19 | | -//---- Don't implement default handlers for Windows (so as not to link with OpenClipboard() and others Win32 functions) |
20 | | -//#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCS |
21 | | -//#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCS |
| 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 |
22 | 30 |
|
23 | | -//---- Don't implement help and test window functionality (ShowUserGuide()/ShowStyleEditor()/ShowTestWindow() methods will be empty) |
24 | | -//#define IMGUI_DISABLE_TEST_WINDOWS |
| 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(). You will need to call ImGui::SetAllocatorFunctions(). |
25 | 37 |
|
26 | | -//---- Don't define obsolete functions names |
27 | | -//#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS |
| 38 | +//---- Include imgui_user.h at the end of imgui.h as a convenience |
| 39 | +//#define IMGUI_INCLUDE_IMGUI_USER_H |
28 | 40 |
|
29 | | -//---- Pack colors to BGRA instead of RGBA (remove need to post process vertex buffer in back ends) |
| 41 | +//---- Pack colors to BGRA8 instead of RGBA8 (if you needed to convert from one to another anyway) |
30 | 42 | //#define IMGUI_USE_BGRA_PACKED_COLOR |
31 | 43 |
|
32 | | -//---- Implement STB libraries in a namespace to avoid conflicts |
33 | | -//#define IMGUI_STB_NAMESPACE ImGuiStb |
| 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 |
34 | 50 |
|
35 | 51 | //---- Define constructor and implicit cast operators to convert back<>forth from your math types and ImVec2/ImVec4. |
| 52 | +// This will be inlined as part of ImVec2 and ImVec4 class declarations. |
36 | 53 | /* |
37 | 54 | #define IM_VEC2_CLASS_EXTRA \ |
38 | 55 | ImVec2(const MyVec2& f) { x = f.x; y = f.y; } \ |
|
43 | 60 | operator MyVec4() const { return MyVec4(x,y,z,w); } |
44 | 61 | */ |
45 | 62 |
|
46 | | -//---- Use 32-bit vertex indices (instead of default: 16-bit) to allow meshes with more than 64K vertices |
| 63 | +//---- Use 32-bit vertex indices (default is 16-bit) to allow meshes with more than 64K vertices. Render function needs to support it. |
47 | 64 | //#define ImDrawIdx unsigned int |
48 | 65 |
|
49 | 66 | //---- Tip: You can add extra functions within the ImGui:: namespace, here or in your own headers files. |
50 | | -//---- e.g. create variants of the ImGui::Value() helper for your low-level math types, or your own widgets/helpers. |
51 | 67 | /* |
52 | 68 | namespace ImGui |
53 | 69 | { |
54 | | - void Value(const char* prefix, const MyMatrix44& v, const char* float_format = NULL); |
| 70 | + void MyFunction(const char* name, const MyMatrix44& v); |
55 | 71 | } |
56 | 72 | */ |
57 | | - |
|
0 commit comments