@shopify/react-native-skia 0.0.135

package/src/skia/types/Font/Font.ts

@@ -0,0 +1,232 @@
+import type { SkJSIInstance } from "../JsiInstance";
+import type { SkPaint } from "../Paint";
+import type { SkRect } from "../Rect";
+import type { SkPoint } from "../Point";
+import type { SkTypeface } from "../Typeface";
+
+export interface FontMetrics {
+  ascent: number; // suggested space above the baseline. < 0
+  descent: number; // suggested space below the baseline. > 0
+  leading: number; // suggested spacing between descent of previous line and ascent of next line.
+  bounds?: SkRect; // smallest rect containing all glyphs (relative to 0,0)
+}
+
+export interface SkFont extends SkJSIInstance<"Font"> {
+  /**
+   * Retrieves the total width of the provided text
+   * @param text
+   * @param paint
+   */
+  getTextWidth(text: string, paint?: SkPaint): number;
+
+  /**
+   * Retrieves the advanceX measurements for each glyph.
+   * If paint is not null, its stroking, PathEffect, and MaskFilter fields are respected.
+   * One width per glyph is returned in the returned array.
+   * @param glyphs
+   * @param paint
+   */
+  getGlyphWidths(glyphs: number[], paint?: SkPaint): number[];
+
+  /** Returns the advance width of text.
+      The advance is the normal distance to move before drawing additional text.
+      Returns the bounding box of text if bounds is not nullptr. The paint
+      stroke settings, mask filter, or path effect may modify the bounds.
+
+      @param text        character storage encoded with SkTextEncoding
+      @param byteLength  length of character storage in bytes
+      @param bounds      returns bounding box relative to (0, 0) if not nullptr
+      @param paint       optional; may be nullptr
+      @return            number of glyphs represented by text of length byteLength
+  */
+  measureText: (text: string, paint?: SkPaint) => SkRect;
+
+  /**
+   * Returns the FontMetrics for this font.
+   */
+  getMetrics(): FontMetrics;
+
+  /**
+   * Retrieves the glyph ids for each code point in the provided string. This call is passed to
+   * the typeface of this font. Note that glyph IDs are typeface-dependent; different faces
+   * may have different ids for the same code point.
+   * @param str
+   * @param numCodePoints - the number of code points in the string. Defaults to str.length.
+   */
+  getGlyphIDs(str: string, numCodePoints?: number): number[];
+
+  /**
+   * Computes any intersections of a thick "line" and a run of positionsed glyphs.
+   * The thick line is represented as a top and bottom coordinate (positive for
+   * below the baseline, negative for above). If there are no intersections
+   * (e.g. if this is intended as an underline, and there are no "collisions")
+   * then the returned array will be empty. If there are intersections, the array
+   * will contain pairs of X coordinates [start, end] for each segment that
+   * intersected with a glyph.
+   *
+   * @param glyphs        the glyphs to intersect with
+   * @param positions     x,y coordinates (2 per glyph) for each glyph
+   * @param top           top of the thick "line" to use for intersection testing
+   * @param bottom        bottom of the thick "line" to use for intersection testing
+   * @return              array of [start, end] x-coordinate pairs. Maybe be empty.
+   */
+  getGlyphIntercepts(
+    glyphs: number[],
+    positions: SkPoint[],
+    top: number,
+    bottom: number
+  ): number[];
+
+  /**
+   * Returns text scale on x-axis. Default value is 1.
+   */
+  getScaleX(): number;
+
+  /**
+   * Returns text size in points.
+   */
+  getSize(): number;
+
+  /**
+   * Returns text skew on x-axis. Default value is zero.
+   */
+  getSkewX(): number;
+
+  /**
+   * Returns embolden effect for this font. Default value is false.
+   */
+  isEmbolden(): boolean;
+
+  /**
+   * Returns the Typeface set for this font.
+   */
+  getTypeface(): SkTypeface | null;
+
+  /**
+   * Requests, but does not require, that edge pixels draw opaque or with partial transparency.
+   * @param edging
+   */
+  setEdging(edging: FontEdging): void;
+
+  /**
+   * Requests, but does not require, to use bitmaps in fonts instead of outlines.
+   * @param embeddedBitmaps
+   */
+  setEmbeddedBitmaps(embeddedBitmaps: boolean): void;
+
+  /**
+   * Sets level of glyph outline adjustment.
+   * @param hinting
+   */
+  setHinting(hinting: FontHinting): void;
+
+  /**
+   * Requests, but does not require, linearly scalable font and glyph metrics.
+   *
+   * For outline fonts 'true' means font and glyph metrics should ignore hinting and rounding.
+   * Note that some bitmap formats may not be able to scale linearly and will ignore this flag.
+   * @param linearMetrics
+   */
+  setLinearMetrics(linearMetrics: boolean): void;
+
+  /**
+   * Sets the text scale on the x-axis.
+   * @param sx
+   */
+  setScaleX(sx: number): void;
+
+  /**
+   * Sets the text size in points on this font.
+   * @param points
+   */
+  setSize(points: number): void;
+
+  /**
+   * Sets the text-skew on the x axis for this font.
+   * @param sx
+   */
+  setSkewX(sx: number): void;
+
+  /**
+   * Set embolden effect for this font.
+   * @param embolden
+   */
+  setEmbolden(embolden: boolean): void;
+
+  /**
+   * Requests, but does not require, that glyphs respect sub-pixel positioning.
+   * @param subpixel
+   */
+  setSubpixel(subpixel: boolean): void;
+
+  /**
+   * Sets the typeface to use with this font. null means to clear the typeface and use the
+   * default one.
+   * @param face
+   */
+  setTypeface(face: SkTypeface | null): void;
+}
+
+const fontStyle = (
+  weight: FontWeight,
+  width: FontWidth,
+  slant: FontSlant
+): FontStyle => ({ weight, width, slant });
+
+export interface FontStyle {
+  weight?: FontWeight;
+  width?: FontWidth;
+  slant?: FontSlant;
+}
+
+export enum FontWeight {
+  Invisible = 0,
+  Thin = 100,
+  ExtraLight = 200,
+  Light = 300,
+  Normal = 400,
+  Medium = 500,
+  SemiBold = 600,
+  Bold = 700,
+  ExtraBold = 800,
+  Black = 900,
+  ExtraBlack = 1000,
+}
+
+export enum FontWidth {
+  UltraCondensed = 1,
+  ExtraCondensed = 2,
+  Condensed = 3,
+  SemiCondensed = 4,
+  Normal = 5,
+  SemiExpanded = 6,
+  Expanded = 7,
+  ExtraExpanded = 8,
+  UltraExpanded = 9,
+}
+
+export enum FontSlant {
+  Upright,
+  Italic,
+  Oblique,
+}
+
+export enum FontEdging {
+  Alias,
+  AntiAlias,
+  SubpixelAntiAlias,
+}
+
+export enum FontHinting {
+  None,
+  Slight,
+  Normal,
+  Full,
+}
+
+export const FontStyle = {
+  Normal: fontStyle(FontWeight.Normal, FontWidth.Normal, FontSlant.Upright),
+  Bold: fontStyle(FontWeight.Bold, FontWidth.Normal, FontSlant.Upright),
+  Italic: fontStyle(FontWeight.Normal, FontWidth.Normal, FontSlant.Italic),
+  BoldItalic: fontStyle(FontWeight.Bold, FontWidth.Normal, FontSlant.Italic),
+};

package/src/skia/types/Font/index.ts

@@ -0,0 +1 @@
+export * from "./Font";

package/src/skia/types/FontMgr/FontMgr.ts

@@ -0,0 +1,24 @@
+import type { SkJSIInstance } from "../JsiInstance";
+import type { FontStyle } from "../Font/Font";
+import type { SkTypeface } from "../Typeface";
+
+export interface SkFontMgr extends SkJSIInstance<"FontMgr"> {
+  /**
+   * Return the number of font families loaded in this manager. Useful for debugging.
+   */
+  countFamilies(): number;
+
+  /**
+   * Return the nth family name. Useful for debugging.
+   * @param index
+   */
+  getFamilyName(index: number): string;
+
+  /**
+   *  Find the closest matching typeface to the specified familyName and style and return a ref to it.
+   */
+  matchFamilyStyle(
+    familyName: string,
+    fontStyle?: FontStyle
+  ): SkTypeface | null;
+}

package/src/skia/types/FontMgr/FontMgrFactory.ts

@@ -0,0 +1,12 @@
+import type { SkFontMgr } from "./FontMgr";
+
+// Commented code below is the CanvasKit reference
+export interface FontMgrFactory {
+  // FromData: (...data: Data[]) => FontMgr | null;
+  RefDefault: () => SkFontMgr;
+}
+
+//const fontMgrFactory = (data: Data[]) => Skia.FontMgr.FromData(...data);
+
+// export const useFontMgr = (data: DataSource[], deps: DependencyList = []) =>
+//   useDataCollection(data, fontMgrFactory, deps);

package/src/skia/types/FontMgr/index.ts

@@ -0,0 +1,2 @@
+export * from "./FontMgrFactory";
+export * from "./FontMgr";

package/src/skia/types/Image/Image.ts

@@ -0,0 +1,96 @@
+import type { SkMatrix } from "../Matrix";
+import type { SkJSIInstance } from "../JsiInstance";
+import type { TileMode } from "../ImageFilter";
+import type { SkShader } from "../Shader";
+
+export enum FilterMode {
+  Nearest,
+  Linear,
+}
+
+export enum MipmapMode {
+  None,
+  Nearest,
+  Linear,
+}
+
+export enum ImageFormat {
+  JPEG = 3,
+  PNG = 4,
+  WEBP = 6,
+}
+
+export interface SkImage extends SkJSIInstance<"Image"> {
+  /**
+   * Returns the possibly scaled height of the image.
+   */
+  height(): number;
+
+  /**
+   * Returns the possibly scaled width of the image.
+   */
+  width(): number;
+
+  /**
+   * Returns this image as a shader with the specified tiling. It will use cubic sampling.
+   * @param tx - tile mode in the x direction.
+   * @param ty - tile mode in the y direction.
+   * @param fm - The filter mode. (default nearest)
+   * @param mm - The mipmap mode. Note: for settings other than None, the image must have mipmaps (default none)
+   *             calculated with makeCopyWithDefaultMipmaps;
+   * @param localMatrix
+   */
+  makeShaderOptions(
+    tx: TileMode,
+    ty: TileMode,
+    fm: FilterMode,
+    mm: MipmapMode,
+    localMatrix?: SkMatrix
+  ): SkShader;
+
+  /**
+   * Returns this image as a shader with the specified tiling. It will use cubic sampling.
+   * @param tx - tile mode in the x direction.
+   * @param ty - tile mode in the y direction.
+   * @param B - See CubicResampler in SkSamplingOptions.h for more information
+   * @param C - See CubicResampler in SkSamplingOptions.h for more information
+   * @param localMatrix
+   */
+  makeShaderCubic(
+    tx: TileMode,
+    ty: TileMode,
+    B: number,
+    C: number,
+    localMatrix?: SkMatrix
+  ): SkShader;
+
+  /** Encodes Image pixels, returning result as UInt8Array. Returns existing
+     encoded data if present; otherwise, SkImage is encoded with
+     SkEncodedImageFormat::kPNG. Skia must be built with SK_ENCODE_PNG to encode
+     SkImage.
+
+    Returns nullptr if existing encoded data is missing or invalid, and
+    encoding fails.
+
+    @param fmt - PNG is the default value.
+    @param quality - a value from 0 to 100; 100 is the least lossy. May be ignored.
+
+    @return  Uint8Array with data
+  */
+  encodeToBytes(fmt?: ImageFormat, quality?: number): Uint8Array;
+
+  /** Encodes Image pixels, returning result as a base64 encoded string. Returns existing
+     encoded data if present; otherwise, SkImage is encoded with
+     SkEncodedImageFormat::kPNG. Skia must be built with SK_ENCODE_PNG to encode
+     SkImage.
+
+    Returns nullptr if existing encoded data is missing or invalid, and
+    encoding fails.
+
+    @param fmt - PNG is the default value.
+    @param quality - a value from 0 to 100; 100 is the least lossy. May be ignored.
+
+    @return  base64 encoded string of data
+  */
+  encodeToBase64(fmt?: ImageFormat, quality?: number): string;
+}

package/src/skia/types/Image/ImageFactory.ts

@@ -0,0 +1,78 @@
+/* eslint-disable camelcase */
+import type { SkData } from "../Data";
+
+import type { SkImage } from "./Image";
+
+export enum AlphaType {
+  Unknown,
+  Opaque,
+  Premul,
+  Unpremul,
+}
+
+export enum ColorType {
+  Unknown, //!< uninitialized
+  Alpha_8, //!< pixel with alpha in 8-bit byte
+  RGB_565, //!< pixel with 5 bits red, 6 bits green, 5 bits blue, in 16-bit word
+  ARGB_4444, //!< pixel with 4 bits for alpha, red, green, blue; in 16-bit word
+  RGBA_8888, //!< pixel with 8 bits for red, green, blue, alpha; in 32-bit word
+  RGB_888x, //!< pixel with 8 bits each for red, green, blue; in 32-bit word
+  BGRA_8888, //!< pixel with 8 bits for blue, green, red, alpha; in 32-bit word
+  RGBA_1010102, //!< 10 bits for red, green, blue; 2 bits for alpha; in 32-bit word
+  BGRA_1010102, //!< 10 bits for blue, green, red; 2 bits for alpha; in 32-bit word
+  RGB_101010x, //!< pixel with 10 bits each for red, green, blue; in 32-bit word
+  BGR_101010x, //!< pixel with 10 bits each for blue, green, red; in 32-bit word
+  Gray_8, //!< pixel with grayscale level in 8-bit byte
+  RGBA_F16Norm, //!< pixel with half floats in [0,1] for red, green, blue, alpha;
+  //   in 64-bit word
+  RGBA_F16, //!< pixel with half floats for red, green, blue, alpha;
+  //   in 64-bit word
+  RGBA_F32, //!< pixel using C float for red, green, blue, alpha; in 128-bit word
+
+  // The following 6 colortypes are just for reading from - not for rendering to
+  R8G8_unorm, //!< pixel with a uint8_t for red and green
+
+  A16_float, //!< pixel with a half float for alpha
+  R16G16_float, //!< pixel with a half float for red and green
+
+  A16_unorm, //!< pixel with a little endian uint16_t for alpha
+  R16G16_unorm, //!< pixel with a little endian uint16_t for red and green
+  R16G16B16A16_unorm, //!< pixel with a little endian uint16_t for red, green, blue
+  //   and alpha
+  SRGBA_8888,
+}
+
+export interface ImageInfo {
+  alphaType: AlphaType;
+  // TODO: add support for color space
+  // colorSpace: ColorSpace;
+  colorType: ColorType;
+  height: number;
+  width: number;
+}
+
+export interface ImageFactory {
+  /**
+   * Return an Image backed by the encoded data, but attempt to defer decoding until the image
+   * is actually used/drawn. This deferral allows the system to cache the result, either on the
+   * CPU or on the GPU, depending on where the image is drawn.
+   * This decoding uses the codecs that have been compiled into CanvasKit. If the bytes are
+   * invalid (or an unrecognized codec), null will be returned. See Image.h for more details.
+   * @param data - Data object with bytes of data
+   * @returns If the encoded format is not supported, or subset is outside of the bounds of the decoded
+   *  image, nullptr is returned.
+   */
+  MakeImageFromEncoded: (encoded: SkData) => SkImage | null;
+
+  /**
+   * Returns an image with the given pixel data and format.
+   * Note that we will always make a copy of the pixel data, because of inconsistencies in
+   * behavior between GPU and CPU (i.e. the pixel data will be turned into a GPU texture and
+   * not modifiable after creation).
+   *
+   * @param info
+   * @param data - bytes representing the pixel data.
+   * @param bytesPerRow
+   */
+  MakeImage(info: ImageInfo, data: SkData, bytesPerRow: number): SkImage | null;
+}

package/src/skia/types/Image/index.ts

@@ -0,0 +1,2 @@
+export * from "./Image";
+export * from "./ImageFactory";

package/src/skia/types/ImageFilter/ImageFilter.ts

@@ -0,0 +1,31 @@
+import type { SkJSIInstance } from "../JsiInstance";
+
+export enum TileMode {
+  /**
+   *  Replicate the edge color if the shader draws outside of its
+   *  original bounds.
+   */
+  Clamp,
+
+  /**
+   *  Repeat the shader's image horizontally and vertically.
+   */
+  Repeat,
+
+  /**
+   *  Repeat the shader's image horizontally and vertically, alternating
+   *  mirror images so that adjacent images always seam.
+   */
+  Mirror,
+
+  /**
+   *  Only draw within the original domain, return transparent-black everywhere else.
+   */
+  Decal,
+}
+
+export const isImageFilter = (
+  obj: SkJSIInstance<string> | null
+): obj is SkImageFilter => obj !== null && obj.__typename__ === "ImageFilter";
+
+export type SkImageFilter = SkJSIInstance<"ImageFilter">;

package/src/skia/types/ImageFilter/ImageFilterFactory.ts

@@ -0,0 +1,192 @@
+import type { SkColor } from "../Color";
+import type { SkColorFilter } from "../ColorFilter/ColorFilter";
+import type { BlendMode } from "../Paint";
+import type { SkRect } from "../Rect";
+import type { SkRuntimeShaderBuilder } from "../RuntimeEffect";
+import type { SkShader } from "../Shader";
+
+import type { SkImageFilter, TileMode } from "./ImageFilter";
+
+export enum ColorChannel {
+  R,
+  G,
+  B,
+  A,
+}
+
+export interface ImageFilterFactory {
+  /**
+   * Offsets the input image
+   *
+   * @param dx - Offset along the X axis
+   * @param dy - Offset along the X axis
+   * @param input - if null, it will use the dynamic source image
+   */
+  MakeOffset(
+    dx: number,
+    dy: number,
+    input: SkImageFilter | null
+  ): SkImageFilter;
+  /**
+   * Spatially displace pixel values of the filtered image
+   *
+   * @param channelX - Color channel to be used along the X axis
+   * @param channelY - Color channel to be used along the Y axis
+   * @param scale - Scale factor to be used in the displacement
+   * @param in1 - Source image filter to use for the displacement
+   * @param input - if null, it will use the dynamic source image
+   */
+  MakeDisplacementMap(
+    channelX: ColorChannel,
+    channelY: ColorChannel,
+    scale: number,
+    in1: SkImageFilter,
+    input: SkImageFilter | null
+  ): SkImageFilter;
+  /**
+   * Transforms a shader into an impage filter
+   *
+   * @param shader - The Shader to be transformed
+   * @param input - if null, it will use the dynamic source image
+   */
+  MakeShader(shader: SkShader, input: SkImageFilter | null): SkImageFilter;
+  /**
+   * Create a filter that blurs its input by the separate X and Y sigmas. The provided tile mode
+   * is used when the blur kernel goes outside the input image.
+   *
+   * @param sigmaX - The Gaussian sigma value for blurring along the X axis.
+   * @param sigmaY - The Gaussian sigma value for blurring along the Y axis.
+   * @param mode
+   * @param input - if null, it will use the dynamic source image (e.g. a saved layer)
+   */
+  MakeBlur(
+    sigmaX: number,
+    sigmaY: number,
+    mode: TileMode,
+    input: SkImageFilter | null
+  ): SkImageFilter;
+
+  /**
+   * Create a filter that applies the color filter to the input filter results.
+   * @param cf
+   * @param input - if null, it will use the dynamic source image (e.g. a saved layer)
+   */
+  MakeColorFilter(
+    cf: SkColorFilter,
+    input: SkImageFilter | null
+  ): SkImageFilter;
+
+  /**
+   * Create a filter that composes 'inner' with 'outer', such that the results of 'inner' are
+   * treated as the source bitmap passed to 'outer'.
+   * If either param is null, the other param will be returned.
+   * @param outer
+   * @param inner - if null, it will use the dynamic source image (e.g. a saved layer)
+   */
+  MakeCompose(
+    outer: SkImageFilter | null,
+    inner: SkImageFilter | null
+  ): SkImageFilter;
+
+  /**
+   * Create a filter that draws a drop shadow under the input content.
+   * This filter produces an image that includes the inputs' content.
+   * @param dx The X offset of the shadow.
+   * @param dy	The Y offset of the shadow.
+   * @param sigmaX	The blur radius for the shadow, along the X axis.
+   * @param sigmaY	The blur radius for the shadow, along the Y axis.
+   * @param color	The color of the drop shadow.
+   * @param input	The input filter, or will use the source bitmap if this is null.
+   * @param cropRect	Optional rectangle that crops the input and output.
+   */
+  MakeDropShadow: (
+    dx: number,
+    dy: number,
+    sigmaX: number,
+    sigmaY: number,
+    color: SkColor,
+    input: SkImageFilter | null,
+    cropRect?: SkRect
+  ) => SkImageFilter;
+  /**
+   * Create a filter that renders a drop shadow, in exactly the same manner as ::DropShadow, except
+   * that the resulting image does not include the input content.
+   * This allows the shadow and input to be composed by a filter DAG in a more flexible manner.
+   * @param dx The X offset of the shadow.
+   * @param dy	The Y offset of the shadow.
+   * @param sigmaX	The blur radius for the shadow, along the X axis.
+   * @param sigmaY	The blur radius for the shadow, along the Y axis.
+   * @param color	The color of the drop shadow.
+   * @param input	The input filter, or will use the source bitmap if this is null.
+   * @param cropRect	Optional rectangle that crops the input and output.
+   */
+  MakeDropShadowOnly: (
+    dx: number,
+    dy: number,
+    sigmaX: number,
+    sigmaY: number,
+    color: SkColor,
+    input: SkImageFilter | null,
+    cropRect?: SkRect
+  ) => SkImageFilter;
+  /**
+   *  Create a filter that erodes each input pixel's channel values to the minimum channel value
+   *  within the given radii along the x and y axes.
+   *  @param radiusX  The distance to erode along the x axis to either side of each pixel.
+   *  @param radiusY  The distance to erode along the y axis to either side of each pixel.
+   *  @param input    The image filter that is eroded, using source bitmap if this is null.
+   *  @param cropRect Optional rectangle that crops the input and output.
+   */
+  MakeErode: (
+    rx: number,
+    ry: number,
+    input: SkImageFilter | null,
+    cropRect?: SkRect
+  ) => SkImageFilter;
+  /**
+   *  Create a filter that dilates each input pixel's channel values to the max value within the
+   *  given radii along the x and y axes.
+   *  @param radiusX  The distance to dilate along the x axis to either side of each pixel.
+   *  @param radiusY  The distance to dilate along the y axis to either side of each pixel.
+   *  @param input    The image filter that is dilated, using source bitmap if this is null.
+   *  @param cropRect Optional rectangle that crops the input and output.
+   */
+  MakeDilate: (
+    rx: number,
+    ry: number,
+    input: SkImageFilter | null,
+    cropRect?: SkRect
+  ) => SkImageFilter;
+  /**
+   *  This filter takes an SkBlendMode and uses it to composite the two filters together.
+   *  @param mode       The blend mode that defines the compositing operation
+   *  @param background The Dst pixels used in blending, if null the source bitmap is used.
+   *  @param foreground The Src pixels used in blending, if null the source bitmap is used.
+   *  @cropRect         Optional rectangle to crop input and output.
+   */
+  MakeBlend: (
+    mode: BlendMode,
+    background: SkImageFilter,
+    foreground: SkImageFilter | null,
+    cropRect?: SkRect
+  ) => SkImageFilter;
+  /**
+   *  Create a filter that fills the output with the per-pixel evaluation of the SkShader produced
+   *  by the SkRuntimeShaderBuilder. The shader is defined in the image filter's local coordinate
+   *  system, so it will automatically be affected by SkCanvas' transform.
+   *
+   *  @param builder         The builder used to produce the runtime shader, that will in turn
+   *                         fill the result image
+   *  @param childShaderName The name of the child shader defined in the builder that will be
+   *                         bound to the input param (or the source image if the input param
+   *                         is null).  If null the builder can have exactly one child shader,
+   *                         which automatically binds the input param.
+   *  @param input           The image filter that will be provided as input to the runtime
+   *                         shader. If null the implicit source image is used instead
+   */
+  MakeRuntimeShader: (
+    builder: SkRuntimeShaderBuilder,
+    childShaderName: string | null,
+    input: SkImageFilter | null
+  ) => SkImageFilter;
+}

package/src/skia/types/ImageFilter/index.ts

@@ -0,0 +1,2 @@
+export * from "./ImageFilter";
+export * from "./ImageFilterFactory";

package/src/skia/types/JsiInstance.ts

@@ -0,0 +1,3 @@
+export interface SkJSIInstance<T extends string> {
+  __typename__: T;
+}