@shopify/react-native-skia 0.1.122 → 0.1.125

package/lib/typescript/src/views/SkiaView.d.ts

@@ -1,40 +1,7 @@
 import React from "react";
-import type { ViewProps } from "react-native";
-import type { SkImage, SkRect } from "../skia";
+import type { SkRect } from "../skia";
 import type { SkiaReadonlyValue } from "../values";
-import type { DrawMode, RNSkiaDrawCallback } from "./types";
-declare global {
-    var SkiaViewApi: {
-        invalidateSkiaView: (nativeId: number) => void;
-        makeImageSnapshot: (nativeId: number, rect?: SkRect) => SkImage;
-        setDrawCallback: (nativeId: number, callback: RNSkiaDrawCallback | undefined) => void;
-        setDrawMode: (nativeId: number, mode: DrawMode) => void;
-        registerValuesInView: (nativeId: number, values: SkiaReadonlyValue<unknown>[]) => () => void;
-    };
-}
-export interface SkiaViewProps extends ViewProps {
-    /**
-     * Sets the drawing mode for the skia view. There are two drawing
-     * modes, "continuous" and "default", where the continuous mode will
-     * continuously redraw the view, and the default mode will only
-     * redraw when any of the regular react properties are changed like
-     * sizes and margins.
-     */
-    mode?: DrawMode;
-    /**
-     * When set to true the view will display information about the
-     * average time it takes to render.
-     */
-    debug?: boolean;
-    /**
-     * Draw callback. Will be called whenever the view is invalidated and
-     * needs to redraw. This is either caused by a change in a react
-     * property, a touch event, or a call to redraw. If the view is in
-     * continuous mode the callback will be called 60 frames per second
-     * by the native view.
-     */
-    onDraw?: RNSkiaDrawCallback;
-}
+import type { DrawMode, SkiaViewProps } from "./types";
 export declare class SkiaView extends React.Component<SkiaViewProps> {
     constructor(props: SkiaViewProps);
     private _nativeId;
@@ -45,7 +12,7 @@ export declare class SkiaView extends React.Component<SkiaViewProps> {
      * @param rect Rect to use as bounds. Optional.
      * @returns An Image object.
      */
-    makeImageSnapshot(rect?: SkRect): SkImage;
+    makeImageSnapshot(rect?: SkRect): import("../skia").SkImage;
     /**
      * Sends a redraw request to the native SkiaView.
      */

package/lib/typescript/src/views/api.d.ts

@@ -0,0 +1,5 @@
+import type { ISkiaViewApi } from "./types";
+declare global {
+    var SkiaViewApi: ISkiaViewApi;
+}
+export declare const SkiaViewApi: ISkiaViewApi;

package/lib/typescript/src/views/types.d.ts

@@ -1,5 +1,7 @@
 import type { ViewProps } from "react-native";
+import type { SkImage, SkRect } from "../skia";
 import type { SkCanvas } from "../skia/Canvas";
+import type { SkiaReadonlyValue } from "../values";
 export declare type DrawMode = "continuous" | "default";
 export declare type NativeSkiaViewProps = ViewProps & {
     mode?: DrawMode;
@@ -42,3 +44,33 @@ export interface ValueListener {
     addListener: (callback: () => void) => number;
     removeListener: (id: number) => void;
 }
+export interface ISkiaViewApi {
+    invalidateSkiaView: (nativeId: number) => void;
+    makeImageSnapshot: (nativeId: number, rect?: SkRect) => SkImage;
+    setDrawCallback: (nativeId: number, callback: RNSkiaDrawCallback | undefined) => void;
+    setDrawMode: (nativeId: number, mode: DrawMode) => void;
+    registerValuesInView: (nativeId: number, values: SkiaReadonlyValue<unknown>[]) => () => void;
+}
+export interface SkiaViewProps extends ViewProps {
+    /**
+     * Sets the drawing mode for the skia view. There are two drawing
+     * modes, "continuous" and "default", where the continuous mode will
+     * continuously redraw the view, and the default mode will only
+     * redraw when any of the regular react properties are changed like
+     * sizes and margins.
+     */
+    mode?: DrawMode;
+    /**
+     * When set to true the view will display information about the
+     * average time it takes to render.
+     */
+    debug?: boolean;
+    /**
+     * Draw callback. Will be called whenever the view is invalidated and
+     * needs to redraw. This is either caused by a change in a react
+     * property, a touch event, or a call to redraw. If the view is in
+     * continuous mode the callback will be called 60 frames per second
+     * by the native view.
+     */
+    onDraw?: RNSkiaDrawCallback;
+}

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "title": "React Native Skia",
-  "version": "0.1.122",
+  "version": "0.1.125",
   "description": "High-performance React Native Graphics using Skia",
   "main": "lib/module/index.js",
   "files": [
@@ -76,7 +76,7 @@
     "react-native": "0.66.2",
     "react-native-builder-bob": "^0.18.2",
     "ts-jest": "^27.0.7",
-    "typescript": "^4.6.2"
+    "typescript": "^4.6.4"
   },
   "dependencies": {
     "react-reconciler": "^0.26.2"

package/src/{values/animation → animation}/decay/runDecay.ts

@@ -1,5 +1,5 @@
-import { ValueApi } from "../../api";
-import type { SkiaValue } from "../../types";
+import { ValueApi } from "../../values/api";
+import type { SkiaValue } from "../../values/types";
 
 import { decay } from "./decay";
 import type { DecayConfig, DefaultDecayConfig, DecayState } from "./types";

package/src/{values/animation → animation}/decay/types.ts

@@ -1,4 +1,4 @@
-import type { AnimationState } from "../../types";
+import type { AnimationState } from "../../values/types";
 
 export interface DecayConfig {
   from?: number;

package/src/animation/functions/interpolate.ts

@@ -0,0 +1,182 @@
+/* eslint-disable max-len */
+export enum Extrapolate {
+  IDENTITY = "identity",
+  CLAMP = "clamp",
+  EXTEND = "extend",
+}
+
+interface InterpolationNarrowedInput {
+  leftEdgeInput: number;
+  rightEdgeInput: number;
+  leftEdgeOutput: number;
+  rightEdgeOutput: number;
+}
+
+export interface ExtrapolationConfig {
+  extrapolateLeft?: Extrapolate | string;
+  extrapolateRight?: Extrapolate | string;
+}
+
+interface RequiredExtrapolationConfig {
+  extrapolateLeft: Extrapolate;
+  extrapolateRight: Extrapolate;
+}
+
+export type ExtrapolationType =
+  | ExtrapolationConfig
+  | Extrapolate
+  | string
+  | undefined;
+
+function getVal(
+  type: Extrapolate,
+  coef: number,
+  val: number,
+  leftEdgeOutput: number,
+  rightEdgeOutput: number,
+  x: number
+): number {
+  switch (type) {
+    case Extrapolate.IDENTITY:
+      return x;
+    case Extrapolate.CLAMP:
+      if (coef * val < coef * leftEdgeOutput) {
+        return leftEdgeOutput;
+      }
+      return rightEdgeOutput;
+    case Extrapolate.EXTEND:
+    default:
+      return val;
+  }
+}
+
+function isExtrapolate(value: string): value is Extrapolate {
+  return (
+    value === Extrapolate.EXTEND ||
+    value === Extrapolate.CLAMP ||
+    value === Extrapolate.IDENTITY
+  );
+}
+
+// validates extrapolations type
+// if type is correct, converts it to ExtrapolationConfig
+function validateType(type: ExtrapolationType): RequiredExtrapolationConfig {
+  // initialize extrapolationConfig with default extrapolation
+  const extrapolationConfig: RequiredExtrapolationConfig = {
+    extrapolateLeft: Extrapolate.EXTEND,
+    extrapolateRight: Extrapolate.EXTEND,
+  };
+
+  if (!type) {
+    return extrapolationConfig;
+  }
+
+  if (typeof type === "string") {
+    if (!isExtrapolate(type)) {
+      throw new Error(
+        `No supported value for "interpolate" \nSupported values: ["extend", "clamp", "identity", Extrapolatation.CLAMP, Extrapolatation.EXTEND, Extrapolatation.IDENTITY]\n Valid example:
+        interpolate(value, [inputRange], [outputRange], "clamp")`
+      );
+    }
+    extrapolationConfig.extrapolateLeft = type;
+    extrapolationConfig.extrapolateRight = type;
+    return extrapolationConfig;
+  }
+
+  // otherwise type is extrapolation config object
+  if (
+    (type.extrapolateLeft && !isExtrapolate(type.extrapolateLeft)) ||
+    (type.extrapolateRight && !isExtrapolate(type.extrapolateRight))
+  ) {
+    throw new Error(
+      `No supported value for "interpolate" \nSupported values: ["extend", "clamp", "identity", Extrapolatation.CLAMP, Extrapolatation.EXTEND, Extrapolatation.IDENTITY]\n Valid example:
+      interpolate(value, [inputRange], [outputRange], {
+        extrapolateLeft: Extrapolation.CLAMP,
+        extrapolateRight: Extrapolation.IDENTITY
+      }})`
+    );
+  }
+
+  Object.assign(extrapolationConfig, type);
+  return extrapolationConfig;
+}
+
+function internalInterpolate(
+  x: number,
+  narrowedInput: InterpolationNarrowedInput,
+  extrapolationConfig: RequiredExtrapolationConfig
+) {
+  const { leftEdgeInput, rightEdgeInput, leftEdgeOutput, rightEdgeOutput } =
+    narrowedInput;
+  if (rightEdgeInput - leftEdgeInput === 0) {
+    return leftEdgeOutput;
+  }
+  const progress = (x - leftEdgeInput) / (rightEdgeInput - leftEdgeInput);
+  const val = leftEdgeOutput + progress * (rightEdgeOutput - leftEdgeOutput);
+  const coef = rightEdgeOutput >= leftEdgeOutput ? 1 : -1;
+
+  if (coef * val < coef * leftEdgeOutput) {
+    return getVal(
+      extrapolationConfig.extrapolateLeft,
+      coef,
+      val,
+      leftEdgeOutput,
+      rightEdgeOutput,
+      x
+    );
+  } else if (coef * val > coef * rightEdgeOutput) {
+    return getVal(
+      extrapolationConfig.extrapolateRight,
+      coef,
+      val,
+      leftEdgeOutput,
+      rightEdgeOutput,
+      x
+    );
+  }
+
+  return val;
+}
+
+// e.g. function interpolate(x, input, output, type = Extrapolatation.CLAMP)
+export function interpolate(
+  x: number,
+  input: readonly number[],
+  output: readonly number[],
+  type?: ExtrapolationType
+): number {
+  if (input.length < 2 || output.length < 2) {
+    throw Error(
+      "Interpolation input and output should contain at least two values."
+    );
+  }
+
+  const extrapolationConfig = validateType(type);
+  const { length } = input;
+  const narrowedInput: InterpolationNarrowedInput = {
+    leftEdgeInput: input[0],
+    rightEdgeInput: input[1],
+    leftEdgeOutput: output[0],
+    rightEdgeOutput: output[1],
+  };
+  if (length > 2) {
+    if (x > input[length - 1]) {
+      narrowedInput.leftEdgeInput = input[length - 2];
+      narrowedInput.rightEdgeInput = input[length - 1];
+      narrowedInput.leftEdgeOutput = output[length - 2];
+      narrowedInput.rightEdgeOutput = output[length - 1];
+    } else {
+      for (let i = 1; i < length; ++i) {
+        if (x <= input[i]) {
+          narrowedInput.leftEdgeInput = input[i - 1];
+          narrowedInput.rightEdgeInput = input[i];
+          narrowedInput.leftEdgeOutput = output[i - 1];
+          narrowedInput.rightEdgeOutput = output[i];
+          break;
+        }
+      }
+    }
+  }
+
+  return internalInterpolate(x, narrowedInput, extrapolationConfig);
+}

package/src/animation/functions/interpolateColors.ts

@@ -0,0 +1,58 @@
+import { mix } from "../../renderer";
+import type { Color } from "../../skia";
+import { Skia } from "../../skia";
+import type { SkColor } from "../../skia/Color";
+
+import { interpolate } from "./interpolate";
+
+const interpolateColorsRGB = (
+  value: number,
+  inputRange: number[],
+  outputRange: SkColor[]
+) => {
+  const r = interpolate(
+    value,
+    inputRange,
+    outputRange.map((c) => c[0]),
+    "clamp"
+  );
+  const g = interpolate(
+    value,
+    inputRange,
+    outputRange.map((c) => c[1]),
+    "clamp"
+  );
+  const b = interpolate(
+    value,
+    inputRange,
+    outputRange.map((c) => c[2]),
+    "clamp"
+  );
+  const a = interpolate(
+    value,
+    inputRange,
+    outputRange.map((c) => c[3]),
+    "clamp"
+  );
+  return new Float32Array([r, g, b, a]);
+};
+
+export const interpolateColors = (
+  value: number,
+  inputRange: number[],
+  _outputRange: Color[]
+) => {
+  const outputRange = _outputRange.map((cl) => Skia.Color(cl));
+  return interpolateColorsRGB(value, inputRange, outputRange);
+};
+
+export const mixColors = (value: number, x: Color, y: Color) => {
+  const c1 = Skia.Color(x);
+  const c2 = Skia.Color(y);
+  return new Float32Array([
+    mix(value, c1[0], c2[0]),
+    mix(value, c1[1], c2[1]),
+    mix(value, c1[2], c2[2]),
+    mix(value, c1[3], c2[3]),
+  ]);
+};

package/src/{values/animation → animation}/spring/runSpring.ts

@@ -1,4 +1,4 @@
-import type { SkiaValue, SkiaAnimation } from "../../types";
+import type { SkiaValue, SkiaAnimation } from "../../values/types";
 import type {
   AnimationParams,
   SpringConfig,

package/src/{values/animation → animation}/spring/useSpring.ts

@@ -1,4 +1,4 @@
-import type { SkiaReadonlyValue } from "../../types";
+import type { SkiaReadonlyValue } from "../../values/types";
 import type {
   SpringConfig,
   AnimationParams,

package/src/{values/animation → animation}/timing/createTiming.ts

@@ -3,8 +3,8 @@ import type {
   RequiredAnimationParams,
   AnimationCallback,
 } from "../types";
-import type { AnimationState, SkiaValue } from "../../types";
-import { ValueApi } from "../../api";
+import type { AnimationState, SkiaValue } from "../../values/types";
+import { ValueApi } from "../../values/api";
 
 import { timing } from "./functions";
 

package/src/{values/animation → animation}/timing/functions/getResolvedParams.ts

@@ -42,8 +42,8 @@ export const getResolvedParams = (
 
   const resolvedConfig: Required<TimingConfig> = { ...DefaultTimingConfig };
   if (config) {
-    resolvedConfig.duration = config.duration;
-    resolvedConfig.easing = config.easing ?? ((t) => t);
+    resolvedConfig.duration = config.duration ?? DefaultTimingConfig.duration;
+    resolvedConfig.easing = config.easing ?? DefaultTimingConfig.easing;
   }
 
   return { ...resolvedParameters, ...resolvedConfig };

package/src/{values/animation → animation}/timing/functions/timing.ts

@@ -1,4 +1,4 @@
-import type { AnimationState } from "../../../types";
+import type { AnimationState } from "../../../values/types";
 
 /**
  * Calculates and returns a timing value based on the

package/src/{values/animation → animation}/timing/runTiming.ts

@@ -1,4 +1,4 @@
-import type { SkiaValue, SkiaAnimation } from "../../types";
+import type { SkiaValue, SkiaAnimation } from "../../values/types";
 import type {
   AnimationParams,
   TimingConfig,

package/src/{values/animation → animation}/timing/useTiming.ts

@@ -1,12 +1,12 @@
 import { useEffect, useMemo, useRef } from "react";
 
-import type { SkiaReadonlyValue, SkiaAnimation } from "../../types";
+import type { SkiaReadonlyValue, SkiaAnimation } from "../../values/types";
 import type {
   AnimationParams,
   TimingConfig,
   AnimationCallback,
 } from "../types";
-import { useValue } from "../../hooks/useValue";
+import { useValue } from "../../values/hooks/useValue";
 
 import { getResolvedParams } from "./functions";
 import { createTiming } from "./createTiming";

package/src/{values/animation → animation}/types.ts

@@ -1,12 +1,12 @@
 export interface SpringConfig {
-  mass: number;
-  stiffness: number;
-  damping: number;
-  velocity: number;
+  mass?: number;
+  stiffness?: number;
+  damping?: number;
+  velocity?: number;
 }
 
 export interface TimingConfig {
-  duration: number;
+  duration?: number;
   easing?: (t: number) => number;
 }
 

package/src/index.ts

@@ -5,3 +5,4 @@ export * from "./views";
 export * from "./skia";
 export * from "./external";
 export * from "./values";
+export * from "./animation";

package/src/renderer/Canvas.tsx

@@ -23,6 +23,7 @@ import { Skia } from "../skia";
 import type { FontMgr } from "../skia/FontMgr/FontMgr";
 import { useValue } from "../values/hooks/useValue";
 import type { SkiaReadonlyValue } from "../values/types";
+import { SkiaPaint } from "../skia/Paint/Paint";
 
 import { debug as hostDebug, skHostConfig } from "./HostConfig";
 // import { debugTree } from "./nodes";
@@ -35,12 +36,19 @@ const CanvasContext = React.createContext<SkiaReadonlyValue<{
   height: number;
 }> | null>(null);
 
-export const useCanvasSize = () => {
-  const canvas = useContext(CanvasContext);
-  if (!canvas) {
+export const useCanvas = () => {
+  const size = useContext(CanvasContext);
+  if (!size) {
     throw new Error("Canvas context is not available");
   }
-  return canvas;
+  return { size };
+};
+
+export const useCanvasSize = () => {
+  console.warn(
+    "useCanvasSize is deprecated, use the size member of useCanvas() instead."
+  );
+  return useCanvas().size;
 };
 
 export const skiaReconciler = ReactReconciler(skHostConfig);
@@ -112,8 +120,7 @@ export const Canvas = forwardRef<SkiaView, CanvasProps>(
         ) {
           canvasCtx.current = { width, height };
         }
-        const paint = Skia.Paint();
-        paint.setAntiAlias(true);
+        const paint = SkiaPaint();
         const ctx = {
           width,
           height,

package/src/renderer/components/Paint.tsx

@@ -2,7 +2,7 @@ import type { ReactNode } from "react";
 import React, { useRef, useMemo, forwardRef, useImperativeHandle } from "react";
 
 import type { SkPaint } from "../../skia";
-import { Skia } from "../../skia";
+import { SkiaPaint } from "../../skia";
 import type { CustomPaintProps, AnimatedProps } from "../processors";
 import { processPaint } from "../processors";
 import { createDeclaration } from "../nodes";
@@ -15,7 +15,7 @@ export interface PaintProps extends Omit<CustomPaintProps, "paint"> {
 
 export const Paint = forwardRef<SkPaint, AnimatedProps<PaintProps>>(
   (props, ref) => {
-    const paint = useMemo(() => Skia.Paint(), []);
+    const paint = useMemo(() => SkiaPaint(), []);
     useImperativeHandle(ref, () => paint, [paint]);
     const onDeclare = useMemo(
       () =>

package/src/renderer/components/colorFilters/BlendColor.tsx

@@ -1,11 +1,11 @@
 import React from "react";
 import type { ReactNode } from "react";
 
+import type { Color } from "../../../skia";
 import { BlendMode, Skia } from "../../../skia";
 import { createDeclaration } from "../../nodes";
 import type { SkEnum, AnimatedProps } from "../../processors";
 import { enumKey } from "../../processors";
-import type { Color } from "../../../skia";
 
 import { composeColorFilter } from "./Compose";
 

package/src/renderer/components/colorFilters/Lerp.tsx

@@ -15,7 +15,7 @@ export interface LerpProps {
 
 const onDeclare = createDeclaration<LerpProps>(({ t }, children) => {
   const [src, dst] = children.filter(isColorFilter);
-  const cf = Skia.ColorFilter.MakeLerp(t, dst, src);
+  const cf = Skia.ColorFilter.MakeLerp(t, src, dst);
   return composeColorFilter(
     cf,
     children.filter((c) => c !== src && c !== dst)

package/src/renderer/components/imageFilters/InnerShadow.tsx

@@ -2,6 +2,8 @@ import type { SkColor } from "../../../skia";
 import { BlendMode, Skia, TileMode } from "../../../skia";
 import type { SkImageFilter } from "../../../skia/ImageFilter/ImageFilter";
 
+const Black = Skia.Color("black");
+
 export const MakeInnerShadow = (
   shadowOnly: boolean | undefined,
   dx: number,
@@ -12,11 +14,11 @@ export const MakeInnerShadow = (
   input: SkImageFilter | null
 ) => {
   const sourceGraphic = Skia.ImageFilter.MakeColorFilter(
-    Skia.ColorFilter.MakeBlend(0xff000000, BlendMode.Dst),
+    Skia.ColorFilter.MakeBlend(Black, BlendMode.Dst),
     null
   );
   const sourceAlpha = Skia.ImageFilter.MakeColorFilter(
-    Skia.ColorFilter.MakeBlend(0xff000000, BlendMode.SrcIn),
+    Skia.ColorFilter.MakeBlend(Black, BlendMode.SrcIn),
     null
   );
   const f1 = Skia.ImageFilter.MakeColorFilter(

package/src/renderer/components/imageFilters/RuntimeShader.tsx

@@ -0,0 +1,23 @@
+import React from "react";
+
+import { Skia } from "../../../skia";
+import { createDeclaration } from "../../nodes/Declaration";
+import type { AnimatedProps } from "../../processors/Animations/Animations";
+import type { SkRuntimeEffect } from "../../../skia/RuntimeEffect/RuntimeEffect";
+
+import { getInput } from "./getInput";
+
+export interface RuntimeShaderProps {
+  source: SkRuntimeEffect;
+}
+
+const onDeclare = createDeclaration<RuntimeShaderProps>(
+  ({ source }, children) => {
+    const rtb = Skia.RuntimeShaderBuilder(source);
+    return Skia.ImageFilter.MakeRuntimeShader(rtb, null, getInput(children));
+  }
+);
+
+export const RuntimeShader = (props: AnimatedProps<RuntimeShaderProps>) => {
+  return <skDeclaration onDeclare={onDeclare} {...props} />;
+};

package/src/renderer/components/imageFilters/index.ts

@@ -3,3 +3,4 @@ export * from "./Offset";
 export * from "./DisplacementMap";
 export * from "./Shadow";
 export * from "./Morphology";
+export * from "./RuntimeShader";