@shopify/react-native-skia 1.3.12 → 1.4.0

package/src/skia/__tests__/setup.ts

@@ -0,0 +1,77 @@
+import type { Node } from "../../dom/types";
+import { mapKeys } from "../../renderer/typeddash";
+import { LoadSkiaWeb } from "../../web/LoadSkiaWeb";
+import { isMatrix, Skia } from "../types";
+import { JsiSkApi } from "../web";
+
+let Skia: ReturnType<typeof JsiSkApi>;
+
+beforeAll(async () => {
+  await LoadSkiaWeb();
+  Skia = JsiSkApi(global.CanvasKit);
+});
+
+export const setupSkia = (width = 256, height = 256) => {
+  expect(Skia).toBeDefined();
+  const surface = Skia.Surface.Make(width, height)!;
+  expect(surface).toBeDefined();
+  const canvas = surface.getCanvas();
+  expect(canvas).toBeDefined();
+  return {
+    surface,
+    width,
+    height,
+    center: { x: width / 2, y: height / 2 },
+    canvas,
+    Skia,
+    CanvasKit: global.CanvasKit,
+  };
+};
+
+const asValue = (value: unknown) => {
+  if (value instanceof Float32Array) {
+    return Array.from(value)
+      .map((v) => Math.round(v * 100) / 100)
+      .join(", ");
+  } else if (isMatrix(value)) {
+    // TODO: https://github.com/Shopify/react-native-skia/issues/715
+    return "m3x3";
+  } else if (
+    typeof value === "object" &&
+    value !== null &&
+    "x" in value &&
+    "y" in value
+  ) {
+    const v = value as { x: number; y: number };
+    return `{x:${v.x}, y:${v.y}}`;
+  }
+  return value;
+};
+
+export const printAsXML = (node: Node<unknown>) => {
+  console.log(asXML(node));
+};
+
+// Print nodes as XML tree
+export const asXML = (node: Node<unknown>, indent = 0): string => {
+  // TODO: remove cast
+  const hasChildren = node.children().length > 0;
+  const props = node.getProps() as object;
+  const space = new Array(indent).fill(" ").join("");
+  const keys = mapKeys(props).filter((key) => props[key] !== undefined);
+  if (hasChildren) {
+    return `${space}<${node.type}${keys.length > 0 ? " " : ""}${keys
+      .map((name) => `${name}="${asValue(props[name])}"`)
+      .join(" ")}>
+${node
+  .children()
+
+  .map((child) => asXML(child, indent + 2)).join(`
+`)}
+${space}</${node.type}>`;
+  } else {
+    return `${space}<${node.type} ${keys
+      .map((name) => `${name}="${asValue(props[name])}"`)
+      .join(" ")} />`;
+  }
+};

package/src/skia/types/Paragraph/TextStyle.ts

@@ -50,10 +50,10 @@ export enum TextBaseline {
 export interface SkTextStyle {
   backgroundColor?: SkColor;
   color?: SkColor;
-  decoration?: number;
+  decoration?: TextDecoration;
   decorationColor?: SkColor;
   decorationThickness?: number;
-  decorationStyle?: TextDecoration;
+  decorationStyle?: TextDecorationStyle;
   fontFamilies?: string[];
   fontFeatures?: SkTextFontFeatures[];
   fontSize?: number;

package/src/skia/types/Skia.ts

@@ -21,7 +21,7 @@ import type { SkVertices, VertexMode } from "./Vertices/Vertices";
 import type { DataFactory } from "./Data";
 import type { SVGFactory } from "./SVG";
 import type { TextBlobFactory } from "./TextBlob";
-import type { SurfaceFactory } from "./Surface";
+import type { SkSurface, SurfaceFactory } from "./Surface";
 import type { SkRSXform } from "./RSXform";
 import type { SkPath } from "./Path/Path";
 import type { SkContourMeasureIter } from "./ContourMeasure";
@@ -33,6 +33,11 @@ import type { ParagraphBuilderFactory } from "./Paragraph/ParagraphBuilder";
 import type { Video } from "./Video";
 import type { NativeBufferFactory } from "./NativeBuffer";
 
+export interface SkiaContext {
+  getSurface(): SkSurface;
+  present(): void;
+}
+
 /**
  * Declares the interface for the native Skia API
  */
@@ -97,5 +102,6 @@ export interface Skia {
   Surface: SurfaceFactory;
   ParagraphBuilder: ParagraphBuilderFactory;
   Video: (url: string) => Promise<Video> | Video;
+  Context(surface: bigint, width: number, height: number): SkiaContext;
   NativeBuffer: NativeBufferFactory;
 }

package/src/skia/web/JsiSkia.ts

@@ -129,4 +129,7 @@ export const JsiSkApi = (CanvasKit: CanvasKit): Skia => ({
   ParagraphBuilder: new JsiSkParagraphBuilderFactory(CanvasKit),
   NativeBuffer: new JsiSkNativeBufferFactory(CanvasKit),
   Video: createVideo.bind(null, CanvasKit),
+  Context: (_surface: bigint, _width: number, _height: number) => {
+    throw new Error("Not implemented on React Native Web");
+  }
 });

package/src/web/WithSkiaWeb.tsx

@@ -5,17 +5,28 @@ import { Platform } from "../Platform";
 
 import { LoadSkiaWeb } from "./LoadSkiaWeb";
 
-interface WithSkiaProps {
+type NonOptionalKeys<T> = {
+  [k in keyof T]-?: undefined extends T[k] ? never : k;
+}[keyof T];
+
+type WithSkiaProps<TProps> = {
   fallback?: ComponentProps<typeof Suspense>["fallback"];
-  getComponent: () => Promise<{ default: ComponentType }>;
+  getComponent: () => Promise<{ default: ComponentType<TProps> }>;
   opts?: Parameters<typeof LoadSkiaWeb>[0];
-}
+} & (NonOptionalKeys<TProps> extends never
+  ? {
+      componentProps?: TProps;
+    }
+  : {
+      componentProps: TProps;
+    });
 
-export const WithSkiaWeb = ({
+export const WithSkiaWeb = <TProps extends object>({
   getComponent,
   fallback,
   opts,
-}: WithSkiaProps) => {
+  componentProps,
+}: WithSkiaProps<TProps>) => {
   const Inner = useMemo(
     // TODO: investigate
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -34,7 +45,7 @@ export const WithSkiaWeb = ({
   );
   return (
     <Suspense fallback={fallback ?? null}>
-      <Inner />
+      <Inner {...componentProps} />
     </Suspense>
   );
 };

package/cpp/skia/include/core/SkDrawLooper.h

@@ -1,135 +0,0 @@
-
-/*
- * Copyright 2011 The Android Open Source Project
- *
- * Use of this source code is governed by a BSD-style license that can be
- * found in the LICENSE file.
- */
-
-
-#ifndef SkDrawLooper_DEFINED
-#define SkDrawLooper_DEFINED
-
-#include "include/core/SkBlurTypes.h"
-#include "include/core/SkColor.h"
-#include "include/core/SkFlattenable.h"
-#include "include/core/SkPoint.h"
-#include <functional>  // std::function
-
-#ifndef SK_SUPPORT_LEGACY_DRAWLOOPER
-#error "SkDrawLooper is unsupported"
-#endif
-
-class  SkArenaAlloc;
-class  SkCanvas;
-class  SkMatrix;
-class  SkPaint;
-struct SkRect;
-
-/** \class SkDrawLooper
-    DEPRECATED: No longer supported in Skia.
-*/
-class SK_API SkDrawLooper : public SkFlattenable {
-public:
-    /**
-     *  Holds state during a draw. Users call next() until it returns false.
-     *
-     *  Subclasses of SkDrawLooper should create a subclass of this object to
-     *  hold state specific to their subclass.
-     */
-    class SK_API Context {
-    public:
-        Context() {}
-        virtual ~Context() {}
-
-        struct Info {
-            SkVector fTranslate;
-            bool     fApplyPostCTM;
-
-            void applyToCTM(SkMatrix* ctm) const;
-            void applyToCanvas(SkCanvas*) const;
-        };
-
-        /**
-         *  Called in a loop on objects returned by SkDrawLooper::createContext().
-         *  Each time true is returned, the object is drawn (possibly with a modified
-         *  canvas and/or paint). When false is finally returned, drawing for the object
-         *  stops.
-         *
-         *  On each call, the paint will be in its original state, but the
-         *  canvas will be as it was following the previous call to next() or
-         *  createContext().
-         *
-         *  The implementation must ensure that, when next() finally returns
-         *  false, the canvas has been restored to the state it was
-         *  initially, before createContext() was first called.
-         */
-        virtual bool next(Info*, SkPaint*) = 0;
-
-    private:
-        Context(const Context&) = delete;
-        Context& operator=(const Context&) = delete;
-    };
-
-    /**
-     *  Called right before something is being drawn. Returns a Context
-     *  whose next() method should be called until it returns false.
-     */
-    virtual Context* makeContext(SkArenaAlloc*) const = 0;
-
-    /**
-     * The fast bounds functions are used to enable the paint to be culled early
-     * in the drawing pipeline. If a subclass can support this feature it must
-     * return true for the canComputeFastBounds() function.  If that function
-     * returns false then computeFastBounds behavior is undefined otherwise it
-     * is expected to have the following behavior. Given the parent paint and
-     * the parent's bounding rect the subclass must fill in and return the
-     * storage rect, where the storage rect is with the union of the src rect
-     * and the looper's bounding rect.
-     */
-    bool canComputeFastBounds(const SkPaint& paint) const;
-    void computeFastBounds(const SkPaint& paint, const SkRect& src, SkRect* dst) const;
-
-    struct BlurShadowRec {
-        SkScalar        fSigma;
-        SkVector        fOffset;
-        SkColor         fColor;
-        SkBlurStyle     fStyle;
-    };
-    /**
-     *  If this looper can be interpreted as having two layers, such that
-     *      1. The first layer (bottom most) just has a blur and translate
-     *      2. The second layer has no modifications to either paint or canvas
-     *      3. No other layers.
-     *  then return true, and if not null, fill out the BlurShadowRec).
-     *
-     *  If any of the above are not met, return false and ignore the BlurShadowRec parameter.
-     */
-    virtual bool asABlurShadow(BlurShadowRec*) const;
-
-    static SkFlattenable::Type GetFlattenableType() {
-        return kSkDrawLooper_Type;
-    }
-
-    SkFlattenable::Type getFlattenableType() const override {
-        return kSkDrawLooper_Type;
-    }
-
-    static sk_sp<SkDrawLooper> Deserialize(const void* data, size_t size,
-                                          const SkDeserialProcs* procs = nullptr) {
-        return sk_sp<SkDrawLooper>(static_cast<SkDrawLooper*>(
-                                  SkFlattenable::Deserialize(
-                                  kSkDrawLooper_Type, data, size, procs).release()));
-    }
-
-    void apply(SkCanvas* canvas, const SkPaint& paint,
-               std::function<void(SkCanvas*, const SkPaint&)>);
-
-protected:
-    SkDrawLooper() {}
-
-private:
-    using INHERITED = SkFlattenable;
-};
-
-#endif

package/cpp/skia/include/effects/SkBlurDrawLooper.h

@@ -1,26 +0,0 @@
-/*
- * Copyright 2008 The Android Open Source Project
- *
- * Use of this source code is governed by a BSD-style license that can be
- * found in the LICENSE file.
- */
-
-#ifndef SkBlurDrawLooper_DEFINED
-#define SkBlurDrawLooper_DEFINED
-
-#include "include/core/SkDrawLooper.h"
-
-#ifndef SK_SUPPORT_LEGACY_DRAWLOOPER
-#error "SkDrawLooper is unsupported"
-#endif
-
-/**
- *  DEPRECATED: No longer supported in Skia.
- */
-namespace SkBlurDrawLooper {
-    sk_sp<SkDrawLooper> SK_API Make(SkColor4f color, SkColorSpace* cs,
-            SkScalar sigma, SkScalar dx, SkScalar dy);
-    sk_sp<SkDrawLooper> SK_API Make(SkColor color, SkScalar sigma, SkScalar dx, SkScalar dy);
-}  // namespace SkBlurDrawLooper
-
-#endif

package/cpp/skia/include/effects/SkLayerDrawLooper.h

@@ -1,161 +0,0 @@
-/*
- * Copyright 2011 Google Inc.
- *
- * Use of this source code is governed by a BSD-style license that can be
- * found in the LICENSE file.
- */
-
-#ifndef SkLayerDrawLooper_DEFINED
-#define SkLayerDrawLooper_DEFINED
-
-#include "include/core/SkBlendMode.h"
-#include "include/core/SkDrawLooper.h"
-#include "include/core/SkPaint.h"
-#include "include/core/SkPoint.h"
-
-#ifndef SK_SUPPORT_LEGACY_DRAWLOOPER
-#error "SkDrawLooper is unsupported"
-#endif
-
-/**
- *  DEPRECATED: No longer supported by Skia.
- */
-class SK_API SkLayerDrawLooper : public SkDrawLooper {
-public:
-    ~SkLayerDrawLooper() override;
-
-    /**
-     *  Bits specifies which aspects of the layer's paint should replace the
-     *  corresponding aspects on the draw's paint.
-     *  kEntirePaint_Bits means use the layer's paint completely.
-     *  0 means ignore the layer's paint... except for fColorMode, which is
-     *  always applied.
-     */
-    enum Bits {
-        kStyle_Bit      = 1 << 0,   //!< use this layer's Style/stroke settings
-        kPathEffect_Bit = 1 << 2,   //!< use this layer's patheffect
-        kMaskFilter_Bit = 1 << 3,   //!< use this layer's maskfilter
-        kShader_Bit     = 1 << 4,   //!< use this layer's shader
-        kColorFilter_Bit = 1 << 5,  //!< use this layer's colorfilter
-        kXfermode_Bit   = 1 << 6,   //!< use this layer's xfermode
-
-        // unsupported kTextSkewX_Bit  = 1 << 1,
-
-        /**
-         *  Use the layer's paint entirely, with these exceptions:
-         *  - We never override the draw's paint's text_encoding, since that is
-         *    used to interpret the text/len parameters in draw[Pos]Text.
-         *  - Color is always computed using the LayerInfo's fColorMode.
-         */
-        kEntirePaint_Bits = -1
-
-    };
-    typedef int32_t BitFlags;
-
-    /**
-     *  Info for how to apply the layer's paint and offset.
-     *
-     *  fColorMode controls how we compute the final color for the layer:
-     *      The layer's paint's color is treated as the SRC
-     *      The draw's paint's color is treated as the DST
-     *      final-color = Mode(layers-color, draws-color);
-     *  Any SkBlendMode will work. Two common choices are:
-     *      kSrc: to use the layer's color, ignoring the draw's
-     *      kDst: to just keep the draw's color, ignoring the layer's
-     */
-    struct SK_API LayerInfo {
-        BitFlags    fPaintBits;
-        SkBlendMode fColorMode;
-        SkVector    fOffset;
-        bool        fPostTranslate; //!< applies to fOffset
-
-        /**
-         *  Initial the LayerInfo. Defaults to settings that will draw the
-         *  layer with no changes: e.g.
-         *      fPaintBits == 0
-         *      fColorMode == kDst_Mode
-         *      fOffset == (0, 0)
-         */
-        LayerInfo();
-    };
-
-    SkDrawLooper::Context* makeContext(SkArenaAlloc*) const override;
-
-    bool asABlurShadow(BlurShadowRec* rec) const override;
-
-protected:
-    SkLayerDrawLooper();
-
-    void flatten(SkWriteBuffer&) const override;
-
-private:
-    SK_FLATTENABLE_HOOKS(SkLayerDrawLooper)
-
-    struct Rec {
-        Rec*    fNext;
-        SkPaint fPaint;
-        LayerInfo fInfo;
-    };
-    Rec*    fRecs;
-    int     fCount;
-
-    // state-machine during the init/next cycle
-    class LayerDrawLooperContext : public SkDrawLooper::Context {
-    public:
-        explicit LayerDrawLooperContext(const SkLayerDrawLooper* looper);
-
-    protected:
-        bool next(Info*, SkPaint* paint) override;
-
-    private:
-        Rec* fCurrRec;
-
-        static void ApplyInfo(SkPaint* dst, const SkPaint& src, const LayerInfo&);
-    };
-
-    using INHERITED = SkDrawLooper;
-
-public:
-    class SK_API Builder {
-    public:
-        Builder();
-
-        ~Builder();
-
-        /**
-         *  Call for each layer you want to add (from top to bottom).
-         *  This returns a paint you can modify, but that ptr is only valid until
-         *  the next call made to addLayer().
-         */
-        SkPaint* addLayer(const LayerInfo&);
-
-        /**
-         *  This layer will draw with the original paint, at the specified offset
-         */
-        void addLayer(SkScalar dx, SkScalar dy);
-
-        /**
-         *  This layer will with the original paint and no offset.
-         */
-        void addLayer() { this->addLayer(0, 0); }
-
-        /// Similar to addLayer, but adds a layer to the top.
-        SkPaint* addLayerOnTop(const LayerInfo&);
-
-        /**
-          * Pass list of layers on to newly built looper and return it. This will
-          * also reset the builder, so it can be used to build another looper.
-          */
-        sk_sp<SkDrawLooper> detach();
-
-    private:
-        Builder(const Builder&) = delete;
-        Builder& operator=(const Builder&) = delete;
-
-        Rec* fRecs;
-        Rec* fTopRec;
-        int  fCount;
-    };
-};
-
-#endif

package/cpp/skia/include/gpu/gl/GrGLConfig_chrome.h

@@ -1,14 +0,0 @@
-
-/*
- * Copyright 2011 Google Inc.
- *
- * Use of this source code is governed by a BSD-style license that can be
- * found in the LICENSE file.
- */
-#ifndef GrGLConfig_chrome_DEFINED
-#define GrGLConfig_chrome_DEFINED
-
-// glGetError() forces a sync with gpu process on chrome
-#define GR_GL_CHECK_ERROR_START                     0
-
-#endif

package/cpp/skia/include/gpu/vk/GrVkBackendContext.h

@@ -1,84 +0,0 @@
-/*
- * Copyright 2016 Google Inc.
- *
- * Use of this source code is governed by a BSD-style license that can be
- * found in the LICENSE file.
- */
-
-#ifndef GrVkBackendContext_DEFINED
-#define GrVkBackendContext_DEFINED
-
-#include "include/core/SkRefCnt.h"
-#include "include/gpu/vk/GrVkTypes.h"
-#include "include/gpu/vk/VulkanMemoryAllocator.h"
-
-namespace skgpu { class VulkanExtensions; }
-
-enum GrVkExtensionFlags {
-    kEXT_debug_report_GrVkExtensionFlag    = 0x0001,
-    kNV_glsl_shader_GrVkExtensionFlag      = 0x0002,
-    kKHR_surface_GrVkExtensionFlag         = 0x0004,
-    kKHR_swapchain_GrVkExtensionFlag       = 0x0008,
-    kKHR_win32_surface_GrVkExtensionFlag   = 0x0010,
-    kKHR_android_surface_GrVkExtensionFlag = 0x0020,
-    kKHR_xcb_surface_GrVkExtensionFlag     = 0x0040,
-};
-
-enum GrVkFeatureFlags {
-    kGeometryShader_GrVkFeatureFlag    = 0x0001,
-    kDualSrcBlend_GrVkFeatureFlag      = 0x0002,
-    kSampleRateShading_GrVkFeatureFlag = 0x0004,
-};
-
-// It is not guaranteed VkPhysicalDeviceProperties2 will be in the client's header so we forward
-// declare it here to be safe.
-struct VkPhysicalDeviceFeatures2;
-
-// The BackendContext contains all of the base Vulkan objects needed by the GrVkGpu. The assumption
-// is that the client will set these up and pass them to the GrVkGpu constructor. The VkDevice
-// created must support at least one graphics queue, which is passed in as well.
-// The QueueFamilyIndex must match the family of the given queue. It is needed for CommandPool
-// creation, and any GrBackendObjects handed to us (e.g., for wrapped textures) needs to be created
-// in or transitioned to that family. The refs held by members of this struct must be released
-// (either by deleting the struct or manually releasing the refs) before the underlying vulkan
-// device and instance are destroyed.
-struct SK_API GrVkBackendContext {
-    VkInstance                          fInstance = VK_NULL_HANDLE;
-    VkPhysicalDevice                    fPhysicalDevice = VK_NULL_HANDLE;
-    VkDevice                            fDevice = VK_NULL_HANDLE;
-    VkQueue                             fQueue = VK_NULL_HANDLE;
-    uint32_t                            fGraphicsQueueIndex = 0;
-    uint32_t                            fMinAPIVersion = 0; // Deprecated. Use fInstanceVersion
-                                                            // instead.
-    uint32_t                            fInstanceVersion = 0; // Deprecated. Use fMaxApiVersion
-    // The max api version set here should match the value set in VkApplicationInfo::apiVersion when
-    // then VkInstance was created.
-    uint32_t                            fMaxAPIVersion = 0;
-    uint32_t                            fExtensions = 0; // Deprecated. Use fVkExtensions instead.
-    const skgpu::VulkanExtensions*      fVkExtensions = nullptr;
-    uint32_t                            fFeatures = 0; // Deprecated. Use fDeviceFeatures[2]
-                                                       // instead.
-    // The client can create their VkDevice with either a VkPhysicalDeviceFeatures or
-    // VkPhysicalDeviceFeatures2 struct, thus we have to support taking both. The
-    // VkPhysicalDeviceFeatures2 struct is needed so we know if the client enabled any extension
-    // specific features. If fDeviceFeatures2 is not null then we ignore fDeviceFeatures. If both
-    // fDeviceFeatures and fDeviceFeatures2 are null we will assume no features are enabled.
-    const VkPhysicalDeviceFeatures*     fDeviceFeatures = nullptr;
-    const VkPhysicalDeviceFeatures2*    fDeviceFeatures2 = nullptr;
-    sk_sp<skgpu::VulkanMemoryAllocator> fMemoryAllocator;
-    skgpu::VulkanGetProc                fGetProc = nullptr;
-    // This is deprecated and should be set to false. The client is responsible for managing the
-    // lifetime of the VkInstance and VkDevice objects.
-    bool                                fOwnsInstanceAndDevice = false;
-    // Indicates that we are working with protected content and all CommandPool and Queue operations
-    // should be done in a protected context.
-    skgpu::Protected                    fProtectedContext = skgpu::Protected::kNo;
-    // Optional callback which will be invoked if a VK_ERROR_DEVICE_LOST error code is received from
-    // the driver. Debug information from the driver will be provided to the callback if the
-    // VK_EXT_device_fault extension is supported and enabled (VkPhysicalDeviceFaultFeaturesEXT must
-    // be in the pNext chain of VkDeviceCreateInfo).
-    skgpu::VulkanDeviceLostContext      fDeviceLostContext = nullptr;
-    skgpu::VulkanDeviceLostProc         fDeviceLostProc = nullptr;
-};
-
-#endif

package/cpp/skia/include/gpu/vk/GrVkExtensions.h

@@ -1,15 +0,0 @@
-/*
- * Copyright 2016 Google Inc.
- *
- * Use of this source code is governed by a BSD-style license that can be
- * found in the LICENSE file.
- */
-
-#ifndef GrVkExtensions_DEFINED
-#define GrVkExtensions_DEFINED
-
-#include "include/gpu/vk/VulkanExtensions.h"
-
-using GrVkExtensions = skgpu::VulkanExtensions;
-
-#endif

package/cpp/skia/include/gpu/vk/GrVkMemoryAllocator.h

@@ -1,15 +0,0 @@
-/*
- * Copyright 2018 Google Inc.
- *
- * Use of this source code is governed by a BSD-style license that can be
- * found in the LICENSE file.
- */
-
-#ifndef GrVkMemoryAllocator_DEFINED
-#define GrVkMemoryAllocator_DEFINED
-
-#include "include/gpu/vk/VulkanMemoryAllocator.h"
-
-using GrVkMemoryAllocator = skgpu::VulkanMemoryAllocator;
-
-#endif