melonjs 10.2.0 → 10.3.0

package/src/text/text.js

@@ -1,5 +1,4 @@
 import Color from "./../math/color.js";
-import Renderer from "./../video/renderer.js";
 import WebGLRenderer from "./../video/webgl/webgl_renderer.js";
 import { renderer, createCanvas } from "./../video/video.js";
 import * as stringUtil from "./../utils/string.js";
@@ -39,23 +38,22 @@ var setContextStyle = function(context, font, stroke = false) {
  * @classdesc
  * a generic system font object.
  * @class Text
- * @extends me.Renderable
- * @memberOf me
- * @constructor
- * @param {Number} x position of the text object
- * @param {Number} y position of the text object
- * @param {Object} settings the text configuration
- * @param {String} settings.font a CSS family font name
- * @param {Number|String} settings.size size, or size + suffix (px, em, pt)
- * @param {me.Color|String} [settings.fillStyle="#000000"] a CSS color value
- * @param {me.Color|String} [settings.strokeStyle="#000000"] a CSS color value
- * @param {Number} [settings.lineWidth=1] line width, in pixels, when drawing stroke
- * @param {String} [settings.textAlign="left"] horizontal text alignment
- * @param {String} [settings.textBaseline="top"] the text baseline
- * @param {Number} [settings.lineHeight=1.0] line spacing height
+ * @augments me.Renderable
+ * @memberof me
+ * @param {number} x position of the text object
+ * @param {number} y position of the text object
+ * @param {object} settings the text configuration
+ * @param {string} settings.font a CSS family font name
+ * @param {number|string} settings.size size, or size + suffix (px, em, pt)
+ * @param {me.Color|string} [settings.fillStyle="#000000"] a CSS color value
+ * @param {me.Color|string} [settings.strokeStyle="#000000"] a CSS color value
+ * @param {number} [settings.lineWidth=1] line width, in pixels, when drawing stroke
+ * @param {string} [settings.textAlign="left"] horizontal text alignment
+ * @param {string} [settings.textBaseline="top"] the text baseline
+ * @param {number} [settings.lineHeight=1.0] line spacing height
  * @param {me.Vector2d} [settings.anchorPoint={x:0.0, y:0.0}] anchor point to draw the text at
- * @param {Boolean} [settings.offScreenCanvas=false] whether to draw the font to an individual "cache" texture first
- * @param {(String|String[])} [settings.text=""] a string, or an array of strings
+ * @param {boolean} [settings.offScreenCanvas=false] whether to draw the font to an individual "cache" texture first
+ * @param {(string|string[])} [settings.text=""] a string, or an array of strings
  * @example
  * var font = new me.Text(0, 0, {font: "Arial", size: 8, fillStyle: this.color});
  */
@@ -74,7 +72,7 @@ class Text extends Renderable {
         /**
          * defines the color used to draw the font.<br>
          * @public
-         * @type me.Color
+         * @type {me.Color}
          * @default black
          * @name me.Text#fillStyle
          */
@@ -92,7 +90,7 @@ class Text extends Renderable {
         /**
          * defines the color used to draw the font stroke.<br>
          * @public
-         * @type me.Color
+         * @type {me.Color}
          * @default black
          * @name me.Text#strokeStyle
          */
@@ -110,7 +108,7 @@ class Text extends Renderable {
         /**
          * sets the current line width, in pixels, when drawing stroke
          * @public
-         * @type Number
+         * @type {number}
          * @default 1
          * @name me.Text#lineWidth
          */
@@ -120,7 +118,7 @@ class Text extends Renderable {
          * Set the default text alignment (or justification),<br>
          * possible values are "left", "right", and "center".<br>
          * @public
-         * @type String
+         * @type {string}
          * @default "left"
          * @name me.Text#textAlign
          */
@@ -130,7 +128,7 @@ class Text extends Renderable {
          * Set the text baseline (e.g. the Y-coordinate for the draw operation), <br>
          * possible values are "top", "hanging, "middle, "alphabetic, "ideographic, "bottom"<br>
          * @public
-         * @type String
+         * @type {string}
          * @default "top"
          * @name me.Text#textBaseline
          */
@@ -140,7 +138,7 @@ class Text extends Renderable {
          * Set the line spacing height (when displaying multi-line strings). <br>
          * Current font height will be multiplied with this value to set the line height.
          * @public
-         * @type Number
+         * @type {number}
          * @default 1.0
          * @name me.Text#lineHeight
          */
@@ -151,7 +149,7 @@ class Text extends Renderable {
          * Note: this will improve performances when using WebGL, but will impact
          * memory consumption as every text element will have its own canvas texture
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name me.Text#offScreenCanvas
          */
@@ -160,20 +158,20 @@ class Text extends Renderable {
         /**
          * the text to be displayed
          * @private
-         * @type {String[]}
+         * @type {string[]}
          * @name _text
-         * @memberOf me.Text
+         * @memberof me.Text
          */
         this._text = [];
 
         /**
          * the font size (in px)
          * @public
-         * @type {Number}
+         * @type {number}
          * @name fontSize
          * @default 10
-         * @memberOf me.Text
-        */
+         * @memberof me.Text
+         */
         this.fontSize = 10;
 
         // anchor point
@@ -216,22 +214,21 @@ class Text extends Renderable {
     onDeactivateEvent() {
         // free the canvas and potential corresponding texture when deactivated
         if (this.offScreenCanvas === true) {
-            if (renderer instanceof WebGLRenderer) {
-                renderer.currentCompositor.unbindTexture2D(renderer.cache.get(this.canvas));
-                renderer.cache.remove(this.canvas);
-            }
+            renderer.currentCompositor.deleteTexture2D(renderer.currentCompositor.getTexture2D(this.glTextureUnit));
+            renderer.cache.delete(this.canvas);
             this.canvas.width = this.canvas.height = 0;
             this.context = undefined;
             this.canvas = undefined;
+            this.glTextureUnit = undefined;
         }
     }
 
     /**
      * make the font bold
      * @name bold
-     * @memberOf me.Text.prototype
+     * @memberof me.Text.prototype
      * @function
-     * @return this object for chaining
+     * @returns {me.Text} this object for chaining
      */
     bold() {
         this.font = "bold " + this.font;
@@ -242,9 +239,9 @@ class Text extends Renderable {
     /**
      * make the font italic
      * @name italic
-     * @memberOf me.Text.prototype
+     * @memberof me.Text.prototype
      * @function
-     * @return this object for chaining
+     * @returns {me.Text} this object for chaining
      */
     italic() {
         this.font = "italic " + this.font;
@@ -255,11 +252,11 @@ class Text extends Renderable {
     /**
      * set the font family and size
      * @name setFont
-     * @memberOf me.Text.prototype
+     * @memberof me.Text.prototype
      * @function
-     * @param {String} font a CSS font name
-     * @param {Number|String} [size=10] size in px, or size + suffix (px, em, pt)
-     * @return this object for chaining
+     * @param {string} font a CSS font name
+     * @param {number|string} [size=10] size in px, or size + suffix (px, em, pt)
+     * @returns {me.Text} this object for chaining
      * @example
      * font.setFont("Arial", 20);
      * font.setFont("Arial", "1.5em");
@@ -299,10 +296,10 @@ class Text extends Renderable {
     /**
      * change the text to be displayed
      * @name setText
-     * @memberOf me.Text.prototype
+     * @memberof me.Text.prototype
      * @function
-     * @param {Number|String|String[]} value a string, or an array of strings
-     * @return this object for chaining
+     * @param {number|string|string[]} value a string, or an array of strings
+     * @returns {me.Text} this object for chaining
      */
     setText(value = "") {
         if (this._text.toString() !== value.toString()) {
@@ -320,14 +317,14 @@ class Text extends Renderable {
     /**
      * measure the given text size in pixels
      * @name measureText
-     * @memberOf me.Text.prototype
+     * @memberof me.Text.prototype
      * @function
      * @param {me.CanvasRenderer|me.WebGLRenderer} [renderer] reference to the active renderer
-     * @param {String} [text] the text to be measured
+     * @param {string} [text] the text to be measured
      * @param {me.Rect|me.Bounds} [ret] a object in which to store the text metrics
      * @returns {TextMetrics} a TextMetrics object with two properties: `width` and `height`, defining the output dimensions
      */
-    measureText(_renderer, text, ret) {
+    measureText(renderer, text, ret) {
         var context;
         var textMetrics = ret || this.getBounds();
         var lineHeight = this.fontSize * this.lineHeight;
@@ -335,8 +332,6 @@ class Text extends Renderable {
 
         if (this.offScreenCanvas === true) {
             context = this.context;
-        } else if (_renderer instanceof Renderer) {
-            context = _renderer.getFontContext();
         } else {
             context = renderer.getFontContext();
         }
@@ -383,7 +378,8 @@ class Text extends Renderable {
 
                 if (renderer instanceof WebGLRenderer) {
                     // invalidate the previous corresponding texture so that it can reuploaded once changed
-                    renderer.currentCompositor.unbindTexture2D(renderer.cache.get(this.canvas));
+                    this.glTextureUnit = renderer.cache.getUnit(renderer.cache.get(this.canvas));
+                    renderer.currentCompositor.unbindTexture2D(null, this.glTextureUnit);
 
                     if (renderer.WebGLVersion === 1) {
                         // round size to next Pow2
@@ -410,12 +406,13 @@ class Text extends Renderable {
     /**
      * draw a text at the specified coord
      * @name draw
-     * @memberOf me.Text.prototype
+     * @memberof me.Text.prototype
      * @function
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer Reference to the destination renderer instance
-     * @param {String} [text]
-     * @param {Number} [x]
-     * @param {Number} [y]
+     * @param {string} [text]
+     * @param {number} [x]
+     * @param {number} [y]
+     * @param {boolean} [stroke=false] draw stroke the the text if true
      */
     draw(renderer, text, x, y, stroke) {
         // "hacky patch" for backward compatibilty
@@ -475,12 +472,12 @@ class Text extends Renderable {
      * by the `lineWidth` and `fillStroke` properties. <br>
      * Note : using drawStroke is not recommended for performance reasons
      * @name drawStroke
-     * @memberOf me.Text.prototype
+     * @memberof me.Text.prototype
      * @function
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer Reference to the destination renderer instance
-     * @param {String} text
-     * @param {Number} x
-     * @param {Number} y
+     * @param {string} text
+     * @param {number} x
+     * @param {number} y
      */
     drawStroke(renderer, text, x, y) {
         this.draw(renderer, text, x, y, true);

package/src/tweens/easing.js

@@ -1,7 +1,7 @@
 /**
-* Tween.js - Licensed under the MIT license
-* https://github.com/tweenjs/tween.js
-*/
+ * Tween.js - Licensed under the MIT license
+ * https://github.com/tweenjs/tween.js
+ */
 
 /* eslint-disable quotes, keyword-spacing, comma-spacing, no-return-assign */
 
@@ -42,9 +42,9 @@
  * </p>
  * @public
  * @constant
- * @type enum
+ * @enum {Function}
  * @name Easing
- * @memberOf me.Tween
+ * @memberof me.Tween
  */
 export let Easing = {
 

package/src/tweens/interpolation.js

@@ -1,7 +1,7 @@
 /**
-* Tween.js - Licensed under the MIT license
-* https://github.com/tweenjs/tween.js
-*/
+ * Tween.js - Licensed under the MIT license
+ * https://github.com/tweenjs/tween.js
+ */
 
 /**
  * Interpolation Function :<br>
@@ -12,9 +12,9 @@
  * </p>
  * @public
  * @constant
- * @type enum
+ * @enum {Function}
  * @name Interpolation
- * @memberOf me.Tween
+ * @memberof me.Tween
  */
 export let Interpolation = {
     /** @ignore */

package/src/tweens/tween.js

@@ -5,9 +5,9 @@ import { Easing } from "./easing.js";
 import { Interpolation } from "./interpolation.js";
 
 /**
-* Tween.js - Licensed under the MIT license
-* https://github.com/tweenjs/tween.js
-*/
+ * Tween.js - Licensed under the MIT license
+ * https://github.com/tweenjs/tween.js
+ */
 
 /**
  * @classdesc
@@ -23,9 +23,8 @@ import { Interpolation } from "./interpolation.js";
  * author lechecacharro<br>
  * author Josh Faul / http://jocafa.com/
  * @class Tween
- * @memberOf me
- * @constructor
- * @param {Object} object object on which to apply the tween
+ * @memberof me
+ * @param {object} object object on which to apply the tween
  * @example
  * // add a tween to change the object pos.x and pos.y variable to 200 in 3 seconds
  * tween = new me.Tween(myObject.pos).to({
@@ -121,18 +120,19 @@ class Tween {
     /**
      * object properties to be updated and duration
      * @name to
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
-     * @param {Object} properties hash of properties
-     * @param {Object|Number} [options] object of tween properties, or a duration if a numeric value is passed
-     * @param {Number} [options.duration] tween duration
+     * @param {object} properties hash of properties
+     * @param {object|number} [options] object of tween properties, or a duration if a numeric value is passed
+     * @param {number} [options.duration] tween duration
      * @param {me.Tween.Easing} [options.easing] easing function
-     * @param {Number} [options.delay] delay amount expressed in milliseconds
-     * @param {Boolean} [options.yoyo] allows the tween to bounce back to their original value when finished. To be used together with repeat to create endless loops.
-     * @param {Number} [options.repeat] amount of times the tween should be repeated
+     * @param {number} [options.delay] delay amount expressed in milliseconds
+     * @param {boolean} [options.yoyo] allows the tween to bounce back to their original value when finished. To be used together with repeat to create endless loops.
+     * @param {number} [options.repeat] amount of times the tween should be repeated
      * @param {me.Tween.Interpolation} [options.interpolation] interpolation function
-     * @param {Boolean} [options.autoStart] allow this tween to start automatically. Otherwise call me.Tween.start().
+     * @param {boolean} [options.autoStart] allow this tween to start automatically. Otherwise call me.Tween.start().
+     * @returns {me.Tween} this instance for object chaining
      */
     to( properties, options ) {
 
@@ -157,15 +157,16 @@ class Tween {
         }
 
         return this;
-
     }
 
     /**
      * start the tween
      * @name start
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
+     * @param {number} [time] the current time when the tween was started
+     * @returns {me.Tween} this instance for object chaining
      */
     start( time = timer.getTime() ) {
 
@@ -203,15 +204,15 @@ class Tween {
         }
 
         return this;
-
     }
 
     /**
      * stop the tween
      * @name stop
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
+     * @returns {me.Tween} this instance for object chaining
      */
     stop() {
         // remove the tween from the world container
@@ -222,10 +223,11 @@ class Tween {
     /**
      * delay the tween
      * @name delay
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
-     * @param {Number} amount delay amount expressed in milliseconds
+     * @param {number} amount delay amount expressed in milliseconds
+     * @returns {me.Tween} this instance for object chaining
      */
     delay( amount ) {
 
@@ -237,10 +239,11 @@ class Tween {
     /**
      * Repeat the tween
      * @name repeat
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
-     * @param {Number} times amount of times the tween should be repeated
+     * @param {number} times amount of times the tween should be repeated
+     * @returns {me.Tween} this instance for object chaining
      */
     repeat( times ) {
 
@@ -253,11 +256,12 @@ class Tween {
      * Allows the tween to bounce back to their original value when finished.
      * To be used together with repeat to create endless loops.
      * @name yoyo
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
      * @see me.Tween#repeat
-     * @param {Boolean} yoyo
+     * @param {boolean} yoyo
+     * @returns {me.Tween} this instance for object chaining
      */
     yoyo( yoyo ) {
 
@@ -269,10 +273,11 @@ class Tween {
     /**
      * set the easing function
      * @name easing
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
-     * @param {me.Tween.Easing} fn easing function
+     * @param {me.Tween.Easing} easing easing function
+     * @returns {me.Tween} this instance for object chaining
      */
     easing( easing ) {
         if (typeof easing !== "function") {
@@ -280,16 +285,16 @@ class Tween {
         }
         this._easingFunction = easing;
         return this;
-
     }
 
     /**
      * set the interpolation function
      * @name interpolation
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
-     * @param {me.Tween.Interpolation} fn interpolation function
+     * @param {me.Tween.Interpolation} interpolation interpolation function
+     * @returns {me.Tween} this instance for object chaining
      */
     interpolation( interpolation ) {
         this._interpolationFunction = interpolation;
@@ -299,10 +304,11 @@ class Tween {
     /**
      * chain the tween
      * @name chain
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
-     * @param {me.Tween} chainedTween Tween to be chained
+     * @param {...me.Tween} chainedTween Tween(s) to be chained
+     * @returns {me.Tween} this instance for object chaining
      */
     chain() {
         this._chainedTweens = arguments;
@@ -312,39 +318,42 @@ class Tween {
     /**
      * onStart callback
      * @name onStart
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
      * @param {Function} onStartCallback callback
+     * @returns {me.Tween} this instance for object chaining
      */
-    onStart( callback ) {
-        this._onStartCallback = callback;
+    onStart( onStartCallback ) {
+        this._onStartCallback = onStartCallback;
         return this;
     }
 
     /**
      * onUpdate callback
      * @name onUpdate
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
      * @param {Function} onUpdateCallback callback
+     * @returns {me.Tween} this instance for object chaining
      */
-    onUpdate( callback ) {
-        this._onUpdateCallback = callback;
+    onUpdate( onUpdateCallback ) {
+        this._onUpdateCallback = onUpdateCallback;
         return this;
     }
 
     /**
      * onComplete callback
      * @name onComplete
-     * @memberOf me.Tween
+     * @memberof me.Tween
      * @public
      * @function
      * @param {Function} onCompleteCallback callback
+     * @returns {me.Tween} this instance for object chaining
      */
-    onComplete( callback ) {
-        this._onCompleteCallback = callback;
+    onComplete( onCompleteCallback ) {
+        this._onCompleteCallback = onCompleteCallback;
         return this;
     };
 

package/src/utils/agent.js

@@ -3,7 +3,7 @@ import { capitalize } from "./string.js";
 /**
  * a collection of utility functons to ease porting between different user agents.
  * @namespace me.utils.agent
- * @memberOf me
+ * @memberof me
  */
 
 /**
@@ -17,10 +17,10 @@ var vendors = [ "ms", "MS", "moz", "webkit", "o" ];
  * @public
  * @name prefixed
  * @function
- * @param {String} name Property name
- * @param {Object} [obj=window] Object or element reference to access
- * @return {Mixed} Value of property
- * @memberOf me.utils.agent
+ * @param {string} name Property name
+ * @param {object} [obj=window] Object or element reference to access
+ * @returns {string} Value of property
+ * @memberof me.utils.agent
  */
 export function prefixed(name, obj) {
     obj = obj || window;
@@ -43,11 +43,11 @@ export function prefixed(name, obj) {
  * @public
  * @name setPrefixed
  * @function
- * @param {String} name Property name
- * @param {Mixed} value Property value
- * @param {Object} [obj=window] Object or element reference to access
- * @return true if one of the vendor-prefixed property was found
- * @memberOf me.utils.agent
+ * @param {string} name Property name
+ * @param {string} value Property value
+ * @param {object} [obj=window] Object or element reference to access
+ * @returns {boolean} true if one of the vendor-prefixed property was found
+ * @memberof me.utils.agent
  */
 export function setPrefixed(name, value, obj) {
     obj = obj || window;
@@ -64,6 +64,7 @@ export function setPrefixed(name, value, obj) {
             obj[name] = value;
             return true;
         }
-        return false;
     });
+
+    return false;
 };

package/src/utils/array.js

@@ -3,18 +3,18 @@ import {random as mathRandom, weightedRandom as mathWeightedRandom} from "./../m
 /**
  * a collection of array utility functions
  * @namespace me.utils.array
- * @memberOf me
+ * @memberof me
  */
 
 /**
  * Remove the specified object from the given Array
  * @public
  * @function
- * @memberOf me.utils.array
+ * @memberof me.utils.array
  * @name remove
  * @param {Array} arr array from which to remove an object
- * @param {Object} object to be removed
- * @return {Array} the modified Array
+ * @param {object} obj to be removed
+ * @returns {Array} the modified Array
  * var arr = [ "foo", "bar", "baz" ];
  * // remove "foo" from the array
  * me.utils.array.remove(arr, "foo");
@@ -31,10 +31,10 @@ export function remove(arr, obj) {
  * return a random array element
  * @public
  * @function
- * @memberOf me.utils.array
+ * @memberof me.utils.array
  * @name random
  * @param {Array} arr array to pick a element
- * @return {any} random member of array
+ * @returns {any} random member of array
  * @example
  * // Select a random array element
  * var arr = [ "foo", "bar", "baz" ];
@@ -48,10 +48,10 @@ export function random(arr) {
  * return a weighted random array element, favoring the earlier entries
  * @public
  * @function
- * @memberOf me.utils.array
+ * @memberof me.utils.array
  * @name weightedRandom
  * @param {Array} arr array to pick a element
- * @return {any} random member of array
+ * @returns {any} random member of array
  */
 export function weightedRandom(arr) {
     return arr[mathWeightedRandom(0, arr.length)];