Surface and PictureRecorder cache returned Canvas object and invalida…

…te it when owner is closed (closes #66)

CHANGELOG.md

@@ -1,3 +1,9 @@
+# WIP
+
+Changed:
+
+- Surface and PictureRecorder cache returned Canvas object and invalidate it when owner is closed #66
+
 # 0.116.2 - Dec 8, 2023
 
 Changed:

examples/jwm/script/run.py

@@ -39,7 +39,7 @@ def main():
   os.chdir(common.basedir + '/examples/jwm')
 
   sources = build_utils.files('src/**/*.java', '../scenes/src/**/*.java')
-  build_utils.javac(sources, 'target/classes', classpath = classpath, release = '16', opts = ["-Xlint:deprecation"])
+  build_utils.javac(sources, 'target/classes', classpath = classpath, release = '16', opts = ["-Xlint:deprecation", '-Xlint:-options',])
 
   # Java
   subprocess.check_call([

examples/scenes/src/DecorationsBenchScene.java

@@ -25,7 +25,7 @@ public DecorationsBenchScene() {
     @Override
     public void draw(Canvas canvas, int width, int height, float dpi, int xpos, int ypos) {
         if (shaderStrokeOdd == null) {
-            try (var surface = Surface.makeRasterN32Premul((int) Math.ceil(4 * dpi), (int) Math.ceil(3 * dpi));) {
+            try (var surface = Surface.makeRaster(ImageInfo.makeN32Premul((int) Math.ceil(4 * dpi), (int) Math.ceil(3 * dpi)));) {
                 var c = surface.getCanvas();
                 c.scale(dpi, dpi);
                 c.translate(0, 1.5f);
@@ -37,7 +37,7 @@ public void draw(Canvas canvas, int width, int height, float dpi, int xpos, int
         }
 
         if (shaderStrokeEven == null) {
-            try (var surface = Surface.makeRasterN32Premul((int) Math.ceil(4 * dpi), (int) Math.ceil(3 * dpi));) {
+            try (var surface = Surface.makeRaster(ImageInfo.makeN32Premul((int) Math.ceil(4 * dpi), (int) Math.ceil(3 * dpi)));) {
                 var c = surface.getCanvas();
                 c.scale(dpi, dpi);
                 c.translate(0, 1.5f);

examples/scenes/src/SwingScene.java

@@ -839,7 +839,7 @@ public SkiaVolatileImage(int width, int height, java.awt.ImageCapabilities caps,
         this.width = width;
         this.height = height;
         this.caps = caps;
-        this.surface = Surface.makeRasterN32Premul(width, height);
+        this.surface = Surface.makeRaster(ImageInfo.makeN32Premul(width, height));
     }
 
     @Override

examples/scenes/src/TextLineDecorationsScene.java

@@ -134,7 +134,7 @@ public void drawSine(Canvas canvas, float w, float dx, float dpi) {
         var control = strokew * 1f;
 
         try (var line = TextLine.make("Sinus " + w + "px" + descenders, inter13);
-             var surface = Surface.makeRasterN32Premul((int) Math.ceil(texw), (int) Math.ceil(texh));
+             var surface = Surface.makeRaster(ImageInfo.makeN32Premul((int) Math.ceil(texw), (int) Math.ceil(texh)));
              var path = new Path()
                             .moveTo(0, texh - 0.5f * strokew)
                             .cubicTo(control, texh - 0.5f * strokew, texw / 2f - control, 0.5f * strokew, texw / 2f, 0.5f * strokew)

platform/cc/PictureRecorder.cc

@@ -27,13 +27,6 @@ extern "C" JNIEXPORT jlong JNICALL Java_io_github_humbleui_skija_PictureRecorder
     return reinterpret_cast<jlong>(canvas);
 }
 
-extern "C" JNIEXPORT jlong JNICALL Java_io_github_humbleui_skija_PictureRecorder__1nGetRecordingCanvas
-  (JNIEnv* env, jclass jclass, jlong ptr) {
-    SkPictureRecorder* instance = reinterpret_cast<SkPictureRecorder*>(static_cast<uintptr_t>(ptr));
-    SkCanvas* canvas = instance->getRecordingCanvas();
-    return reinterpret_cast<jlong>(canvas);
-}
-
 extern "C" JNIEXPORT jlong JNICALL Java_io_github_humbleui_skija_PictureRecorder__1nFinishRecordingAsPicture
   (JNIEnv* env, jclass jclass, jlong ptr) {
     SkPictureRecorder* instance = reinterpret_cast<SkPictureRecorder*>(static_cast<uintptr_t>(ptr));

script/build.py

@@ -73,7 +73,8 @@ def main():
                     '../shared/target/classes-java9',
                     classpath = common.deps_compile(),
                     modulepath = common.deps_compile(),
-                    opts = ['--patch-module', 'io.github.humbleui.skija.shared=../shared/target/classes'],
+                    opts = ['-Xlint:-options',
+                            '--patch-module', 'io.github.humbleui.skija.shared=../shared/target/classes',],
                     release = '9')
 
   build_utils.copy_replace(

shared/java/PictureRecorder.java

@@ -7,6 +7,8 @@
 
 public class PictureRecorder extends Managed {
     static { Library.staticLoad(); }
+
+    @ApiStatus.Internal public Canvas _canvas;
 
     public PictureRecorder() {
         this(_nMake());
@@ -31,9 +33,11 @@ public static class _FinalizerHolder {
      * @return the canvas.
     */
     public Canvas beginRecording(Rect bounds) {
+        assert _canvas == null : "Recording already in progress";
         try {
             Stats.onNativeCall();
-            return new Canvas(_nBeginRecording(_ptr, bounds._left, bounds._top, bounds._right, bounds._bottom), false, this);
+            _canvas = new Canvas(_nBeginRecording(_ptr, bounds._left, bounds._top, bounds._right, bounds._bottom), false, this);
+            return _canvas;
         } finally {
             ReferenceUtil.reachabilityFence(this);
         }
@@ -44,13 +48,7 @@ public Canvas beginRecording(Rect bounds) {
      */
     @Nullable
     public Canvas getRecordingCanvas() {
-        try {
-            Stats.onNativeCall();
-            long ptr = _nGetRecordingCanvas(_ptr);
-            return ptr == 0 ? null : new Canvas(ptr, false, this);
-        } finally {
-            ReferenceUtil.reachabilityFence(this);
-        }
+        return _canvas;
     }
 
     /**
@@ -64,6 +62,9 @@ public Canvas getRecordingCanvas() {
      */
     public Picture finishRecordingAsPicture() {
         try {
+            assert _canvas != null : "Recording not started";
+            _canvas.invalidate();
+            _canvas = null;
             Stats.onNativeCall();
             return new Picture(_nFinishRecordingAsPicture(_ptr));
         } finally {
@@ -83,13 +84,25 @@ public Picture finishRecordingAsPicture() {
      */
     public Picture finishRecordingAsPicture(@NotNull Rect cull) {
         try {
+            assert _canvas != null : "Recording not started";
+            _canvas.invalidate();
+            _canvas = null;
             Stats.onNativeCall();
             return new Picture(_nFinishRecordingAsPictureWithCull(_ptr, cull._left, cull._top, cull._right, cull._bottom));
         } finally {
             ReferenceUtil.reachabilityFence(this);
         }
     }
 
+    @Override
+    public void close() {
+        if (_canvas != null) {
+            _canvas.invalidate();
+            _canvas = null;
+        }
+        super.close();
+    }
+
     // TODO
     /**
      * <p>Signal that the caller is done recording. This invalidates the canvas returned by
@@ -109,7 +122,6 @@ public Picture finishRecordingAsPicture(@NotNull Rect cull) {
     @ApiStatus.Internal public static native long _nMake();
     @ApiStatus.Internal public static native long _nGetFinalizer();
     @ApiStatus.Internal public static native long _nBeginRecording(long ptr, float left, float top, float right, float bottom);
-    @ApiStatus.Internal public static native long _nGetRecordingCanvas(long ptr);
     @ApiStatus.Internal public static native long _nFinishRecordingAsPicture(long ptr);
     @ApiStatus.Internal public static native long _nFinishRecordingAsPictureWithCull(long ptr, float left, float top, float right, float bottom);
     @ApiStatus.Internal public static native long _nFinishRecordingAsDrawable(long ptr);

shared/java/Surface.java

@@ -9,6 +9,7 @@ public class Surface extends RefCnt {
         Library.staticLoad();
     }
 
+    @ApiStatus.Internal public Canvas _canvas;
     @ApiStatus.Internal public final DirectContext _context;
     @ApiStatus.Internal public final BackendRenderTarget _renderTarget;
 
@@ -660,9 +661,12 @@ public DirectContext getRecordingContext() {
     @NotNull
     public Canvas getCanvas() {
         try {
-            Stats.onNativeCall();
-            long ptr = _nGetCanvas(_ptr);
-            return ptr == 0 ? null : new Canvas(ptr, false, this);
+            if (_canvas == null) {
+                Stats.onNativeCall();
+                long ptr = _nGetCanvas(_ptr);
+                _canvas = ptr == 0 ? null : new Canvas(ptr, false, this);
+            }
+            return _canvas;
         } finally {
             ReferenceUtil.reachabilityFence(this);
         }
@@ -967,6 +971,15 @@ public Surface(long ptr, DirectContext context, BackendRenderTarget renderTarget
         _renderTarget = renderTarget;
     }
 
+    @Override
+    public void close() {
+        if (_canvas != null) {
+            _canvas.invalidate();
+            _canvas = null;
+        }
+        super.close();
+    }
+
     public static native long _nWrapPixels(int width, int height, int colorType, int alphaType, long colorSpacePtr, long pixelsPtr, long rowBytes, SurfaceProps surfaceProps);
     public static native long _nWrapPixelsPixmap(long pixmapPtr, SurfaceProps surfaceProps);
     public static native long _nMakeRaster(int width, int height, int colorType, int alphaType, long colorSpacePtr, long rowBytes, SurfaceProps surfaceProps);