Switch renderer from OpenGL to ANGLE by Wires77 · Pull Request #35 · PathOfBuildingCommunity/PathOfBuilding-SimpleGraphic

Wires77 · 2023-09-17T03:55:58Z

To be done before merging:

Merge in master
Update CI script
Default ImGUI to off
Find out why debugging Lua doesn't let PoB launch
For running on wine (Running in an Ubuntu VM) it looks like we will need to also build VCRUNTIME140D.dll and ucrtbased.dll in order for it to work.

Nice-to-haves for later PRs:

Update SG version (1 -> 2)
Update README.md
Update PathOfBuilding-Launcher to support this update
Remove .sln and .vcxproj files
Update vcpkg hash
Remove vcpkg.txt and vcpkg-ports

The naive implementation only supported `*`, `*.*` and `*.ext` type patterns. This improves the matching mechanism by mechanically rewriting the file part of the pattern into a regular expression. Do not pass untrusted paths into this as it doesn't guard against expressions of high complexity.

commit 4fdaf05 Author: Lars Viklund <zao@zao.se> Date: Mon Aug 22 19:27:01 2022 +0200 Bump vcpkg to one with working LuaJIT, disable x64 builds commit c5a1278 Author: Lars Viklund <zao@zao.se> Date: Sun Aug 14 23:55:56 2022 +0200 Specify vcpkg.json path explicitly to avoid conflicts with registry commit 601ea2c Author: Lars Viklund <zao@zao.se> Date: Sun Aug 14 23:52:16 2022 +0200 Add vcpkg registry for own LuaJIT build

There's plenty of optimization possible when drawing UI primitives where primitives related by texture or colour can be merged into composite GPU draw calls. This optimization can currently not be enabled wholesale as much of the Lua code has hardcoded assumptions about draw order within layers being preserved. In order to more clearly manifest such order dependencies there's also an entertaining option to completely shuffle the draw order of primitives within each layer. These new variables are `r_layerOptimize` and `r_layerShuffle`, both defaulting to 0 (off).

It's possible that a legacy version of `cldapi.dll` is present on older systems where it's not officially supported, which may have a different set of exports. Guard against this by explicitly checking if the export we desire is present.

Between no merging of draw calls at all and aggressively merging draw commands in a way that the draw order differs from the submission order, there's the possibility of a conservative order-preserving optimization. This merges any contiguous sequence of draw calls that have the same batch key into a single vertex buffer and drawing them together. This reduces the number of GPU draw calls submitted, yielding decent frame rate gains.

We can detect if nothing has changed from the previous frame by computing a cheap hash of the draw command stream and if it matches we reuse the previous contents of the render target we prepare anyway for resolution scaling.

Historically we broke up draw batches by texture, viewport or blend mode. If any of those changed, a new batch was opened and the previous one was submitted to the GPU as it could no longer be appended to without violating ordering constraints. This commit adds a vertex attribute used to select among a set of textures, limited by the maximum texture sampler count the OpenGL ES implementation supports. As long as no more than that many textures are used in adjacent draw calls they can all be merged into a single draw call. With an implementation that supports 16 texture samplers, a typical passive skill tree can be drawn in around six draw calls with correct draw ordering.

Viewport clipping can be emulated in shaders by passing in the viewport extents via primitive attributes and discarding fragments in the fragment shader with `discard` statements. This allows us to merge more draw calls across previously uncrossable batch boundaries that arose from viewport changes as those caused GPU state changes that must be between draw calls.

Some views in the application can have a lot of geometry outside of the viewports, particularly the passive skill tree. We can save a lot of GPU work and emit fewer batch boundaries if we conservatively cull out quads that are entirely outside of their viewports by testing axis-aligned bounding boxes. This greatly speeds up the skill tree when partially zoomed, which tends to be a common case. This has benefits in reducing the amount of batch boundary cuts by not having to consider the render states of unseen geometry, especially texture changes.

Wires77 · 2023-09-20T02:03:24Z

Do we still need this file now that we have vcpkg.json?

The vcpkg.txt files are indeed superfluous now in manifest mode as we have it all declared in vcpkg.json.

Wires77

We don't need the vcpkg-ports folder anymore, right? Didn't they add a luajit version upstream we can use?

zao · 2023-09-20T02:23:36Z

We don't need the vcpkg-ports folder anymore, right? Didn't they add a luajit version upstream we can use?

The local ports tree is currently unused, we are currently using a LuaJIT port from vcpkg upstream as we define which baseline vcpkg commit and what overlay ports to use in vcpkg-configuration.json.
I didn't remove the tree as I was uncertain if upstream LuaJIT would be good enough.

Wires77

I saw some support for other OSes in here, is the only thing unsupported opening URLs?

Wires77 · 2023-09-20T02:07:09Z

-				glLoadIdentity();
+			nextViewport_ = cmd->viewport;
+			if (showStats_) {
+				// ImGui::Text("VIEWPORT: %dx%d @ %d,%d", cmd->viewport.width, cmd->viewport.height, cmd->viewport.x, cmd->viewport.y);


Guessing these commented lines can be uncommented or removed?

Wires77 · 2023-09-20T02:09:47Z

+	r_layerOptimize = sys->con->Cvar_Add("r_layerOptimize", CV_ARCHIVE | CV_CLAMP, "1", 0, 1);
+	r_layerShuffle = sys->con->Cvar_Add("r_layerShuffle", CV_ARCHIVE | CV_CLAMP, "0", 0, 1);
+	r_elideFrames = sys->con->Cvar_Add("r_elideFrames", CV_ARCHIVE | CV_CLAMP, "1", 0, 1);
+	r_drawCull = sys->con->Cvar_Add("r_drawCull", CV_ARCHIVE | CV_CLAMP, "1", 0, 1);


Cool, was going to ask if these were defaulted properly, as they weren't last time I tested.

Wires77 · 2023-09-20T03:00:53Z

@@ -0,0 +1,158 @@
+// SimpleGraphic Engine
+// (c) David Gowor, 2014


Technically this isn't their work ;)

Wires77 · 2023-09-20T03:10:18Z

Wow, surprised that most of this isn't necessary with GLFW

Wires77 · 2023-09-20T03:11:19Z

 	wrec.right = wrec.left + cur.mode[0];
 	wrec.bottom = wrec.top + cur.mode[1];
-	AdjustWindowRectEx(&wrec, style, FALSE, exStyle);
+	// TODO(LV): Verify that stored coordinates are aligned right.


Showstopping TODO or nice-to-have?

Wires77 · 2023-09-20T04:36:03Z

So one big issue I'm finding is that if I try and attach a debugger on the Lua side via PyCharm, PoB doesn't open and also doesn't kill the process. That invocation looks like this in Launch.lua:OnInit():

package.cpath = package.cpath .. ';C:/Users/trevo/AppData/Roaming/JetBrains/PyCharmCE2021.1/plugins/EmmyLua/debugger/emmy/windows/x86/?.dll'
local dbg = require('emmy_core')
dbg.tcpListen('localhost', 9966)
dbg.waitIDE()

I tried to use GetCloudProvider on Windows 11 using these reproduction steps: PathOfBuildingCommunity/PathOfBuilding#5390 (comment) Unfortunately, the output of the function showed a status of 1 for both a file that had been freed up, and one that was available...

For running on wine (Running in an Ubuntu VM) it looks like we will need to also build VCRUNTIME140D.dll and ucrtbased.dll in order for it to work.

Finally, we need to hide the ImGUI UI by default.

zao · 2023-09-20T12:56:04Z

On the debugger - you seem to use the x86 rather than the x64 DLL. The docs need an update around this assuming it's the only problem. I could attach to the process (which had no window at the time) with PyCharm's Emmy plugin.

The cloud state is more about the provider as a whole rather than individual files as it queries the state of the sync root that contains the path. I couldn't find any conclusive state to query for whether a file could be successfully obtained apart from attempting to actually read it.
The cloud status mostly indicates if the service is running and as such has a chance to hydrate files, with 0 being disconnected, 1 being connected and values up in the 0x8000'0000s suggest that a new file hasn't been ingested yet.

We should never have a dependency on the Debug runtime in a shipping situation and custom is to not ever deploy it outside of a development machine as the license doesn't allow redistribution. To run a Debug build on a machine that doesn't have a dev environment you need to privately deploy those non-redist files - were you running a Debug build or has aspects of it crept into the release?

ImGui - yep.

Wires77 · 2023-09-20T15:32:22Z

On the debugger - you seem to use the x86 rather than the x64 DLL. The docs need an update around this assuming it's the only problem. I could attach to the process (which had no window at the time) with PyCharm's Emmy plugin.

Doh, I just kept using my existing debug lines, forgetting they would have different DLLs. Works fine now as well.

The cloud state is more about the provider as a whole rather than individual files as it queries the state of the sync root that contains the path. I couldn't find any conclusive state to query for whether a file could be successfully obtained apart from attempting to actually read it. The cloud status mostly indicates if the service is running and as such has a chance to hydrate files, with 0 being disconnected, 1 being connected and values up in the 0x8000'0000s suggest that a new file hasn't been ingested yet.

It's better than nothing, we can see what kind of things we can do with that information at least.

We should never have a dependency on the Debug runtime in a shipping situation and custom is to not ever deploy it outside of a development machine as the license doesn't allow redistribution. To run a Debug build on a machine that doesn't have a dev environment you need to privately deploy those non-redist files - were you running a Debug build or has aspects of it crept into the release?

I found it easiest to pull the built binaries onto my VM via this PR: PathOfBuildingCommunity/PathOfBuilding#6705 They were built with these commands:

cmake -A x64 -G "Visual Studio 17 2022" --toolchain .\vcpkg\scripts\buildsystems\vcpkg.cmake -B build-output -DCMAKE_INSTALL_PREFIX=runtime
cmake --build build-output --config RelWithDebInfo -t INSTALL

zao added 30 commits May 14, 2021 16:52

Window creation, own context, partial input handling

cc4d430

Send wheel events from GLFW

10070d4

Skip GLFW context creation

89c36c1

Map GLFW keys more like the native implementation

29a0bab

Move context creation to GLFW and drop async texture loading

0313aec

WIP, everything but win and ui builds

42d3272

Port all UI files

777cbf7

Load GIF via stb_image instead of giflib

c864a76

Compiles on macOS, several things left as TODOs

ed9d5a4

Scale UI according to framebuffer size

3ad2ca2

Build against LuaJIT

2ce5bb6

Make TreeData path separator portable

53cace6

Linux port, replace most image formats with STB libs

4456818

Convert gray-with-alpha PNG to RGBA on load

df8bb64

Replace async key query by tracking key history

4fba9cb

Track cursor history and implement doubleclicking

b50d4c2

CMake build requires zlib for character builds

6b221cf

Compute correct length of console text on UNIX

626f060

Add URL opening with default browser on macOS

7edabe2

Initial port to GLESv2 with ANGLE

e307939

Use vertex buffers, merge adjacent colored draws

08c57d9

Merge all compatible draw calls inside layers

73b0adc

Link RE2 and use non-static dependencies in CI

c08c659

Vendor GLAD ES2 headers, update vcpkg

14cfc8c

Build lcurl and lzip in-tree, add INSTALL target including dependencies

685e023

Draw application to a lower-res texture for DPI scaling

3ab4e3e

Mute MSVC C4996 warnings

d866acb

zao added 6 commits September 13, 2023 19:34

Update CI for x64

aaeea19

Merge branch 'onedrive-info' into angle-meld

e07f05a

Add F10 hotkey for Dear ImGui developer tools

b314bc3

Re-show previous frame if nothing has changed

15c9cc1

We can detect if nothing has changed from the previous frame by computing a cheap hash of the draw command stream and if it matches we reuse the previous contents of the render target we prepare anyway for resolution scaling.

Wires77 requested a review from zao September 17, 2023 03:55

Wires77 mentioned this pull request Sep 17, 2023

Switch renderer from OpenGL to ANGLE #34

Closed

zao added 7 commits September 17, 2023 07:50

Build a single shared vertex buffer for all draws

4803e40

Reduce startup flashbang by presenting early

64abde8

Find LuaJIT/zlib DLLs correctly in clean builds

f61322a

Fix window not storing maximize state across runs

23e8ad0

Wires77 commented Sep 20, 2023

View reviewed changes

zao added 6 commits September 20, 2023 18:01

Clean up build tree, bump vcpkg version

4053210

Hide ImGui tools by default

74b45f4

Bump version to 2.0

7fa002e

Update contribution documentation

30680b7

Update README/DEPENDENCIES docs

d095ce8

Remove more stale files

19cca6d

Wires77 merged commit c3860c9 into PathOfBuildingCommunity:master Sep 22, 2023

zao deleted the angle-meld branch October 16, 2023 13:24

		@@ -0,0 +1,158 @@
		// SimpleGraphic Engine
		// (c) David Gowor, 2014

Conversation

Wires77 commented Sep 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Wires77 Sep 20, 2023

Choose a reason for hiding this comment

Uh oh!

zao Sep 20, 2023

Choose a reason for hiding this comment

Uh oh!

Wires77 left a comment

Choose a reason for hiding this comment

Uh oh!

zao commented Sep 20, 2023

Uh oh!

Wires77 left a comment

Choose a reason for hiding this comment

Uh oh!

Wires77 Sep 20, 2023

Choose a reason for hiding this comment

Uh oh!

Wires77 Sep 20, 2023

Choose a reason for hiding this comment

Uh oh!

Wires77 Sep 20, 2023

Choose a reason for hiding this comment

Uh oh!

Wires77 Sep 20, 2023

Choose a reason for hiding this comment

Uh oh!

Wires77 Sep 20, 2023

Choose a reason for hiding this comment

Uh oh!

Wires77 commented Sep 20, 2023

Uh oh!

zao commented Sep 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Wires77 commented Sep 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Wires77 commented Sep 17, 2023 •

edited

Loading

zao commented Sep 20, 2023 •

edited

Loading

Wires77 commented Sep 20, 2023 •

edited

Loading