a73957a590
* Refactor web examples and tutorials - Consolidate web/docs and web/samples into web/examples - Remove literal programming blocks from Markdown tutorials - Replace tutorial_template.html with a fully embedded template in serve.py - Move serve.py to web/examples/serve.py and update dependency rules - Update filament-js wrapper to expose _malloc, _free and set GEN_MIPMAPPABLE usage - Update sample materials and WebGL asset generation within web/examples/CMakeLists.txt - Add python venv instructions and usage details to web/README.md - Remove obsolete examples, Pipfile, and demo templates * Transfer web tutorials and samples to docs_src - Introduce copy_web_docs.py api to deploy and rewrite web sample outputs into the docs output tree - Hook copy_web_docs into docs_src/build/run.py natively - Configure duplicates.json to map WebGL outputs to embedded .md docs - Strip html skeleton out of examples in run.py so they map into markdown cleanly - Update update-docs workflow to pre-build the WebGL target - Remove obsolete remote docs path from src_raw - Add explanatory comments to copy_web_docs.py and run.py - Add index page with thumbnails for Web Tutorials and samples
Filament for Web
Filament is a mobile-first library for physically based rendering. It has a lightweight C++ core made available to web developers via a WebAssembly module. The WASM file is bundled with a first-class JavaScript API.
See the web docs for more information.
Publishing to npm
See Versioning.md for a description of Filament's three-tier versioning scheme.
By pushing Filament's WebAssembly build to the npm registry, we can simplify the workflow for web developers due to tools like yarn. This also has the benefit of making Filament available on CDN servers like unpkg and jsdelivr.
To publish a new package to npm, do the following.
- Follow the instructions in the toplevel README for installing Emscripten.
- Make sure you have an npm account and that your npm account belongs to the Google team.
- Edit the version number in
package.json. You cannot publish the same version more than once. - From the root folder in your Filament repo, do:
./build.sh -ap webgl release
./build.sh -ap all release
- Make a commit and a tag whose label is the 3-tiered version number prefixed with a
v:
git commit && git tag -a v{XX}.{YY}.{ZZ}
- Push your change to GitHub, then make a GitHub Release associated with your new tag.
- Perform a "dry run" of the npm packaging process:
| ‼️ | If there is a material change, be sure to update the live demos! |
|---|
cd out/cmake-webgl-release/web/filament-js
npm publish --dry-run
- If the output of the dry run looks okay to you (double check the version number!), then finally
do
npm publish.
-
Update the live drag-and-drop viewer as follows:
- Edit the pinned Filament version in the
<script>tag indocs/viewer/index.html. - Push the change to GitHub and test the site:
https://google.github.io/filament/viewer/.
- Edit the pinned Filament version in the