diff --git a/imconfig.h b/imconfig.h index 4ba731341d84..47f4f54fe671 100644 --- a/imconfig.h +++ b/imconfig.h @@ -5,7 +5,8 @@ //----------------------------------------------------------------------------- // A) You may edit imconfig.h (and not overwrite it when updating imgui, or maintain a patch/branch with your modifications to imconfig.h) // B) or add configuration directives in your own file and compile with #define IMGUI_USER_CONFIG "myfilename.h" -// Note that options such as IMGUI_API, IM_VEC2_CLASS_EXTRA or ImDrawIdx needs to be defined consistently everywhere you include imgui.h, not only for the imgui*.cpp compilation units. +// C) Many compile-time options have an effect on data structures. They need defined consistently _everywhere_ imgui.h is included, +// not only for the imgui*.cpp compilation units. Defining those options in imconfig.h will ensure they correctly get used everywhere. //----------------------------------------------------------------------------- #pragma once diff --git a/imgui.cpp b/imgui.cpp index 4699e6735fa8..33574f66edb4 100644 --- a/imgui.cpp +++ b/imgui.cpp @@ -8,7 +8,12 @@ // Gallery (please post your screenshots/video there!): https://github.com/ocornut/imgui/issues/1269 // Developed by Omar Cornut and every direct or indirect contributors to the GitHub. // This library is free but I need your support to sustain development and maintenance. -// If you work for a company, please consider financial support, see Readme. For individuals: https://www.patreon.com/imgui +// If you work for a company, please consider financial support, see README. For individuals: https://www.patreon.com/imgui + +// It is recommended that you don't modify imgui.cpp! It will become difficult for you to update the library. +// Note that 'ImGui::' is a namespace and so you can add functions into it from your own source files without modifying imgui.h or imgui.cpp. +// You may include imgui_internal.h to access internal data structures, but it doesn't come with any guarantee of forward compatibility. +// Discussing your changes on the GitHub Issue Tracker may lead you to a better solution or official support for them. /*