Rmlui integration #1076

loveridge · 2023-11-15T23:19:23Z

Ready for general reviews.

This MR integrates RmlUi into LuaUI so that Rml interfaces can be created in unsynced lua widgets. Overhead for games not adding RmlUi widgets is negligible.

Examples of two widgets using the rmlui interface can be found here.

sprunk · 2023-12-29T22:07:31Z

rts/System/Input/MouseInput.cpp

@@ -68,6 +69,9 @@ IMouseInput::~IMouseInput()

 bool IMouseInput::HandleSDLMouseEvent(const SDL_Event& event)
 {
+	if (!mouse->ButtonPressed() && RmlGui::ProcessMouseEvent(event)) {


why the !mouse->ButtonPressed() check?

Only want to give a mouse event to RmlUi if the mouse isn't currently performing a drag. Otherwise box selections get stuck when the mouse goes over an Rml element.

I've taken the liberty of putting that as a comment in the code ca9aeb0

sprunk · 2023-12-29T22:08:12Z

rts/Rml/RmlInputReceiver.h

+	CRmlInputReceiver() : CInputReceiver(FRONT), rml_active(false){};
+	~CRmlInputReceiver() = default;
+
+	bool IsAbove(int x, int y) { return rml_active; };


shouldn't this check if any actual gui panel is underneath?

Thinks like a dropdown combobox could drop below a gui panel?

Sure, by "gui panel" I mean anything drawn by rml at the coordinates being asked about.

IsAbove is used for determining which cursor icon should be displayed. I track if the mouse is over an rml element in ProcessMouseEvent and just return if rml is capturing the mouse since the xy is the mouse location.

Good, put that in a comment at the function.

I added the comment, and integrated the mouse event handling with the main mouse handler

sprunk · 2023-12-29T22:18:29Z

rts/Lua/LuaHandle.cpp

@@ -172,6 +172,10 @@ void CLuaHandle::KillLua(bool inFreeHandler)
 	if (inFreeHandler)
 		Shutdown();

+	if(rmlui) {
+		RmlGui::Reload();


shouldn't this be some sort of shutdown and not reload?

Completed. On luaui shutdown we will remove the lua rml plugin and all contexts/documents created from lua. This allows the engine to continue to use rml for it's interface.

rts/Rml/Backends/RmlUi_Backend.cpp

sprunk · 2024-01-10T10:45:29Z

rts/System/Input/MouseInput.cpp

@@ -68,6 +69,10 @@ IMouseInput::~IMouseInput()

 bool IMouseInput::HandleSDLMouseEvent(const SDL_Event& event)
 {
+	/* Only want to give a mouse event to RmlUI if the mouse isn't currently performing a drag.


Move this to rts/Game/UI/MouseHandler.cpp line 276.

Not all is ready and there will be more work needed on build system, but the basic integration of RmlUi Core is done. - I've not created and linked any of the provided GL3 or SDL backends, that needs separate work - Lua bindings are blocked on mikke89/RmlUi#302 we need to find some workaround for that - Tracy integration is blocked on mikke89/RmlUi#516

sprunk · 2024-01-18T08:32:08Z

rts/Rml/Backends/RmlUi_Renderer_GL3.cpp

@@ -1,5 +1,7 @@
+/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */


sprunk · 2024-01-18T08:33:24Z

rts/Rml/Backends/RmlUi_Renderer_GL3.cpp

 /*
- * This source file is part of RmlUi, the HTML/CSS Interface Middleware
+ * This source file is dervied from the source code of RmlUi, the HTML/CSS Interface Middleware


t. dervish

Suggested change

* This source file is dervied from the source code of RmlUi, the HTML/CSS Interface Middleware

* This source file is derived from the source code of RmlUi, the HTML/CSS Interface Middleware

but also idk if it makes sense to modify this. did we actually change anything substantial?

There is only minor changes that I do not know the full impact of.
The one I noted is that the shader GLSL version was changed.

sprunk · 2024-01-28T16:33:48Z

rts/System/Platform/errorhandler.cpp

@@ -59,7 +59,7 @@ static void ExitSpringProcess(const char* msg, const char* caption, unsigned int

 static void ExitSpringProcess(const char* msg, const char* caption, unsigned int flags)
 {
-	LOG_L(L_ERROR, "[%s] errorMsg=\"%s\" msgCaption=\"%s\" mainThread=%d", __func__, msg, caption, Threading::IsMainThread());
+	LOG_L(L_FATAL, "[%s] errorMsg=\"%s\" msgCaption=\"%s\" mainThread=%d", __func__, msg, caption, Threading::IsMainThread());


This could probably go to mainline separately

rts/System/Input/MouseInput.cpp

get rid of never-going-to-be-used code in RmlUi_Renderer_GL3 rename file/class to RmlUi_Renderer_GL3_Spring since it's now more deeply integrated with Spring move VFSInterface to own files

…ces-cleanup rts/Rml code cleanup + move general plugin init/destroy out of Lua-related code

…Texture code to be able to reuse already made textures

lhog · 2024-01-29T09:51:04Z

As outlined in Discord, please extract the engine/build system integration and exclude:

Unrelated trailing space and other formatting changes
Lua integration
Changes to the 3rd party libs.

Let this draft serve as work-in-progress branch, but extract the above into another PR/branch so it's easy to review and integrate.

…ture-element custom <(lua)texture> element to reuse existing textures

rts/Rml/Backends/RmlUi_Backend.cpp

sprunk · 2024-01-30T16:45:21Z

rts/Rml/Backends/RmlUi_Renderer_GL3_Spring.cpp

@@ -657,6 +657,10 @@ bool RenderInterface_GL3_Spring::GenerateTexture(Rml::TextureHandle& texture_han

 void RenderInterface_GL3_Spring::ReleaseTexture(Rml::TextureHandle texture_handle)
 {
+	// Something was using a texture loaded/managed outside of Rml. Do nothing.


Sounds worrisome, when can this happen? What if "the outside" frees the texture while RML is still using it?

Then you end up getting a broken texture when you try to render.
Same thing that can happen if RML (or anything else) frees up a texture that's still in use elsewhere.

I think it's a better solution than copying the texture data needlessly. Though I suppose someone could force a copy to happen.

This check was added because of the <lua-texture> custom element which asks for texture handles from LuaOpenGLUtils::ParseTextureImage.
Which I made because I think loading in another copy of all the buildpics/icons for use by RML is a terrible idea.

A copy texture function/element could also be made- for when you aren't certain that the original texture handle is going to stick around when you need it to.

ChrisFloofyKitsune · 2024-01-31T02:19:46Z

As outlined in Discord, please extract the engine/build system integration and exclude:
1. Unrelated trailing space and other formatting changes
2. Lua integration
3. Changes to the 3rd party libs.
Let this draft serve as work-in-progress branch, but extract the above into another PR/branch so it's easy to review and integrate.

Here is the PR for part 1: the non lua stuff

#1261

p2004a · 2024-04-06T18:23:12Z

I'm closing this PR as it's being replaced by #1415.

The only difference is:

It's based on the engine rmlui-integration-fork so anybody can make PRs to that branch, not to your fork @loveridge. In addition, being main engine branch, we can create preview builds off it.
It contains the full history of this branch + more changes on top by @ChrisFloofyKitsune
It's rebased on the current stable engine version

loveridge changed the title ~~Rmlui integration fork~~ Rmlui integration Nov 15, 2023

sprunk reviewed Dec 29, 2023

View reviewed changes

rts/Rml/Backends/RmlUi_Backend.cpp Outdated Show resolved Hide resolved

sprunk reviewed Dec 29, 2023

View reviewed changes

rts/Rml/Backends/RmlUi_Backend.cpp Outdated Show resolved Hide resolved

p2004a force-pushed the rmlui-integration-fork branch from ca9aeb0 to 449a692 Compare December 30, 2023 17:45

sprunk reviewed Jan 10, 2024

View reviewed changes

p2004a and others added 22 commits January 13, 2024 19:48

render first light

d7ad618

remove sdl2_image

13010e2

VFS system integration

1bb6420

rmlui lua and sdl integration

bb6ebfd

rmlui reload support and better luaui integration

5133197

delete extra file

74f253e

Temporarily switch to RmlUi branch with tracy integration fixed

0e5dde9

data model change detection bad edition

2aaf8c6

fix for chobby support, better binds, translation table

f260dcc

key event handling, luaui reloading, rmlsol bug fixes

ee297a5

remove rml demo files

28857f1

create contexts lua side

f0386dc

clean up comments

aae1055

allow multiple rmlui contexts

02a2344

pull out inner loop of processevent calls

fc4e86b

add comment to make it clear certain events are not captured

5ccc2c4

Update RmlUi to latest git version

3f6b957

headless building and lua support

5c37983

add lunasvg submodule

8a7df4f

update lunasvg version

9258d2a

reset build option

31a9bb6

reference fix

2ee7847

sprunk reviewed Jan 18, 2024

View reviewed changes

loveridge added 2 commits January 26, 2024 23:33

use cbitmap texture binding

641d2a3

spaces to tabs with clang-format

b86474b

sprunk reviewed Jan 28, 2024

View reviewed changes

rts/System/Input/MouseInput.cpp Outdated Show resolved Hide resolved

loveridge and others added 11 commits January 28, 2024 10:40

mask lua macros

e8604eb

Remove unused variable

5777014

add an explicit removeLua call

2845335

accurate tracking of lua added items

8f31df3

move general Rml::Context watching plugin outside of Lua init/destroy

b931931

get rid of never-going-to-be-used code in RmlUi_Renderer_GL3 rename file/class to RmlUi_Renderer_GL3_Spring since it's now more deeply integrated with Spring move VFSInterface to own files

left some mess in, sorry

0af0f42

Merge pull request #3 from ChrisFloofyKitsune/floof/rmlui/rml-interfa…

7cea7bd

…ces-cleanup rts/Rml code cleanup + move general plugin init/destroy out of Lua-related code

create new <texture> element which hooks into the existing LuaOpenGL/…

8ac855f

…Texture code to be able to reuse already made textures

create new <texture> element which hooks into the existing LuaOpenGL/…

c6d8c9a

…Texture code to be able to reuse already made textures

what if we just kept the texture handle away from Rml

7d310ed

clearer and more readable element tag name

74fa133

loveridge added 3 commits January 30, 2024 09:32

Remove unnecessary includes

3f8cb98

Merge pull request #2 from ChrisFloofyKitsune/floof/rmlui/add-lua-tex…

2ab12a4

…ture-element custom <(lua)texture> element to reuse existing textures

formatting

6762251

sprunk reviewed Jan 30, 2024

View reviewed changes

rts/Rml/Backends/RmlUi_Backend.cpp Outdated Show resolved Hide resolved

sprunk reviewed Jan 30, 2024

View reviewed changes

loveridge marked this pull request as ready for review February 14, 2024 05:05

blaisemccourtney mentioned this pull request Apr 5, 2024

Tracking issue for RmlUi integration. #1412

Closed

p2004a closed this Apr 6, 2024

p2004a mentioned this pull request Apr 6, 2024

Integrate RmlUi #1415

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rmlui integration #1076

Rmlui integration #1076

loveridge commented Nov 15, 2023

sprunk Dec 29, 2023

loveridge Dec 30, 2023

sprunk Dec 30, 2023

sprunk Dec 29, 2023

Beherith Dec 30, 2023

sprunk Dec 30, 2023

loveridge Jan 2, 2024

sprunk Jan 2, 2024

loveridge Jan 10, 2024

sprunk Dec 29, 2023

loveridge Jan 28, 2024

sprunk Jan 10, 2024

sprunk Jan 18, 2024

sprunk Jan 18, 2024

ChrisFloofyKitsune Jan 18, 2024

sprunk Jan 28, 2024

lhog commented Jan 29, 2024

sprunk Jan 30, 2024

ChrisFloofyKitsune Jan 31, 2024 •

edited

Loading

ChrisFloofyKitsune Jan 31, 2024 •

edited

Loading

ChrisFloofyKitsune commented Jan 31, 2024 •

edited

Loading

p2004a commented Apr 6, 2024

		@@ -1,5 +1,7 @@
		/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */

	* This source file is dervied from the source code of RmlUi, the HTML/CSS Interface Middleware
	* This source file is derived from the source code of RmlUi, the HTML/CSS Interface Middleware

Rmlui integration #1076

Rmlui integration #1076

Conversation

loveridge commented Nov 15, 2023

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

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

lhog commented Jan 29, 2024

Choose a reason for hiding this comment

ChrisFloofyKitsune Jan 31, 2024 • edited Loading

Choose a reason for hiding this comment

ChrisFloofyKitsune Jan 31, 2024 • edited Loading

Choose a reason for hiding this comment

ChrisFloofyKitsune commented Jan 31, 2024 • edited Loading

p2004a commented Apr 6, 2024

ChrisFloofyKitsune Jan 31, 2024 •

edited

Loading

ChrisFloofyKitsune Jan 31, 2024 •

edited

Loading

ChrisFloofyKitsune commented Jan 31, 2024 •

edited

Loading