@pixi/canvas-renderer - npm Package Compare versions

Comparing version 6.5.9 to 6.5.10

dist/browser/canvas-renderer.js

 /*!
- * @pixi/canvas-renderer - v6.5.9
- * Compiled Wed, 25 Jan 2023 05:01:45 UTC
+ * @pixi/canvas-renderer - v6.5.10
+ * Compiled Thu, 06 Jul 2023 15:25:11 UTC
  *
@@ -542,22 +542,23 @@ * @pixi/canvas-renderer is licensed under the MIT License.
         /**
-         * @param options - The optional renderer parameters
-         * @param {number} [options.width=800] - the width of the screen
-         * @param {number} [options.height=600] - the height of the screen
-         * @param {HTMLCanvasElement} [options.view] - the canvas to use as a view, optional
-         * @param {boolean} [options.useContextAlpha=true] - Pass-through value for canvas' context `alpha` property.
-         *   If you want to set transparency, please use `backgroundAlpha`. This option is for cases where the
-         *   canvas needs to be opaque, possibly for performance reasons on some older devices.
-         * @param {boolean} [options.autoDensity=false] - Resizes renderer view in CSS pixels to allow for
-         *   resolutions other than 1
-         * @param {boolean} [options.antialias=false] - sets antialias
-         * @param {number} [options.resolution=PIXI.settings.RESOLUTION] - The resolution / device pixel ratio of the renderer.
-         * @param {boolean} [options.preserveDrawingBuffer=false] - enables drawing buffer preservation,
-         *  enable this if you need to call toDataUrl on the webgl context.
-         * @param {boolean} [options.clearBeforeRender=true] - This sets if the renderer will clear the canvas or
-         *      not before the new render pass.
-         * @param {number} [options.backgroundColor=0x000000] - The background color of the rendered area
-         *  (shown if not transparent).
-         * @param {number} [options.backgroundAlpha=1] - Value from 0 (fully transparent) to 1 (fully opaque).
-         * @param {boolean} [options.transparent] − **Deprecated**. `true` sets backgroundAlpha to 0,
-         *  `false` sets backgroundAlpha to 1.
+         * @param {PIXI.IRendererOptions} [options] - The optional renderer parameters.
+         * @param {boolean} [options.autoDensity=false] -
+         *  Whether the CSS dimensions of the renderer's view should be resized automatically.
+         * @param {number} [options.backgroundAlpha=1] -
+         *  Transparency of the background color, value from `0` (fully transparent) to `1` (fully opaque).
+         * @param {number} [options.backgroundColor=0x000000] -
+         *  The background color used to clear the canvas. It accepts hex numbers (e.g. `0xff0000`).
+         * @param {boolean} [options.clearBeforeRender=true] - Whether to clear the canvas before new render passes.
+         * @param {number} [options.height=600] - The height of the renderer's view.
+         * @param {number} [options.resolution=PIXI.settings.RESOLUTION] -
+         *  The resolution / device pixel ratio of the renderer.
+         * @param {boolean} [options.transparent] -
+         *  **Deprecated since 6.0.0, Use `backgroundAlpha` instead.** \
+         *  `true` sets `backgroundAlpha` to `0`, `false` sets `backgroundAlpha` to `1`.
+         * @param {boolean} [options.useContextAlpha=true] -
+         *  Pass-through value for canvas' context attribute `alpha`. This option is for cases where the
+         *  canvas needs to be opaque, possibly for performance reasons on some older devices.
+         *  If you want to set transparency, please use `backgroundAlpha`.
+         * @param {HTMLCanvasElement} [options.view=null] -
+         *  The canvas to use as the view. If omitted, a new canvas will be created.
+         * @param {number} [options.width=800] - The width of the renderer's view.
          */
@@ -564,0 +565,0 @@ function CanvasRenderer(options) {

dist/browser/canvas-renderer.min.js

 /*!
- * @pixi/canvas-renderer - v6.5.9
- * Compiled Wed, 25 Jan 2023 05:01:45 UTC
+ * @pixi/canvas-renderer - v6.5.10
+ * Compiled Thu, 06 Jul 2023 15:25:11 UTC
  *
@@ -5,0 +5,0 @@ * @pixi/canvas-renderer is licensed under the MIT License.

dist/cjs/canvas-renderer.js

 /*!
- * @pixi/canvas-renderer - v6.5.9
- * Compiled Wed, 25 Jan 2023 05:01:45 UTC
+ * @pixi/canvas-renderer - v6.5.10
+ * Compiled Thu, 06 Jul 2023 15:25:11 UTC
  *
@@ -352,22 +352,23 @@ * @pixi/canvas-renderer is licensed under the MIT License.
     /**
-     * @param options - The optional renderer parameters
-     * @param {number} [options.width=800] - the width of the screen
-     * @param {number} [options.height=600] - the height of the screen
-     * @param {HTMLCanvasElement} [options.view] - the canvas to use as a view, optional
-     * @param {boolean} [options.useContextAlpha=true] - Pass-through value for canvas' context `alpha` property.
-     *   If you want to set transparency, please use `backgroundAlpha`. This option is for cases where the
-     *   canvas needs to be opaque, possibly for performance reasons on some older devices.
-     * @param {boolean} [options.autoDensity=false] - Resizes renderer view in CSS pixels to allow for
-     *   resolutions other than 1
-     * @param {boolean} [options.antialias=false] - sets antialias
-     * @param {number} [options.resolution=PIXI.settings.RESOLUTION] - The resolution / device pixel ratio of the renderer.
-     * @param {boolean} [options.preserveDrawingBuffer=false] - enables drawing buffer preservation,
-     *  enable this if you need to call toDataUrl on the webgl context.
-     * @param {boolean} [options.clearBeforeRender=true] - This sets if the renderer will clear the canvas or
-     *      not before the new render pass.
-     * @param {number} [options.backgroundColor=0x000000] - The background color of the rendered area
-     *  (shown if not transparent).
-     * @param {number} [options.backgroundAlpha=1] - Value from 0 (fully transparent) to 1 (fully opaque).
-     * @param {boolean} [options.transparent] − **Deprecated**. `true` sets backgroundAlpha to 0,
-     *  `false` sets backgroundAlpha to 1.
+     * @param {PIXI.IRendererOptions} [options] - The optional renderer parameters.
+     * @param {boolean} [options.autoDensity=false] -
+     *  Whether the CSS dimensions of the renderer's view should be resized automatically.
+     * @param {number} [options.backgroundAlpha=1] -
+     *  Transparency of the background color, value from `0` (fully transparent) to `1` (fully opaque).
+     * @param {number} [options.backgroundColor=0x000000] -
+     *  The background color used to clear the canvas. It accepts hex numbers (e.g. `0xff0000`).
+     * @param {boolean} [options.clearBeforeRender=true] - Whether to clear the canvas before new render passes.
+     * @param {number} [options.height=600] - The height of the renderer's view.
+     * @param {number} [options.resolution=PIXI.settings.RESOLUTION] -
+     *  The resolution / device pixel ratio of the renderer.
+     * @param {boolean} [options.transparent] -
+     *  **Deprecated since 6.0.0, Use `backgroundAlpha` instead.** \
+     *  `true` sets `backgroundAlpha` to `0`, `false` sets `backgroundAlpha` to `1`.
+     * @param {boolean} [options.useContextAlpha=true] -
+     *  Pass-through value for canvas' context attribute `alpha`. This option is for cases where the
+     *  canvas needs to be opaque, possibly for performance reasons on some older devices.
+     *  If you want to set transparency, please use `backgroundAlpha`.
+     * @param {HTMLCanvasElement} [options.view=null] -
+     *  The canvas to use as the view. If omitted, a new canvas will be created.
+     * @param {number} [options.width=800] - The width of the renderer's view.
      */
@@ -374,0 +375,0 @@ function CanvasRenderer(options) {

dist/cjs/canvas-renderer.min.js

 /*!
- * @pixi/canvas-renderer - v6.5.9
- * Compiled Wed, 25 Jan 2023 05:01:45 UTC
+ * @pixi/canvas-renderer - v6.5.10
+ * Compiled Thu, 06 Jul 2023 15:25:11 UTC
  *
@@ -5,0 +5,0 @@ * @pixi/canvas-renderer is licensed under the MIT License.

index.d.ts

@@ -103,22 +103,23 @@ /// <reference path="./global.d.ts" />
     /**
-     * @param options - The optional renderer parameters
-     * @param {number} [options.width=800] - the width of the screen
-     * @param {number} [options.height=600] - the height of the screen
-     * @param {HTMLCanvasElement} [options.view] - the canvas to use as a view, optional
-     * @param {boolean} [options.useContextAlpha=true] - Pass-through value for canvas' context `alpha` property.
-     *   If you want to set transparency, please use `backgroundAlpha`. This option is for cases where the
-     *   canvas needs to be opaque, possibly for performance reasons on some older devices.
-     * @param {boolean} [options.autoDensity=false] - Resizes renderer view in CSS pixels to allow for
-     *   resolutions other than 1
-     * @param {boolean} [options.antialias=false] - sets antialias
-     * @param {number} [options.resolution=PIXI.settings.RESOLUTION] - The resolution / device pixel ratio of the renderer.
-     * @param {boolean} [options.preserveDrawingBuffer=false] - enables drawing buffer preservation,
-     *  enable this if you need to call toDataUrl on the webgl context.
-     * @param {boolean} [options.clearBeforeRender=true] - This sets if the renderer will clear the canvas or
-     *      not before the new render pass.
-     * @param {number} [options.backgroundColor=0x000000] - The background color of the rendered area
-     *  (shown if not transparent).
-     * @param {number} [options.backgroundAlpha=1] - Value from 0 (fully transparent) to 1 (fully opaque).
-     * @param {boolean} [options.transparent] − **Deprecated**. `true` sets backgroundAlpha to 0,
-     *  `false` sets backgroundAlpha to 1.
+     * @param {PIXI.IRendererOptions} [options] - The optional renderer parameters.
+     * @param {boolean} [options.autoDensity=false] -
+     *  Whether the CSS dimensions of the renderer's view should be resized automatically.
+     * @param {number} [options.backgroundAlpha=1] -
+     *  Transparency of the background color, value from `0` (fully transparent) to `1` (fully opaque).
+     * @param {number} [options.backgroundColor=0x000000] -
+     *  The background color used to clear the canvas. It accepts hex numbers (e.g. `0xff0000`).
+     * @param {boolean} [options.clearBeforeRender=true] - Whether to clear the canvas before new render passes.
+     * @param {number} [options.height=600] - The height of the renderer's view.
+     * @param {number} [options.resolution=PIXI.settings.RESOLUTION] -
+     *  The resolution / device pixel ratio of the renderer.
+     * @param {boolean} [options.transparent] -
+     *  **Deprecated since 6.0.0, Use `backgroundAlpha` instead.** \
+     *  `true` sets `backgroundAlpha` to `0`, `false` sets `backgroundAlpha` to `1`.
+     * @param {boolean} [options.useContextAlpha=true] -
+     *  Pass-through value for canvas' context attribute `alpha`. This option is for cases where the
+     *  canvas needs to be opaque, possibly for performance reasons on some older devices.
+     *  If you want to set transparency, please use `backgroundAlpha`.
+     * @param {HTMLCanvasElement} [options.view=null] -
+     *  The canvas to use as the view. If omitted, a new canvas will be created.
+     * @param {number} [options.width=800] - The width of the renderer's view.
      */
@@ -125,0 +126,0 @@ constructor(options?: IRendererOptions);

package.json

 {
   "name": "@pixi/canvas-renderer",
-  "version": "6.5.9",
+  "version": "6.5.10",
   "main": "dist/cjs/canvas-renderer.js",
@@ -41,9 +41,9 @@ "module": "dist/esm/canvas-renderer.mjs",
   "peerDependencies": {
-    "@pixi/constants": "6.5.9",
-    "@pixi/core": "6.5.9",
-    "@pixi/math": "6.5.9",
-    "@pixi/settings": "6.5.9",
-    "@pixi/utils": "6.5.9"
+    "@pixi/constants": "6.5.10",
+    "@pixi/core": "6.5.10",
+    "@pixi/math": "6.5.10",
+    "@pixi/settings": "6.5.10",
+    "@pixi/utils": "6.5.10"
   },
-  "gitHead": "387386b5da1a22c955aa97d0ef1eb59f5458729a"
+  "gitHead": "8cdbf55064b7adc05f65c51e177f1c22f7329f0f"
 }

No alert changes

Improved metrics

Lines of code

3267

increased by0.12%

Worsened metrics

Total package byte prevSize

669473

decreased by-0.05%

No dependency changes