@rive-app/webgl - npm Package Compare versions

Comparing version 2.22.0 to 2.23.0

package.json

 {
   "name": "@rive-app/webgl",
-  "version": "2.22.0",
+  "version": "2.23.0",
   "description": "Rive's webgl based web api.",
@@ -5,0 +5,0 @@ "main": "rive.js",

rive.d.ts

@@ -360,2 +360,4 @@ import * as rc from "./rive_advanced.mjs";
     private _volume;
+    private _artboardWidth;
+    private _artboardHeight;
     private _devicePixelRatioUsed;
@@ -388,2 +390,3 @@ private _hasZeroSize;
     private initializeAudio;
+    private initArtboardSize;
     private initData;
@@ -484,3 +487,8 @@ private initArtboard;
      * 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.
      */
@@ -653,6 +661,42 @@ resizeDrawingSurfaceToCanvas(customDevicePixelRatio?: number): void;
     /**
-     * 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);
 }
@@ -659,0 +703,0 @@ /**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10887467

increased by0.12%

Lines of code

8785

increased by1.74%

No dependency changes