melonjs 10.2.3 → 10.3.0

package/src/math/color.js

@@ -173,8 +173,7 @@ var cssToRGB = new Map();
  * @classdesc
  * A color manipulation object.
  * @class Color
- * @memberOf me
- * @constructor
+ * @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
@@ -206,7 +205,7 @@ class Color {
      * @type {number}
      * @name r
      * @readonly
-     * @memberOf me.Color
+     * @memberof me.Color
      */
 
     get r() {
@@ -223,7 +222,7 @@ class Color {
      * @type {number}
      * @name g
      * @readonly
-     * @memberOf me.Color
+     * @memberof me.Color
      */
 
     get g() {
@@ -240,7 +239,7 @@ class Color {
      * @type {number}
      * @name b
      * @readonly
-     * @memberOf me.Color
+     * @memberof me.Color
      */
 
     get b() {
@@ -256,7 +255,7 @@ class Color {
      * @type {number}
      * @name alpha
      * @readonly
-     * @memberOf me.Color
+     * @memberof me.Color
      */
 
     get alpha() {
@@ -271,7 +270,7 @@ 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]
@@ -295,7 +294,7 @@ class Color {
     /**
      * Create a new copy of this color object.
      * @name clone
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @returns {me.Color} Reference to the newly cloned object
      */
@@ -306,7 +305,7 @@ 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
      * @returns {me.Color} Reference to this object for method chaining
@@ -323,7 +322,7 @@ class Color {
     /**
      * Blend this color with the given one using addition.
      * @name add
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @param {me.Color} color
      * @returns {me.Color} Reference to this object for method chaining
@@ -340,7 +339,7 @@ class Color {
     /**
      * Darken this color value by 0..1
      * @name darken
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @param {number} scale
      * @returns {me.Color} Reference to this object for method chaining
@@ -357,7 +356,7 @@ 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.
@@ -375,7 +374,7 @@ class Color {
     /**
      * Lighten this color value by 0..1
      * @name lighten
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @param {number} scale
      * @returns {me.Color} Reference to this object for method chaining
@@ -392,7 +391,7 @@ 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
@@ -418,7 +417,7 @@ 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
      * @returns {boolean}
@@ -436,7 +435,7 @@ 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} cssColor
      * @returns {me.Color} Reference to this object for method chaining
@@ -454,7 +453,7 @@ class Color {
     /**
      * Parse an RGB or RGBA CSS color string
      * @name parseRGB
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @param {string} rgbColor
      * @returns {me.Color} Reference to this object for method chaining
@@ -474,7 +473,7 @@ 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} hexColor
      * @param {boolean} [argb = false] true if format is #ARGB, or #AARRGGBB (as opposed to #RGBA or #RGGBBAA)
@@ -534,7 +533,7 @@ 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]
      * @returns {Uint32}
@@ -551,7 +550,7 @@ class Color {
     /**
      * return an array representation of this object
      * @name toArray
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @returns {Float32Array}
      */
@@ -563,7 +562,7 @@ class Color {
     /**
      * Get the color in "#RRGGBB" format
      * @name toHex
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @returns {string}
      */
@@ -577,7 +576,7 @@ class Color {
     /**
      * Get the color in "#RRGGBBAA" format
      * @name toHex8
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @returns {string}
      */
@@ -591,7 +590,7 @@ class Color {
     /**
      * Get the color in "rgb(R,G,B)" format
      * @name toRGB
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @returns {string}
      */
@@ -609,7 +608,7 @@ class Color {
     /**
      * Get the color in "rgba(R,G,B,A)" format
      * @name toRGBA
-     * @memberOf me.Color
+     * @memberof me.Color
      * @function
      * @returns {string}
      */

package/src/math/math.js

@@ -1,7 +1,7 @@
 /**
  * a collection of math utility functions
  * @namespace Math
- * @memberOf me
+ * @memberof me
  */
 
 /**
@@ -9,7 +9,7 @@
  * @public
  * @type {number}
  * @name DEG_TO_RAD
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const DEG_TO_RAD = Math.PI / 180.0;
 
@@ -18,7 +18,7 @@ export const DEG_TO_RAD = Math.PI / 180.0;
  * @public
  * @type {number}
  * @name RAD_TO_DEG
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const RAD_TO_DEG = 180.0 / Math.PI;
 
@@ -27,7 +27,7 @@ export const RAD_TO_DEG = 180.0 / Math.PI;
  * @public
  * @type {number}
  * @name TAU
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const TAU = Math.PI * 2;
 
@@ -36,7 +36,7 @@ export const TAU = Math.PI * 2;
  * @public
  * @type {number}
  * @name ETA
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const ETA = Math.PI * 0.5;
 
@@ -45,7 +45,7 @@ export const ETA = Math.PI * 0.5;
  * @public
  * @type {number}
  * @name EPSILON
- * @memberOf me.Math
+ * @memberof me.Math
  */
 export const EPSILON = 0.000001;
 
@@ -53,7 +53,7 @@ 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
  * @returns {boolean}
@@ -66,7 +66,7 @@ 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
  * @returns {boolean}
@@ -86,7 +86,7 @@ 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
  * @returns {number} corresponding angle in radians
@@ -102,7 +102,7 @@ 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
  * @returns {number} corresponding angle in degrees
@@ -118,7 +118,7 @@ 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
@@ -133,7 +133,7 @@ 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.
@@ -150,7 +150,7 @@ 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.
@@ -167,7 +167,7 @@ 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.
@@ -184,7 +184,7 @@ 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.
@@ -203,7 +203,7 @@ 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

package/src/math/matrix2.js

@@ -7,8 +7,7 @@ import Matrix3d from "./matrix3.js";
  * the identity matrix and parameters position : <br>
  * <img src="images/identity-matrix_2x.png"/>
  * @class Matrix2d
- * @memberOf me
- * @constructor
+ * @memberof me
  * @param {me.Matrix2d} [mat2d] An instance of me.Matrix2d to copy from
  * @param {number[]} [arguments...] Matrix elements. See {@link me.Matrix2d.setTransform}
  */
@@ -49,7 +48,7 @@ class Matrix2d {
      * @readonly
      * @see me.Matrix2d.translate
      * @name tx
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      */
     get tx() {
         return this.val[6];
@@ -62,7 +61,7 @@ class Matrix2d {
      * @readonly
      * @see me.Matrix2d.translate
      * @name ty
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      */
     get ty() {
         return this.val[7];
@@ -73,7 +72,7 @@ class Matrix2d {
      * the identity matrix and parameters position : <br>
      * <img src="images/identity-matrix_2x.png"/>
      * @name identity
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @returns {me.Matrix2d} Reference to this object for method chaining
      */
@@ -89,7 +88,7 @@ class Matrix2d {
     /**
      * set the matrix to the specified value
      * @name setTransform
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {number} a
      * @param {number} b
@@ -133,7 +132,7 @@ class Matrix2d {
     /**
      * Copies over the values from another me.Matrix2d.
      * @name copy
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Matrix2d} m the matrix object to copy from
      * @returns {me.Matrix2d} Reference to this object for method chaining
@@ -146,7 +145,7 @@ class Matrix2d {
     /**
      * Copies over the upper-left 3x3 values from the given me.Matrix3d
      * @name fromMat3d
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Matrix3d} m the matrix object to copy from
      * @returns {me.Matrix2d} Reference to this object for method chaining
@@ -171,7 +170,7 @@ class Matrix2d {
     /**
      * multiply both matrix
      * @name multiply
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Matrix2d} m the other matrix
      * @returns {me.Matrix2d} Reference to this object for method chaining
@@ -203,7 +202,7 @@ class Matrix2d {
     /**
      * Transpose the value of this matrix.
      * @name transpose
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @returns {me.Matrix2d} Reference to this object for method chaining
      */
@@ -226,7 +225,7 @@ class Matrix2d {
     /**
      * invert this matrix, causing it to apply the opposite transformation.
      * @name invert
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @returns {me.Matrix2d} Reference to this object for method chaining
      */
@@ -261,7 +260,7 @@ class Matrix2d {
    /**
     * apply the current transform to the given 2d vector
     * @name apply
-    * @memberOf me.Matrix2d
+    * @memberof me.Matrix2d
     * @function
     * @param {me.Vector2d} v the vector object to be transformed
     * @returns {me.Vector2d} result vector object.
@@ -280,7 +279,7 @@ class Matrix2d {
     /**
      * apply the inverted current transform to the given 2d vector
      * @name applyInverse
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Vector2d} v the vector object to be transformed
      * @returns {me.Vector2d} result vector object.
@@ -301,7 +300,7 @@ class Matrix2d {
     /**
      * scale the matrix
      * @name scale
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {number} x a number representing the abscissa of the scaling vector.
      * @param {number} [y=x] a number representing the ordinate of the scaling vector.
@@ -323,7 +322,7 @@ class Matrix2d {
     /**
      * adds a 2D scaling transformation.
      * @name scaleV
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Vector2d} v scaling vector
      * @returns {me.Matrix2d} Reference to this object for method chaining
@@ -335,7 +334,7 @@ class Matrix2d {
     /**
      * specifies a 2D scale operation using the [sx, 1] scaling vector
      * @name scaleX
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {number} x x scaling vector
      * @returns {me.Matrix2d} Reference to this object for method chaining
@@ -347,7 +346,7 @@ class Matrix2d {
     /**
      * specifies a 2D scale operation using the [1,sy] scaling vector
      * @name scaleY
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {number} y y scaling vector
      * @returns {me.Matrix2d} Reference to this object for method chaining
@@ -359,7 +358,7 @@ class Matrix2d {
     /**
      * rotate the matrix (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {number} angle Rotation angle in radians.
      * @returns {me.Matrix2d} Reference to this object for method chaining
@@ -390,7 +389,7 @@ class Matrix2d {
     /**
      * translate the matrix position on the horizontal and vertical axis
      * @name translate
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {number} x the x coordindates to translate the matrix by
      * @param {number} y the y coordindates to translate the matrix by
@@ -399,7 +398,7 @@ class Matrix2d {
     /**
      * translate the matrix by a vector on the horizontal and vertical axis
      * @name translateV
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Vector2d} v the vector to translate the matrix by
      * @returns {me.Matrix2d} Reference to this object for method chaining
@@ -427,7 +426,7 @@ class Matrix2d {
     /**
      * returns true if the matrix is an identity matrix.
      * @name isIdentity
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @returns {boolean}
      */
@@ -450,7 +449,7 @@ class Matrix2d {
     /**
      * return true if the two matrices are identical
      * @name equals
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Matrix2d} m the other matrix
      * @returns {boolean} true if both are equals
@@ -475,7 +474,7 @@ class Matrix2d {
     /**
      * Clone the Matrix
      * @name clone
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @returns {me.Matrix2d}
      */
@@ -486,7 +485,7 @@ class Matrix2d {
     /**
      * return an array representation of this Matrix
      * @name toArray
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @returns {Float32Array}
      */
@@ -497,7 +496,7 @@ class Matrix2d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @returns {string}
      */