Browse Source

imconfig.h tweak, not advertising IMGUI_INCLUDE_IMGUI_USER_INL anymore.

ocornut 9 years ago
parent
commit
25c9448dda
2 changed files with 5 additions and 10 deletions
  1. 3 8
      imconfig.h
  2. 2 2
      imgui.cpp

+ 3 - 8
imconfig.h

@@ -13,9 +13,6 @@
 //#define IMGUI_API __declspec( dllexport )
 //#define IMGUI_API __declspec( dllimport )
 
-//---- Include imgui_user.inl at the end of imgui.cpp so you can include code that extends ImGui using its private data/functions.
-//#define IMGUI_INCLUDE_IMGUI_USER_INL
-
 //---- Include imgui_user.h at the end of imgui.h
 //#define IMGUI_INCLUDE_IMGUI_USER_H
 
@@ -43,14 +40,12 @@
         operator MyVec4() const { return MyVec4(x,y,z,w); }
 */
 
-//---- Freely implement extra functions within the ImGui:: namespace.
-//---- Declare helpers or widgets implemented in imgui_user.inl or elsewhere, so end-user doesn't need to include multiple files.
-//---- e.g. you can create variants of the ImGui::Value() helper for your low-level math types, or your own widgets/helpers.
+//---- Tip: You can add extra functions within the ImGui:: namespace, here or in your own headers files.
+//---- e.g. create variants of the ImGui::Value() helper for your low-level math types, or your own widgets/helpers.
 /*
 namespace ImGui
 {
-    void    Value(const char* prefix, const MyVec2& v, const char* float_format = NULL);
-    void    Value(const char* prefix, const MyVec4& v, const char* float_format = NULL);
+    void    Value(const char* prefix, const MyMatrix44& v, const char* float_format = NULL);
 }
 */
 

+ 2 - 2
imgui.cpp

@@ -9310,8 +9310,8 @@ void ImGui::ShowMetricsWindow(bool* opened)
 
 //-----------------------------------------------------------------------------
 
-//---- Include imgui_user.inl at the end of imgui.cpp
-//---- So you can include code that extends ImGui using its private data/functions.
+// Include imgui_user.inl at the end of imgui.cpp to access private data/functions that aren't exposed.
+// Prefer just including imgui_internal.h from your code rather than using this define. If a declaration is missing from imgui_internal.h add it or request it on the github.
 #ifdef IMGUI_INCLUDE_IMGUI_USER_INL
 #include "imgui_user.inl"
 #endif