Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(150)

Unified Diff: third_party/WebKit/Source/modules/csspaint/README.md

Issue 1866623002: Hook up CSSPaintValue::image to CSS Paint API callback. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: addressed comments + rebase. Created 4 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: third_party/WebKit/Source/modules/csspaint/README.md
diff --git a/third_party/WebKit/Source/modules/csspaint/README.md b/third_party/WebKit/Source/modules/csspaint/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..926274472e6b4981aadbef3fbbcebc131f799f92
--- /dev/null
+++ b/third_party/WebKit/Source/modules/csspaint/README.md
@@ -0,0 +1,55 @@
+# CSS Paint API
+
+This directory contains the implementation of the CSS Paint API.
+
+See [CSS Paint API](https://drafts.css-houdini.org/css-paint-api/) for the web exposed APIs this
+implements.
+
+## Implementation
+
+### [CSSPaintDefinition](CSSPaintDefinition.h)
+
+Represents a class registered by the author through `PaintWorkletGlobalScope#registerPaint`.
+Specifically this class holds onto the javascript constructor and paint functions of the class via
+persistent handles. This class keeps these functions alive so they don't get garbage collected.
+
+The `CSSPaintDefinition` also holds onto an instance of the paint class va a persistent handle. This
+instance is lazily created upon first use. If the constructor throws for some reason the constructor
+is marked as invalid and will always produce invalid images.
+
+The `PaintWorkletGlobalScope` has a map of paint `name` to `CSSPaintDefinition`.
+
+### [CSSPaintImageGenerator][generator] and [CSSPaintImageGeneratorImpl][generator-impl]
+
+`CSSPaintImageGenerator` represents the interface from which the `CSSPaintValue` can generate
+`Image`s. This is done via the `CSSPaintImageGenerator#paint` method. Each `CSSPaintValue` owns a
+separate instance of `CSSPaintImageGenerator`.
+
+`CSSPaintImageGeneratorImpl` is the implementation which lives in `modules/csspaint`. (We have this
+interface / implementation split as `core/` cannot depend on `modules/`).
+
+When created the generator will access its paint worklet and lookup it's corresponding
+`CSSPaintDefinition` via `PaintWorkletGlobalScope#findDefinition`.
+
+If the paint worklet does not have a `CSSPaintDefinition` matching the paint `name` the
+`CSSPaintImageGeneratorImpl` is placed in a "pending" map. Once a paint class with `name` is
+registered the generator is notified so it can invalidate an display the correct image.
+
+[generator]: ../../core/css/CSSPaintImageGenerator.h
+[generator-impl]: CSSPaintImageGeneratorImpl.h
+[paint-value]: ../../core/css/CSSPaintValue.h
+
+### Generating a [PaintGeneratedImage](../../platform/graphics/PaintGeneratedImage.h)
+
+`PaintGeneratedImage` is a `Image` which just paints a single `SkPicture`.
+
+A `CSSPaintValue` can generate an image from the method `CSSPaintImageGenerator#paint`. This method
+calls through to `CSSPaintDefinition#paint` which actually invokes the javascript paint method.
+This method returns the `PaintGeneratedImage`.
+
+The `SkPicture` is produced from a `RecordingImageBufferSurface`.
+
+## Testing
+
+Tests live [here](../../../LayoutTests/csspaint/).
+
« no previous file with comments | « third_party/WebKit/Source/modules/csspaint/PaintWorkletGlobalScope.cpp ('k') | third_party/WebKit/Source/modules/modules.gypi » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698