Skip to content

Commit 1aa59f9

Browse files
committed
Minor API comments and tweaks, standardize index used in imgui.h. Tables: tweaked TableSetupColumn() assert to use IM_ASSERT_USER_ERROR().
1 parent 2e48c2d commit 1aa59f9

File tree

5 files changed

+92
-72
lines changed

5 files changed

+92
-72
lines changed

docs/CHANGELOG.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,8 @@ Other Changes:
132132
VERSION 1.79 (Released 2020-10-08)
133133
-----------------------------------------------------------------------
134134

135+
Decorated log: https://github.com/ocornut/imgui/releases/tag/v1.79
136+
135137
Breaking Changes:
136138

137139
- Fonts: Removed ImFont::DisplayOffset in favor of ImFontConfig::GlyphOffset. DisplayOffset was applied
@@ -224,6 +226,8 @@ Other Changes:
224226
VERSION 1.78 (Released 2020-08-18)
225227
-----------------------------------------------------------------------
226228

229+
Decorated log: https://github.com/ocornut/imgui/releases/tag/v1.78
230+
227231
Breaking Changes:
228232

229233
- Obsoleted use of the trailing 'float power=1.0f' parameter for those functions: [@Shironekoben, @ocornut]

imgui.cpp

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ CODE
124124
- You can apply arithmetic operators +,*,/ on numerical values. Use +- to subtract (because - would set a negative value!)
125125
- Controls are automatically adjusted for OSX to match standard OSX text editing operations.
126126
- General Keyboard controls: enable with ImGuiConfigFlags_NavEnableKeyboard.
127-
- General Gamepad controls: enable with ImGuiConfigFlags_NavEnableGamepad. See suggested mappings in imgui.h ImGuiNavInput_ + download PNG/PSD at http://goo.gl/9LgVZW
127+
- General Gamepad controls: enable with ImGuiConfigFlags_NavEnableGamepad. See suggested mappings in imgui.h ImGuiNavInput_ + download PNG/PSD at http://dearimgui.org/controls_sheets
128128

129129

130130
PROGRAMMER GUIDE
@@ -156,18 +156,20 @@ CODE
156156
HOW TO UPDATE TO A NEWER VERSION OF DEAR IMGUI
157157
----------------------------------------------
158158
- Overwrite all the sources files except for imconfig.h (if you have made modification to your copy of imconfig.h)
159-
- Or maintain your own branch where you have imconfig.h modified.
159+
- Or maintain your own branch where you have imconfig.h modified as a top-most commit which you can regularly rebase over master.
160+
- You can also use '#define IMGUI_USER_CONFIG "my_config_file.h" to redirect configuration to your own file.
160161
- Read the "API BREAKING CHANGES" section (below). This is where we list occasional API breaking changes.
161162
If a function/type has been renamed / or marked obsolete, try to fix the name in your code before it is permanently removed
162163
from the public API. If you have a problem with a missing function/symbols, search for its name in the code, there will
163164
likely be a comment about it. Please report any issue to the GitHub page!
164-
- Try to keep your copy of dear imgui reasonably up to date.
165+
- To find out usage of old API, you can add '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' in your configuration file.
166+
- Try to keep your copy of Dear ImGui reasonably up to date.
165167

166168

167169
GETTING STARTED WITH INTEGRATING DEAR IMGUI IN YOUR CODE/ENGINE
168170
---------------------------------------------------------------
169171
- Run and study the examples and demo in imgui_demo.cpp to get acquainted with the library.
170-
- In the majority of cases you should be able to use unmodified backends files available in the examples/ folder.
172+
- In the majority of cases you should be able to use unmodified backends files available in the backends/ folder.
171173
- Add the Dear ImGui source files + selected backend source files to your projects or using your preferred build system.
172174
It is recommended you build and statically link the .cpp files as part of your project and NOT as shared library (DLL).
173175
- You can later customize the imconfig.h file to tweak some compile-time behavior, such as integrating Dear ImGui types with your own maths types.
@@ -348,7 +350,7 @@ CODE
348350
0.0f= not held. 1.0f= fully held. Pass intermediate 0.0f..1.0f values for analog triggers/sticks.
349351
- We uses a simple >0.0f test for activation testing, and won't attempt to test for a dead-zone.
350352
Your code will probably need to transform your raw inputs (such as e.g. remapping your 0.2..0.9 raw input range to 0.0..1.0 imgui range, etc.).
351-
- You can download PNG/PSD files depicting the gamepad controls for common controllers at: http://goo.gl/9LgVZW.
353+
- You can download PNG/PSD files depicting the gamepad controls for common controllers at: http://dearimgui.org/controls_sheets
352354
- If you need to share inputs between your game and the imgui parts, the easiest approach is to go all-or-nothing, with a buttons combo
353355
to toggle the target. Please reach out if you think the game vs navigation input sharing could be improved.
354356
- Mouse:

0 commit comments

Comments
 (0)