*Update DearImGui lib to 1.88 WIP version #31

lemantisee · 2022-05-23T22:44:05Z

Remove direct access to obsolete key arrays for version starts from 1.87
Replace ImGui opengl loader by glad

Signed-off-by: Kostiantyn kos.chernenok@gmail.com

Remove direct access to obsolete key arrays for version starts from 1.87 Replace ImGui opengl loader by glad Signed-off-by: Kostiantyn <kos.chernenok@gmail.com>

lemantisee · 2022-05-23T22:50:12Z

Purpose to update ImGui library to latest version 1.88 WIP.
Starting from 1.87 ImGui suggest don't use key arrays in ImGuiIO struct and marked it as obsolete. So I remade keybord processing with suggested methods in ImGuiIO struct. Add back compability for versions less than 1.87.
Also file imgui_impl_opengl3_loader.h now is internal file and ImGui lib suggests to use own opengl loader. I add glad for opengl 3.0 Core.

sammyfreg · 2022-05-24T00:08:10Z

Cool, I'll have a look this weekend. I had initially decided to wait a bit to integrate 1.88, to make sure the big key change in Dear ImGui didn't have any unforeseen issue.

sammyfreg · 2022-05-29T01:58:28Z

I am not done checking the PR, but its looking good, with a few changes needed.

We only need Dear ImGui version check on code used by Client (Code\Client\*). Anything else is only using a predetermined version stored under ThirdParty, so can just replace the code without ifdef.
The CmdPacket classes can be used by Client with any Dear ImGui Version and a different Server Version. We cannot used ifdef in the class member declaration, (could lead to a different class size between client / server). What needs to happen here is that the input command needs data that can be used to update client 1.87+ and 1.86-. The cmdinput cpp can have ifdef that knows how to take the common input and feed it properly to any client version.
With the change to the CmdInput data, the Command version (CmdVersion::eVersion) will need to be incremented to prevent error between mismatching Client/Server data exchange.

sammyfreg · 2022-05-29T01:20:04Z

Code/Client/Private/NetImgui_CmdPackets.h

@@ -112,6 +119,11 @@ struct alignas(8) CmdInput
 	bool							mCompressionUse		= false;	// Server would like client to compress the communication data
 	bool							mCompressionSkip	= false;	// Server forcing next client's frame data to be uncompressed
 	uint8_t							PADDING[4]			= {};
+
+#if IMGUI_VERSION_NUM >= 18700


Cannot have Command Packets data structure that vary depending on ImGui version. The server needs to support both Imgui clients that are pre 1.87 and post 1.87. It should export the information needed by both, then the client api code should consume the one it needs.

This class is used by both Client and Server to communicate.
Its values are written by the Server application and read by the Client.

The Server is always compiled with the same Dear ImGui version (stored under ThirdParty/DearImgui) so you can rely on having a predictable code used too fill the data, that uses the new 1.87 (still need to use the version define since still client includes the same code, without compiling it).

The Client has its own Dear ImGui version that can be any version. So the command packet needs to be able to fill the Dear Imgui client inputs in any format that it can supports.

Hmm. Do we need back compability if imgui introduces this breaking changes?) It's seems quite complicated to support versions before and after keyboard chages. I think it can be done in that way - we implement own enums for keys and mouse buttons and getter/setter for keys state which uses this enums. But it will be hardly to convert legacy imgui KeysDown array to our enums.

I haven't looked in detail about the input changes Dear ImGui introduced, but there are a lot of people pre Dear ImGui 1.87. Game projects tend to minimize changes until the game is shipped, so plenty of people will still be relying on the older input system. On my side, I would like the NetImgui Server application to continue being able to communicate with multiple clients using different Dear ImGui versions simultaneously.

As for how to support it properly, I guess we could copy the new ImGui input enum into NetImgui and only enable it when the version is 1.87, so the enum is always valid. Instead of using windows virtual keys override, we now can use this same enum instead. This is just a quick idea, without having research the problem yet.

Done. Added copy of ImGuiKey_ enum to NetImgui_CmdPackets.inl. Hide implementation for getting and setting keyboard keys. Also moved setup of imgui key map to CmdPackets. With this changes we can increase encapsulation and hide all keyboard routine.

sammyfreg · 2022-05-29T01:30:05Z

Code/ServerApp/Source/GlfwGL3/NetImguiServer_App_GlfwGL3.cpp

@@ -8,6 +8,7 @@
 #if HAL_API_PLATFORM_GLFW_GL3

 #ifdef _MSC_VER
+#include <Windows.h>


windows.h ;(
https://twitter.com/SebAaltonen/status/1530170473149042689?s=20&t=s4JXYbfOYS12IxOs48VCsw

Can you explain a little bit more about the problem with Windows.h? As I understood from twitt including Windows.h increasing compile time. But we need Windows.h for GetCommandLineA() function. It's not trivial to include header processenv.h which contains definition of GetCommandLineA(). And Windows.h widely used in dx11 imgui backend.

Yeah, it is just the concern of additional compile time and everything else that windows.h pulls. Do you need the GetCommandlineA? main(...) already contains the calling parameters, no?

Unless it's because one of the newly added backend file is trying to use that function?

Yes, I can combine cmd args to string without windows functions. Maybe there is some reason to use GetCommandlineA? Because it's legacy code.

sammyfreg · 2022-05-29T01:33:42Z

Code/ServerApp/Source/NetImguiServer_RemoteClient.cpp

@@ -415,6 +415,7 @@ void Client::CaptureImguiInput()

 	if( ImGui::IsWindowFocused() )
 	{
+#if IMGUI_VERSION_NUM < 18700


Do not need the version check define, since this is server only code, using only the internally provided ImGui. Only code used by client needs to have version check (everything under Code\Client\. Can just remove the old code here.

Code/ServerApp/Source/Win32DX11/NetImguiServer_HAL_win32.cpp

sammyfreg · 2022-05-29T01:43:02Z

Code/ServerApp/Source/GlfwGL3/NetImguiServer_HAL_Glfw.cpp

@@ -69,6 +69,7 @@ void HAL_Shutdown()

 }

+#if IMGUI_VERSION_NUM < 18700


Remove code entirelly

sammyfreg · 2022-05-29T01:43:22Z

Code/ServerApp/Source/NetImguiServer_App.h

@@ -48,8 +48,10 @@ namespace NetImguiServer { namespace App
 	bool	HAL_Startup(const char* CmdLine);
 	// Prepare for shutdown of application, with platform specific code
 	void	HAL_Shutdown();
+#if IMGUI_VERSION_NUM < 18700


Remove declaration entirely.

lemantisee · 2022-05-31T11:36:58Z

Thank you for review. I will try to fix it on this week.

sammyfreg · 2022-06-08T14:01:09Z

I had not noticed the use of GetCommandLineA before. If you didn't add it, then the windows.h includes can't be help, and can be left there.

…

On Wed., Jun. 8, 2022, 22:49 Kostiantyn Chernenok ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In Code/ServerApp/Source/GlfwGL3/NetImguiServer_App_GlfwGL3.cpp <#31 (comment)>: > @@ -8,6 +8,7 @@ #if HAL_API_PLATFORM_GLFW_GL3 #ifdef _MSC_VER +#include <Windows.h> Yes, I can combine cmd args to string without windows functions. Maybe there is some reason to use GetCommandlineA? Because it's legacy code. — Reply to this email directly, view it on GitHub <#31 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AESBPYYARYCZQ5TIOXZAOVDVOCQFPANCNFSM5WXIPB7Q> . You are receiving this because you commented.Message ID: ***@***.***>

… client Signed-off-by: Kostiantyn <k.chernenok@frontpictures.com>

sammyfreg · 2022-06-10T00:06:02Z

Nice! Thank you for this PR. I will finish looking at it and testing it locally next weekend (in ~ 9 days).

sammyfreg · 2022-06-14T12:13:31Z

I just realized, I think your PR integrated the main branch of Dear ImGui. The branch I need submitted into the ThirdParty\DearImgui needs to be from the dock branch, since the NetImgui Server needs the docking.

Signed-off-by: Kostiantyn <kos.chernenok@gmail.com>

lemantisee · 2022-06-16T11:45:13Z

I have checked ThirdParty\DearImgui. It's looks like docking branch. imgui.h has docking flags and other docking routine.
But to be sure on 100% I have updated lib to last version from docking branch.

sammyfreg · 2022-06-16T12:08:58Z

Thanks, I will try to have a look this Sunday. Since this is a significant change, I will pull the changelist and try it locally.

sammyfreg · 2022-06-18T09:53:55Z

I have pulled the PR locally, and can see that there are various compile issues happening.

The OpenGL server backend has been left active by default, should be put back to DX11 since that's the only one that compiles in both debug/release version (I didn't include some OpenGL debug library when first adding support for it)
Every project should be able compile using 'Build->Batch build->Select all and build'. Right now, various projects do not build.
I also have regression test with older version of Dear Imgui, call 'Build\GenerateCompatibilityTest.bat' once, before generating the solutions, to fetch them and have them included in the build
Some of the errors are warnings needing to be fixed. Since I have -Wall active

lemantisee · 2022-06-19T15:59:08Z

To fix compile errors in PR I trying to compile current dev branch to setup clang. And can't compile under VS 2022 + clang 13.01. There is a lot of errors in imgui.h such as '_CmdBuffer' is reserved because it starts with '_' followed by a capital letter. Clang build requires some additional setups?

sammyfreg · 2022-06-20T00:36:14Z

Ah yes, I noticed that this weekend too, and submitted a fix on my Dev branch. The 2022 support is new and unfortunately I am getting PDB linking error now on it (clang build). I am still trying to figure these one out, but there are no issues under 2019. If you can compile with only the linking error, that's good enough, while I figure it out.

…

On Mon., Jun. 20, 2022, 00:59 Kostiantyn Chernenok ***@***.***> wrote: To fix compile errors in PR I trying to compile current dev branch to setup clang. And can't compile under VS 2022 + clang 13.01. There is a lot of errors in imgui.h such as "'*CmdBuffer' is reserved because it starts with '*' followed by a capital letter". Clang build requires some additional setups? — Reply to this email directly, view it on GitHub <#31 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AESBPY2ZJUB4KWLLZ5W4QTTVP47VNANCNFSM5WXIPB7Q> . You are receiving this because you commented.Message ID: ***@***.***>

- Fix CmdInput for compatibility tests - Add linking for glfw debug lib - Update glfw to version 3.3 Signed-off-by: Kostiantyn <k.chernenok@frontpictures.com>

lemantisee · 2022-06-20T11:52:56Z

Fix compatibility test
Fix glfw error linking for debug build
Fix some warnings

Since we cannot include imgui opengl backend source files anymore (or maybe I didn't find good solution) I added permanent linking of opengl and glfw lib (both for win11 and opengl version). Maybe it will better to split server to two targets?

sammyfreg · 2022-06-25T02:43:16Z

Ok, I was able to compile it locally, but it seems that the Clang build doesn't work (missing GLFW libs which are not available on Glfw.org). Thus, NetImguiServer will need to have it's conditional lib/cpp include restored. For now, could you move this PR to a new branch I created instead (Task_InputRefactor) so we can finally have it in. Afterward, I will be able to fix the Clang support, and modify my samples project to support multiple Dear ImGui version. This input change has the potential to break some things and I would like to isolate and test it further before moving it to the dev branch.

Thank you.

sammyfreg · 2022-06-26T05:10:07Z

Thank you, I have pulled this into a input branch and will look at fixing the opengl lib issue in clang and make sure there's not issues.

* Fixed a few issues -Prevent client crash when Dear Imgui has 0 draws -Fixed 32bits Client rendering issues -Added Dear ImGui 1.87 compatibility test * Make sure new client connection RT is cleared Prevents seeing previous client content until 1st DrawCommand is received * Skip preamble when parsing command line host;port (#25) * Bug fix for command line parsing including the executable location. * Add some safety to command line parsing. * Coverity warning fixes Fixes some issues found by Coverity static analyser * Fix to null check & change vertex UV range * * Fix data race between reading and writing pending textures (#26) (#28) Signed-off-by: Kostiantyn <kos.chernenok@gmail.com> * VS2022 warning fixes * Fix accept thread not getting properly signalled to stop on certain platforms (#33) * Version update * *Update DearImGui lib to 1.88 WIP version (#31) * *Update DearImGui lib to 1.88 WIP version Remove direct access to obsolete key arrays for version starts from 1.87 Replace ImGui opengl loader by glad Signed-off-by: Kostiantyn <kos.chernenok@gmail.com> * *Add back compatibility for keyboard keys transfer between server and client Signed-off-by: Kostiantyn <k.chernenok@frontpictures.com> * * Update DearImgui lib to 1879 version Signed-off-by: Kostiantyn <kos.chernenok@gmail.com> * * Add debug libs for glfw - Fix CmdInput for compatibility tests - Add linking for glfw debug lib - Update glfw to version 3.3 Signed-off-by: Kostiantyn <k.chernenok@frontpictures.com> * Some OpenGl build fixes Also reimported NetImguiServer_App_win32dx11.cpp from latest dear imgui sample main.cpp, makign sure it fits the current backend * Added NoBackend sample New Sample demonstrating use of Dear Imgui without any Backend. -Useful for hardward without display/input. Refactored the Dear Imgui compatibility test to now be console application trying to connect to NetImguiServer (using NoBackend sample code) -This allows making sure older Dear ImGui works with current NetImgui (instead of only testing that it compiles) * Support of the new Dear ImGui in put api Fixed compatibility with older Dear ImGui version * Added Gamepad support * Updated to Dear ImGui 1.88 (docking branch) * Visual Studio 2022 LLVM build fix Runtime library switched to DLL * Center server popup Center server popup on parent Window when they first appear Bug fix that prevent server asset copy in post build step * readme update Co-authored-by: Jeff <96199164+rtjeffk@users.noreply.github.com> Co-authored-by: Kostiantyn Chernenok <44094399+lemantisee@users.noreply.github.com> Co-authored-by: Víctor Popovici <557049+TheAnswer@users.noreply.github.com>

* Fixed a few issues -Prevent client crash when Dear Imgui has 0 draws -Fixed 32bits Client rendering issues -Added Dear ImGui 1.87 compatibility test * Make sure new client connection RT is cleared Prevents seeing previous client content until 1st DrawCommand is received * Skip preamble when parsing command line host;port (#25) * Bug fix for command line parsing including the executable location. * Add some safety to command line parsing. * Coverity warning fixes Fixes some issues found by Coverity static analyser * Fix to null check & change vertex UV range * * Fix data race between reading and writing pending textures (#26) (#28) Signed-off-by: Kostiantyn <kos.chernenok@gmail.com> * VS2022 warning fixes * Fix accept thread not getting properly signalled to stop on certain platforms (#33) * Version update * *Update DearImGui lib to 1.88 WIP version (#31) * *Update DearImGui lib to 1.88 WIP version Remove direct access to obsolete key arrays for version starts from 1.87 Replace ImGui opengl loader by glad Signed-off-by: Kostiantyn <kos.chernenok@gmail.com> * *Add back compatibility for keyboard keys transfer between server and client Signed-off-by: Kostiantyn <k.chernenok@frontpictures.com> * * Update DearImgui lib to 1879 version Signed-off-by: Kostiantyn <kos.chernenok@gmail.com> * * Add debug libs for glfw - Fix CmdInput for compatibility tests - Add linking for glfw debug lib - Update glfw to version 3.3 Signed-off-by: Kostiantyn <k.chernenok@frontpictures.com> * Some OpenGl build fixes Also reimported NetImguiServer_App_win32dx11.cpp from latest dear imgui sample main.cpp, makign sure it fits the current backend * Added NoBackend sample New Sample demonstrating use of Dear Imgui without any Backend. -Useful for hardward without display/input. Refactored the Dear Imgui compatibility test to now be console application trying to connect to NetImguiServer (using NoBackend sample code) -This allows making sure older Dear ImGui works with current NetImgui (instead of only testing that it compiles) * Support of the new Dear ImGui in put api Fixed compatibility with older Dear ImGui version * Added Gamepad support * Updated to Dear ImGui 1.88 (docking branch) * Visual Studio 2022 LLVM build fix Runtime library switched to DLL * Center server popup Center server popup on parent Window when they first appear Bug fix that prevent server asset copy in post build step * readme update * NetImgui 1.8 version update * Version update to 1.8.1 wip * Added ASAN to debug build * Generate Project changes for GitAction Co-authored-by: Jeff <96199164+rtjeffk@users.noreply.github.com> Co-authored-by: Kostiantyn Chernenok <44094399+lemantisee@users.noreply.github.com> Co-authored-by: Víctor Popovici <557049+TheAnswer@users.noreply.github.com>

*Update DearImGui lib to 1.88 WIP version

351f9e1

Remove direct access to obsolete key arrays for version starts from 1.87 Replace ImGui opengl loader by glad Signed-off-by: Kostiantyn <kos.chernenok@gmail.com>

sammyfreg reviewed May 31, 2022

View reviewed changes

*Add back compatibility for keyboard keys transfer between server and…

c8df605

… client Signed-off-by: Kostiantyn <k.chernenok@frontpictures.com>

* Update DearImgui lib to 1879 version

b457ace

Signed-off-by: Kostiantyn <kos.chernenok@gmail.com>

* Add debug libs for glfw

4b39ca9

- Fix CmdInput for compatibility tests - Add linking for glfw debug lib - Update glfw to version 3.3 Signed-off-by: Kostiantyn <k.chernenok@frontpictures.com>

sammyfreg changed the base branch from dev to Task_InputRefactor June 26, 2022 05:08

sammyfreg merged commit 49b688e into sammyfreg:Task_InputRefactor Jun 26, 2022

lemantisee deleted the keyboard_PR branch June 1, 2023 12:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

*Update DearImGui lib to 1.88 WIP version #31

*Update DearImGui lib to 1.88 WIP version #31

lemantisee commented May 23, 2022

lemantisee commented May 23, 2022

sammyfreg commented May 24, 2022

sammyfreg commented May 29, 2022 •

edited

Loading

sammyfreg May 29, 2022

sammyfreg May 29, 2022

lemantisee Jun 8, 2022 •

edited

Loading

sammyfreg Jun 8, 2022

sammyfreg Jun 8, 2022

lemantisee Jun 9, 2022

sammyfreg May 29, 2022

lemantisee Jun 8, 2022 •

edited

Loading

sammyfreg Jun 8, 2022

sammyfreg Jun 8, 2022

lemantisee Jun 8, 2022

lemantisee Jun 9, 2022

sammyfreg May 29, 2022

lemantisee Jun 9, 2022

sammyfreg May 29, 2022

lemantisee Jun 9, 2022

sammyfreg May 29, 2022

lemantisee Jun 9, 2022

lemantisee commented May 31, 2022

sammyfreg commented Jun 8, 2022 via email

sammyfreg commented Jun 10, 2022 •

edited

Loading

sammyfreg commented Jun 14, 2022

lemantisee commented Jun 16, 2022

sammyfreg commented Jun 16, 2022

sammyfreg commented Jun 18, 2022

lemantisee commented Jun 19, 2022 •

edited

Loading

sammyfreg commented Jun 20, 2022 via email

lemantisee commented Jun 20, 2022 •

edited

Loading

sammyfreg commented Jun 25, 2022

sammyfreg commented Jun 26, 2022

		@@ -69,6 +69,7 @@ void HAL_Shutdown()

		}

		#if IMGUI_VERSION_NUM < 18700

*Update DearImGui lib to 1.88 WIP version #31

*Update DearImGui lib to 1.88 WIP version #31

Conversation

lemantisee commented May 23, 2022

lemantisee commented May 23, 2022

sammyfreg commented May 24, 2022

sammyfreg commented May 29, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lemantisee Jun 8, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lemantisee Jun 8, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lemantisee commented May 31, 2022

sammyfreg commented Jun 8, 2022 via email

sammyfreg commented Jun 10, 2022 • edited Loading

sammyfreg commented Jun 14, 2022

lemantisee commented Jun 16, 2022

sammyfreg commented Jun 16, 2022

sammyfreg commented Jun 18, 2022

lemantisee commented Jun 19, 2022 • edited Loading

sammyfreg commented Jun 20, 2022 via email

lemantisee commented Jun 20, 2022 • edited Loading

sammyfreg commented Jun 25, 2022

sammyfreg commented Jun 26, 2022

sammyfreg commented May 29, 2022 •

edited

Loading

lemantisee Jun 8, 2022 •

edited

Loading

lemantisee Jun 8, 2022 •

edited

Loading

sammyfreg commented Jun 10, 2022 •

edited

Loading

lemantisee commented Jun 19, 2022 •

edited

Loading

lemantisee commented Jun 20, 2022 •

edited

Loading