@vpmedia/phaser 1.17.0 → 1.18.0

package/src/phaser/display/graphics.js

@@ -7,6 +7,7 @@ import { Polygon } from '../geom/polygon';
 import { Circle } from '../geom/circle';
 import { Ellipse } from '../geom/ellipse';
 import { Point } from '../geom/point';
+import { Matrix } from '../geom/matrix';
 import { GraphicsData } from './graphics_data';
 import { CanvasBuffer } from './canvas/buffer';
 import { textureFromCanvas } from './webgl/texture_util';
@@ -51,6 +52,7 @@ export class Graphics extends DisplayObject {
     this._localBounds = new Rectangle(0, 0, 1, 1);
     this.dirty = true;
     this._boundsDirty = false;
+    this._cacheAsBitmap = false;
     this.webGLDirty = false;
     this.cachedSpriteDirty = false;
   }
@@ -66,9 +68,10 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param lineWidth - TBD.
-   * @param color - TBD.
-   * @param alpha - TBD.
+   * @param {number} lineWidth - TBD.
+   * @param {number} color - TBD.
+   * @param {number} alpha - TBD.
+   * @returns {Graphics} TBD.
    */
   lineStyle(lineWidth = 0, color = 0, alpha = 1) {
     this.lineWidth = lineWidth || 0;
@@ -92,6 +95,7 @@ export class Graphics extends DisplayObject {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
+   * @returns {Graphics} TBD.
    */
   moveTo(x, y) {
     this.drawShape(new Polygon([x, y]));
@@ -102,6 +106,7 @@ export class Graphics extends DisplayObject {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
+   * @returns {Graphics} TBD.
    */
   lineTo(x, y) {
     if (!this.currentPath) {
@@ -115,10 +120,11 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param cpX - TBD.
-   * @param cpY - TBD.
-   * @param toX - TBD.
-   * @param toY - TBD.
+   * @param {number} cpX - TBD.
+   * @param {number} cpY - TBD.
+   * @param {number} toX - TBD.
+   * @param {number} toY - TBD.
+   * @returns {Graphics} TBD.
    */
   quadraticCurveTo(cpX, cpY, toX, toY) {
     if (this.currentPath) {
@@ -151,12 +157,13 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param cpX - TBD.
-   * @param cpY - TBD.
-   * @param cpX2 - TBD.
-   * @param cpY2 - TBD.
-   * @param toX - TBD.
-   * @param toY - TBD.
+   * @param {number} cpX - TBD.
+   * @param {number} cpY - TBD.
+   * @param {number} cpX2 - TBD.
+   * @param {number} cpY2 - TBD.
+   * @param {number} toX - TBD.
+   * @param {number} toY - TBD.
+   * @returns {Graphics} TBD.
    */
   bezierCurveTo(cpX, cpY, cpX2, cpY2, toX, toY) {
     if (this.currentPath) {
@@ -195,11 +202,12 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param x1 - TBD.
-   * @param y1 - TBD.
-   * @param x2 - TBD.
-   * @param y2 - TBD.
-   * @param radius - TBD.
+   * @param {number} x1 - TBD.
+   * @param {number} y1 - TBD.
+   * @param {number} x2 - TBD.
+   * @param {number} y2 - TBD.
+   * @param {number} radius - TBD.
+   * @returns {Graphics} TBD.
    */
   arcTo(x1, y1, x2, y2, radius) {
     if (this.currentPath) {
@@ -246,13 +254,14 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param cx - TBD.
-   * @param cy - TBD.
-   * @param radius - TBD.
-   * @param startAngle - TBD.
-   * @param endAngle - TBD.
-   * @param anticlockwise - TBD.
-   * @param segments - TBD.
+   * @param {number} cx - TBD.
+   * @param {number} cy - TBD.
+   * @param {number} radius - TBD.
+   * @param {number} startAngle - TBD.
+   * @param {number} endAngle - TBD.
+   * @param {boolean} anticlockwise - TBD.
+   * @param {number} segments - TBD.
+   * @returns {Graphics} TBD.
    */
   arc(cx, cy, radius, startAngle, endAngle, anticlockwise = false, segments = 40) {
     //  If we do this we can never draw a full circle
@@ -299,8 +308,9 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param color - TBD.
-   * @param alpha - TBD.
+   * @param {number} color - TBD.
+   * @param {number} alpha - TBD.
+   * @returns {Graphics} TBD.
    */
   beginFill(color = 0, alpha = 1) {
     this.filling = true;
@@ -318,6 +328,7 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
+   * @returns {Graphics} TBD.
    */
   endFill() {
     this.filling = false;
@@ -332,6 +343,7 @@ export class Graphics extends DisplayObject {
    * @param {number} y - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
+   * @returns {Graphics} TBD.
    */
   drawRect(x, y, width, height) {
     this.drawShape(new Rectangle(x, y, width, height));
@@ -344,7 +356,8 @@ export class Graphics extends DisplayObject {
    * @param {number} y - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
-   * @param radius - TBD.
+   * @param {number} radius - TBD.
+   * @returns {Graphics} TBD.
    */
   drawRoundedRect(x, y, width, height, radius) {
     this.drawShape(new RoundedRectangle(x, y, width, height, radius));
@@ -355,7 +368,8 @@ export class Graphics extends DisplayObject {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param diameter - TBD.
+   * @param {number} diameter - TBD.
+   * @returns {Graphics} TBD.
    */
   drawCircle(x, y, diameter) {
     this.drawShape(new Circle(x, y, diameter));
@@ -368,6 +382,7 @@ export class Graphics extends DisplayObject {
    * @param {number} y - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
+   * @returns {Graphics} TBD.
    */
   drawEllipse(x, y, width, height) {
     this.drawShape(new Ellipse(x, y, width, height));
@@ -376,7 +391,8 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param path - TBD.
+   * @param {Polygon} path - TBD.
+   * @returns {Graphics} TBD.
    */
   drawPolygon(path) {
     let points;
@@ -400,6 +416,7 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
+   * @returns {Graphics} TBD.
    */
   clear() {
     this.lineWidth = 0;
@@ -422,7 +439,7 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
+   * @param {object} renderSession - TBD.
    */
   renderWebGL(renderSession) {
     // if the sprite is not visible or the alpha is 0 then no need to render this element
@@ -482,7 +499,7 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
+   * @param {object} renderSession - TBD.
    */
   renderCanvas(renderSession) {
     // if the sprite is not visible or the alpha is 0 then no need to render this element
@@ -538,7 +555,8 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param matrix - TBD.
+   * @param {Matrix} matrix - TBD.
+   * @returns {Rectangle} TBD.
    */
   getBounds(matrix = null) {
     if (!this.renderable) {
@@ -598,6 +616,7 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
+   * @returns {Rectangle} TBD.
    */
   getLocalBounds() {
     const matrixCache = this.worldTransform;
@@ -615,8 +634,9 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param point - TBD.
-   * @param tempPoint - TBD.
+   * @param {Point} point - TBD.
+   * @param {Point} tempPoint - TBD.
+   * @returns {boolean} TBD.
    */
   containsPoint(point, tempPoint) {
     this.worldTransform.applyInverse(point, tempPoint);
@@ -772,6 +792,7 @@ export class Graphics extends DisplayObject {
   /**
    * TBD.
    * @param shape - TBD.
+   * @returns {GraphicsData} TBD.
    */
   drawShape(shape) {
     if (this.currentPath) {
@@ -842,7 +863,7 @@ export class Graphics extends DisplayObject {
    * TBD.
    * @param vertices - TBD.
    * @param indices - TBD.
-   * @param cull - TBD.
+   * @param {boolean} cull - TBD.
    */
   drawTriangles(vertices, indices, cull = false) {
     const point1 = new Point();

package/src/phaser/display/graphics_data.js

@@ -3,13 +3,13 @@ import { clone } from './graphics_data_util';
 export class GraphicsData {
   /**
    * TBD.
-   * @param lineWidth - TBD.
-   * @param lineColor - TBD.
-   * @param lineAlpha - TBD.
-   * @param fillColor - TBD.
-   * @param fillAlpha - TBD.
-   * @param fill - TBD.
-   * @param shape - TBD.
+   * @param {number} lineWidth - TBD.
+   * @param {number} lineColor - TBD.
+   * @param {number} lineAlpha - TBD.
+   * @param {number} fillColor - TBD.
+   * @param {number} fillAlpha - TBD.
+   * @param {boolean} fill - TBD.
+   * @param {object} shape - TBD.
    */
   constructor(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) {
     this.lineWidth = lineWidth;

package/src/phaser/display/image.js

@@ -2,6 +2,7 @@ import { Texture } from './webgl/texture';
 import { AnimationManager } from '../core/animation_manager';
 import { EventManager } from '../core/event_manager';
 import { Rectangle } from '../geom/rectangle';
+import { Matrix } from '../geom/matrix';
 import { DisplayObject } from './display_object';
 import { Game } from '../core/game';
 import { clone } from '../geom/util/rectangle';
@@ -96,7 +97,7 @@ export class Image extends DisplayObject {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param frame - TBD.
+   * @param {number} frame - TBD.
    * @param {boolean} stopAnimation - TBD.
    */
   loadTexture(key, frame = 0, stopAnimation = true) {
@@ -184,7 +185,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param parent
+   * @param parent - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
    */
@@ -235,8 +236,8 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param rect
-   * @param copy
+   * @param rect - TBD.
+   * @param {boolean} copy - TBD.
    */
   crop(rect, copy = false) {
     if (rect) {
@@ -289,6 +290,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get width() {
     return this.scale.x * this.texture.frame.width;
@@ -304,6 +306,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get height() {
     return this.scale.y * this.texture.frame.height;
@@ -332,8 +335,8 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param texture
-   * @param destroyBase
+   * @param texture - TBD.
+   * @param {boolean} destroyBase - TBD.
    */
   setTexture(texture, destroyBase = false) {
     setTexture(this, texture, destroyBase);
@@ -341,7 +344,8 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param matrix - TBD.
+   * @param {Matrix} matrix - TBD.
+   * @returns {Rectangle} TBD.
    */
   getBounds(matrix = null) {
     return getBounds(this, matrix);
@@ -349,6 +353,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
+   * @returns {Rectangle} TBD.
    */
   getLocalBounds() {
     return getLocalBounds(this);
@@ -356,8 +361,8 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
-   * @param matrix - TBD.
+   * @param {object} renderSession - TBD.
+   * @param {Matrix} matrix - TBD.
    */
   renderWebGL(renderSession, matrix = null) {
     renderWebGL(this, renderSession, matrix);
@@ -365,8 +370,8 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
-   * @param matrix - TBD.
+   * @param {object} renderSession - TBD.
+   * @param {Matrix} matrix - TBD.
    */
   renderCanvas(renderSession, matrix = null) {
     renderCanvas(this, renderSession, matrix);

package/src/phaser/display/sprite_util.js

@@ -1,5 +1,6 @@
 import { getTintedTexture } from './canvas/tinter';
 import { getIdentityMatrix } from '../geom/util/matrix';
+import { Rectangle } from '../geom/rectangle';
 import { SCALE_LINEAR } from '../core/const';
 
 /**
@@ -22,7 +23,7 @@ export function setTexture(target, texture, destroyBase = false) {
  * TBD.
  * @param {object} target - TBD.
  * @param {object} matrix - TBD.
- * @returns {object} TBD.
+ * @returns {Rectangle} TBD.
  */
 export function getBounds(target, matrix = null) {
   // TODO verify
@@ -104,7 +105,7 @@ export function getBounds(target, matrix = null) {
 /**
  * TBD.
  * @param {object} target - TBD.
- * @returns {object} TBD.
+ * @returns {Rectangle} TBD.
  */
 export function getLocalBounds(target) {
   const matrixCache = target.worldTransform;

package/src/phaser/display/text.js

@@ -1,5 +1,6 @@
 import { Point } from '../geom/point';
 import { Rectangle } from '../geom/rectangle';
+import { Matrix } from '../geom/matrix';
 import { Image } from './image';
 import { create, remove } from './canvas/pool';
 import { textureFromCanvas } from './webgl/texture_util';
@@ -71,9 +72,9 @@ export class Text extends Image {
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param color - TBD.
-   * @param blur
-   * @param shadowStroke
-   * @param shadowFill
+   * @param blur - TBD.
+   * @param shadowStroke - TBD.
+   * @param shadowFill - TBD.
    */
   setShadow(x = 0, y = 0, color = 'rgba(0, 0, 0, 1)', blur = 0, shadowStroke = true, shadowFill = true) {
     this.style.shadowOffsetX = x;
@@ -297,10 +298,10 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line
+   * @param line - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param fill
+   * @param fill - TBD.
    */
   renderTabLine(line, x, y, fill) {
     const text = line.split(/(?:\t)/);
@@ -354,7 +355,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line
+   * @param line - TBD.
    */
   measureLine(line) {
     let lineLength = 0;
@@ -390,7 +391,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line
+   * @param line - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */
@@ -428,6 +429,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {Text} TBD.
    */
   clearColors() {
     this.colors = [];
@@ -438,6 +440,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {Text} TBD.
    */
   clearFontValues() {
     this.fontStyles = [];
@@ -450,6 +453,7 @@ export class Text extends Image {
    * TBD.
    * @param color - TBD.
    * @param position - TBD.
+   * @returns {Text} TBD.
    */
   addColor(color, position) {
     this.colors[position] = color;
@@ -461,6 +465,7 @@ export class Text extends Image {
    * TBD.
    * @param color - TBD.
    * @param position - TBD.
+   * @returns {Text} TBD.
    */
   addStrokeColor(color, position) {
     this.strokeColors[position] = color;
@@ -470,8 +475,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param style
+   * @param style - TBD.
    * @param position - TBD.
+   * @returns {Text} TBD.
    */
   addFontStyle(style, position) {
     this.fontStyles[position] = style;
@@ -481,8 +487,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param weight
+   * @param weight - TBD.
    * @param position - TBD.
+   * @returns {Text} TBD.
    */
   addFontWeight(weight, position) {
     this.fontWeights[position] = weight;
@@ -643,6 +650,7 @@ export class Text extends Image {
   /**
    * TBD.
    * @param font - TBD.
+   * @returns {object} TBD.
    */
   fontToComponents(font) {
     // The format is specified in http://www.w3.org/TR/CSS2/fonts.html#font-shorthand:
@@ -677,7 +685,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param components
+   * @param components - TBD.
    */
   componentsToFont(components) {
     const parts = [];
@@ -712,7 +720,8 @@ export class Text extends Image {
   /**
    * TBD.
    * @param text - TBD.
-   * @param immediate
+   * @param immediate - TBD.
+   * @returns {Text} TBD.
    */
   setText(text, immediate = false) {
     this.text = text.toString() || '';
@@ -727,6 +736,7 @@ export class Text extends Image {
   /**
    * TBD.
    * @param list
+   * @returns {Text} TBD.
    */
   parseList(list) {
     if (!Array.isArray(list)) {
@@ -757,6 +767,7 @@ export class Text extends Image {
    * @param {number} y - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
+   * @returns {Text} TBD.
    */
   setTextBounds(x, y, width, height) {
     if (x === undefined) {
@@ -819,7 +830,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
+   * @param {object} renderSession - TBD.
    */
   renderWebGL(renderSession) {
     if (this.dirty) {
@@ -831,7 +842,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
+   * @param {object} renderSession - TBD.
    */
   renderCanvas(renderSession) {
     if (this.dirty) {
@@ -843,6 +854,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {object} TBD.
    */
   getFontPropertiesCache() {
     if (!window.PhaserRegistry.fontPropertiesCache) {
@@ -853,6 +865,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {HTMLCanvasElement} TBD.
    */
   getFontPropertiesCanvas() {
     if (!window.PhaserRegistry.fontPropertiesCanvas) {
@@ -953,7 +966,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param matrix - TBD.
+   * @param {Matrix} matrix - TBD.
    * @returns {Rectangle} TBD.
    */
   getBounds(matrix = null) {

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

@@ -1,8 +1,8 @@
 export class AbstractFilter {
   /**
    * TBD.
-   * @param fragmentSrc
-   * @param uniforms
+   * @param fragmentSrc - TBD.
+   * @param {object} uniforms - TBD.
    */
   constructor(fragmentSrc, uniforms) {
     this.passes = [this];

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

@@ -3,8 +3,8 @@ import { removeByCanvas } from '../canvas/pool';
 export class BaseTexture {
   /**
    * TBD.
-   * @param source
-   * @param scaleMode
+   * @param {HTMLCanvasElement} source - TBD.
+   * @param {number} scaleMode - TBD.
    */
   constructor(source, scaleMode) {
     this.resolution = 1;

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

@@ -9,7 +9,7 @@ export class WebGLBlendModeManager {
 
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   setContext(gl) {
     this.gl = gl;
@@ -17,7 +17,8 @@ export class WebGLBlendModeManager {
 
   /**
    * TBD.
-   * @param blendMode
+   * @param {number} blendMode - TBD.
+   * @returns {boolean} TBD.
    */
   setBlendMode(blendMode) {
     if (this.currentBlendMode === blendMode) {

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

@@ -1,7 +1,7 @@
 export class Node {
   /**
    * TBD.
-   * @param i
+   * @param {number} i - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */

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

@@ -1,7 +1,7 @@
 export class FastSpriteBatch {
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   constructor(gl) {
     this.vertSize = 10;
@@ -36,7 +36,7 @@ export class FastSpriteBatch {
 
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   setContext(gl) {
     this.gl = gl;
@@ -53,8 +53,8 @@ export class FastSpriteBatch {
 
   /**
    * TBD.
-   * @param spriteBatch
-   * @param renderSession - TBD.
+   * @param spriteBatch - TBD.
+   * @param {object} renderSession - TBD.
    */
   begin(spriteBatch, renderSession) {
     this.renderSession = renderSession;
@@ -72,7 +72,7 @@ export class FastSpriteBatch {
 
   /**
    * TBD.
-   * @param spriteBatch
+   * @param spriteBatch - TBD.
    */
   render(spriteBatch) {
     const children = spriteBatch.children;
@@ -96,7 +96,7 @@ export class FastSpriteBatch {
 
   /**
    * TBD.
-   * @param sprite
+   * @param sprite - TBD.
    */
   renderSprite(sprite) {
     if (!sprite.visible) {

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

@@ -10,7 +10,7 @@ export class WebGLFilterManager {
 
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   setContext(gl) {
     this.gl = gl;