@shopify/react-native-skia 1.0.1 → 1.0.2

package/lib/typescript/src/skia/types/Matrix4.d.ts

@@ -0,0 +1,103 @@
+type Point = {
+    x: number;
+    y: number;
+};
+type Vec2 = readonly [number, number];
+type Vec3 = readonly [number, number, number];
+type Vec4 = readonly [number, number, number, number];
+export type Matrix3 = readonly [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+export type Matrix4 = readonly [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+type Transform3dName = "translateX" | "translateY" | "translateZ" | "translate" | "scale" | "scaleX" | "scaleY" | "skewX" | "skewY" | "rotateZ" | "rotate" | "perspective" | "rotateX" | "rotateY" | "matrix";
+type Transformations = {
+    [Name in Transform3dName]: Name extends "matrix" ? Matrix4 : Name extends "translate" ? Vec3 | Vec2 : number;
+};
+type Transform3d = Pick<Transformations, "translateX"> | Pick<Transformations, "translateY"> | Pick<Transformations, "translateZ"> | Pick<Transformations, "translate"> | Pick<Transformations, "scale"> | Pick<Transformations, "scaleX"> | Pick<Transformations, "scaleY"> | Pick<Transformations, "skewX"> | Pick<Transformations, "skewY"> | Pick<Transformations, "perspective"> | Pick<Transformations, "rotateX"> | Pick<Transformations, "rotateY"> | Pick<Transformations, "rotateZ"> | Pick<Transformations, "rotate"> | Pick<Transformations, "matrix">;
+export type Transforms3d = Transform3d[];
+/**
+ * @worklet
+ */
+export declare const Matrix4: () => Matrix4;
+/**
+ * @worklet
+ */
+export declare const translate: (x: number, y: number, z?: number) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const perspective: (p: number) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const matrixVecMul4: (m: Matrix4, v: Vec4) => Vec4;
+/**
+ * @worklet
+ */
+export declare const mapPoint3d: (m: Matrix4, v: Vec3) => readonly [number, number, number];
+/**
+ * @worklet
+ */
+export declare const multiply4: (a: Matrix4, b: Matrix4) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const toMatrix3: (m: Matrix4) => number[];
+/**
+ * @worklet
+ */
+export declare const pivot: (m: Matrix4, p: Point) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const scale: (sx: number, sy: number, sz?: number, p?: Point) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const rotateZ: (value: number, p?: Point) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const rotateX: (value: number, p?: Point) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const rotateY: (value: number, p?: Point) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const processTransform3d: (transforms: Transforms3d) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const convertToColumnMajor: (rowMajorMatrix: Matrix4) => Matrix4;
+/**
+ * @worklet
+ */
+export declare const convertToAffineMatrix: (m4: Matrix4) => number[];
+export {};

package/lib/typescript/src/skia/types/Paint/BlendMode.d.ts

@@ -0,0 +1,58 @@
+/**
+ *  Blends are operators that take in two colors (source, destination) and
+ * return a new color. Many of these operate the same on all 4 components: red,
+ * green, blue, alpha. For these, we just document what happens to one
+ * component, rather than naming each one separately.
+ *
+ *  Different SkColorTypes have different representations for color components:
+ *      8-bit: 0..255
+ *      6-bit: 0..63
+ *      5-bit: 0..31
+ *      4-bit: 0..15
+ *     floats: 0...1
+ *
+ *  The documentation is expressed as if the component values are always 0..1
+ * (floats).
+ *
+ *  For brevity, the documentation uses the following abbreviations
+ *  s  : source
+ *  d  : destination
+ *  sa : source alpha
+ *  da : destination alpha
+ *
+ *  Results are abbreviated
+ *  r  : if all 4 components are computed in the same manner
+ *  ra : result alpha component
+ *  rc : result "color": red, green, blue components
+ */
+export declare enum BlendMode {
+    Clear = 0,
+    Src = 1,
+    Dst = 2,
+    SrcOver = 3,
+    DstOver = 4,
+    SrcIn = 5,
+    DstIn = 6,
+    SrcOut = 7,
+    DstOut = 8,
+    SrcATop = 9,
+    DstATop = 10,
+    Xor = 11,
+    Plus = 12,
+    Modulate = 13,
+    Screen = 14,
+    Overlay = 15,
+    Darken = 16,
+    Lighten = 17,
+    ColorDodge = 18,
+    ColorBurn = 19,
+    HardLight = 20,
+    SoftLight = 21,
+    Difference = 22,
+    Exclusion = 23,
+    Multiply = 24,
+    Hue = 25,
+    Saturation = 26,
+    Color = 27,
+    Luminosity = 28
+}

package/lib/typescript/src/skia/types/Paint/Paint.d.ts

@@ -0,0 +1,141 @@
+import type { SkImageFilter } from "../ImageFilter";
+import type { SkMaskFilter } from "../MaskFilter";
+import type { SkColorFilter } from "../ColorFilter";
+import type { SkColor } from "../Color";
+import type { SkPathEffect } from "../PathEffect";
+import type { SkJSIInstance } from "../JsiInstance";
+import type { SkShader } from "../Shader";
+import type { BlendMode } from "./BlendMode";
+export declare enum PaintStyle {
+    Fill = 0,
+    Stroke = 1
+}
+export declare enum StrokeCap {
+    Butt = 0,
+    Round = 1,
+    Square = 2
+}
+export declare enum StrokeJoin {
+    Miter = 0,
+    Round = 1,
+    Bevel = 2
+}
+export declare const isPaint: (obj: SkJSIInstance<string> | null) => obj is SkPaint;
+export interface SkPaint extends SkJSIInstance<"Paint"> {
+    /**
+     * Retrieves alpha from the color used when stroking and filling.
+     */
+    getAlphaf(): number;
+    /**
+     * Returns a copy of this paint.
+     */
+    copy(): SkPaint;
+    /**
+     * Sets all SkPaint contents to their initial values. This is equivalent to replacing
+       SkPaint with the result of SkPaint().
+     */
+    reset(): void;
+    /**
+     * Retrieves the alpha and RGB unpremultiplied. RGB are extended sRGB values
+     * (sRGB gamut, and encoded with the sRGB transfer function).
+     */
+    getColor(): SkColor;
+    /**
+     * Returns the geometry drawn at the beginning and end of strokes.
+     */
+    getStrokeCap(): StrokeCap;
+    /**
+     * Returns the geometry drawn at the corners of strokes.
+     */
+    getStrokeJoin(): StrokeJoin;
+    /**
+     *  Returns the limit at which a sharp corner is drawn beveled.
+     */
+    getStrokeMiter(): number;
+    /**
+     * Returns the thickness of the pen used to outline the shape.
+     */
+    getStrokeWidth(): number;
+    /**
+     * Replaces alpha, leaving RGBA unchanged. 0 means fully transparent, 1.0 means opaque.
+     * @param alpha
+     */
+    setAlphaf(alpha: number): void;
+    /**
+     * Requests, but does not require, that edge pixels draw opaque or with
+     * partial transparency.
+     * @param aa
+     */
+    setAntiAlias: (aa: boolean) => void;
+    /**
+     * Requests, but does not require, to distribute color error.
+     * @param dither
+     */
+    setDither: (dither: boolean) => void;
+    /**
+     * Sets the blend mode that is, the mode used to combine source color
+     * with destination color.
+     * @param mode
+     */
+    setBlendMode: (blendMode: BlendMode) => void;
+    /**
+     *  Sets alpha and RGB used when stroking and filling. The color is a 32-bit
+     *  value, unpremultiplied, packing 8-bit components for alpha, red, blue,
+     *  and green.
+     *
+     *   @param color  unpremultiplied ARGB
+     *
+     *    example: https://fiddle.skia.org/c/@Paint_setColor
+     */
+    setColor(color: SkColor): void;
+    /**
+     * Sets the current color filter, replacing the existing one if there was one.
+     * @param filter
+     */
+    setColorFilter(filter: SkColorFilter | null): void;
+    /**
+     * Sets the current image filter, replacing the existing one if there was one.
+     * @param filter
+     */
+    setImageFilter(filter: SkImageFilter | null): void;
+    /**
+     * Sets the current mask filter, replacing the existing one if there was one.
+     * @param filter
+     */
+    setMaskFilter(filter: SkMaskFilter | null): void;
+    /**
+     * Sets the current path effect, replacing the existing one if there was one.
+     * @param effect
+     */
+    setPathEffect(effect: SkPathEffect | null): void;
+    /**
+     * Sets the current shader, replacing the existing one if there was one.
+     * @param shader
+     */
+    setShader(shader: SkShader | null): void;
+    /**
+     * Sets the geometry drawn at the beginning and end of strokes.
+     * @param cap
+     */
+    setStrokeCap(cap: StrokeCap): void;
+    /**
+     * Sets the geometry drawn at the corners of strokes.
+     * @param join
+     */
+    setStrokeJoin(join: StrokeJoin): void;
+    /**
+     * Sets the limit at which a sharp corner is drawn beveled.
+     * @param limit
+     */
+    setStrokeMiter(limit: number): void;
+    /**
+     * Sets the thickness of the pen used to outline the shape.
+     * @param width
+     */
+    setStrokeWidth(width: number): void;
+    /**
+     * Sets whether the geometry is filled or stroked.
+     * @param style
+     */
+    setStyle(style: PaintStyle): void;
+}

package/lib/typescript/src/skia/types/Paint/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Paint";
+export * from "./BlendMode";

package/lib/typescript/src/skia/types/Paragraph/Paragraph.d.ts

@@ -0,0 +1,79 @@
+import type { SkCanvas } from "../Canvas";
+import type { SkJSIInstance } from "../JsiInstance";
+import type { SkRect } from "../Rect";
+import type { TextDirection } from "./ParagraphStyle";
+export interface SkRectWithDirection {
+    rect: SkRect;
+    direction: TextDirection;
+}
+export interface SkParagraph extends SkJSIInstance<"Paragraph"> {
+    /**
+     * Calculates the position of the the glyphs in the paragraph
+     * @param width Max width of the paragraph
+     */
+    layout(width: number): void;
+    /**
+     * Paints the paragraph to the provded canvas
+     * @param canvas Canvas to paint into
+     * @param x X coordinate to paint at
+     * @param y Y coordinate to paint at
+     */
+    paint(canvas: SkCanvas, x: number, y: number): void;
+    /**
+     * Returns the height of the paragraph. This method requires the layout
+     * method to have been called first.
+     */
+    getHeight(): number;
+    /**
+     * Returns the max width of the paragraph. This method requires the layout
+     * method to have been called first.
+     */
+    getMaxWidth(): number;
+    /**
+     * Returns the minimum intrinsic width of the paragraph.
+     * The minimum intrinsic width is the width beyond which increasing the width of the paragraph
+     * does not decrease the height. This is effectively the width at which the paragraph
+     * can no longer wrap lines and is forced to overflow.
+     * This method requires the layout method to have been called first.
+     * @returns {number} The minimum intrinsic width of the paragraph.
+     */
+    getMinIntrinsicWidth(): number;
+    /**
+     * Returns the maximum intrinsic width of the paragraph.
+     * The maximum intrinsic width is the width at which the paragraph can layout its content without line breaks,
+     * meaning it's the width of the widest line or the widest word if the widest line is shorter than that.
+     * This width represents the ideal width for the paragraph to display all content in a single line without overflow.
+     * This method requires the layout method to have been called first.
+     * @returns {number} The maximum intrinsic width of the paragraph.
+     */
+    getMaxIntrinsicWidth(): number;
+    /**
+     * Returns the width of the longest line in the paragraph.
+     * This method requires the layout method to have been called first.
+     */
+    getLongestLine(): number;
+    /**
+     * Returns the index of the glyph at the given position. This method requires
+     * the layout method to have been called first.
+     * @param x X coordinate of the position
+     * @param y Y coordinate of the position
+     */
+    getGlyphPositionAtCoordinate(x: number, y: number): number;
+    /**
+     * Returns the bounding boxes of the glyphs in the given range. This method
+     * requires the layout method to have been called first.
+     * @param start Start index of the range
+     * @param end End index of the range
+     */
+    getRectsForRange(start: number, end: number): SkRect[];
+    /**
+     * Returns the bounding boxes for all lines in the paragraph. This method
+     * requires the layout method to have been called first.
+     */
+    getLineMetrics(): Array<SkRect>;
+    /**
+     * Returns a list of rects with direction info for the placeholders added
+     * to the paragraph.
+     */
+    getRectsForPlaceholders(): SkRectWithDirection[];
+}

package/lib/typescript/src/skia/types/Paragraph/ParagraphBuilder.d.ts

@@ -0,0 +1,60 @@
+import type { SkJSIInstance } from "../JsiInstance";
+import type { SkPaint } from "../Paint";
+import type { SkParagraph } from "./Paragraph";
+import type { SkParagraphStyle } from "./ParagraphStyle";
+import type { SkTextStyle, TextBaseline } from "./TextStyle";
+import type { SkTypefaceFontProvider } from "./TypefaceFontProvider";
+export interface ParagraphBuilderFactory {
+    /**
+     * Creates a new ParagraphBuilder object from custom fonts.
+     * @param paragraphStyle Initial paragraph style
+     * @param typefaceProvider Typeface provider
+     */
+    Make(paragraphStyle?: SkParagraphStyle, typefaceProvider?: SkTypefaceFontProvider): SkParagraphBuilder;
+}
+export declare enum PlaceholderAlignment {
+    Baseline = 0,
+    AboveBaseline = 1,
+    BelowBaseline = 2,
+    Top = 3,
+    Bottom = 4,
+    Middle = 5
+}
+export interface SkParagraphBuilder extends SkJSIInstance<"ParagraphBuilder"> {
+    /**
+     * Creates a Paragraph object from the builder and the inputs given to the builder.
+     */
+    build(): SkParagraph;
+    /**
+     * Restores the builder to its initial empty state.
+     */
+    reset(): void;
+    /**
+     * Pushes a text-style to the builder
+     * @param style Style to push
+     * @param foregroundPaint Foreground paint object
+     * @param backgroundPaint Background paint object
+     * @returns The builder
+     */
+    pushStyle: (style: SkTextStyle, foregroundPaint?: SkPaint | undefined, backgroundPaint?: SkPaint | undefined) => SkParagraphBuilder;
+    /**
+     * Pops the current text style from the builder
+     * @returns The builder
+     */
+    pop: () => SkParagraphBuilder;
+    /**
+     * Adds text to the builder
+     * @param text
+     * @returns The builder
+     */
+    addText: (text: string) => SkParagraphBuilder;
+    /**
+     * Pushes the information required to leave an open space.
+     * @param width
+     * @param height
+     * @param alignment
+     * @param baseline
+     * @param offset
+     */
+    addPlaceholder(width?: number, height?: number, alignment?: PlaceholderAlignment, baseline?: TextBaseline, offset?: number): SkParagraphBuilder;
+}

package/lib/typescript/src/skia/types/Paragraph/ParagraphStyle.d.ts

@@ -0,0 +1,41 @@
+import type { SkTextFontStyle, SkTextStyle } from "./TextStyle";
+export declare enum TextDirection {
+    RTL = 0,
+    LTR = 1
+}
+export declare enum TextAlign {
+    Left = 0,
+    Right = 1,
+    Center = 2,
+    Justify = 3,
+    Start = 4,
+    End = 5
+}
+export interface SkStrutStyle {
+    strutEnabled?: boolean;
+    fontFamilies?: string[];
+    fontStyle?: SkTextFontStyle;
+    fontSize?: number;
+    heightMultiplier?: number;
+    halfLeading?: boolean;
+    leading?: number;
+    forceStrutHeight?: boolean;
+}
+export declare enum TextHeightBehavior {
+    All = 0,
+    DisableFirstAscent = 1,
+    DisableLastDescent = 2,
+    DisableAll = 3
+}
+export interface SkParagraphStyle {
+    disableHinting?: boolean;
+    ellipsis?: string;
+    heightMultiplier?: number;
+    maxLines?: number;
+    replaceTabCharacters?: boolean;
+    strutStyle?: SkStrutStyle;
+    textAlign?: TextAlign;
+    textDirection?: TextDirection;
+    textHeightBehavior?: TextHeightBehavior;
+    textStyle?: SkTextStyle;
+}

package/lib/typescript/src/skia/types/Paragraph/TextStyle.d.ts

@@ -0,0 +1,62 @@
+import type { SkColor } from "../Color";
+import type { FontSlant, FontWeight, FontWidth } from "../Font";
+import type { SkPoint } from "../Point";
+export declare enum TextDecoration {
+    NoDecoration = 0,
+    Underline = 1,
+    Overline = 2,
+    LineThrough = 4
+}
+export declare enum TextDecorationStyle {
+    Solid = 0,
+    Double = 1,
+    Dotted = 2,
+    Dashed = 3,
+    Wavy = 4
+}
+export interface SkTextShadow {
+    color?: SkColor;
+    /**
+     * 2d array for x and y offset. Defaults to [0, 0]
+     */
+    offset?: SkPoint;
+    blurRadius?: number;
+}
+export interface SkTextFontFeatures {
+    name: string;
+    value: number;
+}
+export interface SkTextFontStyle {
+    weight?: FontWeight;
+    width?: FontWidth;
+    slant?: FontSlant;
+}
+export interface SkTextFontVariations {
+    axis: string;
+    value: number;
+}
+export declare enum TextBaseline {
+    Alphabetic = 0,
+    Ideographic = 1
+}
+export interface SkTextStyle {
+    backgroundColor?: SkColor;
+    color?: SkColor;
+    decoration?: number;
+    decorationColor?: SkColor;
+    decorationThickness?: number;
+    decorationStyle?: TextDecoration;
+    fontFamilies?: string[];
+    fontFeatures?: SkTextFontFeatures[];
+    fontSize?: number;
+    fontStyle?: SkTextFontStyle;
+    fontVariations?: SkTextFontVariations[];
+    foregroundColor?: SkColor;
+    heightMultiplier?: number;
+    halfLeading?: boolean;
+    letterSpacing?: number;
+    locale?: string;
+    shadows?: SkTextShadow[];
+    textBaseline?: TextBaseline;
+    wordSpacing?: number;
+}

package/lib/typescript/src/skia/types/Paragraph/TypefaceFontProvider.d.ts

@@ -0,0 +1,10 @@
+import type { SkFontMgr } from "../Font";
+import type { SkTypeface } from "../Typeface";
+export interface SkTypefaceFontProvider extends SkFontMgr {
+    /**
+     * Registers a given typeface with the given family name.
+     * @param typeface - Typeface.
+     * @param family
+     */
+    registerFont(typeface: SkTypeface, familyName: string): void;
+}

package/lib/typescript/src/skia/types/Paragraph/TypefaceFontProviderFactory.d.ts

@@ -0,0 +1,4 @@
+import type { SkTypefaceFontProvider } from "./TypefaceFontProvider";
+export interface TypefaceFontProviderFactory {
+    Make(): SkTypefaceFontProvider;
+}

package/lib/typescript/src/skia/types/Paragraph/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./TypefaceFontProvider";
+export * from "./TypefaceFontProviderFactory";
+export * from "./Paragraph";
+export * from "./ParagraphBuilder";
+export * from "./ParagraphStyle";
+export * from "./TextStyle";