melonjs 18.0.0 → 18.2.0

package/build/application/application.d.ts

@@ -1,45 +1,33 @@
-/**
- * additional import for TypeScript
- * @import WebGLRenderer from "./../video/webgl/webgl_renderer.js";
- * @import Camera2d from "./../camera/camera2d.js";
- */
+import type Camera2d from "./../camera/camera2d.ts";
+import World from "../physics/world.js";
+import type Renderer from "./../video/renderer.js";
+import type { ApplicationSettings } from "./settings.ts";
 /**
  * An Application represents a single melonJS game, and is responsible for updating (each frame) all the related object status and draw them.
+ * @category Application
  * @see {@link game}
  */
 export default class Application {
-    /**
-     * @param {number} width - The width of the canvas viewport
-     * @param {number} height - The height of the canvas viewport
-     * @param {ApplicationSettings} [options] - The optional parameters for the application and default renderer
-     * @throws Will throw an exception if it fails to instantiate a renderer
-     */
-    constructor(width: number, height: number, options?: ApplicationSettings);
     /**
      * the parent HTML element holding the main canvas of this application
-     * @type {HTMLElement}
      */
     parentElement: HTMLElement;
     /**
-     * a reference to the active Canvas or WebGL active renderer renderer
-     * @type {CanvasRenderer|WebGLRenderer}
+     * a reference to the active Canvas or WebGL renderer
      */
-    renderer: CanvasRenderer | WebGLRenderer;
+    renderer: Renderer;
     /**
      * the active stage "default" camera
-     * @type {Camera2d}
      */
     viewport: Camera2d;
     /**
      * a reference to the game world, <br>
      * a world is a virtual environment containing all the game objects
-     * @type {World}
      */
     world: World;
     /**
      * when true, all objects will be added under the root world container.<br>
      * When false, a `me.Container` object will be created for each corresponding groups
-     * @type {boolean}
      * @default true
      */
     mergeGroup: boolean;
@@ -48,38 +36,39 @@ export default class Application {
      * Use this value to implement frame prediction in drawing events,
      * for creating smooth motion while running game update logic at
      * a lower fps.
-     * @type {DOMHighResTimeStamp}
      */
     lastUpdate: DOMHighResTimeStamp;
     /**
      * true when this app instance has been initialized
-     * @type {boolean}
      * @default false
      */
     isInitialized: boolean;
     /**
      * the given settings used when creating this application
-     * @type {ApplicationSettings}
      */
-    settings: ApplicationSettings;
+    settings: ApplicationSettings & {
+        width: number;
+        height: number;
+        autoScale: boolean;
+        zoomX: number;
+        zoomY: number;
+        scale: number | "auto";
+    };
     /**
      * Specify whether to pause this app when losing focus
-     * @type {boolean}
      * @default true
      * @example
-     *  // keep the default game instance running even when loosing focus
+     *  // keep the default game instance running even when losing focus
      *  me.game.pauseOnBlur = false;
      */
     pauseOnBlur: boolean;
     /**
      * Specify whether to unpause this app when gaining back focus
-     * @type {boolean}
      * @default true
      */
     resumeOnFocus: boolean;
     /**
      * Specify whether to stop this app when losing focus
-     * @type {boolean}
      * @default false
      */
     stopOnBlur: boolean;
@@ -94,29 +83,37 @@ export default class Application {
     updateDelta: number;
     lastUpdateStart: number | null;
     updateAverageDelta: number;
+    /**
+     * @param width - The width of the canvas viewport
+     * @param height - The height of the canvas viewport
+     * @param options - The optional parameters for the application and default renderer
+     * @throws {Error} Will throw an exception if it fails to instantiate a renderer
+     */
+    constructor(width: number, height: number, options?: Partial<ApplicationSettings> & {
+        legacy?: boolean;
+    });
     /**
      * init the game instance (create a physic world, update starting time, etc..)
-     * @param {number} width - The width of the canvas viewport
-     * @param {number} height - The height of the canvas viewport
-     * @param {ApplicationSettings} [options] - The optional parameters for the application and default renderer
+     * @param width - The width of the canvas viewport
+     * @param height - The height of the canvas viewport
+     * @param options - The optional parameters for the application and default renderer
      */
-    init(width: number, height: number, options?: ApplicationSettings): void;
+    init(width: number, height: number, options?: Partial<ApplicationSettings>): void;
     /**
      * reset the game Object manager
      * destroy all current objects
      */
     reset(): void;
-    set sortOn(value: string);
     /**
      * Specify the property to be used when sorting renderables for this application game world.
      * Accepted values : "x", "y", "z", "depth"
-     * @type {string}
      * @see {@link World.sortOn}
      */
     get sortOn(): string;
+    set sortOn(value: string);
     /**
      * Fired when a level is fully loaded and all renderable instantiated. <br>
-     * Additionnaly the level id will also be passed to the called function.
+     * Additionally the level id will also be passed to the called function.
      * @example
      * // call myFunction () everytime a level is loaded
      * me.game.onLevelLoaded = this.myFunction.bind(this);
@@ -130,7 +127,7 @@ export default class Application {
     updateFrameRate(): void;
     /**
      * Returns the parent HTML Element holding the main canvas of this application
-     * @returns {HTMLElement} the parent HTML element
+     * @returns the parent HTML element
      */
     getParentElement(): HTMLElement;
     /**
@@ -139,7 +136,7 @@ export default class Application {
     repaint(): void;
     /**
      * update all objects related to this game active scene/stage
-     * @param {number} time - current timestamp as provided by the RAF callback
+     * @param time - current timestamp as provided by the RAF callback
      */
     update(time: number): void;
     /**
@@ -147,8 +144,4 @@ export default class Application {
      */
     draw(): void;
 }
-import CanvasRenderer from "../video/canvas/canvas_renderer.js";
-import type WebGLRenderer from "./../video/webgl/webgl_renderer.js";
-import type Camera2d from "./../camera/camera2d.js";
-import World from "../physics/world.js";
 //# sourceMappingURL=application.d.ts.map

package/build/application/application.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../src/application/application.js"],"names":[],"mappings":"AAgCA;;;;GAIG;AAEH;;;GAGG;AACH;IACC;;;;;OAKG;IACH,mBALW,MAAM,UACN,MAAM,YACN,mBAAmB,EA8G7B;IA1GA;;;OAGG;IACH,eAFU,WAAW,CAES;IAE9B;;;OAGG;IACH,UAFU,cAAc,GAAC,aAAa,CAEb;IAEzB;;;OAGG;IACH,UAFU,QAAQ,CAEO;IAEzB;;;;OAIG;IACH,OAFU,KAAK,CAEO;IAEtB;;;;;OAKG;IACH,YAHU,OAAO,CAGK;IAEtB;;;;;;OAMG;IACH,YAFU,mBAAmB,CAEV;IAEnB;;;;OAIG;IACH,eAHU,OAAO,CAGS;IAE1B;;;OAGG;IACH,UAFU,mBAAmB,CAEJ;IAEzB;;;;;;;OAOG;IACH,aANU,OAAO,CAMM;IAEvB;;;;OAIG;IACH,eAHU,OAAO,CAGQ;IAEzB;;;;OAIG;IACH,YAHU,OAAO,CAGM;IAGvB,iBAAmB;IAGnB,uBAA0B;IAI1B,qBAAqB;IACrB,kBAAkB;IAGlB,oBAAsB;IACtB,uBAAyB;IACzB,+BAA+B;IAG/B,iBAAyB;IACzB,oBAAoB;IACpB,+BAA2B;IAC3B,2BAA2B;IAS5B;;;;;OAKG;IACH,YAJW,MAAM,UACN,MAAM,YACN,mBAAmB,QA6J7B;IAED;;;OAGG;IACH,cAYC;IAWD,kBANU,MAAM,EAQf;IAXD;;;;;OAKG;IACH,cAHU,MAAM,CAKf;IAKD;;;;;;OAMG;IACH,sBAAkB;IAElB;;;;OAIG;IACH,wBAaC;IAED;;;OAGG;IACH,oBAFa,WAAW,CAIvB;IAED;;OAEG;IACH,gBAEC;IAED;;;OAGG;IACH,aAFW,MAAM,QA8ChB;IAED;;OAEG;IACH,aAuBC;CACD;2BAhc0B,oCAAoC;+BASjC,oCAAoC;0BACzC,yBAAyB;kBAlChC,qBAAqB"}
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../src/application/application.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AAEpD,OAAO,KAAK,MAAM,qBAAqB,CAAC;AAyBxC,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AAMnD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEzD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC/B;;OAEG;IACH,aAAa,EAAG,WAAW,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAG,QAAQ,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAG,QAAQ,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAG,KAAK,CAAC;IAEd;;;;OAIG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;;;OAKG;IACH,UAAU,EAAE,mBAAmB,CAAC;IAEhC;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAG,mBAAmB,GAAG;QAChC,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,OAAO,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAAC;IAEF;;;;;;OAMG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAGpB,OAAO,EAAE,OAAO,CAAC;IAGjB,aAAa,EAAE,OAAO,CAAC;IAGvB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAGlB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB,EAAE,MAAM,CAAC;IAG/B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;gBAEF,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAO;IA2BlE;;;;;OAKG;IACH,IAAI,CACH,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GACpC,IAAI;IA4JP;;;OAGG;IACH,KAAK,IAAI,IAAI;IAgBb;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;;;;;OAMG;IACH,aAAa,IAAI,IAAI;IAErB;;;;OAIG;IACH,eAAe,IAAI,IAAI;IAevB;;;OAGG;IACH,gBAAgB,IAAI,WAAW;IAI/B;;OAEG;IACH,OAAO,IAAI,IAAI;IAIf;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IA+C1B;;OAEG;IACH,IAAI,IAAI,IAAI;CAqBZ"}

package/build/application/defaultApplicationSettings.d.ts

@@ -7,7 +7,7 @@ export declare const defaultApplicationSettings: {
     powerPreference: "default";
     transparent: false;
     antiAlias: false;
-    consoleHeader: boolean;
+    consoleHeader: true;
     blendMode: "normal";
     physic: "builtin";
     failIfMajorPerformanceCaveat: true;

package/build/application/header.d.ts

@@ -1,11 +1,7 @@
-/**
- * additional import for TypeScript
- * @import Application from "./application.js";
- */
+import type Application from "./application.ts";
 /**
  * display information
- * @param {Application} app - the game application instance calling this function
+ * @param app - the game application instance calling this function
  */
-export function consoleHeader(app: Application): void;
-import type Application from "./application.js";
+export declare function consoleHeader(app: Application): void;
 //# sourceMappingURL=header.d.ts.map

package/build/application/header.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../src/application/header.js"],"names":[],"mappings":"AAEA;;;GAGG;AAEH;;;GAGG;AACH,mCAFW,WAAW,QAgDrB;6BArD2B,kBAAkB"}
+{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../src/application/header.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAEhD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CA8BpD"}

package/build/application/resize.d.ts

@@ -1,8 +1,7 @@
+import type Application from "./application.ts";
 /**
  * callback for window resize event
- * @private
- * @param {Application} game - the game application instance triggering the resize
+ * @param game - the game application instance triggering the resize
  */
-export function onresize(game: Application): void;
-import type Application from "./application.js";
+export declare function onresize(game: Application): void;
 //# sourceMappingURL=resize.d.ts.map

package/build/application/resize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resize.d.ts","sourceRoot":"","sources":["../../src/application/resize.js"],"names":[],"mappings":"AAyCA;;;;GAIG;AACH,+BAFW,WAAW,QA8ErB;6BAtH2B,kBAAkB"}
+{"version":3,"file":"resize.d.ts","sourceRoot":"","sources":["../../src/application/resize.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAkChD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CA4EhD"}

package/build/application/settings.d.ts

@@ -4,7 +4,7 @@
  */
 import { RendererType } from "../const";
 import Renderer from "../video/renderer";
-import Compositor from "../video/webgl/compositors/compositor";
+import { Batcher } from "../video/webgl/batchers/batcher";
 import { ScaleMethod } from "./scaleMethods";
 type BlendMode = "normal" | "multiply" | "lighter" | "additive" | "screen";
 type PhysicsType = "builtin" | "none";
@@ -71,9 +71,14 @@ export type ApplicationSettings = {
     verbose: boolean;
     legacy: boolean;
     /**
-     * a custom compositor class (WebGL only)
+     * a custom batcher class (WebGL only)
+     * @deprecated since 18.1.0 — use `batcher` instead
      */
-    compositor?: Compositor | undefined;
+    compositor?: (new (renderer: any) => Batcher) | undefined;
+    /**
+     * a custom batcher class (WebGL only)
+     */
+    batcher?: (new (renderer: any) => Batcher) | undefined;
 } & ({
     parent: HTMLElement;
     canvas?: never;

package/build/application/settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/application/settings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,UAAU,MAAM,uCAAuC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,KAAK,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE3E,KAAK,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;AAEtC,KAAK,eAAe,GAAG,SAAS,GAAG,WAAW,CAAC;AAE/C,KAAK,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAExC,MAAM,MAAM,mBAAmB,GAAG;IACjC;;;OAGG;IACH,QAAQ,EAAE,YAAY,GAAG,QAAQ,CAAC;IAElC;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;;OAGG;IACH,eAAe,EAAE,eAAe,CAAC;IAEjC;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,SAAS,CAAC;IAErB;;;OAGG;IACH,MAAM,EAAE,WAAW,CAAC;IACpB,4BAA4B,EAAE,OAAO,CAAC;IACtC,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CACpC,GAAG,CACD;IAEA,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,KAAK,CAAC;CACd,GACD;IACA,MAAM,CAAC,EAAE,KAAK,CAAC;IAEf,MAAM,EAAE,iBAAiB,CAAC;CACzB,CACH,CAAC"}
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/application/settings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,KAAK,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE3E,KAAK,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;AAEtC,KAAK,eAAe,GAAG,SAAS,GAAG,WAAW,CAAC;AAE/C,KAAK,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAExC,MAAM,MAAM,mBAAmB,GAAG;IACjC;;;OAGG;IACH,QAAQ,EAAE,YAAY,GAAG,QAAQ,CAAC;IAElC;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;;OAGG;IACH,eAAe,EAAE,eAAe,CAAC;IAEjC;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,SAAS,CAAC;IAErB;;;OAGG;IACH,MAAM,EAAE,WAAW,CAAC;IACpB,4BAA4B,EAAE,OAAO,CAAC;IACtC,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,QAAQ,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC;IAE1D;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,QAAQ,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC;CACvD,GAAG,CACD;IAEA,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,KAAK,CAAC;CACd,GACD;IACA,MAAM,CAAC,EAAE,KAAK,CAAC;IAEf,MAAM,EAAE,iBAAiB,CAAC;CACzB,CACH,CAAC"}