@vpmedia/phaser 1.12.0 → 1.14.0

package/src/phaser/display/canvas/tinter.js

@@ -1,18 +1,19 @@
 /**
+ * @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
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import CanvasBuffer from './buffer';
+import { CanvasBuffer } from './buffer';
 import { create, removeByCanvas } from './pool';
 import { hex2rgb } from '../../util/math';
 
 /**
+ * TBD.
  *
- * @param {object} sprite TBD
- * @param {object} color TBD
- * @returns {object} TBD
+ * @param {object} sprite - TBD.
+ * @param {object} color - TBD.
+ * @returns {object} TBD.
  */
 export function getTintedTexture(sprite, color) {
   const canvas = sprite.tintedTexture || create('CanvasTinter');
@@ -21,10 +22,11 @@ export function getTintedTexture(sprite, color) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} texture TBD
- * @param {object} color TBD
- * @param {object} canvas TBD
+ * @param {object} texture - TBD.
+ * @param {object} color - TBD.
+ * @param {HTMLCanvasElement} canvas - TBD.
  */
 export function tintWithMultiply(texture, color, canvas) {
   const context = canvas.getContext('2d');
@@ -63,10 +65,11 @@ export function tintWithMultiply(texture, color, canvas) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} texture TBD
- * @param {object} color TBD
- * @param {object} canvas TBD
+ * @param {object} texture - TBD.
+ * @param {object} color - TBD.
+ * @param {HTMLCanvasElement} canvas - TBD.
  */
 export function tintWithPerPixel(texture, color, canvas) {
   const context = canvas.getContext('2d');
@@ -107,8 +110,9 @@ export function tintWithPerPixel(texture, color, canvas) {
 }
 
 /**
+ * TBD.
  *
- * @returns {boolean} TBD
+ * @returns {boolean} TBD.
  */
 export function checkInverseAlpha() {
   const canvas = new CanvasBuffer(2, 1);
@@ -134,8 +138,9 @@ export function checkInverseAlpha() {
 }
 
 /**
+ * TBD.
  *
- * @returns {boolean} TBD
+ * @returns {boolean} TBD.
  */
 export function canUseNewCanvasBlendModes() {
   if (document === undefined) {
@@ -161,7 +166,7 @@ export function canUseNewCanvasBlendModes() {
 }
 
 /**
- * TBD
+ * TBD.
  */
 export function detectCapabilities() {
   if (!window.PhaserRegistry) {

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

@@ -1,19 +1,20 @@
 /**
+ * @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
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
 import { create as createCanvas } from './pool';
 
 /**
+ * TBD.
  *
- * @param {object} parent TBD
- * @param {number} width TBD
- * @param {number} height TBD
- * @param {string} id TBD
- * @param {boolean} skipPool TBD
- * @returns {object} TBD
+ * @param {object} parent - TBD.
+ * @param {number} width - TBD.
+ * @param {number} height - TBD.
+ * @param {string} id - TBD.
+ * @param {boolean} skipPool - TBD.
+ * @returns {object} TBD.
  */
 export function create(parent, width, height, id, skipPool) {
   width = width || 256;
@@ -29,10 +30,11 @@ export function create(parent, width, height, id, skipPool) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} canvas TBD
- * @param {string} color TBD
- * @returns {object} TBD
+ * @param {HTMLCanvasElement} canvas - TBD.
+ * @param {string} color - TBD.
+ * @returns {object} TBD.
  */
 export function setBackgroundColor(canvas, color) {
   color = color || 'rgb(0,0,0)';
@@ -41,10 +43,11 @@ export function setBackgroundColor(canvas, color) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} canvas TBD
- * @param {string} value TBD
- * @returns {object} TBD
+ * @param {HTMLCanvasElement} canvas - TBD.
+ * @param {string} value - TBD.
+ * @returns {object} TBD.
  */
 export function setTouchAction(canvas, value) {
   value = value || 'none';
@@ -55,10 +58,11 @@ export function setTouchAction(canvas, value) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} canvas TBD
- * @param {string} value TBD
- * @returns {object} TBD
+ * @param {HTMLCanvasElement} canvas - TBD.
+ * @param {string} value - TBD.
+ * @returns {object} TBD.
  */
 export function setUserSelect(canvas, value) {
   value = value || 'none';
@@ -73,11 +77,12 @@ export function setUserSelect(canvas, value) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} canvas TBD
- * @param {object} parent TBD
- * @param {boolean} overflowHidden TBD
- * @returns {object} TBD
+ * @param {HTMLCanvasElement} canvas - TBD.
+ * @param {object} parent - TBD.
+ * @param {boolean} overflowHidden - TBD.
+ * @returns {object} TBD.
  */
 export function addToDOM(canvas, parent, overflowHidden = true) {
   let target;
@@ -102,8 +107,9 @@ export function addToDOM(canvas, parent, overflowHidden = true) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} canvas TBD
+ * @param {HTMLCanvasElement} canvas - TBD.
  */
 export function removeFromDOM(canvas) {
   if (canvas.parentNode) {
@@ -112,15 +118,16 @@ export function removeFromDOM(canvas) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} context TBD
- * @param {number} translateX TBD
- * @param {number} translateY TBD
- * @param {number} scaleX TBD
- * @param {number} scaleY TBD
- * @param {number} skewX TBD
- * @param {number} skewY TBD
- * @returns {object} TBD
+ * @param {object} context - TBD.
+ * @param {number} translateX - TBD.
+ * @param {number} translateY - TBD.
+ * @param {number} scaleX - TBD.
+ * @param {number} scaleY - TBD.
+ * @param {number} skewX - TBD.
+ * @param {number} skewY - TBD.
+ * @returns {object} TBD.
  */
 export function setTransform(context, translateX, translateY, scaleX, scaleY, skewX, skewY) {
   context.setTransform(scaleX, skewX, skewY, scaleY, translateX, translateY);
@@ -128,9 +135,10 @@ export function setTransform(context, translateX, translateY, scaleX, scaleY, sk
 }
 
 /**
+ * TBD.
  *
- * @param {object} context TBD
- * @returns {object} TBD
+ * @param {object} context - TBD.
+ * @returns {object} TBD.
  */
 export function getSmoothingPrefix(context) {
   const VENDORS = ['i', 'webkitI', 'msI', 'mozI', 'oI'];
@@ -144,10 +152,11 @@ export function getSmoothingPrefix(context) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} context TBD
- * @param {number} value TBD
- * @returns {object} TBD
+ * @param {object} context - TBD.
+ * @param {number} value - TBD.
+ * @returns {object} TBD.
  */
 export function setSmoothingEnabled(context, value) {
   const s = getSmoothingPrefix(context);

package/src/phaser/display/display_object.js

@@ -1,16 +1,20 @@
 /**
+ * @module display/display_object
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import Point from '../geom/point';
-import Rectangle from '../geom/rectangle';
-import Matrix from '../geom/matrix';
+import { Point } from '../geom/point';
+import { Rectangle } from  '../geom/rectangle';
+import { Matrix } from  '../geom/matrix';
 import { getIdentityMatrix } from '../geom/util/matrix';
 import { PI_2 } from '../util/math';
 import { renderCanvas, renderWebGL } from './sprite_util';
 
-export default class {
+export class DisplayObject {
+  /**
+   * TBD.
+   */
   constructor() {
     this.exists = true;
     this.renderable = false;

package/src/phaser/display/graphics.js

@@ -1,18 +1,19 @@
 /**
+ * @module display/graphics
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import DisplayObject from './display_object';
-import Image from './image';
-import Rectangle from '../geom/rectangle';
-import RoundedRectangle from '../geom/rounded_rectangle';
-import Polygon from '../geom/polygon';
-import Circle from '../geom/circle';
-import Ellipse from '../geom/ellipse';
-import Point from '../geom/point';
-import GraphicsData from './graphics_data';
-import CanvasBuffer from './canvas/buffer';
+import { DisplayObject } from  './display_object';
+import { Image } from './image';
+import { Rectangle } from  '../geom/rectangle';
+import { RoundedRectangle } from  '../geom/rounded_rectangle';
+import { Polygon } from  '../geom/polygon';
+import { Circle } from  '../geom/circle';
+import { Ellipse } from  '../geom/ellipse';
+import { Point } from '../geom/point';
+import { GraphicsData } from  './graphics_data';
+import { CanvasBuffer } from './canvas/buffer';
 import { textureFromCanvas } from './webgl/texture_util';
 import { renderGraphics as renderCanvasGraphics } from './canvas/graphics';
 import { renderGraphics as renderWebGLGraphics } from './webgl/graphics';
@@ -32,7 +33,14 @@ import {
   GEOM_ROUNDED_RECTANGLE,
 } from '../core/const';
 
-export default class extends DisplayObject {
+export class Graphics extends DisplayObject {
+  /**
+   * TBD.
+   *
+   * @param {object} game - TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   */
   constructor(game, x = 0, y = 0) {
     super();
     this.game = game;

package/src/phaser/display/graphics_data.js

@@ -1,11 +1,12 @@
 /**
+ * @module display/graphics_data
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
 import { clone } from './graphics_data_util';
 
-export default class {
+export class GraphicsData {
   constructor(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) {
     this.lineWidth = lineWidth;
     this.lineColor = lineColor;

package/src/phaser/display/graphics_data_util.js

@@ -1,14 +1,16 @@
 /**
+ * @module display/graphics_data_util
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import GraphicsData from './graphics_data';
+import { GraphicsData } from  './graphics_data';
 
 /**
+ * TBD.
  *
- * @param {object} source TBD
- * @returns {object} TBD
+ * @param {object} source - TBD.
+ * @returns {object} TBD.
  */
 export function clone(source) {
   return new GraphicsData(

package/src/phaser/display/group.js

@@ -1,17 +1,26 @@
 /**
+ * @module display/group
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import DisplayObject from './display_object';
-import Image from './image';
-import Signal from '../core/signal';
+import { DisplayObject } from  './display_object';
+import { Image } from './image';
+import { Signal } from  '../core/signal';
 import { GROUP } from '../core/const';
 
 export const SORT_ASCENDING = -1;
 export const SORT_DESCENDING = 1;
 
-export default class extends DisplayObject {
+export class Group extends DisplayObject {
+  /**
+   * TBD.
+   *
+   * @param {object} game - TBD.
+   * @param {DisplayObject} parent - TBD.
+   * @param {string} name - TBD.
+   * @param {boolean} addToStage - TBD.
+   */
   constructor(game, parent = null, name = 'group', addToStage = false) {
     super();
     this.game = game;

package/src/phaser/display/image.js

@@ -1,18 +1,28 @@
 /**
+ * @module display/image
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import Texture from './webgl/texture';
-import AnimationManager from '../core/animation_manager';
-import EventManager from '../core/event_manager';
-import Rectangle from '../geom/rectangle';
-import DisplayObject from './display_object';
+import { Texture } from './webgl/texture';
+import { AnimationManager } from '../core/animation_manager';
+import { EventManager } from '../core/event_manager';
+import { Rectangle } from  '../geom/rectangle';
+import { DisplayObject } from  './display_object';
 import { clone } from '../geom/util/rectangle';
 import { IMAGE, PENDING_ATLAS, BLEND_NORMAL, SCALE_NEAREST } from '../core/const';
 import { setTexture, getBounds, getLocalBounds, renderCanvas, renderWebGL } from './sprite_util';
 
-export default class extends DisplayObject {
+export class Image extends DisplayObject {
+  /**
+   * TBD.
+   *
+   * @param {object} game - TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {string} key - TBD.
+   * @param {string} frame - TBD.
+   */
   constructor(game, x, y, key, frame) {
     super();
     this.game = game;

package/src/phaser/display/sprite_batch.js

@@ -1,11 +1,17 @@
 /**
+ * @module display/sprite_batch
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import DisplayObject from './display_object';
+import { DisplayObject } from  './display_object';
 
-export default class extends DisplayObject {
+export class SpriteBatch extends DisplayObject {
+  /**
+   * TBD.
+   *
+   * @param {object} game - TBD.
+   */
   constructor(game) {
     super();
     this.game = game;

package/src/phaser/display/sprite_util.js

@@ -1,17 +1,19 @@
 /**
+ * @module display/sprite_util
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
 import { getTintedTexture } from './canvas/tinter';
 import { getIdentityMatrix } from '../geom/util/matrix';
 import { SCALE_LINEAR } from '../core/const';
 
 /**
+ * TBD.
  *
- * @param {object} target TBD
- * @param {object} texture TBD
- * @param {boolean} destroyBase TBD
+ * @param {object} target - TBD.
+ * @param {object} texture - TBD.
+ * @param {boolean} destroyBase - TBD.
  */
 export function setTexture(target, texture, destroyBase = false) {
   if (destroyBase) {
@@ -24,10 +26,11 @@ export function setTexture(target, texture, destroyBase = false) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} target TBD
- * @param {object} matrix TBD
- * @returns {object} TBD
+ * @param {object} target - TBD.
+ * @param {object} matrix - TBD.
+ * @returns {object} TBD.
  */
 export function getBounds(target, matrix = null) {
   // TODO verify
@@ -107,9 +110,10 @@ export function getBounds(target, matrix = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} target TBD
- * @returns {object} TBD
+ * @param {object} target - TBD.
+ * @returns {object} TBD.
  */
 export function getLocalBounds(target) {
   const matrixCache = target.worldTransform;
@@ -127,10 +131,11 @@ export function getLocalBounds(target) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} target TBD
- * @param {object} renderSession TBD
- * @param {object} matrix TBD
+ * @param {object} target - TBD.
+ * @param {object} renderSession - TBD.
+ * @param {object} matrix - TBD.
  */
 export function renderWebGL(target, renderSession, matrix) {
   // if the sprite is not visible or the alpha is 0 then no need to render this element
@@ -176,10 +181,11 @@ export function renderWebGL(target, renderSession, matrix) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} target TBD
- * @param {object} renderSession TBD
- * @param {object} matrix TBD
+ * @param {object} target - TBD.
+ * @param {object} renderSession - TBD.
+ * @param {object} matrix - TBD.
  */
 export function renderCanvas(target, renderSession, matrix) {
   // If the sprite is not visible or the alpha is 0 then no need to render this element

package/src/phaser/display/text.js

@@ -1,18 +1,28 @@
 /**
+ * @module display/text
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import Point from '../geom/point';
-import Rectangle from '../geom/rectangle';
-import Image from './image';
+import { Point } from '../geom/point';
+import { Rectangle } from  '../geom/rectangle';
+import { Image } from './image';
 import { create, remove } from './canvas/pool';
 import { textureFromCanvas } from './webgl/texture_util';
 import { TEXT } from '../core/const';
 import { snapToCeil } from '../util/math';
 import { renderCanvas, renderWebGL, getBounds } from './sprite_util';
 
-export default class extends Image {
+export class Text extends Image {
+  /**
+   * TBD.
+   *
+   * @param {object} game - TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {string} text - TBD.
+   * @param {object} style - TBD.
+   */
   constructor(game, x, y, text = '', style = {}) {
     super(game, x, y, null);
     this.game = game;

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

@@ -1,11 +1,11 @@
 /**
+ * @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
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
 
-export default class {
+export class AbstractFilter {
   constructor(fragmentSrc, uniforms) {
     this.passes = [this];
     this.shaders = [];

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

@@ -1,12 +1,13 @@
 /**
+ * @module display/webgl/base_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
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
 import { removeByCanvas } from '../canvas/pool';
 
-export default class {
+export class BaseTexture {
   constructor(source, scaleMode) {
     this.resolution = 1;
     this.width = 100;

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

@@ -1,11 +1,11 @@
 /**
+ * @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
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
 
-export default class {
+export class WebGLBlendModeManager {
   constructor() {
     this.gl = null;
     this.currentBlendMode = 99999;