Examples: Comments
diff --git a/examples/README.txt b/examples/README.txt
index 1f00756..cf99c5d 100644
--- a/examples/README.txt
+++ b/examples/README.txt
@@ -1,10 +1,13 @@
-Those are standalone ready-to-build applications to demonstrate ImGui.
+Those are standalone ready-to-build applications to demonstrate Dear ImGui.
Binaries of some of those demos: http://www.miracleworld.net/imgui/binaries
-Third party languages and frameworks bindings: https://github.com/ocornut/imgui/wiki/Links
-(languages: C, .net, rust, D, Python, Lua..)
-(frameworks: DX12, Vulkan, Cinder, OpenGLES, openFrameworks, Cocos2d-x, SFML, Flexium, NanoRT, Irrlicht..)
-(extras: RemoteImGui, ImWindow, imgui_wm..)
+Third party languages and frameworks bindings:
+ https://github.com/ocornut/imgui/wiki/Links
+(languages: C, C#, ChaiScript, D, Go, Haxe, Odin, Python, Rust, Lua, Pascal)
+(frameworks: DX12, OpenGLES, FreeGlut, Cinder, Cocos2d-x, SFML, GML/GameMaker Studio, Irrlicht, Ogre,
+ OpenSceneGraph, openFrameworks, LOVE, NanoRT, Qt3d, SFML, Unreal Engine 4, etc.)
+(extras: RemoteImGui, ImWindow, imgui_wm, etc.)
+
TL;DR;
- Newcomers, read 'PROGRAMMER GUIDE' in imgui.cpp for notes on how to setup ImGui in your codebase.
@@ -19,14 +22,14 @@
existing rendering backends, don't feel forced to rewrite them with your own engine API, or you can
do that later when you already got things to work.
-ImGui is highly portable and only requires a few things to run:
+Dear ImGui is highly portable and only requires a few things to run and render.
- Providing mouse/keyboard inputs
- Load the font atlas texture into graphics memory
- Providing a render function to render indexed textured triangles
- Optional: clipboard support, mouse cursor supports, Windows IME support, etc.
So this is essentially what those examples are doing + the obligatory cruft for portability.
-Unfortunately in 2016 it is still tedious to create and maintain portable build files using external
+Unfortunately in 2018 it is still tedious to create and maintain portable build files using external
libraries (the kind we're using here to create a window and render 3D triangles) without relying on
third party software. For most examples here I choose to provide:
- Makefiles for Linux/OSX
@@ -36,14 +39,15 @@
You can probably just import the imgui_impl_xxx.cpp/.h files into your own codebase or compile those
directly with a command-line compiler.
-ImGui has zero frame of lag for most behaviors and one frame of lag for some behaviors.
-At 60 FPS your experience should be pleasant. Consider that OS mouse cursors are typically drawn through
-a specific hardware accelerated route and may feel smoother than other GPU rendered contents. You may
-experiment with the io.MouseDrawCursor flag to request ImGui to draw a mouse cursor itself, to visualize
-the lag between a hardware cursor and a software cursor. It might be beneficial to the user experience
-to switch to a software rendered cursor when an interactive drag is in progress.
-Also note that some setup or GPU drivers may be causing extra lag (possibly by enforcing triple buffering),
-leaving you with no option but sadness/anger (Intel GPU drivers were reported as such).
+Dear ImGui has zero to one frame of lag for most behaviors, at 60 FPS your experience should be pleasant.
+Consider that OS mouse cursors are typically drawn through a specific hardware accelerated route and may
+feel smoother than other GPU rendered contents. You may experiment with the io.MouseDrawCursor flag to
+request ImGui to draw a mouse cursor itself, to visualize the lag between a hardware cursor and a software
+cursor. It might be beneficial to the user experience to switch to a software rendered cursor when an
+interactive drag is in progress.
+Also note that some setup or GPU drivers may be causing extra lag (possibly by enforcing triple buffering),
+leaving you with little option but sadness (Intel GPU drivers were reported as such).
+
opengl2_example/
**DO NOT USE THIS CODE IF YOUR CODE/ENGINE IS USING MODERN OPENGL (SHADERS, VBO, VAO, etc.)**
@@ -99,4 +103,4 @@
Vulkan example.
This is quite long and tedious, because: Vulkan.
-TODO: Apple, SDL GL/GL3, Allegro, Marmalade, Vulkan examples do not honor the io.WantMoveMouse flag.
+TODO: Apple, SDL GL2/GL3, Allegro, Marmalade, Vulkan examples do not honor the io.WantMoveMouse flag.
