@vpmedia/phaser 1.17.0 → 1.19.0

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';
@@ -70,10 +71,11 @@ export class Text extends Image {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param color - TBD.
-   * @param blur
-   * @param shadowStroke
-   * @param shadowFill
+   * @param {string} color - TBD.
+   * @param {number} blur - TBD.
+   * @param {boolean} shadowStroke - TBD.
+   * @param {boolean} shadowFill - TBD.
+   * @returns {Text} TBD.
    */
   setShadow(x = 0, y = 0, color = 'rgba(0, 0, 0, 1)', blur = 0, shadowStroke = true, shadowFill = true) {
     this.style.shadowOffsetX = x;
@@ -88,8 +90,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param style
-   * @param update
+   * @param {object} style - TBD.
+   * @param {boolean} update - TBD.
+   * @returns {Text} TBD.
    */
   setStyle(style = null, update = false) {
     style = JSON.parse(JSON.stringify(style)) || {};
@@ -297,10 +300,10 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line
+   * @param {string} line - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param fill
+   * @param {boolean} fill - TBD.
    */
   renderTabLine(line, x, y, fill) {
     const text = line.split(/(?:\t)/);
@@ -336,7 +339,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param state
+   * @param {string} state - TBD.
    */
   updateShadow(state) {
     if (state) {
@@ -354,7 +357,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line
+   * @param {string} line - TBD.
+   * @returns {number} TBD.
    */
   measureLine(line) {
     let lineLength = 0;
@@ -390,7 +394,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line
+   * @param {string} line - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */
@@ -428,6 +432,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {Text} TBD.
    */
   clearColors() {
     this.colors = [];
@@ -438,6 +443,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {Text} TBD.
    */
   clearFontValues() {
     this.fontStyles = [];
@@ -448,8 +454,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param color - TBD.
-   * @param position - TBD.
+   * @param {number} color - TBD.
+   * @param {number} position - TBD.
+   * @returns {Text} TBD.
    */
   addColor(color, position) {
     this.colors[position] = color;
@@ -459,8 +466,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param color - TBD.
-   * @param position - TBD.
+   * @param {number} color - TBD.
+   * @param {number} position - TBD.
+   * @returns {Text} TBD.
    */
   addStrokeColor(color, position) {
     this.strokeColors[position] = color;
@@ -470,8 +478,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param style
-   * @param position - TBD.
+   * @param {object} style - TBD.
+   * @param {number} position - TBD.
+   * @returns {Text} TBD.
    */
   addFontStyle(style, position) {
     this.fontStyles[position] = style;
@@ -481,8 +490,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param weight
-   * @param position - TBD.
+   * @param {number} weight - TBD.
+   * @param {number} position - TBD.
+   * @returns {Text} TBD.
    */
   addFontWeight(weight, position) {
     this.fontWeights[position] = weight;
@@ -492,7 +502,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string[]} TBD.
    */
   precalculateWordWrap(text) {
     this.texture.baseTexture.resolution = this._res;
@@ -503,7 +514,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string} TBD.
    */
   runWordWrap(text) {
     if (this.useAdvancedWrap) {
@@ -514,7 +526,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string} TBD.
+   * @throws Error.
    */
   advancedWordWrap(text) {
     const context = this.context;
@@ -595,7 +609,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string} TBD.
    */
   basicWordWrap(text) {
     let result = '';
@@ -627,7 +642,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param components
+   * @param {object} components - TBD.
    */
   updateFont(components) {
     const font = this.componentsToFont(components);
@@ -642,7 +657,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param font - TBD.
+   * @param {string} font - TBD.
+   * @returns {object} TBD.
    */
   fontToComponents(font) {
     // The format is specified in http://www.w3.org/TR/CSS2/fonts.html#font-shorthand:
@@ -677,7 +693,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param components
+   * @param {object} components - TBD.
+   * @returns {string} TBD.
    */
   componentsToFont(components) {
     const parts = [];
@@ -711,8 +728,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
-   * @param immediate
+   * @param {string} text - TBD.
+   * @param {boolean} immediate - TBD.
+   * @returns {Text} TBD.
    */
   setText(text, immediate = false) {
     this.text = text.toString() || '';
@@ -726,7 +744,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param list
+   * @param {string[]|string[][]} list - TBD.
+   * @returns {Text} TBD.
    */
   parseList(list) {
     if (!Array.isArray(list)) {
@@ -757,6 +776,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 +839,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
+   * @param {object} renderSession - TBD.
    */
   renderWebGL(renderSession) {
     if (this.dirty) {
@@ -831,7 +851,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
+   * @param {object} renderSession - TBD.
    */
   renderCanvas(renderSession) {
     if (this.dirty) {
@@ -843,6 +863,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {object} TBD.
    */
   getFontPropertiesCache() {
     if (!window.PhaserRegistry.fontPropertiesCache) {
@@ -853,6 +874,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {HTMLCanvasElement} TBD.
    */
   getFontPropertiesCanvas() {
     if (!window.PhaserRegistry.fontPropertiesCanvas) {
@@ -863,6 +885,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {CanvasRenderingContext2D} TBD.
    */
   getFontPropertiesContext() {
     if (!window.PhaserRegistry.fontPropertiesContext) {
@@ -875,7 +898,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param fontStyle
+   * @param {string} fontStyle - TBD.
+   * @returns {object} TBD.
    */
   determineFontProperties(fontStyle) {
     const fontPropertiesCache = this.getFontPropertiesCache();
@@ -953,7 +977,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 {string[]} 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,9 @@
+import { Image } from '../image';
+
 export class FastSpriteBatch {
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   constructor(gl) {
     this.vertSize = 10;
@@ -36,7 +38,7 @@ export class FastSpriteBatch {
 
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   setContext(gl) {
     this.gl = gl;
@@ -53,8 +55,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 +74,7 @@ export class FastSpriteBatch {
 
   /**
    * TBD.
-   * @param spriteBatch
+   * @param spriteBatch - TBD.
    */
   render(spriteBatch) {
     const children = spriteBatch.children;
@@ -96,7 +98,7 @@ export class FastSpriteBatch {
 
   /**
    * TBD.
-   * @param sprite
+   * @param {Image} 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;

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

@@ -3,10 +3,10 @@ import { SCALE_LINEAR } from '../../core/const';
 export class FilterTexture {
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
-   * @param scaleMode
+   * @param {number} scaleMode - TBD.
    */
   constructor(gl, width, height, scaleMode) {
     this.gl = gl;

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

@@ -53,7 +53,7 @@ export function switchMode(webGL, type) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildLine(graphicsData, webGLData) {
   // TODO OPTIMISE!
@@ -218,7 +218,7 @@ export function buildLine(graphicsData, webGLData) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildRectangle(graphicsData, webGLData) {
   //
@@ -301,7 +301,7 @@ export function quadraticBezierCurve(fromX, fromY, cpX, cpY, toX, toY) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildRoundedRectangle(graphicsData, webGLData) {
   const rrectData = graphicsData.shape;
@@ -351,7 +351,7 @@ export function buildRoundedRectangle(graphicsData, webGLData) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildCircle(graphicsData, webGLData) {
   // need to convert points to a nice regular data
@@ -402,7 +402,7 @@ export function buildCircle(graphicsData, webGLData) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildComplexPoly(graphicsData, webGLData) {
   // TODO - no need to copy this as it gets turned into a Float32Array anyways..
@@ -446,7 +446,7 @@ export function buildComplexPoly(graphicsData, webGLData) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  * @returns {boolean} TBD.
  */
 export function buildPoly(graphicsData, webGLData) {

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

@@ -1,7 +1,7 @@
 export class GraphicsData {
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   constructor(gl) {
     this.gl = gl;

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

@@ -4,6 +4,8 @@ import { Texture } from './texture';
 import { BaseTexture } from './base_texture';
 import { FilterTexture } from './filter_texture';
 import { CanvasBuffer } from '../canvas/buffer';
+import { CanvasRenderer } from '../canvas/renderer';
+import { WebGLRenderer } from './renderer';
 import { RENDER_WEBGL } from '../../core/const';
 
 export class RenderTexture extends Texture {
@@ -11,9 +13,9 @@ export class RenderTexture extends Texture {
    * TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
-   * @param renderer
-   * @param scaleMode
-   * @param resolution
+   * @param {WebGLRenderer|CanvasRenderer} renderer - TBD.
+   * @param {number} scaleMode - TBD.
+   * @param {number} resolution - TBD.
    */
   constructor(width, height, renderer, scaleMode, resolution = 1) {
     const w = width || 100;
@@ -79,6 +81,7 @@ export class RenderTexture extends Texture {
 
   /**
    * TBD.
+   * @returns {HTMLImageElement} TBD.
    */
   getImage() {
     const image = new Image();
@@ -88,6 +91,7 @@ export class RenderTexture extends Texture {
 
   /**
    * TBD.
+   * @returns {string} TBD.
    */
   getBase64() {
     return this.getCanvas().toDataURL();
@@ -95,8 +99,10 @@ export class RenderTexture extends Texture {
 
   /**
    * TBD.
+   * @returns {HTMLCanvasElement} TBD.
    */
   getCanvas() {
     // TODO
+    return null;
   }
 }

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

@@ -22,12 +22,16 @@ import {
 import { remove } from '../canvas/pool';
 import { isPowerOfTwo } from '../../util/math';
 import { Point } from '../../geom/point';
+import { Matrix } from '../../geom/matrix';
 import { WebGLShaderManager } from './shader_manager';
 import { WebGLSpriteBatch } from './sprite_batch';
 import * as WebGLMaskManager from './mask_manager';
 import { WebGLFilterManager } from './filter_manager';
 import { WebGLStencilManager } from './stencil_manager';
 import { WebGLBlendModeManager } from './blend_manager';
+import { BaseTexture } from './base_texture';
+import { DisplayObject } from '../../display/display_object';
+import { Stage } from '../../core/stage';
 import { Game } from '../../core/game';
 
 export class WebGLRenderer {
@@ -39,6 +43,7 @@ export class WebGLRenderer {
     this.type = RENDER_WEBGL;
     this.resolution = game.config.resolution;
     this.autoResize = false;
+    this.contextLost = false;
     this.clearBeforeRender = game.config.clearBeforeRender;
     this.width = game.width;
     this.height = game.height;
@@ -119,6 +124,7 @@ export class WebGLRenderer {
 
   /**
    * TBD.
+   * @throws Error.
    */
   initContext() {
     const gl =
@@ -152,7 +158,7 @@ export class WebGLRenderer {
 
   /**
    * TBD.
-   * @param stage
+   * @param {Stage} stage - TBD.
    */
   render(stage) {
     if (this.contextLost) {
@@ -174,10 +180,10 @@ export class WebGLRenderer {
 
   /**
    * TBD.
-   * @param displayObject
-   * @param projection
-   * @param buffer
-   * @param matrix - TBD.
+   * @param {DisplayObject} displayObject - TBD.
+   * @param {Point} projection - TBD.
+   * @param {object} buffer - TBD.
+   * @param {Matrix} matrix - TBD.
    */
   renderDisplayObject(displayObject, projection, buffer, matrix) {
     this.renderSession.blendModeManager.setBlendMode(BLEND_NORMAL);
@@ -220,7 +226,8 @@ export class WebGLRenderer {
 
   /**
    * TBD.
-   * @param texture
+   * @param {BaseTexture} texture - TBD.
+   * @returns {boolean} TBD.
    */
   updateTexture(texture) {
     if (!texture.hasLoaded) {

package/src/phaser/display/webgl/shader/complex.js

@@ -6,7 +6,7 @@ import { compileProgram } from '../util';
 export class ComplexPrimitiveShader {
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   constructor(gl) {
     this.gl = gl;

package/src/phaser/display/webgl/shader/fast.js

@@ -6,7 +6,7 @@ import { compileProgram } from '../util';
 export class FastShader {
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   constructor(gl) {
     this.gl = gl;

package/src/phaser/display/webgl/shader/normal.js

@@ -26,7 +26,7 @@ const defaultVertexSrc = [
 export class NormalShader {
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   constructor(gl) {
     this.gl = gl;
@@ -131,7 +131,7 @@ export class NormalShader {
 
   /**
    * TBD.
-   * @param uniform
+   * @param {object} uniform - TBD.
    */
   initSampler2D(uniform) {
     if (!uniform.value || !uniform.value.baseTexture || !uniform.value.baseTexture.hasLoaded) {

package/src/phaser/display/webgl/shader/primitive.js

@@ -6,7 +6,7 @@ import { compileProgram } from '../util';
 export class PrimitiveShader {
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   constructor(gl) {
     this.gl = gl;

package/src/phaser/display/webgl/shader/strip.js

@@ -6,7 +6,7 @@ import { compileProgram } from '../util';
 export class StripShader {
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   constructor(gl) {
     this.gl = gl;

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

@@ -26,7 +26,7 @@ export class WebGLShaderManager {
 
   /**
    * TBD.
-   * @param gl - TBD.
+   * @param {WebGLRenderingContext} gl - TBD.
    */
   setContext(gl) {
     this.gl = gl;
@@ -40,7 +40,7 @@ export class WebGLShaderManager {
 
   /**
    * TBD.
-   * @param attribs
+   * @param {number[]} attribs - TBD.
    */
   setAttribs(attribs) {
     // reset temp state
@@ -68,7 +68,8 @@ export class WebGLShaderManager {
 
   /**
    * TBD.
-   * @param shader
+   * @param {NormalShader} shader - TBD.
+   * @returns {boolean} TBD.
    */
   setShader(shader) {
     if (this._currentId === shader._UID) {