Emscripten application #300

Squareys · 2018-12-15T21:02:46Z

Hi @mosra !

This is the pullrequest for the light-weight emscripten HTML5 API based application hackathon project.

Cheers, Jonathan

TODO

src/Magnum/Platform/EmscriptenApplication.cpp

Squareys · 2019-05-05T08:10:28Z

@mosra Is it sensible to really port all of the examples? Should I keep a macro platform switch to demonstrate that Sdl2Application is compatibly replaceable with EmscriptenApplication?

mosra · 2019-05-05T09:27:27Z

Should I keep a macro platform switch to demonstrate that Sdl2Application is compatibly replaceable with EmscriptenApplication?

The EmscriptenApplication should be the sensible default for Emscripten, but Sdl2Application is still the sensible default basically everywhere else. So, yes there should be a platform switch between EmscriptenApplication, Sdl2Application (and AndroidApplication) because the ports branch still needs to compile on all platforms, but there's no need for having an option to use SDL2 on Emscripten.

Squareys · 2019-05-05T19:34:14Z

@mosra This is ready for review! If there is any bigger tasks I completely overlooked, send those over first so I can work on them in parallel to the rest of the review 🙂

mosra

Finally got to review this, sorry about the delay. Should be mostly minor things, no drastic design-changing requests from me ;) Also I think it isn't missing any large thing, apart from the touch events which I have to do for all the apps anyway.

Thank you!

src/Magnum/Platform/CMakeLists.txt

package/ci/travis.yml

src/Magnum/Platform/CMakeLists.txt

src/Magnum/Platform/Test/EmscriptenApplicationTest.cpp

src/Magnum/Platform/EmscriptenApplication.cpp

src/Magnum/Platform/EmscriptenApplication.h

package/ci/travis-emscripten.sh

Squareys · 2019-05-23T08:36:51Z

@mosra This is also ready for the next review pass, then I'll squash the remaining commits down into one.

mosra

I was about to merge, but the EM_JS thing scared me off -- and you can save one include in the header :)

mosra · 2019-05-25T15:10:00Z

CMakeLists.txt

@@ -103,7 +103,7 @@ option(WITH_SHADERS "Build Shaders library" ON)
 cmake_dependent_option(WITH_TEXT "Build Text library" ON "NOT WITH_FONTCONVERTER;NOT WITH_MAGNUMFONT;NOT WITH_MAGNUMFONTCONVERTER" ON)
 cmake_dependent_option(WITH_TEXTURETOOLS "Build TextureTools library" ON "NOT WITH_TEXT;NOT WITH_DISTANCEFIELDCONVERTER" ON)
 cmake_dependent_option(WITH_TRADE "Build Trade library" ON "NOT WITH_MESHTOOLS;NOT WITH_PRIMITIVES;NOT WITH_IMAGECONVERTER;NOT WITH_ANYIMAGEIMPORTER;NOT WITH_ANYIMAGECONVERTER;NOT WITH_ANYSCENEIMPORTER;NOT WITH_OBJIMPORTER;NOT WITH_TGAIMAGECONVERTER;NOT WITH_TGAIMPORTER" ON)
-cmake_dependent_option(WITH_GL "Build GL library" ON "NOT WITH_SHADERS;NOT WITH_GL_INFO;NOT WITH_ANDROIDAPPLICATION;NOT WITH_WINDOWLESSIOSAPPLICATION;NOT WITH_CGLCONTEXT;NOT WITH_GLXAPPLICATION;NOT WITH_GLXCONTEXT;NOT WITH_XEGLAPPLICATION;NOT WITH_WINDOWLESSWGLAPPLICATION;NOT WITH_WGLCONTEXT;NOT WITH_WINDOWLESSWINDOWSEGLAPPLICATION;NOT WITH_DISTANCEFIELDCONVERTER" ON)
+cmake_dependent_option(WITH_GL "Build GL library" ON "NOT WITH_SHADERS;NOT WITH_GL_INFO;NOT WITH_ANDROIDAPPLICATION;NOT WITH_WINDOWLESSIOSAPPLICATION;NOT WITH_CGLCONTEXT;NOT WITH_GLXAPPLICATION;NOT WITH_GLXCONTEXT;NOT WITH_XEGLAPPLICATION;NOT WITH_WINDOWLESSWGLAPPLICATION;NOT WITH_WGLCONTEXT;NOT WITH_WINDOWLESSWINDOWSEGLAPPLICATION;NOT WITH_EMSCRIPTENAPPLICATION;NOT WITH_DISTANCEFIELDCONVERTER" ON)


The app has #ifndef MAGNUM_TARGET_GL and should thus theoretically work when WITH_GL is disabled, no? The SDL and GLFW apps are not here either.

To be extra sure, can you verify it builds when WITH_GL is disabled?

Was a very good idea, found quite a couple of issues with the GL-less build.
I think the SDL has compile issues without GL, though 🤔 That appears to be the combination of emscripten and non-GL. That would not make sense for Sdl2Application to support, though, right?

Thanks!

SDL should compile w/o GL mainly on desktop and mobile (Vulkan), I don't care much if it breaks on Emscripten tho, since it was superseded by your implementation now :) For EmscriptenApplication we should be able to turn off GL either for WebGPU or 3rd party renderers.

doc/platforms-html5.dox

mosra · 2019-05-25T15:11:12Z

doc/platforms-html5.dox

@@ -351,7 +351,7 @@ Module.doNotCaptureKeyboard = true;
 @endcode

 The above is implicitly set for windowless apps, because these don't have any
-event loop.
+event loop, and is not supported by @ref Platform::EmscriptenApplication.


I would instead mention that there's WindowlessEglApplication that can be used, instead of saying this is not supported by EmscriptenApp.

src/Magnum/Platform/EmscriptenApplication.cpp

src/Magnum/Platform/EmscriptenApplication.h

mosra · 2019-05-25T16:06:07Z

src/Magnum/Platform/EmscriptenApplication.cpp

+    /* The resize event is not fired on window resize, so poll for the canvas
+       size here. But only if the window was requested to be resizable, to
+       avoid resizing the canvas when the user doesn't want that. Related
+       issue: https://github.com/kripken/emscripten/issues/1731 */


This AFAIK holds for emscripten_set_resize_callback() as well, right? Maybe update the comment to make it clear it's not just a copypasted assumption from Sdl2App.

Good question, I think it may actually fire even.

Yes, it holds, see the note in the emscripten documentation

Hmm. That led me to think we could attach the callback to the window instead of this ugly polling. Will try this locally.

codecov-io · 2019-05-25T21:42:23Z

Codecov Report

Merging #300 into master will increase coverage by 0.01%.
The diff coverage is 100%.

@@            Coverage Diff            @@
##           master    #300      +/-   ##
=========================================
+ Coverage   71.39%   71.4%   +0.01%     
=========================================
  Files         349     349              
  Lines       17598   17595       -3     
=========================================
  Hits        12564   12564              
+ Misses       5034    5031       -3

Impacted Files	Coverage Δ
src/Magnum/GL/TimeQuery.h	`25% <ø> (ø)`	⬆️
src/Magnum/Animation/Easing.h	`100% <100%> (ø)`	⬆️
src/Magnum/GL/Context.cpp	`65.58% <0%> (+0.26%)`	⬆️
src/Magnum/Shaders/Phong.cpp	`77.86% <0%> (+1.25%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b11873b...733d417. Read the comment docs.

By mistake I thought it's the same as in Emscripten's SDL, but there Emscripten does some emulation to ensure windowSize() == framebufferSize(). For the resize event it's possible to hook into the window resize callback instead of polling for the size every frame, That's much more efficient.

Also store them as references and not pointers.

The exec() should return int to be API-compatible with other implementations.

And expose it to the users.

Signed-off-by: Squareys <squareys@googlemail.com>

Signed-off-by: Squareys <squareys@googlemail.com> Co-authored-by: Vladimír Vondruš <mosra@centrum.cz>

Signed-off-by: Squareys <squareys@googlemail.com>

mosra · 2019-06-05T13:28:53Z

🎉

Squareys · 2019-06-05T14:01:04Z

@mosra Thanks for merging! And especially thanks for all the great cleanup work! 🎉

Squareys force-pushed the emscripten-application branch 5 times, most recently from 4b89b04 to a976270 Compare December 17, 2018 07:13

mosra mentioned this pull request Dec 29, 2018

Port Sdl2Application to Android #186

Open

7 tasks

mosra mentioned this pull request Mar 7, 2019

Compilation time, CI time and executable size improvements #293

Open

97 tasks

Squareys force-pushed the emscripten-application branch 2 times, most recently from 55dfa4f to 2d9d36d Compare April 10, 2019 14:11

mosra reviewed Apr 11, 2019

View reviewed changes

src/Magnum/Platform/EmscriptenApplication.cpp Outdated Show resolved Hide resolved

Squareys mentioned this pull request Apr 15, 2019

base-emscripten: Use EmscriptenApplication mosra/magnum-bootstrap#17

Closed

Squareys force-pushed the emscripten-application branch from edafc8d to 5d91571 Compare April 15, 2019 15:36

Squareys commented Apr 26, 2019

View reviewed changes

src/Magnum/Platform/EmscriptenApplication.cpp Outdated Show resolved Hide resolved

src/Magnum/Platform/EmscriptenApplication.cpp Outdated Show resolved Hide resolved

This was referenced May 5, 2019

Use EmscriptenApplication for emscripten ports mosra/magnum-examples#59

Closed

webvr: Use EmscriptenApplication mosra/magnum-examples#60

Closed

Squareys force-pushed the emscripten-application branch from cb6eb58 to f815ba5 Compare May 5, 2019 19:32

Squareys mentioned this pull request May 7, 2019

Use Emscripten application mosra/magnum-extras#10

Closed

mosra requested changes May 17, 2019

View reviewed changes

mosra mentioned this pull request May 21, 2019

2019.10 release #340

Closed

60 tasks

Squareys changed the title ~~[WIP] Emscripten application~~ Emscripten application May 22, 2019

Squareys force-pushed the emscripten-application branch from 586d281 to 7014d16 Compare May 23, 2019 07:43

Squareys commented May 23, 2019

View reviewed changes

package/ci/travis-emscripten.sh Outdated Show resolved Hide resolved

mosra reviewed May 25, 2019

View reviewed changes

mosra added this to the 2019.0b milestone May 25, 2019

mosra and others added 21 commits June 4, 2019 23:19

Platform: test explicitly enabled extensions in EmscriptenApplication.

e64adb7

Platform: test also key release events in EmscriptenApplication.

5ddd3a6

Platform: test initial window size params in GLFW and SDL2 apps.

562cf67

Platform: no need to reinterpret_cast the void pointers.

b28ac46

Platform: do not redraw all the time in EmscriptenApplicationTest.

ba1ca34

Platform: expose raw event structures in EmscriptenApplication.

1aa4989

Also store them as references and not pointers.

Platform: why this is here and not here.

e7671c0

Platform: this is all wrong anyway and mainLoopIteration() is useless.

e0019f5

The exec() should return int to be API-compatible with other implementations.

Platform: actually properly destroy the WebGL context after.

ac0d698

And expose it to the users.

Platform: test EmscriptenApplication text input.

9ac7c7f

Platform: why is this protected when it's public elsewhere.

41859d8

Platform: add EmscriptenApplication::setContainerCssClass().

de0d991

Platform: move friends into privates.

1bd78f9

Platform: doc++

ed564b5

doc: mention EmscriptenApplication everywhere.

aa67673

dox: Link to building-doc from developer guide

62e74ea

Signed-off-by: Squareys <squareys@googlemail.com>

package/archlinux: enable EmscriptenApplication.

524e8a9

Platform: Fix UTF8 text input in EmscriptenApplication

cc28453

Signed-off-by: Squareys <squareys@googlemail.com> Co-authored-by: Vladimír Vondruš <mosra@centrum.cz>

Platform: light-weight main loop for EmscriptenApplication

6e5f6b8

Signed-off-by: Squareys <squareys@googlemail.com>

Platform: testing for wheel events.

733d417

mosra force-pushed the emscripten-application branch from c6f242e to 733d417 Compare June 5, 2019 08:03

mosra approved these changes Jun 5, 2019

View reviewed changes

mosra merged commit 733d417 into mosra:master Jun 5, 2019

mosra added the changelog mention added label Jun 5, 2019

Squareys deleted the emscripten-application branch June 5, 2019 14:01

mosra mentioned this pull request Jul 5, 2019

Correct out-of-the-box HiDPI support in SDL, GLFW and Android apps #243

Open

30 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Emscripten application #300

Emscripten application #300

Squareys commented Dec 15, 2018 •

edited

Loading

Squareys commented May 5, 2019

mosra commented May 5, 2019

Squareys commented May 5, 2019

mosra left a comment

Squareys commented May 23, 2019

mosra left a comment

mosra May 25, 2019

Squareys May 25, 2019

mosra May 26, 2019

mosra May 25, 2019

mosra May 25, 2019

Squareys May 25, 2019

Squareys May 25, 2019

mosra May 26, 2019

codecov-io commented May 25, 2019 •

edited

Loading

mosra commented Jun 5, 2019

Squareys commented Jun 5, 2019

Emscripten application #300

Emscripten application #300

Conversation

Squareys commented Dec 15, 2018 • edited Loading

Squareys commented May 5, 2019

mosra commented May 5, 2019

Squareys commented May 5, 2019

mosra left a comment

Choose a reason for hiding this comment

Squareys commented May 23, 2019

mosra left a 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

codecov-io commented May 25, 2019 • edited Loading

Codecov Report

mosra commented Jun 5, 2019

Squareys commented Jun 5, 2019

Squareys commented Dec 15, 2018 •

edited

Loading

codecov-io commented May 25, 2019 •

edited

Loading