6130d5079d
Change-Id: I839fea29c2e56cfc2a4e4557da3197bf211513eb Reviewed-on: https://skia-review.googlesource.com/c/skia/+/299654 Commit-Queue: Nathaniel Nifong <nifong@google.com> Reviewed-by: Kevin Lubick <kjlubick@google.com>
22 KiB
22 KiB
CanvasKit Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[Unreleased]
Added
- Added
CanvasKit.MakeImageFromCanvasImageSource
which takes either an HTMLImageElement, SVGImageElement, HTMLVideoElement, HTMLCanvasElement, ImageBitmap, or OffscreenCanvas and returns an SkImage. This function is an alternative toCanvasKit.MakeImageFromEncoded
for creating SkImages when loading and decoding images. In the future, codesize of CanvasKit may be able to be reduced by removing image codecs in wasm, if browser APIs for decoding images are used along withCanvasKit.MakeImageFromCanvasImageSource
instead ofCanvasKit.MakeImageFromEncoded
. - Three usage examples of
CanvasKit.MakeImageFromCanvasImageSource
in core.spec.ts. - Added support for asynchronous callbacks in perfs and tests.
CanvasKit.SkPath.MakeFromVerbsPointsWeights
andCanvasKit.SkPath.addVerbsPointsWeights
for supplying many path operations (e.g. moveTo, cubicTo) at once.- The object returned by
CanvasKit.malloc
now has asubarray
method which works exactly like the normal TypedArray version. The TypedArray which it returns is also backed by WASM memory and when passed into CanvasKit will be used w/o copying the data (just likeMalloc.toTypedArray
). SkM44.setupCamera
to return a 4x4 matrix which sets up a perspective view from a camera.
Changed
- In all places where color arrays are accepted (gradient makers, drawAtlas, and MakeSkVertices), You can now provide either flat Float32Arrays of float colors, Uint32Arrays of int colors, or 2d Arrays of Float32Array(4) colors. The one thing you should not pass is an Array of numbers, since canvaskit wouldn't be able to tell whether they're ints or floats without checking them all. The fastest choice for gradients is the flat Float32Array, the fastest choice for drawAtlas and MakeSkVertices is the flat Uint32Array.
- Color arrays may also be objects created with CanvasKit.Malloc
Fixed
TextStyle.color
can correctly be a Malloc'd Float32Array.
Deprecated
CanvasKit.MakePathFromCmds
has been renamed toCanvasKit.SkPath.MakeFromCmds
. The alias will be removed in an upcoming release.
[0.16.2] - 2020-06-05
Fixed
- A bug where loading fonts (and other memory intensive calls) would cause CanvasKit
to infrequently crash with
TypeError: Cannot perform %TypedArray%.prototype.set on a neutered ArrayBuffer
. - Incorrectly freeing Malloced colors passed into computeTonalColors.
[0.16.1] - 2020-06-04
Fixed
- Colors are unsigned to be compatible with Flutter Web and previous behavior, not signed ints.
[0.16.0] - 2020-06-03
Added
- Support for wide-gamut color spaces DisplayP3 and AdobeRGB. However, correct representation on a WCG monitor requires that the browser is rendering everything to the DisplayP3 or AdobeRGB profile, since there is not yet any way to indicate to the browser that a canvas element has a non-sRGB color space. See color support example in extra.html. Only supported for WebGL2 backed surfaces.
- Added
SkSurface.reportBackendType
which returns either 'CPU' or 'GPU'. - Added
SkSurface.imageInfo
which returns an ImageInfo object describing the size and color properties of the surface. colorSpace is added to ImageInfo everywhere it is used. CanvasKit.Free
to explicitly clean up memory afterCanvasKit.Malloc
. All memory allocated withCanvasKit.Malloc
must be released withCanvasKit.Free
or it will be leaked. This can improve performance by reducing the copying of data between the JS and WASM side.CanvasKit.ColorAsInt
,SkPaint.setColorComponents
,SkPaint.setColorInt
,SkCanvas.drawColorComponents
,SkCanvas.drawColorInt
for when clients want to avoid the overhead of allocating an array for color components and only need 8888 color.
Changed
- We now compile/ship with Emscripten v1.39.16.
CanvasKit.MakeCanvasSurface
accepts a new enum specifying one of the three color space and pixel format combinations supported by CanvasKit.- all
_Make*Shader
functions now accept a color space argument at the end. leaving it off or passing null makes it behave as it did before, defaulting to sRGB SkPaint.setColor
accepts a new color space argument, defaulting to sRGB.- Fewer allocations required to send Color and Matrices between JS and WASM layer.
- All APIs that take a 1 dimensional array should also accept the object returned by Malloc. It is recommended to pass the Malloc object, as the TypedArray could be invalidated any time CanvasKit needs to allocate memory and needs to resize to accommodate.
Breaking
CanvasKitInit(...)
now directly returns a Promise. As such,CanvasKitInit(...).ready()
has been removed.CanvasKit.MakeCanvasSurface
no longer accepts width/height arguments to override those on the canvas element. Use the canvas element's width/height attributes to dictate the size of the drawing area, and use CSS width/height to set the size it will appear on the page (it is rescaled after drawing when css sizing applies).- Memory returned by
CanvasKit.Malloc
will no longer be automatically cleaned up. Clients must useCanvasKit.Free
to release the memory. CanvasKit.Malloc
no longer directly returns a TypedArray, but an object that can produce them with toTypedArray(). This is to avoid "detached ArrayBuffer" errors: https://github.com/emscripten-core/emscripten/issues/6747
Fixed
- WebGL context is no longer created with "antialias" flag. Using "antialias" caused poor AA quality in Ganesh when trying to do coverage-based AA with MSAA unknowingly enabled. It also reduced performance.
[0.15.0] - 2020-05-14
Added
- Support for DOMMatrix on all APIs that take SkMatrix (i.e. arrays or Float32Arrays of length 6/9/16).
- setEdging and setEmbeddedBitmaps to SkFont. You can disable the ability to draw aliased fonts (and save some code
size) with the compile.sh argument
no_alias_font
.
Removed
- Previously deprecated functions
MakeSkDashPathEffect
,MakeLinearGradientShader
,MakeRadialGradientShader
,MakeTwoPointConicalGradientShader
,MakeSkCornerPathEffect
,MakeSkDiscretePathEffect
Changed
- CanvasKit colors are now represented with a TypedArray of four floats.
- Calls to
getError
should be disabled. This may cause a performance improvement in some scenarios.
Removed
- SkPaint.setColorf is obsolete and removed. setColor accepts a CanvasKit color which is always composed of floats.
- localmatrix option for
SkShader.Lerp
andSkShader.Blend
.
Deprecated
SkCanvas.concat44
has been folded into concat (which now takes 3x2, 3x3, or 4x4 matrices). It will be removed soon.
Fixed
- Memory leak in paragraph binding code (https://github.com/flutter/flutter/issues/56938)
- Safari now properly uses WebGL1 instead of WebGL2 when WebGL2 is not available (skbug.com/10171).
[0.14.0] - 2020-03-18
Added
SkShader.MakeSweepGradient
SkCanvas.saveLayer
can now be called with 1 argument (the paint). In this case the current effective clip will be used, as the current rect is assumed to be null.SkPaint.setAlphaf
- Clients can supply
no_codecs
to compile.sh to remove all codec encoding and decoded code. This can save over 100 kb compressed if codecs are not needed.
Deprecated
MakeSkDashPathEffect
will be removed soon. Calls can be replaced withSkPathEffect.MakeDash
.MakeLinearGradientShader
will be removed soon. Calls can be replaced withSkShader.MakeLinearGradient
.MakeRadialGradientShader
will be removed soon. Calls can be replaced withSkShader.MakeRadialGradient
.MakeTwoPointConicalGradientShader
will be removed soon. Calls can be replaced withSkShader.MakeTwoPointConicalGradient
.
Fixed
- Shadows are properly draw on fillRect and strokeRect in the canvas2d emulation layer.
- Shadow offsets properly ignore the CTM in the canvas2d emulation layer.
Changed
- Stop compiling jpeg and webp encoders by default. This results in a 100kb binary size reduction.
Clients that need these encoders can supply
force_encode_webp
orforce_encode_jpeg
to compile.sh.
Removed
- Removed inverse filltypes.
- Removed StrokeAndFill paint style.
- Removed TextEncoding enum (it was only used internally). All functions assume UTF-8.
[0.13.0] - 2020-02-28
Deprecated
MakeSkCornerPathEffect
will be removed soon. Calls can be replaced withSkPathEffect.MakeCorner
.MakeSkDiscretePathEffect
will be removed soon. Calls can be replaced withSkPathEffect.MakeDiscrete
.
Added
SkSurface.drawOnce
for drawing a single frame (in addition to already existingSkSurface.requestAnimationFrame
for animation logic).CanvasKit.parseColorString
which processes color strings like "#2288FF"- Particles module now exposes effect uniforms, which can be modified for live-updating.
- Experimental 4x4 matrices added in
SkM44
. - Vector math functions added in
SkVector
. SkRuntimeEffect.makeShaderWithChildren
, which can take in other shaders as fragmentProcessors.GrContext.releaseResourcesAndAbandonContext
to free up WebGL contexts.- A few methods on
SkFont
:setHinting
,setLinearMetrics
,setSubpixel
.
Changed
- We now compile/ship with Emscripten v1.39.6.
SkMatrix.multiply
can now accept any number of matrix arguments, multiplying them left-to-right.- SkMatrix.invert now returns null when the matrix is not invertible. Previously it would return an identity matrix. Callers must determine what behavior would be appropriate in this situation.
- In Canvas2D compatibility layer, the underlying SkFont will have setSubpixel(true).
- Bones are removed from Vertices builder
Fixed
- Support for .otf fonts (.woff and .woff2 still not supported).
[0.12.0] - 2020-01-22
Added
SkFontMgr.countFamilies
andSkFontMgr.getFamilyName
to expose the parsed font names.
Changed
- SKP serialization/deserialization now available (can be disabled with the 'no_skp').
SkPicture.DEBUGONLY_saveAsFile
renamed toSkPicture.saveAsFile
andCanvasKit.MakeSkPicture
is now exposed. SKP support is not shipped to npm builds.force_serialize_skp
has been removed since it opt-out, not opt-in.
Fixed
- Bug that sometimes resulted in 'Cannot perform Construct on a neutered ArrayBuffer'
- Bug with SkImage.readPixels (skbug.com/9788)
- Bug with transparent colors in Canvas2d mode (skbug.com/9800)
[0.11.0] - 2020-01-10
Added
- A "Core" build that removes Fonts, the Skottie animation player, the Particles demo,
and PathOps is available in
bin/core/
. It is about half the size of the "CoreWithFonts" build. - Experimental Runtime shader available for custom builds.
- WebP support.
SkAnimatedImage.getCurrentFrame
which returns an SkImage.
Fixed
CanvasKit.SaveLayerInitWithPrevious
andCanvasKit.SaveLayerF16ColorType
constants.- Some compilation configurations, for example, those with no fonts or just one of particles/skottie.
Changed
- Small tweaks to compilation settings to reduce code size and linkage time.
- JS functions are no longer provided when the underlying c++ calls have been compiled out.
Removed
SkShader.Empty
- Support for Type 1 Fonts. These are ancient and removing them saves about 135k of code size.
Breaking
- In an effort to reduce code size for most clients, npm now contains two CanvasKit builds.
In
bin/
there is the "CoreWithFonts" build that contains most functionality from 0.10.0. However, we no longer ship the Skottie animation player, nor the Particles demo. Further, PathOps are removed from this buildMakePathFromOp
,SkPath.op
andSkPath.simplify
. Clients who need any of those features are encouraged to create a custom build usingcompile.sh
. SkPicture.DEBUGONLY_saveAsFile
was accidentally included in release builds. It has been removed. Clients who need this in a release build (e.g. to file a bug report that only reproduces in release) should do a custom build with theforce_serialize_skp
flag given.
Deprecated
SkCanvas.drawAnimatedImage
will be renamed soon. Calls can be replaced withSkCanvas.drawImage
andSkAnimatedImage.getCurrentFrame
.
[0.10.0] - 2019-12-09
Added
SkContourMeasureIter
andSkContourMeasure
as an alternative toSkPathMeasure
.- CanvasKit image decode cache helpers: getDecodeCacheLimitBytes(), setDecodeCacheLimitBytes(), and getDecodeCacheUsedBytes().
SkShader.Blend
,SkShader.Color
,SkShader.Empty
,SkShader.Lerp
.
Changed
- The returned values from
SkParagraph.getRectsForRange
now have direction with valueCanvasKit.TextDirection
.
Fixed
MakeImage
properly in the externs file and can work withCanvasKit.Malloc
.
[0.9.0] - 2019-11-18
Added
- Experimental
CanvasKit.Malloc
, which can be used to create a TypedArray backed by the C++ WASM memory. This can save a copy in some cases (e.g. SkColorFilter.MakeMatrix). This is an advanced feature, so use it with care. SkCanvas.clipRRect
,SkCanvas.drawColor
- Blur, ColorFilter, Compose, MatrixTransform SkImageFilters. Can be used with
SkPaint.setImageFilter
. SkCanvas.saveLayer
now takes 3 or 4 params to include up to bounds, paint, SkImageFilter, flags.SkPath.rArcTo
,SkPath.rConicTo
,SkPath.rCubicTo
,SkPath.rLineTo
,SkPath.rMoveTo
,SkPath.rQuadTo
. Like their non-relative siblings, these are chainable.- Add
width()
,height()
,reset()
,getFrameCount()
to SkAnimatedImage. SkCanvas.drawImageNine
,SkCanvas.drawPoints
and relatedPointMode
enum.SkPath.addPoly
SkPathMeasure.getSegment
- More information on SkParagraph API, eg.
getLongestLine()
,getWordBoundary
, and others.
Deprecated
CanvasKit.MakeBlurMaskFilter
will be renamed/moved soon toCanvasKit.SkMaskFilter.MakeBlur
.
Changed
- Use newer version of Freetype2 (Tracking Skia's DEPS now).
- Use newer versions of libpng and zlib (Tracking Skia's DEPS now).
Fixed
- null dereference when sometimes falling back to CPU.
- Actually ask WebGL for a stencil buffer.
- Can opt out of Paragraph API with no_paragraph passed into compile.sh or when using primitive_shaper.
[0.8.0] - 2019-10-21
Added
CanvasKit.MakeAnimatedImageFromEncoded
,SkCanvas.drawAnimatedImage
.CanvasKit.SkFontMgr.FromData
which takes several ArrayBuffers of font data, parses them, reading the metadata (e.g. family names) and stores them into a SkFontMgr.- SkParagraph as an optional set of APIs for dealing with text layout.
Changed
- The
no_font
compile option should strip out more dead code related to fonts. - and
no_embedded_font
option now allows creating aSkFontMgr.FromData
instead of always having an empty one. - Updated to emscripten 1.38.47
- Switch to WebGL 2.0, but fall back to 1.0 when unavailable - bug.skia.org/9052
Fixed
- Null terminator bug in draw text - skbug.com/9314
[0.7.0] - 2019-09-18
Added
SkCanvas.drawCircle()
,SkCanvas.getSaveCount()
SkPath.offset()
,SkPath.drawOval
SkRRect
support (SkCanvas.drawRRect
,SkCanvas.drawDRRect
,CanvasKit.RRectXY
). Advanced users can specify the 8 individual radii, if needed.CanvasKit.computeTonalColors()
, which returns TonalColors, which has an ambient SkColor and a spot SkColor.CanvasKit.SkColorFilter
and a variety of factories.SkPaint.setColorFilter
is the only consumer of these at the moment.CanvasKit.SkColorMatrix
with functions.identity()
,.scaled()
,.concat()
and others. Primarily for use withCanvasKit.SkColorFilter.MakeMatrix
.
Changed
MakeSkVertices
uses a builder to save a copy.
Breaking
- When
SkPath.arcTo
is given seven arguments, it no longer turns the first four into aSkRect
automatically, and instead uses them asarcTo(rx, ry, xAxisRotate, useSmallArc, isCCW, x, y)
(see SkPath.h for more).
[0.6.0] - 2019-05-06
Added
SkSurface.grContext
now exposed.GrContext
has new methods for monitoring/setting the cache limits; tweaking these may lead to better performance in some cases.getResourceCacheLimitBytes
,setResourceCacheLimitBytes
,getResourceCacheUsageBytes
SkCanvas.drawAtlas
for efficiently drawing multiple sprites from a sprite sheet with a set of transforms, color blends, etc.SkColorBuilder
,RSXFormBuilder
,SkRectBuilder
which increase performance by reducing the amount of malloc/free calls per frame, given that the array size is fixed.- Basic
SkPicture
support.SkSurface.captureFrameAsSkPicture
is a helper function to capture anSkPicture
, which can be dumped to disk (for debugging) withSkPicture.DEBUGONLY_saveAsFile
. SkImage.readPixels
, which returns a TypedArray of pixel values (safe to use anywhere, doesn't need a delete()).
Changed
- Better
GrGLCaps
support for WebGL - this shouldn't have any impacts on APIs or correctness, except by perhaps fixing a few bugs in various surface types. - Use unsigned ints for SkColor on the JS side - this shouldn't have any impacts unless clients have pre-computed colors, in which case, they will need to re-compute them.
- [breaking] Moved
CanvasKit.MakeImageShader
toSkImage.makeShader
- removed clampUnpremul as argument.
[0.5.1] - 2019-03-21
Added
SkPathMeasure
,RSXFormBuilder
,SkFont.getWidths
,SkTextBlob.MakeFromRSXform
which were needed to add the helper functionSkTextBlob.MakeOnPath
.SkSurface.requestAnimationFrame
- wrapper around window.requestAnimationFrame that takes care of the setup/tear down required to use CanvasKit optimally. The callback has anSkCanvas
as the first parameter - callers should draw on that.
Changed
- Location in Skia Git repo now
modules/canvaskit
(wasexperimental/canvaskit
)
Fixed
- Extern bug in
CanvasKit.SkMatrix.invert
- Fallback to CPU now properly refreshes the canvas to get access to the CanvasRenderingContext2D.
- Compile flags for better WebGL1 support for some graphics cards.
- Antialias bug on large oval paths https://crbug.com/skia/8873
Deprecated
SkCanvas.flush
will be removed soon - client should only callSkSurface.flush
[0.5.0] - 2019-03-08
Added
- isVolitile option to
CanvasKit.MakeSkVertices
. The previous (and current default) behavior was for this to be true; some applications may go faster if set to false. SkCanvas.saveLayer(rect, paint)
SkCanvas.restoreToCount(int)
which can be used with the output of .save() and .saveLayer().- Optional particles library from modules/particles.
See CanvasKit.MakeParticles(json)
; - More public APIs for working with Surfaces/Contexts
GetWebGLContext
,MakeGrContext
,MakeOnScreenGLSurface
,MakeRenderTarget
. SkSurface.getSurface()
andSkCanvas.getSurface()
for making compatible surfaces (typically used as a workspace and then "saved" withsurface.makeImageSnapshot()
)
Breaking
CanvasKit.MakeWebGLCanvasSurface
no longer takes a webgl context as a first arg, only a canvas or an id of a canvas. If users want to manage their own GL contexts, they should build theSkSurface
themselves withGetWebGLContext
->MakeGrContext
->MakeOnScreenGLSurface
.
[0.4.1] - 2019-03-01
Added
- Optional arguments to
MakeManagedAnimation
for supplying external assets (like images, fonts).
[0.4.0] - 2019-02-25
Added
SkPath.addRoundRect
,SkPath.reset
,SkPath.rewind
exposed.SkCanvas.drawArc
,SkCanvas.drawLine
,SkCanvas.drawOval
,SkCanvas.drawRoundRect
exposed.- Can import/export a SkPath to an array of commands. See
CanvasKit.MakePathFromCmds
andSkPath.toCmds
. SkCanvas.drawTextBlob()
andSkCanvas.SkTextBlob.MakeFromText()
to draw text to a canvas.CanvasKit.TextEncoding
enum. For use withSkTextBlob
.- Text shaping with
ShapedText
object andSkCanvas.drawText
. At compile time, one can choose between using Harfbuzz/ICU (default) or a primitive one ("primitive_shaper") which just does line breaking. Using Harfbuzz/ICU substantially increases code size (4.3 MB to 6.4 MB).
Changed
SkCanvas.drawText()
now requires anSkFont
object for raw strings.
Removed
SkPaint.setTextSize()
,SkPaint.getTextSize()
,SkPaint.setTypeface()
which should be replaced by usingSkFont
.- Deprecated
CanvasKitInit().then()
interface (see 0.3.1 notes)
Fixed
- Potential bug in
ready()
if already loaded.
[0.3.1] - 2019-01-04
Added
SkFont
now exposed.MakeCanvasSurface
can now take a canvas element directly.MakeWebGLCanvasSurface
can now take a WebGL context as an integer and use it directly.
Changed
CanvasKitInit(...).then()
is no longer the recommended way to initialize things. It will be removed in 0.4.0. UseCanvasKitInit(...).ready()
, which returns a real Promise.
Removed
SkPaint.measureText
- useSkFont.measureText
instead.
[0.3.0] - 2018-12-18
Added
- Add Canvas2D JS layer. This mirrors the HTML Canvas API. This may be omitted at compile time
it by adding
no_canvas
to thecompile.sh
invocation. CanvasKit.FontMgr.DefaultRef()
andfontmgr.MakeTypefaceFromData
to load fonts.- Exposed
SkPath.setVolatile
. Some animations see performance improvements by setting their paths' volatility to true.
Fixed
SkPath.addRect
now correctly draws counter-clockwise vs clockwise.
Changed
CanvasKit.MakeImageShader
no longer takes encoded bytes, but anSkImage
, created fromCanvasKit.MakeImageFromEncoded
. Additionally, the optional parametersclampIfUnpremul
andlocalMatrix
have been exposed.SkPath.arcTo
now takesstartAngle
,sweepAngle
,forceMoveTo
as additional parameters.SkPath.stroke
has a new optionprecision
It defaults to 1.0.- CanvasKit comes with one font (NotoMono) instead of the Skia TestTypeface. Clients are encouraged
to use the new
fontmgr.MakeTypefaceFromData
for more font variety.
Removed
CanvasKit.initFonts()
- no longer needed.
[0.2.1] - 2018-11-20
Beginning of Changelog history