tree: f647e98eac051a3110b77519088f31e2b47bfbe5 [path history] [tgz]
  1. .gitignore
  2. BUILD.gn
  3. CHANGELOG.md
  4. Makefile
  5. README.md
  6. WasmAliases.h
  7. canvaskit/
  8. canvaskit_bindings.cpp
  9. catchExceptionNop.js
  10. compile.sh
  11. cpu.js
  12. debug.js
  13. externs.js
  14. font.js
  15. fonts/
  16. gpu.js
  17. helper.js
  18. htmlcanvas/
  19. interface.js
  20. karma.bench.conf.js
  21. karma.conf.js
  22. karma.google3.conf.js
  23. package.json
  24. paragraph.js
  25. paragraph_bindings.cpp
  26. particles.js
  27. particles_bindings.cpp
  28. pathops.js
  29. perf/
  30. postamble.js
  31. preamble.js
  32. ready.js
  33. release.js
  34. rt_shader.js
  35. serve.py
  36. skottie.js
  37. skottie_bindings.cpp
  38. skp.js
  39. tests/
  40. viewer_bindings.cpp
modules/canvaskit/README.md

Prerequisites

To compile CanvasKit, you will first need to install emscripten. This will set the environment EMSDK (among others) which is required for compilation.

Compile and Test Locally

make release  # make debug is much faster and has better error messages
make local-example

This will print a local endpoint for viewing the example. You can experiment with the CanvasKit API by modifying ./canvaskit/example.html and refreshing the page. For some more experimental APIs, there's also ./canvaskit/extra.html.

For other available build targets, see Makefile and compile.sh. For example, building a stripped-down version of CanvasKit with no text support or any of the “extras”, one might run:

./compile.sh no_skottie no_particles no_font

Such a stripped-down version is about half the size of the default release build.

Infrastructure Playbook

When dealing with CanvasKit (or PathKit) on our bots, we use Docker. Check out $SKIA_ROOT/infra/wasm-common/docker/README.md for more on building/editing the images used for building and testing.

Updating the version of Emscripten we build/test with

This presumes you have updated emscripten locally to a newer version of the sdk and verified/fixed any build issues that have arisen.

  1. Edit $SKIA_ROOT/infra/wasm-common/docker/emsdk-base/Dockerfile to install and activate the desired version of Emscripten.
  2. Edit $SKIA_ROOT/infra/wasm-common/docker/Makefile to have EMSDK_VERSION be set to that desired version. If there is a suffix that is not _v1, reset it to be _v1. If testing the image later does not work and edits are made to the emsdk-base Dockerfile to correct that, increment to _v2,_v3, etc to force the bots to pick up the new image.
  3. In $SKIA_ROOT/infra/wasm-common/docker/, run make publish_emsdk_base
  4. Edit $SKIA_ROOT/infra/canvaskit/docker/canvaskit-emsdk/Dockerfile to be based off the new version from step 2. CanvasKit has its own docker image because it needs a few extra dependencies to build with font support.
  5. Edit $SKIA_ROOT/infra/canvaskit/docker/Makefile to have the same version from step 2. It's easiest to keep the emsdk-base and canvaskit-emsdk versions be in lock-step.
  6. In $SKIA_ROOT/infra/canvaskit/docker/, make publish_canvaskit_emsdk.
  7. In $SKIA_ROOT/infra/bots/recipe_modules/build/, update canvaskit.py and pathkit.py to have DOCKER_IMAAGE point to the desired tagged Docker containers from steps 2 and 5 (which should be the same).
  8. In $SKIA_ROOT/infra/bots/, run make train to re-train the recipes.
  9. Optional: Run something like git grep 1\\.38\\. in $SKIA_ROOT to see if there are any other references that need updating.
  10. Upload a CL with all the changes. Run all Test.+CanvasKit, Perf.+CanvasKit, Test.+PathKit, Perf.+PathKit jobs to make sure the new builds pass all tests and don't crash the perf harnesses.
  11. Send out CL for review. Feel free to point the reviewer at these steps.