[WIP] Test emscripten build for WebGL deployment #53

msavva · 2019-05-28T04:54:37Z

Motivation and Context

Preliminary testing of habitat-sim compiling through emscripten for WebGL deployment. Currently, just a "pile of hacks" to get viewer utility binary working only with pre-loaded data package containing test scenes.

Before landing will need to:

Figure out proper handling of dynamic asset loading (example dynamic data package loading here)
Remove hack ignoring texSize setting (see here)
Also compile with headless contexts so that things other than viewer utility work
Lots of other stuff ...

How Has This Been Tested

Download and install emscripten SDK from https://emscripten.org/
Make sure to source emscripten env variables before building (i.e. source ~/code/emsdk/emsdk_env.sh or similar)
Run ./build_js.sh
Follow instructions at end of build to launch server and open viewer in browser tab

Types of changes

Docs change / refactoring / dependency upgrade
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have completed my CLA (see CONTRIBUTING)
I have added tests to cover my changes.
All new and existing tests passed.

mosra

You're moving fast! :) Added a bunch of notes that might be (hopefully) helpful.

src/CMakeLists.txt

src/esp/core/logging.h

src/esp/gfx/GenericShader.cpp

mosra · 2019-05-28T09:03:59Z

src/esp/gfx/GenericShader.cpp

@@ -160,8 +162,11 @@ GenericShader& GenericShader::bindTexture(Magnum::GL::Texture2D& texture) {

  texture.bind(TextureLayer);

+// TODO this is a hack and terrible! Properly set texSize for WebGL builds


I guess having bindTexture(Texture2D& texture, int size) would be a solution, right? Unfortunately until ES 3.1 there's no way to query texture image sizes.

src/utils/datatool/CMakeLists.txt

mosra · 2019-05-28T09:09:21Z

src/esp/gfx/CMakeLists.txt

+# If not WebGL build, also include offscreen render-reliant code
+# TODO: this should be built as well (with emscripten windowless contexts)
+if(NOT BUILD_WEBGL)
+  list(APPEND gfx_SOURCES Simulator.cpp WindowlessContext.cpp)


The Magnum builtin WindowlessEglApplication works as-is on Emscripten, but I'm not sure about your modified version -- the extension APIs most definitely aren't defined there. I can take a look at this once I get to integrating your WindowlessContext modifications back into Magnum.

build_js.sh

src/utils/viewer/viewer.html

mathfac · 2019-06-01T23:02:56Z

If this PR will be rebased on latest master we will get proper CI testing.

…ng for emscripten

…tead of custom defines

abhiskk · 2019-06-27T03:32:03Z

build_js.sh

+    -DBUILD_DATATOOL=OFF \
+    -DBUILD_PTEX_SUPPORT=OFF \
+    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_PREFIX_PATH="$EMSCRIPTEN" \


The $EMSCRIPTEN variable should be explicitly set to the prefix where emscripten was built otherwise it picks up the wrong compiler.

Thanks @abhiskk for testing out this PR and support in my absence. Regarding, the $EMSCRIPTEN variable: it is defined by sourcing the installed emscripten distribution's emsdk_env.sh file so it is in general a good idea to leave that not explicitly set in the script here. Perhaps it would be good to include in the script a source /path/to/emsdk_env.sh statement though and ask people to modify as necessary.

mosra · 2019-08-08T10:34:09Z

Since #133 got merged, this can be closed, right? Or is here something left that didn't get into #133 (JS bindings code)?

msavva · 2019-08-08T19:34:33Z

Since #133 got merged, this can be closed, right? Or is here something left that didn't get into #133 (JS bindings code)?

Yes, it should be getting closed fairly soon. There are indeed a few JS bindings here that will make their way in as a separate PR.

msavva · 2019-08-22T17:26:00Z

Functionality in this PR has been cleanly merged in separate PRs (mostly #133 and #166). Closing this PR.

facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label May 28, 2019

mosra reviewed May 28, 2019

View reviewed changes

mosra mentioned this pull request May 29, 2019

Use AnySceneImporter for loading arbitrary formats #57

Merged

11 tasks

msavva mentioned this pull request May 30, 2019

Minor CMake cleanup #58

Merged

11 tasks

msavva force-pushed the decouple-util-deps branch from e1e0ebc to b8a417d Compare May 30, 2019 03:22

msavva added 21 commits June 7, 2019 18:58

move SceneLoader into datatool as it is only used there

12ca626

remove SceneLoader from tests

6b68275

make datatool build optional

8125719

remove unused tinyobjloader dep

fdb7e87

remove tinyobjloader include from cmake dependencies

6922388

make building of python bindings conditional

1f53bc9

remove redundant linking of glog

d1c431c

add missing set include

9c4d929

glog broken in emscripten, use glog shims instead of glog when buildi…

87af1d4

…ng for emscripten

add flag for conditional building of ptex support

5abfa65

build changes for conditional compilation of WebGL build

5e3c309

cleanup viewer CMakeLists.txt

380584e

add scaffolding for WebGL build

83d6f0c

add build_js.sh test script

a3b0599

add done message to build_js.sh

bc07dcf

add messages for conditionally built components

0212000

make container fullsize

bf33144

use ALLOW_MEMORY_GROWTH=1 instead of setting size explicitly

a4c551a

use Magnum DebugUtils as glog logging alternative instead of iostreams

8e22ccd

switch to using CORRADE_TARGET_EMSCRIPTEN and MAGNUM_TARGET_WEBGL ins…

4b96235

…tead of custom defines

rename GreedyFollower CODES enum to fix clash with glog shim definitions

0a41312

msavva force-pushed the decouple-util-deps branch from bee06d2 to 0a41312 Compare June 8, 2019 02:26

msavva added 2 commits June 7, 2019 19:57

compile WindowlessContext and Simulator

39e53c4

bindings_js WIP

1dcc449

abhiskk suggested changes Jun 27, 2019

View reviewed changes

msavva mentioned this pull request Jul 2, 2019

Moving to Magnum Python bindings #64

Merged

13 tasks

mosra mentioned this pull request Jul 27, 2019

Proposal: replace glog with Corrade::Utility::Debug #121

Closed

msavva closed this Aug 22, 2019

msavva deleted the decouple-util-deps branch August 22, 2019 17:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Test emscripten build for WebGL deployment #53

[WIP] Test emscripten build for WebGL deployment #53

msavva commented May 28, 2019 •

edited

Loading

mosra left a comment •

edited

Loading

mosra May 28, 2019

mosra May 28, 2019

mathfac commented Jun 1, 2019

abhiskk Jun 27, 2019

msavva Jul 2, 2019 •

edited

Loading

mosra commented Aug 8, 2019 •

edited

Loading

msavva commented Aug 8, 2019

msavva commented Aug 22, 2019

		@@ -160,8 +162,11 @@ GenericShader& GenericShader::bindTexture(Magnum::GL::Texture2D& texture) {

		texture.bind(TextureLayer);

		// TODO this is a hack and terrible! Properly set texSize for WebGL builds

[WIP] Test emscripten build for WebGL deployment #53

[WIP] Test emscripten build for WebGL deployment #53

Conversation

msavva commented May 28, 2019 • edited Loading

Motivation and Context

How Has This Been Tested

Types of changes

Checklist

mosra left a comment • edited Loading

Choose a reason for hiding this comment

mosra May 28, 2019

Choose a reason for hiding this comment

mosra May 28, 2019

Choose a reason for hiding this comment

mathfac commented Jun 1, 2019

abhiskk Jun 27, 2019

Choose a reason for hiding this comment

msavva Jul 2, 2019 • edited Loading

Choose a reason for hiding this comment

mosra commented Aug 8, 2019 • edited Loading

msavva commented Aug 8, 2019

msavva commented Aug 22, 2019

msavva commented May 28, 2019 •

edited

Loading

mosra left a comment •

edited

Loading

msavva Jul 2, 2019 •

edited

Loading

mosra commented Aug 8, 2019 •

edited

Loading