melonjs 10.2.0 → 10.3.0

package/src/math/color.js

@@ -173,12 +173,11 @@ var cssToRGB = new Map();
  * @classdesc
  * A color manipulation object.
  * @class Color
- * @memberOf me
- * @constructor
- * @param {Number|Float32Array} [r=0] red component or array of color components
- * @param {Number} [g=0] green component
- * @param {Number} [b=0] blue component
- * @param {Number} [alpha=1.0] alpha value
+ * @memberof me
+ * @param {number|Float32Array} [r=0] red component or array of color components
+ * @param {number} [g=0] green component
+ * @param {number} [b=0] blue component
+ * @param {number} [alpha=1.0] alpha value
  */
 class Color {
 
@@ -203,21 +202,16 @@ class Color {
 
     /**
      * Color Red Component [0 .. 255]
-     * @type Number
+     * @type {number}
      * @name r
      * @readonly
-     * @memberOf me.Color
+     * @memberof me.Color
      */
 
-    /**
-     * @ignore
-     */
     get r() {
         return ~~(this.glArray[0] * 255);
     }
-    /**
-     * @ignore
-     */
+
     set r(value) {
         this.glArray[0] = clamp(~~value || 0, 0, 255) / 255.0;
     }
@@ -225,21 +219,16 @@ class Color {
 
     /**
      * Color Green Component [0 .. 255]
-     * @type Number
+     * @type {number}
      * @name g
      * @readonly
-     * @memberOf me.Color
+     * @memberof me.Color
      */
 
-    /**
-     * @ignore
-     */
     get g() {
         return ~~(this.glArray[1] * 255);
     }
-    /**
-     * @ignore
-     */
+
     set g(value) {
         this.glArray[1] = clamp(~~value || 0, 0, 255) / 255.0;
     }
@@ -247,41 +236,32 @@ class Color {
 
     /**
      * Color Blue Component [0 .. 255]
-     * @type Number
+     * @type {number}
      * @name b
      * @readonly
-     * @memberOf me.Color
-     */
-    /**
-     * @ignore
+     * @memberof me.Color
      */
+
     get b() {
         return ~~(this.glArray[2] * 255);
     }
-    /**
-     * @ignore
-     */
+
     set b(value) {
         this.glArray[2] = clamp(~~value || 0, 0, 255) / 255.0;
     }
 
     /**
      * Color Alpha Component [0.0 .. 1.0]
-     * @type Number
+     * @type {number}
      * @name alpha
      * @readonly
-     * @memberOf me.Color
+     * @memberof me.Color
      */
 
-    /**
-     * @ignore
-     */
     get alpha() {
         return this.glArray[3];
     }
-    /**
-     * @ignore
-     */
+
     set alpha(value) {
         this.glArray[3] = typeof(value) === "undefined" ? 1.0 : clamp(+value, 0, 1.0);
     }
@@ -290,13 +270,13 @@ class Color {
     /**
      * Set this color to the specified value.
      * @name setColor
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @param {Number} r red component [0 .. 255]
-     * @param {Number} g green component [0 .. 255]
-     * @param {Number} b blue component [0 .. 255]
-     * @param {Number} [alpha=1.0] alpha value [0.0 .. 1.0]
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} r red component [0 .. 255]
+     * @param {number} g green component [0 .. 255]
+     * @param {number} b blue component [0 .. 255]
+     * @param {number} [alpha=1.0] alpha value [0.0 .. 1.0]
+     * @returns {me.Color} Reference to this object for method chaining
      */
     setColor(r, g, b, alpha = 1.0) {
         // Private initialization: copy Color value directly
@@ -314,9 +294,9 @@ class Color {
     /**
      * Create a new copy of this color object.
      * @name clone
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @return {me.Color} Reference to the newly cloned object
+     * @returns {me.Color} Reference to the newly cloned object
      */
     clone() {
         return pool.pull("Color", this);
@@ -325,10 +305,10 @@ class Color {
     /**
      * Copy a color object or CSS color into this one.
      * @name copy
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @param {me.Color|String} color
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {me.Color|string} color
+     * @returns {me.Color} Reference to this object for method chaining
      */
     copy(color) {
         if (color instanceof Color) {
@@ -342,10 +322,10 @@ class Color {
     /**
      * Blend this color with the given one using addition.
      * @name add
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @param {me.Color} color
-     * @return {me.Color} Reference to this object for method chaining
+     * @returns {me.Color} Reference to this object for method chaining
      */
     add(color) {
         this.glArray[0] = clamp(this.glArray[0] + color.glArray[0], 0, 1);
@@ -359,10 +339,10 @@ class Color {
     /**
      * Darken this color value by 0..1
      * @name darken
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @param {Number} scale
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} scale
+     * @returns {me.Color} Reference to this object for method chaining
      */
     darken(scale) {
         scale = clamp(scale, 0, 1);
@@ -376,11 +356,11 @@ class Color {
     /**
      * Linearly interpolate between this color and the given one.
      * @name lerp
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @param {me.Color} color
-     * @param {Number} alpha with alpha = 0 being this color, and alpha = 1 being the given one.
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} alpha with alpha = 0 being this color, and alpha = 1 being the given one.
+     * @returns {me.Color} Reference to this object for method chaining
      */
     lerp(color, alpha) {
         alpha = clamp(alpha, 0, 1);
@@ -394,10 +374,10 @@ class Color {
     /**
      * Lighten this color value by 0..1
      * @name lighten
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @param {Number} scale
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} scale
+     * @returns {me.Color} Reference to this object for method chaining
      */
     lighten(scale) {
         scale = clamp(scale, 0, 1);
@@ -411,11 +391,11 @@ class Color {
     /**
      * Generate random r,g,b values for this color object
      * @name random
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @param {Number} [min=0] minimum value for the random range
-     * @param {Number} [max=255] maxmium value for the random range
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} [min=0] minimum value for the random range
+     * @param {number} [max=255] maxmium value for the random range
+     * @returns {me.Color} Reference to this object for method chaining
      */
     random(min = 0, max = 255) {
         if (min < 0) {
@@ -437,10 +417,10 @@ class Color {
      * Return true if the r,g,b,a values of this color are equal with the
      * given one.
      * @name equals
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @param {me.Color} color
-     * @return {Boolean}
+     * @returns {boolean}
      */
     equals(color) {
         return (
@@ -455,10 +435,10 @@ class Color {
      * Parse a CSS color string and set this color to the corresponding
      * r,g,b values
      * @name parseCSS
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @param {String} color
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {string} cssColor
+     * @returns {me.Color} Reference to this object for method chaining
      */
     parseCSS(cssColor) {
         // TODO : Memoize this function by caching its input
@@ -473,10 +453,10 @@ class Color {
     /**
      * Parse an RGB or RGBA CSS color string
      * @name parseRGB
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @param {String} color
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {string} rgbColor
+     * @returns {me.Color} Reference to this object for method chaining
      */
     parseRGB(rgbColor) {
         // TODO : Memoize this function by caching its input
@@ -493,11 +473,11 @@ class Color {
      * Parse a Hex color ("#RGB", "#RGBA" or "#RRGGBB", "#RRGGBBAA" format) and set this color to
      * the corresponding r,g,b,a values
      * @name parseHex
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @param {String} color
+     * @param {string} hexColor
      * @param {boolean} [argb = false] true if format is #ARGB, or #AARRGGBB (as opposed to #RGBA or #RGGBBAA)
-     * @return {me.Color} Reference to this object for method chaining
+     * @returns {me.Color} Reference to this object for method chaining
      */
     parseHex(hexColor, argb = false) {
         // TODO : Memoize this function by caching its input
@@ -553,10 +533,10 @@ class Color {
     /**
      * Pack this color into a Uint32 ARGB representation
      * @name toUint32
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @param {Number} [alpha=1.0] alpha value [0.0 .. 1.0]
-     * @return {Uint32}
+     * @param {number} [alpha=1.0] alpha value [0.0 .. 1.0]
+     * @returns {Uint32}
      */
     toUint32(alpha = this.alpha) {
         var ur = this.r & 0xff;
@@ -570,9 +550,9 @@ class Color {
     /**
      * return an array representation of this object
      * @name toArray
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @return {Float32Array}
+     * @returns {Float32Array}
      */
     toArray() {
         return this.glArray;
@@ -582,9 +562,9 @@ class Color {
     /**
      * Get the color in "#RRGGBB" format
      * @name toHex
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toHex() {
         // TODO : Memoize this function by caching its result until any of
@@ -596,9 +576,9 @@ class Color {
     /**
      * Get the color in "#RRGGBBAA" format
      * @name toHex8
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toHex8() {
         // TODO : Memoize this function by caching its result until any of
@@ -610,9 +590,9 @@ class Color {
     /**
      * Get the color in "rgb(R,G,B)" format
      * @name toRGB
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toRGB() {
         // TODO : Memoize this function by caching its result until any of
@@ -628,9 +608,9 @@ class Color {
     /**
      * Get the color in "rgba(R,G,B,A)" format
      * @name toRGBA
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toRGBA() {
         // TODO : Memoize this function by caching its result until any of

package/src/math/math.js

@@ -1,51 +1,51 @@
 /**
  * a collection of math utility functions
  * @namespace Math
- * @memberOf me
+ * @memberof me
  */
 
 /**
  * constant to convert from degrees to radians
  * @public
- * @type {Number}
+ * @type {number}
  * @name DEG_TO_RAD
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const DEG_TO_RAD = Math.PI / 180.0;
 
 /**
  * constant to convert from radians to degrees
  * @public
- * @type {Number}
+ * @type {number}
  * @name RAD_TO_DEG
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const RAD_TO_DEG = 180.0 / Math.PI;
 
 /**
  * constant equals to 2 times pi
  * @public
- * @type {Number}
+ * @type {number}
  * @name TAU
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const TAU = Math.PI * 2;
 
 /**
  * constant equals to half pi
  * @public
- * @type {Number}
+ * @type {number}
  * @name ETA
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const ETA = Math.PI * 0.5;
 
 /**
  * the difference between 1 and the smallest floating point number greater than 1
  * @public
- * @type {Number}
+ * @type {number}
  * @name EPSILON
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const EPSILON = 0.000001;
 
@@ -53,10 +53,10 @@ export const EPSILON = 0.000001;
  * returns true if the given value is a power of two
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name isPowerOfTwo
- * @param {Number} val
- * @return {boolean}
+ * @param {number} val
+ * @returns {boolean}
  */
 export function isPowerOfTwo(val) {
     return (val & (val - 1)) === 0;
@@ -66,10 +66,10 @@ export function isPowerOfTwo(val) {
  * returns the next power of two for the given value
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name nextPowerOfTwo
- * @param {Number} val
- * @return {boolean}
+ * @param {number} val
+ * @returns {boolean}
  */
 export function nextPowerOfTwo(val) {
     val --;
@@ -86,10 +86,10 @@ export function nextPowerOfTwo(val) {
  * Converts an angle in degrees to an angle in radians
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name degToRad
  * @param {number} angle angle in degrees
- * @return {number} corresponding angle in radians
+ * @returns {number} corresponding angle in radians
  * @example
  * // convert a specific angle
  * me.Math.degToRad(60); // return 1.0471...
@@ -102,10 +102,10 @@ export function degToRad(angle) {
  * Converts an angle in radians to an angle in degrees.
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name radToDeg
  * @param {number} radians angle in radians
- * @return {number} corresponding angle in degrees
+ * @returns {number} corresponding angle in degrees
  * @example
  * // convert a specific angle
  * me.Math.radToDeg(1.0471975511965976); // return 60
@@ -118,12 +118,12 @@ export function radToDeg(radians) {
  * clamp the given value
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name clamp
  * @param {number} val the value to clamp
  * @param {number} low lower limit
  * @param {number} high higher limit
- * @return {number} clamped value
+ * @returns {number} clamped value
  */
 export function clamp(val, low, high) {
     return val < low ? low : val > high ? high : +val;
@@ -133,11 +133,11 @@ export function clamp(val, low, high) {
  * return a random integer between min (included) and max (excluded)
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name random
  * @param {number} min minimum value.
  * @param {number} max maximum value.
- * @return {number} random value
+ * @returns {number} random value
  * @example
  * // Print a random number; one of 5, 6, 7, 8, 9
  * console.log(me.Math.random(5, 10) );
@@ -150,11 +150,11 @@ export function random(min, max) {
  * return a random float between min, max (exclusive)
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name randomFloat
  * @param {number} min minimum value.
  * @param {number} max maximum value.
- * @return {number} random value
+ * @returns {number} random value
  * @example
  * // Print a random number; one of 5, 6, 7, 8, 9
  * console.log(me.Math.randomFloat(5, 10) );
@@ -167,11 +167,11 @@ export function randomFloat(min, max) {
  * return a weighted random between min, max (exclusive)
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name weightedRandom
  * @param {number} min minimum value.
  * @param {number} max maximum value.
- * @return {number} random value
+ * @returns {number} random value
  * @example
  * // Print a random number; one of 5, 6, 7, 8, 9
  * console.log(me.Math.weightedRandom(5, 10) );
@@ -184,11 +184,11 @@ export function weightedRandom(min, max) {
  * round a value to the specified number of digit
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name round
  * @param {number} num value to be rounded.
  * @param {number} [dec=0] number of decimal digit to be rounded to.
- * @return {number} rounded value
+ * @returns {number} rounded value
  * @example
  * // round a specific value to 2 digits
  * me.Math.round(10.33333, 2); // return 10.33
@@ -203,12 +203,12 @@ export function round(num, dec = 0) {
  * check if the given value is close to the expected one
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof me.Math
  * @name toBeCloseTo
  * @param {number} expected value to be compared with.
  * @param {number} actual actual value to compare
  * @param {number} [precision=2] float precision for the comparison
- * @return {boolean} if close to
+ * @returns {boolean} if close to
  * @example
  * // test if the given value is close to 10
  * if (me.Math.toBeCloseTo(10, value)) {