@rive-app/canvas 2.21.7 → 2.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/canvas",
-  "version": "2.21.7",
+  "version": "2.23.0",
   "description": "Rive's canvas based web api.",
   "main": "rive.js",
   "homepage": "https://rive.app",

package/rive.d.ts

@@ -19,7 +19,8 @@ export declare enum Fit {
     FitWidth = "fitWidth",
     FitHeight = "fitHeight",
     None = "none",
-    ScaleDown = "scaleDown"
+    ScaleDown = "scaleDown",
+    Layout = "layout"
 }
 export declare enum Alignment {
     Center = "center",
@@ -35,6 +36,7 @@ export declare enum Alignment {
 export interface LayoutParameters {
     fit?: Fit;
     alignment?: Alignment;
+    layoutScaleFactor?: number;
     minX?: number;
     minY?: number;
     maxX?: number;
@@ -45,6 +47,7 @@ export declare class Layout {
     private cachedRuntimeAlignment;
     readonly fit: Fit;
     readonly alignment: Alignment;
+    readonly layoutScaleFactor: number;
     readonly minX: number;
     readonly minY: number;
     readonly maxX: number;
@@ -54,7 +57,7 @@ export declare class Layout {
     /**
      * Makes a copy of the layout, replacing any specified parameters
      */
-    copyWith({ fit, alignment, minX, minY, maxX, maxY, }: LayoutParameters): Layout;
+    copyWith({ fit, alignment, layoutScaleFactor, minX, minY, maxX, maxY, }: LayoutParameters): Layout;
     runtimeFit(rive: rc.RiveCanvas): rc.Fit;
     runtimeAlignment(rive: rc.RiveCanvas): rc.Alignment;
 }
@@ -354,6 +357,9 @@ export declare class Rive {
     private automaticallyHandleEvents;
     private enableRiveAssetCDN;
     private _volume;
+    private _artboardWidth;
+    private _artboardHeight;
+    private _devicePixelRatioUsed;
     private _hasZeroSize;
     durations: number[];
     frameTimes: number[];
@@ -380,6 +386,7 @@ export declare class Rive {
      * we hook the instance to the audio manager
      */
     private initializeAudio;
+    private initArtboardSize;
     private initData;
     private initArtboard;
     drawFrame(): void;
@@ -475,7 +482,12 @@ export declare class Rive {
      * Accounts for devicePixelRatio as a multiplier to render the size of the canvas drawing surface.
      * Uses the size of the backing canvas to set new width/height attributes. Need to re-render
      * and resize the layout to match the new drawing surface afterwards.
-     * Useful function for consumers to include in a window resize listener
+     * Useful function for consumers to include in a window resize listener.
+     *
+     * This method will set the {@link devicePixelRatioUsed} property.
+     *
+     * Optionally, you can provide a {@link customDevicePixelRatio} to provide a
+     * custom value.
      */
     resizeDrawingSurfaceToCanvas(customDevicePixelRatio?: number): void;
     get source(): string;
@@ -643,10 +655,46 @@ export declare class Rive {
      */
     get contents(): RiveFileContents;
     /**
-     * getter and setter for the volume of the artboard
+     * Getter / Setter for the volume of the artboard
      */
     get volume(): number;
     set volume(value: number);
+    /**
+     * The width of the artboard.
+     *
+     * This will return undefined if the artboard is not loaded yet and a custom
+     * width has not been set.
+     *
+     * Do not set this value manually when using {@link resizeDrawingSurfaceToCanvas}
+     * with a {@link Layout.fit} of {@link Fit.Layout}, as the artboard width is
+     * automatically set.
+     */
+    get artboardWidth(): number | undefined;
+    set artboardWidth(value: number);
+    /**
+     * The height of the artboard.
+     *
+     * This will return undefined if the artboard is not loaded yet and a custom
+     * height has not been set.
+     *
+     * Do not set this value manually when using {@link resizeDrawingSurfaceToCanvas}
+     * with a {@link Layout.fit} of {@link Fit.Layout}, as the artboard height is
+     * automatically set.
+     */
+    get artboardHeight(): number | undefined;
+    set artboardHeight(value: number);
+    /**
+     * Reset the artboard size to its original values.
+     */
+    resetArtboardSize(): void;
+    /**
+     * The device pixel ratio used in rendering and canvas/artboard resizing.
+     *
+     * This value will be overidden by the device pixel ratio used in
+     * {@link resizeDrawingSurfaceToCanvas}. If you use that method, do not set this value.
+     */
+    get devicePixelRatioUsed(): number;
+    set devicePixelRatioUsed(value: number);
 }
 /**
  * Contents of a state machine input