@rive-app/canvas-advanced-single 2.43.1 → 2.44.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/canvas-advanced-single",
-  "version": "2.43.1",
+  "version": "2.44.1",
   "description": "Rive's lightweight low-level canvas based web api all in one js file.",
   "main": "canvas_advanced_single.mjs",
   "homepage": "https://rive.app",

package/rive_advanced.mjs.d.ts

@@ -286,6 +286,14 @@ export declare class RenderPaintWrapper {
   radialGradient(sx: number, sy: number, ex: number, ey: number): void;
   addStop(color: number, stop: number): void;
   completeGradient(): void;
+  gradientTransform(
+    xx: number,
+    xy: number,
+    yx: number,
+    yy: number,
+    tx: number,
+    ty: number,
+  ): void;
 }
 
 /**
@@ -460,6 +468,11 @@ export declare class File {
    * @returns Number of view models in the Rive file
    */
   viewModelCount(): number;
+  /**
+   * Reports device pixels per layout point to scripts in this file
+   * @param scale - Device pixels per layout point
+   */
+  displayScale(scale: number): void;
   /**
    * Returns a view model by the index in which it is located in the file
    * @returns ViewModel
@@ -1018,6 +1031,70 @@ export declare class StateMachineInstance {
    * @param y - Y coordinate
    */
   pointerExit(x: number, y: number, id: number): void;
+  /**
+   * Notifies the state machine of indirect scroll input (a mouse wheel, or a trackpad gesture the
+   * platform already classified as a scroll) at the given coordinate in Artboard space. Direct
+   * touch scrolling stays on the pointer path.
+   *
+   * A gesture latches to the scroll view that takes its first event and stays there, even past
+   * that view's edge, until the gesture ends. A gesture with no end phase (a wheel) ends once the
+   * state machine advances 0.1s without another scroll event.
+   *
+   * @param x - X coordinate
+   * @param y - Y coordinate
+   * @param dx - Horizontal distance the content moves, in Artboard pixels. Revealing content to
+   * the right is negative, so a DOM wheel delta must be negated.
+   * @param dy - Vertical distance the content moves, in Artboard pixels. Revealing content below
+   * is negative.
+   * @param phase - Where the event sits within its gesture: 0 begin, 1 update, 2 end,
+   * 3 momentum, 4 inertiaCancel. A phaseless wheel only ever sends 1 (update).
+   * @param precise - True for a pixel-precise source such as a trackpad, false for a detented
+   * wheel.
+   * @param timeStamp - Event time in seconds.
+   * @param id - Pointer id
+   * @returns 0 when nothing took the event, 1 when a scroll view did, 2 when an opaque scroll
+   * view did.
+   */
+  pointerScroll(
+    x: number,
+    y: number,
+    dx: number,
+    dy: number,
+    phase: number,
+    precise: boolean,
+    timeStamp: number,
+    id: number,
+  ): number;
+  /**
+   * Returns true if anything under the given Artboard coordinate would move for this scroll
+   * event, without applying it. Always true while a gesture is latched.
+   * See {@link pointerScroll} for the parameters.
+   */
+  wantsScroll(
+    x: number,
+    y: number,
+    dx: number,
+    dy: number,
+    phase: number,
+    precise: boolean,
+  ): boolean;
+  /**
+   * Returns true if a wheel-enabled scroll view sits under the given Artboard coordinate, even
+   * one that cannot move right now.
+   *
+   * @param x - X coordinate
+   * @param y - Y coordinate
+   */
+  hasScrollTargetAt(x: number, y: number): boolean;
+  /**
+   * Returns true while a scroll gesture is latched to a scroll view in this state machine or a
+   * nested one.
+   */
+  hasScrollLatch(): boolean;
+  /**
+   * Ends any scroll gesture in flight, latch included.
+   */
+  cancelScroll(): void;
 
   /**
    * Returns true if this state machine has any focus nodes registered in its focus tree.
@@ -1049,13 +1126,13 @@ export declare class StateMachineInstance {
   focusRight(): boolean;
 
   /**
-   * Move focus to the nearest focusable node to the up of the current focus, by on-screen position.
+   * Move focus to the nearest focusable node above the current focus, by on-screen position.
    * @returns false if nothing is focused or no node lies in that direction
    */
   focusUp(): boolean;
 
   /**
-   * Move focus to the nearest focusable node to the down of the current focus, by on-screen position.
+   * Move focus to the nearest focusable node below the current focus, by on-screen position.
    * @returns false if nothing is focused or no node lies in that direction
    */
   focusDown(): boolean;
@@ -1075,7 +1152,7 @@ export declare class StateMachineInstance {
   /**
    * Forward a key press/release to the focus tree via the state machine's focus manager.
    * The event bubbles from the primary focus node up its ancestors until a handler consumes it.
-   * Standalone modifier keys must never be sent; fold held modifiers into the `modifiers` bitmask.
+   * Modifier keys are sent as keys too; held modifiers also go in the `modifiers` bitmask.
    * @param key - GLFW-style key code (see js/src/utils/keyMap.ts)
    * @param modifiers - KeyModifiers bitmask (shift=1, ctrl=2, alt=4, meta=8)
    * @param isPressed - true for keydown, false for keyup
@@ -1094,6 +1171,13 @@ export declare class StateMachineInstance {
    */
   textInput(text: string): boolean;
 
+  /**
+   * The selected text of the focused element, or an empty string when nothing with a
+   * selection is focused. Used to fill the clipboard on copy/cut. An obscured field 
+   * (i.e. a password) reports empty string.
+   */
+  selectedText(): string;
+
   /**
    * Deletes the underlying instance created via the WASM. It's important to clean up this instance
    * when no longer in use