@vpmedia/phaser 1.0.2 → 1.0.3

package/src/phaser/display/webgl/earcut.js

@@ -4,12 +4,12 @@
  * @author       Mat Groves http://matgroves.com/ @Doormat23
  * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-/* eslint-disable no-continue */
 import Node from './earcut_node';
 
 /**
  *
- * @param list
+ * @param {object} list TBD
+ * @returns {object} TBD
  */
 export function sortLinked(list) {
   let i;
@@ -74,8 +74,9 @@ export function sortLinked(list) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {number} TBD
  */
 export function compareX(a, b) {
   return a.x - b.x;
@@ -83,11 +84,12 @@ export function compareX(a, b) {
 
 /**
  *
- * @param x
- * @param y
- * @param minX
- * @param minY
- * @param size
+ * @param {number} x TBD
+ * @param {number} y TBD
+ * @param {number} minX TBD
+ * @param {number} minY TBD
+ * @param {number} size TBD
+ * @returns {number} TBD
  */
 export function zOrder(x, y, minX, minY, size) {
   // coords are transformed into non-negative 15-bit integer range
@@ -106,10 +108,10 @@ export function zOrder(x, y, minX, minY, size) {
 
 /**
  *
- * @param start
- * @param minX
- * @param minY
- * @param size
+ * @param {object} start TBD
+ * @param {number} minX TBD
+ * @param {number} minY TBD
+ * @param {number} size TBD
  */
 export function indexCurve(start, minX, minY, size) {
   let p = start;
@@ -126,7 +128,8 @@ export function indexCurve(start, minX, minY, size) {
 
 /**
  *
- * @param start
+ * @param {object} start TBD
+ * @returns {object} TBD
  */
 export function getLeftmost(start) {
   let p = start;
@@ -140,14 +143,15 @@ export function getLeftmost(start) {
 
 /**
  *
- * @param ax
- * @param ay
- * @param bx
- * @param by
- * @param cx
- * @param cy
- * @param px
- * @param py
+ * @param {number} ax TBD
+ * @param {number} ay TBD
+ * @param {number} bx TBD
+ * @param {number} by TBD
+ * @param {number} cx TBD
+ * @param {number} cy TBD
+ * @param {number} px TBD
+ * @param {number} py TBD
+ * @returns {object} TBD
  */
 export function pointInTriangle(ax, ay, bx, by, cx, cy, px, py) {
   return (cx - px) * (ay - py) - (ax - px) * (cy - py) >= 0 && (ax - px) * (by - py) - (bx - px) * (ay - py) >= 0 && (bx - px) * (cy - py) - (cx - px) * (by - py) >= 0;
@@ -155,9 +159,10 @@ export function pointInTriangle(ax, ay, bx, by, cx, cy, px, py) {
 
 /**
  *
- * @param p
- * @param q
- * @param r
+ * @param {object} p TBD
+ * @param {object} q TBD
+ * @param {object} r TBD
+ * @returns {number} TBD
  */
 export function area(p, q, r) {
   return (q.y - p.y) * (r.x - q.x) - (q.x - p.x) * (r.y - q.y);
@@ -165,8 +170,9 @@ export function area(p, q, r) {
 
 /**
  *
- * @param p1
- * @param p2
+ * @param {object} p1 TBD
+ * @param {object} p2 TBD
+ * @returns {boolean} TBD
  */
 export function equals(p1, p2) {
   return p1.x === p2.x && p1.y === p2.y;
@@ -174,10 +180,11 @@ export function equals(p1, p2) {
 
 /**
  *
- * @param p1
- * @param q1
- * @param p2
- * @param q2
+ * @param {object} p1 TBD
+ * @param {object} q1 TBD
+ * @param {object} p2 TBD
+ * @param {object} q2 TBD
+ * @returns {boolean} TBD
  */
 export function intersects(p1, q1, p2, q2) {
   return area(p1, q1, p2) > 0 !== area(p1, q1, q2) > 0 && area(p2, q2, p1) > 0 !== area(p2, q2, q1) > 0;
@@ -185,8 +192,9 @@ export function intersects(p1, q1, p2, q2) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function intersectsPolygon(a, b) {
   let p = a;
@@ -199,8 +207,9 @@ export function intersectsPolygon(a, b) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {object} TBD
  */
 export function locallyInside(a, b) {
   return area(a.prev, a, a.next) < 0 ? area(a, b, a.next) >= 0 && area(a, a.prev, b) >= 0 : area(a, b, a.prev) < 0 || area(a, a.next, b) < 0;
@@ -208,8 +217,9 @@ export function locallyInside(a, b) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function middleInside(a, b) {
   let p = a;
@@ -227,8 +237,9 @@ export function middleInside(a, b) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function isValidDiagonal(a, b) {
   return equals(a, b) || a.next.i !== b.i && a.prev.i !== b.i && !intersectsPolygon(a, b) && locallyInside(a, b) && locallyInside(b, a) && middleInside(a, b);
@@ -236,8 +247,9 @@ export function isValidDiagonal(a, b) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {object} TBD
  */
 export function splitPolygon(a, b) {
   const a2 = new Node(a.i, a.x, a.y);
@@ -257,10 +269,11 @@ export function splitPolygon(a, b) {
 
 /**
  *
- * @param i
- * @param x
- * @param y
- * @param last
+ * @param {number} i TBD
+ * @param {number} x TBD
+ * @param {number} y TBD
+ * @param {object} last TBD
+ * @returns {object} TBD
  */
 export function insertNode(i, x, y, last) {
   const p = new Node(i, x, y);
@@ -278,7 +291,7 @@ export function insertNode(i, x, y, last) {
 
 /**
  *
- * @param p
+ * @param {object} p TBD
  */
 export function removeNode(p) {
   p.next.prev = p.prev;
@@ -293,7 +306,8 @@ export function removeNode(p) {
 
 /**
  *
- * @param ear
+ * @param {object} ear TBD
+ * @returns {boolean} TBD
  */
 export function isEar(ear) {
   const a = ear.prev;
@@ -311,10 +325,11 @@ export function isEar(ear) {
 
 /**
  *
- * @param ear
- * @param minX
- * @param minY
- * @param size
+ * @param {object} ear TBD
+ * @param {number} minX TBD
+ * @param {number} minY TBD
+ * @param {number} size TBD
+ * @returns {boolean} TBD
  */
 export function isEarHashed(ear, minX, minY, size) {
   const a = ear.prev;
@@ -322,13 +337,9 @@ export function isEarHashed(ear, minX, minY, size) {
   const c = ear.next;
   if (area(a, b, c) >= 0) return false; // reflex, can't be an ear
   // triangle bbox; min & max are calculated like this for speed
-  /* eslint-disable no-nested-ternary */
   const minTX = a.x < b.x ? (a.x < c.x ? a.x : c.x) : (b.x < c.x ? b.x : c.x);
-  /* eslint-disable no-nested-ternary */
   const minTY = a.y < b.y ? (a.y < c.y ? a.y : c.y) : (b.y < c.y ? b.y : c.y);
-  /* eslint-disable no-nested-ternary */
   const maxTX = a.x > b.x ? (a.x > c.x ? a.x : c.x) : (b.x > c.x ? b.x : c.x);
-  /* eslint-disable no-nested-ternary */
   const maxTY = a.y > b.y ? (a.y > c.y ? a.y : c.y) : (b.y > c.y ? b.y : c.y);
   // z-order range for the current triangle bbox;
   const minZ = zOrder(minTX, minTY, minX, minY, size);
@@ -354,11 +365,12 @@ export function isEarHashed(ear, minX, minY, size) {
 
 /**
  *
- * @param data
- * @param start
- * @param end
- * @param dim
- * @param clockwise
+ * @param {object} data TBD
+ * @param {number} start TBD
+ * @param {number} end TBD
+ * @param {number} dim TBD
+ * @param {boolean} clockwise TBD
+ * @returns {object} TBD
  */
 export function linkedList(data, start, end, dim, clockwise) {
   let sum = 0;
@@ -381,8 +393,9 @@ export function linkedList(data, start, end, dim, clockwise) {
 
 /**
  *
- * @param start
- * @param end
+ * @param {object} start TBD
+ * @param {object} end TBD
+ * @returns {object} TBD
  */
 export function filterPoints(start, end) {
   if (!start) return start;
@@ -406,8 +419,9 @@ export function filterPoints(start, end) {
 
 /**
  *
- * @param hole
- * @param outerNode
+ * @param {object} hole TBD
+ * @param {object} outerNode TBD
+ * @returns {object} TBD
  */
 export function findHoleBridge(hole, outerNode) {
   let p = outerNode;
@@ -451,8 +465,8 @@ export function findHoleBridge(hole, outerNode) {
 
 /**
  *
- * @param hole
- * @param outerNode
+ * @param {object} hole TBD
+ * @param {object} outerNode TBD
  */
 export function eliminateHole(hole, outerNode) {
   outerNode = findHoleBridge(hole, outerNode);
@@ -464,10 +478,11 @@ export function eliminateHole(hole, outerNode) {
 
 /**
  *
- * @param data
- * @param holeIndices
- * @param outerNode
- * @param dim
+ * @param {object} data TBD
+ * @param {object} holeIndices TBD
+ * @param {object} outerNode TBD
+ * @param {object} dim TBD
+ * @returns {object} TBD
  */
 export function eliminateHoles(data, holeIndices, outerNode, dim) {
   const queue = [];
@@ -494,9 +509,10 @@ export function eliminateHoles(data, holeIndices, outerNode, dim) {
 
 /**
  *
- * @param start
- * @param triangles
- * @param dim
+ * @param {object} start TBD
+ * @param {object} triangles TBD
+ * @param {number} dim TBD
+ * @returns {object} TBD
  */
 export function cureLocalIntersections(start, triangles, dim) {
   let p = start;
@@ -521,12 +537,12 @@ export function cureLocalIntersections(start, triangles, dim) {
 
 /**
  *
- * @param start
- * @param triangles
- * @param dim
- * @param minX
- * @param minY
- * @param size
+ * @param {object} start TBD
+ * @param {object} triangles TBD
+ * @param {number} dim TBD
+ * @param {number} minX TBD
+ * @param {number} minY TBD
+ * @param {number} size TBD
  */
 export function splitEarcut(start, triangles, dim, minX, minY, size) {
   // look for a valid diagonal that divides the polygon into two
@@ -541,9 +557,7 @@ export function splitEarcut(start, triangles, dim, minX, minY, size) {
         a = filterPoints(a, a.next);
         c = filterPoints(c, c.next);
         // run earcut on each half
-        /* eslint-disable no-use-before-define */
         earcutLinked(a, triangles, dim, minX, minY, size);
-        /* eslint-disable no-use-before-define */
         earcutLinked(c, triangles, dim, minX, minY, size);
         return;
       }
@@ -555,13 +569,13 @@ export function splitEarcut(start, triangles, dim, minX, minY, size) {
 
 /**
  *
- * @param ear
- * @param triangles
- * @param dim
- * @param minX
- * @param minY
- * @param size
- * @param pass
+ * @param {object} ear TBD
+ * @param {object} triangles TBD
+ * @param {number} dim TBD
+ * @param {number} minX TBD
+ * @param {number} minY TBD
+ * @param {number} size TBD
+ * @param {object} pass TBD
  */
 export function earcutLinked(ear, triangles, dim, minX, minY, size, pass) {
   if (!ear) return;
@@ -606,9 +620,10 @@ export function earcutLinked(ear, triangles, dim, minX, minY, size, pass) {
 
 /**
  *
- * @param data
- * @param holeIndices
- * @param dim
+ * @param {object} data TBD
+ * @param {object} holeIndices TBD
+ * @param {number} dim TBD
+ * @returns {object} TBD
  */
 export function triangulate(data, holeIndices, dim) {
   dim = dim || 2;

package/src/phaser/display/webgl/graphics.js

@@ -11,7 +11,9 @@ import { hex2rgb } from '../../util/math';
 import { triangulate } from './earcut';
 
 /**
+ * TBD
  *
+ * @returns {number} TBD
  */
 export function getStencilBufferLimit() {
   if (!window.PhaserRegistry.stencilBufferLimit) {
@@ -21,7 +23,9 @@ export function getStencilBufferLimit() {
 }
 
 /**
+ * TBD
  *
+ * @returns {object[]} TBD
  */
 export function getGraphicsDataPool() {
   if (!window.PhaserRegistry.graphicsDataPool) {
@@ -32,8 +36,9 @@ export function getGraphicsDataPool() {
 
 /**
  *
- * @param webGL
- * @param type
+ * @param {object} webGL TBD
+ * @param {number} type TBD
+ * @returns {object} TBD
  */
 export function switchMode(webGL, type) {
   let webGLData;
@@ -55,8 +60,8 @@ export function switchMode(webGL, type) {
 
 /**
  *
- * @param graphicsData
- * @param webGLData
+ * @param {object} graphicsData TBD
+ * @param {object} webGLData TBD
  */
 export function buildLine(graphicsData, webGLData) {
   // TODO OPTIMISE!
@@ -168,7 +173,6 @@ export function buildLine(graphicsData, webGLData) {
       denom += 10.1;
       verts.push(p2x - perpx, p2y - perpy, r, g, b, alpha);
       verts.push(p2x + perpx, p2y + perpy, r, g, b, alpha);
-      /* eslint-disable no-continue */
       continue;
     }
     px = (b1 * c2 - b2 * c1) / denom;
@@ -221,8 +225,8 @@ export function buildLine(graphicsData, webGLData) {
 
 /**
  *
- * @param graphicsData
- * @param webGLData
+ * @param {object} graphicsData TBD
+ * @param {object} webGLData TBD
  */
 export function buildRectangle(graphicsData, webGLData) {
   //
@@ -265,12 +269,13 @@ export function buildRectangle(graphicsData, webGLData) {
 
 /**
  *
- * @param fromX
- * @param fromY
- * @param cpX
- * @param cpY
- * @param toX
- * @param toY
+ * @param {number} fromX TBD
+ * @param {number} fromY TBD
+ * @param {number} cpX TBD
+ * @param {number} cpY TBD
+ * @param {number} toX TBD
+ * @param {number} toY TBD
+ * @returns {number[]} TBD
  */
 export function quadraticBezierCurve(fromX, fromY, cpX, cpY, toX, toY) {
   let xa;
@@ -303,8 +308,8 @@ export function quadraticBezierCurve(fromX, fromY, cpX, cpY, toX, toY) {
 
 /**
  *
- * @param graphicsData
- * @param webGLData
+ * @param {object} graphicsData TBD
+ * @param {object} webGLData TBD
  */
 export function buildRoundedRectangle(graphicsData, webGLData) {
   const rrectData = graphicsData.shape;
@@ -351,8 +356,8 @@ export function buildRoundedRectangle(graphicsData, webGLData) {
 
 /**
  *
- * @param graphicsData
- * @param webGLData
+ * @param {object} graphicsData TBD
+ * @param {object} webGLData TBD
  */
 export function buildCircle(graphicsData, webGLData) {
   // need to convert points to a nice regular data
@@ -402,8 +407,8 @@ export function buildCircle(graphicsData, webGLData) {
 
 /**
  *
- * @param graphicsData
- * @param webGLData
+ * @param {object} graphicsData TBD
+ * @param {object} webGLData TBD
  */
 export function buildComplexPoly(graphicsData, webGLData) {
   // TODO - no need to copy this as it gets turned into a Float32Array anyways..
@@ -446,8 +451,9 @@ export function buildComplexPoly(graphicsData, webGLData) {
 
 /**
  *
- * @param graphicsData
- * @param webGLData
+ * @param {object} graphicsData TBD
+ * @param {object} webGLData TBD
+ * @returns {boolean} TBD
  */
 export function buildPoly(graphicsData, webGLData) {
   const points = graphicsData.points;
@@ -484,8 +490,8 @@ export function buildPoly(graphicsData, webGLData) {
 
 /**
  *
- * @param graphics
- * @param gl
+ * @param {object} graphics TBD
+ * @param {object} gl TBD
  */
 export function updateGraphics(graphics, gl) {
   const stencilBufferLimit = getStencilBufferLimit();
@@ -572,8 +578,8 @@ export function updateGraphics(graphics, gl) {
 
 /**
  *
- * @param graphics
- * @param renderSession
+ * @param {object} graphics TBD
+ * @param {object} renderSession TBD
  */
 export function renderGraphics(graphics, renderSession) {
   const gl = renderSession.gl;

package/src/phaser/display/webgl/mask_manager.js

@@ -8,8 +8,8 @@ import { updateGraphics } from './graphics';
 
 /**
  *
- * @param maskData
- * @param renderSession
+ * @param {object} maskData TBD
+ * @param {object} renderSession TBD
  */
 export function pushMask(maskData, renderSession) {
   const gl = renderSession.gl;
@@ -24,8 +24,8 @@ export function pushMask(maskData, renderSession) {
 
 /**
  *
- * @param maskData
- * @param renderSession
+ * @param {object} maskData TBD
+ * @param {object} renderSession TBD
  */
 export function popMask(maskData, renderSession) {
   const gl = renderSession.gl;

package/src/phaser/display/webgl/texture_util.js

@@ -9,8 +9,9 @@ import Texture from './texture';
 
 /**
  *
- * @param canvas
- * @param scaleMode
+ * @param {object} canvas TBD
+ * @param {number} scaleMode TBD
+ * @returns {object} TBD
  */
 export function baseTextureFromCanvas(canvas, scaleMode) {
   if (canvas.width === 0) {
@@ -24,8 +25,9 @@ export function baseTextureFromCanvas(canvas, scaleMode) {
 
 /**
  *
- * @param canvas
- * @param scaleMode
+ * @param {object} canvas TBD
+ * @param {number} scaleMode TBD
+ * @returns {object} TBD
  */
 export function textureFromCanvas(canvas, scaleMode) {
   return new Texture(baseTextureFromCanvas(canvas, scaleMode));

package/src/phaser/display/webgl/util.js

@@ -13,9 +13,10 @@ export function initDefaultShaders() {
 
 /**
  *
- * @param gl
- * @param shaderSrc
- * @param shaderType
+ * @param {object} gl TBD
+ * @param {string[]|string} shaderSrc TBD
+ * @param {object} shaderType TBD
+ * @returns {object} TBD
  */
 export function compileShader(gl, shaderSrc, shaderType) {
   let src = shaderSrc;
@@ -34,8 +35,9 @@ export function compileShader(gl, shaderSrc, shaderType) {
 
 /**
  *
- * @param gl
- * @param shaderSrc
+ * @param {object} gl TBD
+ * @param {string[]|string} shaderSrc TBD
+ * @returns {object} TBD
  */
 export function compileVertexShader(gl, shaderSrc) {
   return compileShader(gl, shaderSrc, gl.VERTEX_SHADER);
@@ -43,8 +45,9 @@ export function compileVertexShader(gl, shaderSrc) {
 
 /**
  *
- * @param gl
- * @param shaderSrc
+ * @param {object} gl TBD
+ * @param {string[]|string} shaderSrc TBD
+ * @returns {object} TBD
  */
 export function compileFragmentShader(gl, shaderSrc) {
   return compileShader(gl, shaderSrc, gl.FRAGMENT_SHADER);
@@ -52,9 +55,10 @@ export function compileFragmentShader(gl, shaderSrc) {
 
 /**
  *
- * @param gl
- * @param vertexSrc
- * @param fragmentSrc
+ * @param {object} gl TBD
+ * @param {string[]|string} vertexSrc TBD
+ * @param {string[]|string} fragmentSrc TBD
+ * @returns {object} TBD
  */
 export function compileProgram(gl, vertexSrc, fragmentSrc) {
   const fragmentShader = compileFragmentShader(gl, fragmentSrc);

package/src/phaser/geom/polygon.js

@@ -3,7 +3,6 @@
  * @author       Richard Davey <rich@photonstorm.com>
  * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-/* eslint-disable no-cond-assign, no-plusplus */
 import Point from './point';
 import { clone } from './util/polygon';
 import { GEOM_POLYGON } from '../core/const';