@vpmedia/phaser 1.14.0 → 1.16.0

package/src/phaser/display/image.js

@@ -1,14 +1,9 @@
-/**
- * @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>
- */
 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 { Rectangle } from '../geom/rectangle';
+import { DisplayObject } from './display_object';
+import { Game } from '../core/game';
 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';
@@ -16,8 +11,7 @@ import { setTexture, getBounds, getLocalBounds, renderCanvas, renderWebGL } from
 export class Image extends DisplayObject {
   /**
    * TBD.
-   *
-   * @param {object} game - TBD.
+   * @param {Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} key - TBD.
@@ -48,6 +42,9 @@ export class Image extends DisplayObject {
     this.loadTexture(key, frame);
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.game = null;
     this.key = null;
@@ -69,6 +66,9 @@ export class Image extends DisplayObject {
     super.destroy();
   }
 
+  /**
+   * TBD.
+   */
   preUpdate() {
     if (this.pendingDestroy) {
       this.destroy();
@@ -92,6 +92,12 @@ export class Image extends DisplayObject {
 
   // LoadTexture
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param frame - TBD.
+   * @param stopAnimation - TBD.
+   */
   loadTexture(key, frame = 0, stopAnimation = true) {
     if (key === PENDING_ATLAS) {
       key = frame;
@@ -130,6 +136,10 @@ export class Image extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param frame - TBD.
+   */
   setFrame(frame) {
     this._frame = frame;
     this.texture.frame.x = frame.x;
@@ -171,35 +181,61 @@ export class Image extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param parent
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   resizeFrame(parent, width, height) {
     this.texture.frame.resize(width, height);
     this.texture.setFrame(this.texture.frame);
   }
 
+  /**
+   * TBD.
+   */
   resetFrame() {
     if (this._frame) {
       this.setFrame(this._frame);
     }
   }
 
+  /**
+   * TBD.
+   */
   get frame() {
     return this.animations.frame;
   }
 
+  /**
+   * TBD.
+   */
   set frame(value) {
     this.animations.frame = value;
   }
 
+  /**
+   * TBD.
+   */
   get frameName() {
     return this.animations.frameName;
   }
 
+  /**
+   * TBD.
+   */
   set frameName(value) {
     this.animations.frameName = value;
   }
 
   // Crop
 
+  /**
+   * TBD.
+   * @param rect
+   * @param copy
+   */
   crop(rect, copy = false) {
     if (rect) {
       if (copy && this.cropRect !== null) {
@@ -217,6 +253,9 @@ export class Image extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   updateCrop() {
     if (!this.cropRect) {
       return;
@@ -246,24 +285,39 @@ export class Image extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   get width() {
     return this.scale.x * this.texture.frame.width;
   }
 
+  /**
+   * TBD.
+   */
   set width(value) {
     this.scale.x = value / this.texture.frame.width;
     this._width = value;
   }
 
+  /**
+   * TBD.
+   */
   get height() {
     return this.scale.y * this.texture.frame.height;
   }
 
+  /**
+   * TBD.
+   */
   set height(value) {
     this.scale.y = value / this.texture.frame.height;
     this._height = value;
   }
 
+  /**
+   * TBD.
+   */
   onTextureUpdate() {
     // so if _width is 0 then width was not set..
     if (this._width) {
@@ -274,22 +328,44 @@ export class Image extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param texture
+   * @param destroyBase
+   */
   setTexture(texture, destroyBase = false) {
     setTexture(this, texture, destroyBase);
   }
 
+  /**
+   * TBD.
+   * @param matrix - TBD.
+   */
   getBounds(matrix = null) {
     return getBounds(this, matrix);
   }
 
+  /**
+   * TBD.
+   */
   getLocalBounds() {
     return getLocalBounds(this);
   }
 
+  /**
+   * TBD.
+   * @param renderSession - TBD.
+   * @param matrix - TBD.
+   */
   renderWebGL(renderSession, matrix = null) {
     renderWebGL(this, renderSession, matrix);
   }
 
+  /**
+   * TBD.
+   * @param renderSession - TBD.
+   * @param matrix - TBD.
+   */
   renderCanvas(renderSession, matrix = null) {
     renderCanvas(this, renderSession, matrix);
   }

package/src/phaser/display/sprite_batch.js

@@ -1,16 +1,10 @@
-/**
- * @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>
- */
-import { DisplayObject } from  './display_object';
+import { Game } from '../core/game';
+import { DisplayObject } from './display_object';
 
 export class SpriteBatch extends DisplayObject {
   /**
    * TBD.
-   *
-   * @param {object} game - TBD.
+   * @param {Game} game - TBD.
    */
   constructor(game) {
     super();

package/src/phaser/display/sprite_util.js

@@ -1,16 +1,9 @@
-/**
- * @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>
- */
 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.
@@ -27,7 +20,6 @@ export function setTexture(target, texture, destroyBase = false) {
 
 /**
  * TBD.
- *
  * @param {object} target - TBD.
  * @param {object} matrix - TBD.
  * @returns {object} TBD.
@@ -111,7 +103,6 @@ export function getBounds(target, matrix = null) {
 
 /**
  * TBD.
- *
  * @param {object} target - TBD.
  * @returns {object} TBD.
  */
@@ -132,7 +123,6 @@ export function getLocalBounds(target) {
 
 /**
  * TBD.
- *
  * @param {object} target - TBD.
  * @param {object} renderSession - TBD.
  * @param {object} matrix - TBD.
@@ -182,7 +172,6 @@ export function renderWebGL(target, renderSession, matrix) {
 
 /**
  * TBD.
- *
  * @param {object} target - TBD.
  * @param {object} renderSession - TBD.
  * @param {object} matrix - TBD.
@@ -217,13 +206,9 @@ export function renderCanvas(target, renderSession, matrix) {
     renderSession.context.globalAlpha = target.worldAlpha;
 
     //  If smoothingEnabled is supported and we need to change the smoothing property for this texture
-    if (
-      renderSession.smoothProperty &&
-      renderSession.scaleMode !== target.texture.baseTexture.scaleMode
-    ) {
+    if (renderSession.smoothProperty && renderSession.scaleMode !== target.texture.baseTexture.scaleMode) {
       renderSession.scaleMode = target.texture.baseTexture.scaleMode;
-      renderSession.context[renderSession.smoothProperty] =
-        renderSession.scaleMode === SCALE_LINEAR;
+      renderSession.context[renderSession.smoothProperty] = renderSession.scaleMode === SCALE_LINEAR;
     }
     //  If the texture is trimmed we offset by the trim x/y, otherwise we use the frame dimensions
     let dx = target.texture.trim
@@ -252,17 +237,7 @@ export function renderCanvas(target, renderSession, matrix) {
         target.cachedTint = target.tint;
         target.texture.requiresReTint = false;
       }
-      renderSession.context.drawImage(
-        target.tintedTexture,
-        0,
-        0,
-        cw,
-        ch,
-        dx,
-        dy,
-        cw / resolution,
-        ch / resolution
-      );
+      renderSession.context.drawImage(target.tintedTexture, 0, 0, cw, ch, dx, dy, cw / resolution, ch / resolution);
     } else {
       const cx = target.texture.crop.x;
       const cy = target.texture.crop.y;