Add Canvas.quickReject to quickly tell if a Rect is within the clip

Change-Id: I72fe7c22c863992519c47e54b26528c1ae5390f1
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/903702
Reviewed-by: Kaylee Lubick <[email protected]>
Commit-Queue: Harry Terkelsen <[email protected]>

Author: harryterkelsen

modules/canvaskit/CHANGELOG.md

@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
  - `CanvasKit.Typeface.GetDefault()` as a way to explicitly get the compiled-in typeface (if any).
+ - `Canvas.quickReject` to quickly check if a Rect is within the current clip region.
 
 ## [0.39.1] - 2023-10-12
 

modules/canvaskit/canvaskit_bindings.cpp

@@ -91,8 +91,8 @@
 #include "include/gpu/ganesh/GrTypes.h"
 #include "include/gpu/ganesh/gl/GrGLBackendSurface.h"
 #include "include/gpu/ganesh/gl/GrGLDirectContext.h"
-#include "include/gpu/ganesh/gl/GrGLMakeWebGLInterface.h"
 #include "include/gpu/ganesh/gl/GrGLInterface.h"
+#include "include/gpu/ganesh/gl/GrGLMakeWebGLInterface.h"
 #include "include/gpu/ganesh/gl/GrGLTypes.h"
 #include "src/gpu/RefCntedCallback.h"
 #include "src/gpu/ganesh/GrProxyProvider.h"
@@ -1425,6 +1425,12 @@ EMSCRIPTEN_BINDINGS(Skia) {
             }
             self.getDeviceClipBounds(outputRect);
         }))
+
+        .function("_quickReject", optional_override([](const SkCanvas& self, WASMPointerF32 fPtr)->bool {
+          const SkRect* rect = reinterpret_cast<const SkRect*>(fPtr);
+          return self.quickReject(*rect);
+        }))
+
         // 4x4 matrix functions
         // Just like with getTotalMatrix, we allocate the buffer for the 16 floats to go in from
         // interface.js, so it can also free them when its done.

modules/canvaskit/externs.js

@@ -322,6 +322,7 @@ var CanvasKit = {
       drawTextBlob: function() {},
       drawVertices: function() {},
       getDeviceClipBounds: function() {},
+      quickReject: function() {},
       getLocalToDevice: function() {},
       getTotalMatrix: function() {},
       readPixels: function() {},
@@ -365,6 +366,7 @@ var CanvasKit = {
     _drawTextBlob: function() {},
     _drawVertices: function() {},
     _getDeviceClipBounds: function() {},
+    _quickReject: function() {},
     _getLocalToDevice: function() {},
     _getTotalMatrix: function() {},
     _readPixels: function() {},

modules/canvaskit/interface.js

@@ -779,6 +779,11 @@ CanvasKit.onRuntimeInitialized = function() {
     return copyIRectFromWasm(_scratchIRect, outputRect);
   };
 
+  CanvasKit.Canvas.prototype.quickReject = function(rect) {
+    var rPtr = copyRectToWasm(rect);
+    return this._quickReject(rPtr);
+  };
+
   // getLocalToDevice returns a 4x4 matrix.
   CanvasKit.Canvas.prototype.getLocalToDevice = function() {
     // _getLocalToDevice will copy the values into the pointer.

modules/canvaskit/npm_build/types/canvaskit-wasm-tests.ts

@@ -150,6 +150,7 @@ function canvasTests(CK: CanvasKit, canvas?: Canvas, paint?: Paint, path?: Path,
     canvas.drawVertices(verts, CK.BlendMode.DstOut, paint);
     const irect = canvas.getDeviceClipBounds(); // $ExpectType Int32Array
     const irect2 = canvas.getDeviceClipBounds(irect); // $ExpectType Int32Array
+    const isCulled = canvas.quickReject(someRect); // $ExpectType boolean
     const matrTwo = canvas.getLocalToDevice(); // $ExpectType Float32Array
     const sc = canvas.getSaveCount(); // $ExpectType number
     const matrThree = canvas.getTotalMatrix(); // $ExpectType number[]

modules/canvaskit/npm_build/types/index.d.ts

@@ -1729,6 +1729,12 @@ export interface Canvas extends EmbindObject<"Canvas"> {
      */
     getDeviceClipBounds(output?: IRect): IRect;
 
+    /**
+     * Returns true if the given rect, transformed by the current canvas
+     * transform, can be quickly determined to fall entirely outside the clip.
+     */
+    quickReject(rect: InputRect): boolean;
+
     /**
      * Returns the current transform from local coordinates to the 'device', which for most
      * purposes means pixels.