skia2/modules/pathkit/npm-asmjs
Kevin Lubick d1285b131b Upgrade CanvasKit emscripten to version 1.39.16.
Changes are largely mechanical.  Non-mechanical changes to support newer
versions of emscripten are enumerated below, in format ${EMSCRIPTEN_VERSION}:
${RELEVANT_CHANGE}.

- 1.39.9: TOTAL_MEMORY has been renamed INITIAL_MEMORY.
- 1.39.12: passing of linker flags to wasm-ld has changed in a way that requires
  supplying `--no-entry` to avoid error message "wasm-ld: error: entry symbol
  not defined (pass --no-entry to suppress): main".
- 1.39.16: The factory function created by using `MODULARIZE` build option now
  returns a Promise instead of the module instance.  As such, the ready.js
  workaround is removed.  Note this is a breaking API change for CanvasKit,
  which now uses just `then()` and not `ready().then()`.
- 1.38.33: `emsdk install` hasn't required the `-64bit` suffix on version names
  since `1.38.33`, so we remove them.  E.g. `emsdk install sdk-1.39.6-64bit`
  simply becomes `emsdk install sdk-1.39.16`.

cf. https://github.com/emscripten-core/emscripten/blob/master/ChangeLog.md

Bug: NONE
Change-Id: Iabec4bd5ad7db2e0715ad42c2e4cf7d67b192b4c
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/291182
Reviewed-by: Kevin Lubick <kjlubick@google.com>
2020-05-21 14:18:48 +00:00
..
CODE_OF_CONDUCT.md [canvaskit] Add files needed for npm release 2018-12-17 17:21:34 +00:00
CONTRIBUTING.md [canvaskit] Add files needed for npm release 2018-12-17 17:21:34 +00:00
example.html Upgrade CanvasKit emscripten to version 1.39.16. 2020-05-21 14:18:48 +00:00
LICENSE [canvaskit] Add files needed for npm release 2018-12-17 17:21:34 +00:00
package.json [pathkit][canvaskit] roll versions 2019-02-25 21:53:53 +00:00
README.md Upgrade CanvasKit emscripten to version 1.39.16. 2020-05-21 14:18:48 +00:00

An asm.js version of Skia's PathOps toolkit.

To use the library, run npm install pathkit-asmjs and then simply include it:

<script src="/node_modules/pathkit-asmjs/bin/pathkit.js"></script>
PathKitInit({
    locateFile: (file) => '/node_modules/pathkit-asmjs/bin/'+file,
}).then((PathKit) => {
    // Code goes here using PathKit
});

PathKit comes in two parts, a JS loader and the actual WASM code. The JS loader creates a global PathKitInit that can be called to load the WASM code. The locateFile function is used to tell the JS loader where to find the .js.mem file. By default, it will look for /pathkit.js.mem, so if this is not the case, use locateFile to configure this properly. The PathKit object returned upon resolution of the PathKitInit Promise is fully loaded and ready to use.

See the API page and example.html for details on how to use the library.

Using PathKit and WebPack

WebPack's support for asm.js should be straight-forward, since it's just another JS library. PathKit can be used with just a few configuration changes.

In the JS code, use require():

const PathKitInit = require('pathkit-asmjs/bin/pathkit.js')
PathKitInit().then((PathKit) => {
    // Code goes here using PathKit
})

Since WebPack does not expose the entire /node_modules/ directory, but instead packages only the needed pieces, we have to copy pathkit.mem into the build directory. One such solution is to use CopyWebpackPlugin. For example, add the following plugin:

config.plugins.push(
    new CopyWebpackPlugin([
        { from: 'node_modules/pathkit-asmjs/bin/pathkit.js.mem' }
    ])
);

If webpack gives an error similar to:

ERROR in ./node_modules/pathkit-asmjs/bin/pathkit.js
Module not found: Error: Can't resolve 'fs' in '...'

Then, add the following configuration change to the node section of the config:

config.node = {
    fs: 'empty'
};