skia2

History

Kevin Lubick 5f0e3a158a [PathKit] Made some APIs return null if things failed This makes our calls to emscripten::val a bit more consistent. Adds in the macro SkPathOrVal to self-document where it's really a SkPath we are returning, but C++ doesn't realize SkPath and emscripten::val::null() can be the same type. Casting SkPath via emscripten::val() is basically a no-op, since Emscripten bind seems to be doing it under the hood anyway. No functional changes, except when there would be a failure, methods will return null instead of an empty SkPath. Bug: skia:8216 Change-Id: I1fff620d5aa50ec4a57f76e706d8d005ea26605f Reviewed-on: https://skia-review.googlesource.com/145728 Reviewed-by: Cary Clark <caryclark@google.com> Reviewed-by: Florin Malita <fmalita@chromium.org>		2018-08-07 16:41:58 +00:00
..
example.html	[PathKit] Add more Path2D functionality and move some methods to be members	2018-08-06 19:07:12 +00:00
LICENSE	Make flutter roll happy	2018-08-02 18:22:00 +00:00
package.json	[PathKit] Made some APIs return null if things failed	2018-08-07 16:41:58 +00:00
README.md	Add Debug version of PathKit	2018-08-03 16:54:20 +00:00

README.md

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 example.html for a fuller example of 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'
};