skia2/experimental/pathkit/npm-wasm
Kevin Lubick d993648fa4 [PathKit] Write more complete docs and clean up API to be consistent
Breaking Changes (should be minor, as it's mostly just things
for testing):
 - PathKit.ApplyPathOp should have returned a new SkPath, but didn't.
It now does and is named "MakeFromOp", which makes the convention of
"Have 'make' in name, needs delete" more consistent.
 - PathKit.FromCmds(arr) now only needs to take the JS Array and
will handle the TypedArrays under the hood. If clients want to deal
with TypedArrays themselves, they can use _FromCmds(ptr, len) directly.
 - PathKit.MakeLTRBRect is now just PathKit.LTRBRect. The thing
returned is a normal JS Object and doesn't need delete().

As per custom with v0 apps, we are updating the minor version
to v0.3.0 to account for breaking changes.


Docs-Preview: https://skia.org/?cl=147960
Bug: skia:8216
Change-Id: Ia3626e69f3e97698fc62a6aee876af005e29ffca
Reviewed-on: https://skia-review.googlesource.com/147960
Reviewed-by: Mike Reed <reed@google.com>
Reviewed-by: Heather Miller <hcm@google.com>
2018-08-24 16:30:00 +00:00
..
example.html [PathKit] Write more complete docs and clean up API to be consistent 2018-08-24 16:30:00 +00:00
LICENSE Make flutter roll happy 2018-08-02 18:22:00 +00:00
package.json [PathKit] Write more complete docs and clean up API to be consistent 2018-08-24 16:30:00 +00:00
README.md [PathKit] Add asm.js build and test jobs 2018-08-22 17:19:10 +00:00

A WASM version of Skia's PathOps toolkit.

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

<script src="/node_modules/experimental-pathkit-wasm/bin/pathkit.js"></script>
PathKitInit({
    locateFile: (file) => '/node_modules/experimental-pathkit-wasm/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 .wasm file. By default, it will look for /pathkit.wasm, so if this is not the case, use locateFile to configure this properly. The PathKit object returned through the .then() callback 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 WASM is still somewhat experimental, but PathKit can be used with a few configuration changes.

In the JS code, use require():

const PathKitInit = require('experimental-pathkit-wasm/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.wasm 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/experimental-pathkit-wasm/bin/pathkit.wasm' }
    ])
);

If webpack gives an error similar to:

ERROR in ./node_modules/experimental-pathkit-wasm/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'
};