Files
filament/web/filament-js
Mathias Agopian b2ec57776d new feature level API for backends (#5784)
* new feature level API for backends

backend can now return a "feature level", each level corresponds to a
"bundle" of features.
Level1: ES3.0 capabilities
Level2: ES3.1 capabilities + 31 textures + cubemap arrays

Currently metal always returns level 1, GL and Vulkan return level 2
if 31 textures or more are supported.

* Add public APIs for feature levels

* Add infrastructure to check feature levels in materials

* validate material feature level on use

The validation is done when creating a renderable. If the engine doesn't
support the material's feature level, an exception is thrown (or assert
if exceptions are not enabled).

* material documentation

* activate ESSL 3.10 for feature level 2

also generate #defines to identify available feature levels

* support for cubemap arrays in the public API


if feature level 2 is supported, cubemap arrays can be used from the
public API.

* add release notes
2022-08-17 10:14:26 -07:00
..
2022-05-21 11:57:18 -07:00
2022-08-16 10:59:05 -07:00

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.

  1. Follow the instructions in the toplevel README for installing Emscripten.
  2. Make sure you have an npm account and that your npm account belongs to the Google team.
  3. Edit the version number in package.json. You cannot publish the same version more than once.
  4. From the root folder in your Filament repo, do:
./build.sh -ap webgl release
./build.sh -ap all release
  1. 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}
  1. Push your change to GitHub, then make a GitHub Release associated with your new tag.
  2. 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
  1. If the output of the dry run looks okay to you (double check the version number!), then finally do npm publish.
  1. Update the live drag-and-drop viewer as follows:

    1. Edit the pinned Filament version in the <script> tag in docs/viewer/index.html.
    2. Copy web/filament-js/filament-viewer.js to docs/viewer. To keep life simple, we do not bother minifying this file.
    3. Push these changes to GitHub and test the site: https://google.github.io/filament/viewer/.