skia2/modules/canvaskit
Greg Daniel 49de1031d4 Reland "Remove deprecated flush calls."
This reverts commit 5e6d789ce4.

Reason for revert: Relanding with fix landed in chrome

Original change's description:
> Revert "Remove deprecated flush calls."
> 
> This reverts commit d8fd0bf574.
> 
> Reason for revert: chrome roll
> 
> Original change's description:
> > Remove deprecated flush calls.
> > 
> > Bug: skia:10118
> > Change-Id: I13758b5416784c296b8b5be9f3228230ac1be05f
> > Reviewed-on: https://skia-review.googlesource.com/c/skia/+/290540
> > Commit-Queue: Greg Daniel <egdaniel@google.com>
> > Reviewed-by: Brian Salomon <bsalomon@google.com>
> 
> TBR=egdaniel@google.com,bsalomon@google.com
> 
> Change-Id: I49d35cdb258e632f645974c5ec62075d3392efe0
> No-Presubmit: true
> No-Tree-Checks: true
> No-Try: true
> Bug: skia:10118
> Reviewed-on: https://skia-review.googlesource.com/c/skia/+/290834
> Reviewed-by: Greg Daniel <egdaniel@google.com>
> Commit-Queue: Greg Daniel <egdaniel@google.com>

TBR=egdaniel@google.com,bsalomon@google.com

# Not skipping CQ checks because this is a reland.

Bug: skia:10118
Change-Id: Ie24d7845a4ad75f95afe59037ea80a9f38082f13
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/290918
Reviewed-by: Greg Daniel <egdaniel@google.com>
Commit-Queue: Greg Daniel <egdaniel@google.com>
2020-05-20 15:48:46 +00:00
..
canvaskit try adding some code to example.html 2020-05-19 18:55:15 +00:00
fonts [canvaskit] Clean up embedded fonts 2019-10-09 14:51:39 +00:00
htmlcanvas Reland "Switch to using a Float32Array (bound as value array) for color." 2020-03-26 14:41:29 +00:00
perf Pass 4f colors to private functions with float pointers 2020-05-05 13:17:28 +00:00
tests Add 'shader' as an alias for 'fragmentProcessor' 2020-05-15 13:52:15 +00:00
.gitignore [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
BUILD.gn reformat GN files 2020-04-01 23:23:03 +00:00
canvaskit_bindings.cpp Reland "Remove deprecated flush calls." 2020-05-20 15:48:46 +00:00
catchExceptionNop.js JS files to support running jasmine tests in google3 2020-03-09 14:20:27 +00:00
CHANGELOG.md [canvaskit] Update to 0.15.0 2020-05-14 19:54:26 +00:00
compile.sh [canvaskit] Update to 0.15.0 2020-05-14 19:54:26 +00:00
cpu.js rm CanvasKit.HEAPU8.buffer caching (fix UAF bug). 2020-01-15 14:48:36 +00:00
debug.js Expose 4x4 matrices on canvas in a way similar to SimpleMatrix, add example. 2020-02-22 00:12:13 +00:00
externs.js [canvaskit] Properly fix Safari (detect if WebGL2 is not available) 2020-05-14 19:15:25 +00:00
font.js Clean up Enums in Canvaskit 2020-03-10 15:17:20 +00:00
gpu.js [canvaskit] Properly fix Safari (detect if WebGL2 is not available) 2020-05-14 19:15:25 +00:00
helper.js Pass 4f colors to private functions with float pointers 2020-05-05 13:17:28 +00:00
interface.js Add markCTM to canvaskit API, use in 3D cube example 2020-05-06 21:10:34 +00:00
karma.bench.conf.js Pass 4f colors to private functions with float pointers 2020-05-05 13:17:28 +00:00
karma.conf.js [canvaskit] Try some things to reduce GPU test flakiness 2019-11-21 20:56:42 +00:00
karma.google3.conf.js JS files to support running jasmine tests in google3 2020-03-09 14:20:27 +00:00
Makefile [canvaskit] Enable font edging 2020-05-08 13:22:18 +00:00
package.json [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
paragraph_bindings.cpp [canvaskit] Fix memory leak in paragraph bindings 2020-05-14 14:48:21 +00:00
paragraph.js [canvaskit] Fix memory leak in paragraph bindings 2020-05-14 14:48:21 +00:00
particles_bindings.cpp Pure SkSL RNG for particles 2020-04-10 17:20:07 +00:00
particles.js [canvaskit] Expose bindings to particles uniforms. 2020-02-21 14:43:01 +00:00
pathops.js [canvaskit] Add build flag for pathops 2020-01-06 13:10:43 +00:00
postamble.js [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
preamble.js [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
README.md [canvaskit] Update build script to support latest Emscripten 2020-01-28 15:41:58 +00:00
ready.js [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
release.js Expose 4x4 matrices on canvas in a way similar to SimpleMatrix, add example. 2020-02-22 00:12:13 +00:00
rt_shader.js [canvaskit] Handle 4x4 matrix passing ourselves. 2020-04-06 19:21:58 +00:00
serve.py [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
skottie_bindings.cpp [skottie-wasm] Add support for nested animation playback 2020-05-07 12:31:57 +00:00
skottie.js Pass 4f colors to private functions with float pointers 2020-05-05 13:17:28 +00:00
skp.js Add support for reading .skp files in CanvasKit. 2020-01-15 14:46:37 +00:00
viewer_bindings.cpp Fix the CanvasKit viewer build 2020-04-02 11:23:29 +00:00
WasmCommon.h Pass 4f colors to private functions with float pointers 2020-05-05 13:17:28 +00:00

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.