@vpmedia/phaser 1.14.0 → 1.16.0

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

@@ -1,9 +1,3 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
 import { PrimitiveShader } from './shader/primitive';
 import { ComplexPrimitiveShader } from './shader/complex';
 import { NormalShader } from './shader/normal';
@@ -11,6 +5,9 @@ import { FastShader } from './shader/fast';
 import { StripShader } from './shader/strip';
 
 export class WebGLShaderManager {
+  /**
+   * TBD.
+   */
   constructor() {
     this.gl = null;
     this.primitiveShader = null;
@@ -27,6 +24,10 @@ export class WebGLShaderManager {
     this.stack = [];
   }
 
+  /**
+   * TBD.
+   * @param gl - TBD.
+   */
   setContext(gl) {
     this.gl = gl;
     this.primitiveShader = new PrimitiveShader(gl);
@@ -37,6 +38,10 @@ export class WebGLShaderManager {
     this.setShader(this.defaultShader);
   }
 
+  /**
+   * TBD.
+   * @param attribs
+   */
   setAttribs(attribs) {
     // reset temp state
     let i;
@@ -61,6 +66,10 @@ export class WebGLShaderManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param shader
+   */
   setShader(shader) {
     if (this._currentId === shader._UID) {
       return false;
@@ -72,6 +81,9 @@ export class WebGLShaderManager {
     return true;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.attribState = null;
     this.tempAttribState = null;

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

@@ -1,13 +1,10 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
 import { AbstractFilter } from './abstract_filter';
 import { NormalShader } from './shader/normal';
 
 export class WebGLSpriteBatch {
+  /**
+   * TBD.
+   */
   constructor() {
     this.vertSize = 5;
     this.size = 2000; // Math.pow(2, 16) /  this.vertSize;
@@ -47,6 +44,10 @@ export class WebGLSpriteBatch {
     ]);
   }
 
+  /**
+   * TBD.
+   * @param gl - TBD.
+   */
   setContext(gl) {
     this.gl = gl;
     // create a couple of buffers
@@ -66,16 +67,28 @@ export class WebGLSpriteBatch {
     this.defaultShader.shaders[gl.id] = shader;
   }
 
+  /**
+   * TBD.
+   * @param renderSession - TBD.
+   */
   begin(renderSession) {
     this.renderSession = renderSession;
     this.shader = this.renderSession.shaderManager.defaultShader;
     this.start();
   }
 
+  /**
+   * TBD.
+   */
   end() {
     this.flush();
   }
 
+  /**
+   * TBD.
+   * @param sprite
+   * @param matrix - TBD.
+   */
   render(sprite, matrix) {
     const texture = sprite.texture;
     //  They provided an alternative rendering matrix, so use it
@@ -164,8 +177,7 @@ export class WebGLSpriteBatch {
     positions[i + 18] = uvs.y3;
     // color and alpha
     const tint = sprite.tint;
-    colors[i + 4] =
-      (tint >> 16) + (tint & 0xff00) + ((tint & 0xff) << 16) + ((sprite.worldAlpha * 255) << 24);
+    colors[i + 4] = (tint >> 16) + (tint & 0xff00) + ((tint & 0xff) << 16) + ((sprite.worldAlpha * 255) << 24);
     colors[i + 9] = colors[i + 4];
     colors[i + 14] = colors[i + 4];
     colors[i + 19] = colors[i + 4];
@@ -174,10 +186,16 @@ export class WebGLSpriteBatch {
     this.currentBatchSize += 1;
   }
 
+  /**
+   * TBD.
+   */
   renderTilingSprite() {
     // TODO
   }
 
+  /**
+   * TBD.
+   */
   flush() {
     // If the batch is length 0 then return as there is nothing to draw
     if (this.currentBatchSize === 0) {
@@ -274,6 +292,12 @@ export class WebGLSpriteBatch {
     this.currentBatchSize = 0;
   }
 
+  /**
+   * TBD.
+   * @param texture
+   * @param size
+   * @param startIndex
+   */
   renderBatch(texture, size, startIndex) {
     if (size === 0) {
       return;
@@ -295,15 +319,24 @@ export class WebGLSpriteBatch {
     this.renderSession.drawCount += 1;
   }
 
+  /**
+   * TBD.
+   */
   stop() {
     this.flush();
     this.dirty = true;
   }
 
+  /**
+   * TBD.
+   */
   start() {
     this.dirty = true;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.vertices = null;
     this.positions = null;

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

@@ -1,27 +1,37 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
 import { hex2rgb } from '../../util/math';
 
 export class WebGLStencilManager {
+  /**
+   * TBD.
+   */
   constructor() {
     this.stencilStack = [];
     this.reverse = true;
     this.count = 0;
   }
 
+  /**
+   * TBD.
+   * @param gl - TBD.
+   */
   setContext(gl) {
     this.gl = gl;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.stencilStack = null;
     this.gl = null;
   }
 
+  /**
+   * TBD.
+   * @param graphics - TBD.
+   * @param webGLData
+   * @param renderSession - TBD.
+   */
   pushStencil(graphics, webGLData, renderSession) {
     const gl = renderSession.gl;
     this.bindGraphics(graphics, webGLData, renderSession);
@@ -74,6 +84,12 @@ export class WebGLStencilManager {
     this.count += 1;
   }
 
+  /**
+   * TBD.
+   * @param graphics - TBD.
+   * @param webGLData
+   * @param renderSession - TBD.
+   */
   bindGraphics(graphics, webGLData, renderSession) {
     // if(this._currentGraphics === graphics)return;
     // this._currentGraphics = graphics;
@@ -115,6 +131,12 @@ export class WebGLStencilManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param graphics - TBD.
+   * @param webGLData
+   * @param renderSession - TBD.
+   */
   popStencil(graphics, webGLData, renderSession) {
     const gl = renderSession.gl;
     this.stencilStack.pop();

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

@@ -1,13 +1,9 @@
-/**
- * @module display/webgl/texture
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
-import { Rectangle } from  '../../geom/rectangle';
+import { Rectangle } from '../../geom/rectangle';
 
 export class TextureUvs {
+  /**
+   * TBD.
+   */
   constructor() {
     this.x0 = 0;
     this.y0 = 0;
@@ -21,6 +17,13 @@ export class TextureUvs {
 }
 
 export class Texture {
+  /**
+   * TBD.
+   * @param baseTexture - TBD.
+   * @param frame - TBD.
+   * @param crop - TBD.
+   * @param trim - TBD.
+   */
   constructor(baseTexture, frame, crop, trim) {
     this.noFrame = false;
     if (!frame) {
@@ -49,6 +52,9 @@ export class Texture {
     }
   }
 
+  /**
+   * TBD.
+   */
   onBaseTextureLoaded() {
     if (this.noFrame) {
       this.frame = new Rectangle(0, 0, this.baseTexture.width, this.baseTexture.height);
@@ -56,6 +62,10 @@ export class Texture {
     this.setFrame(this.frame);
   }
 
+  /**
+   * TBD.
+   * @param destroyBase - TBD.
+   */
   destroy(destroyBase = false) {
     if (destroyBase) {
       this.baseTexture.destroy();
@@ -63,6 +73,10 @@ export class Texture {
     this.valid = false;
   }
 
+  /**
+   * TBD.
+   * @param frame - TBD.
+   */
   setFrame(frame) {
     this.noFrame = false;
     this.frame = frame;
@@ -74,23 +88,19 @@ export class Texture {
     this.crop.height = frame.height;
     if (
       !this.trim &&
-      (frame.x + frame.width > this.baseTexture.width ||
-        frame.y + frame.height > this.baseTexture.height)
+      (frame.x + frame.width > this.baseTexture.width || frame.y + frame.height > this.baseTexture.height)
     ) {
       // If `true` then `PIXI.Texture.setFrame` will no longer throw an error if the texture dimensions are incorrect.
       // Instead `Texture.valid` will be set to `false` (#1556)
       // TODO: make this configurable
       const isTextureSilentFail = true;
       if (!isTextureSilentFail) {
-        throw new Error(
-          'Texture Error: frame does not fit inside the base Texture dimensions ' + this
-        );
+        throw new Error('Texture Error: frame does not fit inside the base Texture dimensions ' + this);
       }
       this.valid = false;
       return;
     }
-    this.valid =
-      frame && frame.width && frame.height && this.baseTexture.source && this.baseTexture.hasLoaded;
+    this.valid = frame && frame.width && frame.height && this.baseTexture.source && this.baseTexture.hasLoaded;
     if (this.trim) {
       this.width = this.trim.width;
       this.height = this.trim.height;
@@ -102,6 +112,9 @@ export class Texture {
     }
   }
 
+  /**
+   * TBD.
+   */
   _updateUvs() {
     if (!this._uvs) {
       this._uvs = new TextureUvs();

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

@@ -1,15 +1,8 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
 import { BaseTexture } from './base_texture';
 import { Texture } from './texture';
 
 /**
  * TBD.
- *
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {number} scaleMode - TBD.
  * @returns {object} TBD.
@@ -26,7 +19,6 @@ export function baseTextureFromCanvas(canvas, scaleMode) {
 
 /**
  * TBD.
- *
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {number} scaleMode - TBD.
  * @returns {object} TBD.

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

@@ -1,10 +1,3 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
-
 /**
  * TBD.
  */
@@ -12,7 +5,6 @@ export function initDefaultShaders() {}
 
 /**
  * TBD.
- *
  * @param {object} gl - TBD.
  * @param {string[]|string} shaderSrc - TBD.
  * @param {object} shaderType - TBD.
@@ -37,7 +29,6 @@ export function compileShader(gl, shaderSrc, shaderType) {
 
 /**
  * TBD.
- *
  * @param {object} gl - TBD.
  * @param {string[]|string} shaderSrc - TBD.
  * @returns {object} TBD.
@@ -48,7 +39,6 @@ export function compileVertexShader(gl, shaderSrc) {
 
 /**
  * TBD.
- *
  * @param {object} gl - TBD.
  * @param {string[]|string} shaderSrc - TBD.
  * @returns {object} TBD.
@@ -59,7 +49,6 @@ export function compileFragmentShader(gl, shaderSrc) {
 
 /**
  * TBD.
- *
  * @param {object} gl - TBD.
  * @param {string[]|string} vertexSrc - TBD.
  * @param {string[]|string} fragmentSrc - TBD.

package/src/phaser/geom/circle.js

@@ -1,11 +1,5 @@
-/**
- * @module geom/circle
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
 import { Point } from './point';
-import { Rectangle } from  './rectangle';
+import { Rectangle } from './rectangle';
 import { distance } from '../util/math';
 import { clone, contains, circumferencePoint } from './util/circle';
 import { GEOM_CIRCLE } from '../core/const';
@@ -13,7 +7,6 @@ import { GEOM_CIRCLE } from '../core/const';
 export class Circle {
   /**
    * TBD.
-   *
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {number} diameter - TBD.
@@ -29,10 +22,19 @@ export class Circle {
     this.type = GEOM_CIRCLE;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   circumference() {
     return 2 * (Math.PI * this._radius);
   }
 
+  /**
+   * TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   random(output = null) {
     const result = output || new Point();
     const t = 2 * Math.PI * Math.random();
@@ -45,10 +47,21 @@ export class Circle {
     return result;
   }
 
+  /**
+   * TBD.
+   * @returns {Rectangle} TBD.
+   */
   getBounds() {
     return new Rectangle(this.x - this.radius, this.y - this.radius, this.diameter, this.diameter);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} diameter - TBD.
+   * @returns {Circle} TBD.
+   */
   setTo(x, y, diameter) {
     this.x = x;
     this.y = y;
@@ -57,10 +70,20 @@ export class Circle {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {Circle} source - TBD.
+   * @returns {Circle} TBD.
+   */
   copyFrom(source) {
     return this.setTo(source.x, source.y, source.diameter);
   }
 
+  /**
+   * TBD.
+   * @param {Circle} dest - TBD.
+   * @returns {Circle} TBD.
+   */
   copyTo(dest) {
     dest.x = this.x;
     dest.y = this.y;
@@ -68,51 +91,86 @@ export class Circle {
     return dest;
   }
 
+  /**
+   * TBD.
+   * @param {Circle} dest - TBD.
+   * @param {boolean} round - TBD.
+   * @returns {number} TBD.
+   */
   distance(dest, round = false) {
     const d = distance(this.x, this.y, dest.x, dest.y);
     return round ? Math.round(d) : d;
   }
 
+  /**
+   * TBD.
+   * @returns {Circle} TBD.
+   */
   clone() {
     return clone(this);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {boolean} TBD.
+   */
   contains(x, y) {
     return contains(this, x, y);
   }
 
+  /**
+   * TBD.
+   * @param {number} angle - TBD.
+   * @param {boolean} asDegrees - TBD.
+   * @param {Point} out - TBD.
+   * @returns {Point} TBD.
+   */
   circumferencePoint(angle, asDegrees, out) {
     return circumferencePoint(this, angle, asDegrees, out);
   }
 
+  /**
+   * TBD.
+   * @param {number} dx - TBD.
+   * @param {number} dy - TBD.
+   * @returns {Circle} TBD.
+   */
   offset(dx, dy) {
     this.x += dx;
     this.y += dy;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {Point} point - TBD.
+   * @returns {Circle} TBD.
+   */
   offsetPoint(point) {
     return this.offset(point.x, point.y);
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   toString() {
-    return (
-      '[{Circle (x=' +
-      this.x +
-      ' y=' +
-      this.y +
-      ' diameter=' +
-      this.diameter +
-      ' radius=' +
-      this.radius +
-      ')}]'
-    );
+    return '[{Circle (x=' + this.x + ' y=' + this.y + ' diameter=' + this.diameter + ' radius=' + this.radius + ')}]';
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get diameter() {
     return this._diameter;
   }
 
+  /**
+   * TBD.
+   */
   set diameter(value) {
     if (value > 0) {
       this._diameter = value;
@@ -120,10 +178,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get radius() {
     return this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set radius(value) {
     if (value > 0) {
       this._radius = value;
@@ -131,10 +196,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get left() {
     return this.x - this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set left(value) {
     if (value > this.x) {
       this._radius = 0;
@@ -144,10 +216,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get right() {
     return this.x + this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set right(value) {
     if (value < this.x) {
       this._radius = 0;
@@ -157,10 +236,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get top() {
     return this.y - this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set top(value) {
     if (value > this.y) {
       this._radius = 0;
@@ -170,10 +256,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get bottom() {
     return this.y + this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set bottom(value) {
     if (value < this.y) {
       this._radius = 0;
@@ -183,6 +276,10 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get area() {
     if (this._radius > 0) {
       return Math.PI * this._radius * this._radius;
@@ -190,10 +287,17 @@ export class Circle {
     return 0;
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get empty() {
     return this._diameter === 0;
   }
 
+  /**
+   * TBD.
+   */
   set empty(value) {
     if (value === true) {
       this.setTo(0, 0, 0);