@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/display/webgl/renderer.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 {
   RENDER_WEBGL,
   SCALE_LINEAR,
@@ -34,8 +28,13 @@ import * as WebGLMaskManager from './mask_manager';
 import { WebGLFilterManager } from './filter_manager';
 import { WebGLStencilManager } from './stencil_manager';
 import { WebGLBlendModeManager } from './blend_manager';
+import { Game } from '../../core/game';
 
 export class WebGLRenderer {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.type = RENDER_WEBGL;
     this.resolution = game.config.resolution;
@@ -75,6 +74,9 @@ export class WebGLRenderer {
     this.mapBlendModes();
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     window.PhaserRegistry.GL_CONTEXTS[this.glContextId] = null;
     this.projection = null;
@@ -100,6 +102,9 @@ export class WebGLRenderer {
     window.PhaserRegistry.GL_CONTEXT_ID -= 1;
   }
 
+  /**
+   * TBD.
+   */
   initRegistry() {
     if (!window.PhaserRegistry.GL_CONTEXT_ID) {
       window.PhaserRegistry.GL_CONTEXT_ID = 0;
@@ -112,6 +117,9 @@ export class WebGLRenderer {
     }
   }
 
+  /**
+   * TBD.
+   */
   initContext() {
     const gl =
       this.view.getContext('webgl', this._contextOptions) ||
@@ -142,6 +150,10 @@ export class WebGLRenderer {
     this.resize(this.width, this.height);
   }
 
+  /**
+   * TBD.
+   * @param stage
+   */
   render(stage) {
     if (this.contextLost) {
       return;
@@ -160,6 +172,13 @@ export class WebGLRenderer {
     this.renderDisplayObject(stage, this.projection);
   }
 
+  /**
+   * TBD.
+   * @param displayObject
+   * @param projection
+   * @param buffer
+   * @param matrix - TBD.
+   */
   renderDisplayObject(displayObject, projection, buffer, matrix) {
     this.renderSession.blendModeManager.setBlendMode(BLEND_NORMAL);
     // reset the render session data..
@@ -180,6 +199,11 @@ export class WebGLRenderer {
     this.spriteBatch.end();
   }
 
+  /**
+   * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   resize(width, height) {
     this.width = width * this.resolution;
     this.height = height * this.resolution;
@@ -194,6 +218,10 @@ export class WebGLRenderer {
     this.projection.y = -this.height / 2 / this.resolution;
   }
 
+  /**
+   * TBD.
+   * @param texture
+   */
   updateTexture(texture) {
     if (!texture.hasLoaded) {
       return false;
@@ -205,11 +233,7 @@ export class WebGLRenderer {
     gl.bindTexture(gl.TEXTURE_2D, texture._glTextures[gl.id]);
     gl.pixelStorei(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, texture.premultipliedAlpha);
     gl.texImage2D(gl.TEXTURE_2D, 0, gl.RGBA, gl.RGBA, gl.UNSIGNED_BYTE, texture.source);
-    gl.texParameteri(
-      gl.TEXTURE_2D,
-      gl.TEXTURE_MAG_FILTER,
-      texture.scaleMode === SCALE_LINEAR ? gl.LINEAR : gl.NEAREST
-    );
+    gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, texture.scaleMode === SCALE_LINEAR ? gl.LINEAR : gl.NEAREST);
     if (texture.mipmap && isPowerOfTwo(texture.width, texture.height)) {
       gl.texParameteri(
         gl.TEXTURE_2D,
@@ -236,6 +260,9 @@ export class WebGLRenderer {
     return true;
   }
 
+  /**
+   * TBD.
+   */
   mapBlendModes() {
     if (window.PhaserRegistry.blendModesWebGL) {
       return;

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

@@ -1,15 +1,13 @@
-/**
- * @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 { generateShaderID } from '../../../util/math';
 import { compileProgram } from '../util';
 
 // the next one is used for rendering triangle strips
 
 export class ComplexPrimitiveShader {
+  /**
+   * TBD.
+   * @param gl - TBD.
+   */
   constructor(gl) {
     this.gl = gl;
     this._UID = generateShaderID();
@@ -44,6 +42,9 @@ export class ComplexPrimitiveShader {
     this.init();
   }
 
+  /**
+   * TBD.
+   */
   init() {
     const gl = this.gl;
     const program = compileProgram(gl, this.vertexSrc, this.fragmentSrc);
@@ -63,6 +64,9 @@ export class ComplexPrimitiveShader {
     this.program = program;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.gl.deleteProgram(this.program);
     this.uniforms = null;

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

@@ -1,15 +1,13 @@
-/**
- * @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 { generateShaderID } from '../../../util/math';
 import { compileProgram } from '../util';
 
 // this shader is used for the fast sprite rendering
 
 export class FastShader {
+  /**
+   * TBD.
+   * @param gl - TBD.
+   */
   constructor(gl) {
     this.gl = gl;
     this._UID = generateShaderID();
@@ -56,6 +54,9 @@ export class FastShader {
     this.init();
   }
 
+  /**
+   * TBD.
+   */
   init() {
     const gl = this.gl;
     const program = compileProgram(gl, this.vertexSrc, this.fragmentSrc);
@@ -93,6 +94,9 @@ export class FastShader {
     this.program = program;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.gl.deleteProgram(this.program);
     this.uniforms = null;

package/src/phaser/display/webgl/shader/normal.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 { generateShaderID } from '../../../util/math';
 import { compileProgram } from '../util';
 
@@ -30,6 +24,10 @@ const defaultVertexSrc = [
 // this shader is used for the default sprite rendering
 
 export class NormalShader {
+  /**
+   * TBD.
+   * @param gl - TBD.
+   */
   constructor(gl) {
     this.gl = gl;
     this._UID = generateShaderID();
@@ -51,6 +49,9 @@ export class NormalShader {
     this.init();
   }
 
+  /**
+   * TBD.
+   */
   init() {
     const gl = this.gl;
     const program = compileProgram(gl, this.vertexSrc || defaultVertexSrc, this.fragmentSrc);
@@ -84,6 +85,9 @@ export class NormalShader {
     this.program = program;
   }
 
+  /**
+   * TBD.
+   */
   initUniforms() {
     this.textureCount = 1;
     const gl = this.gl;
@@ -125,6 +129,10 @@ export class NormalShader {
     }
   }
 
+  /**
+   * TBD.
+   * @param uniform
+   */
   initSampler2D(uniform) {
     if (!uniform.value || !uniform.value.baseTexture || !uniform.value.baseTexture.hasLoaded) {
       return;
@@ -159,27 +167,10 @@ export class NormalShader {
         const border = data.border ? data.border : 0;
 
         // void texImage2D(GLenum target, GLint level, GLenum internalformat, GLsizei width, GLsizei height, GLint border, GLenum format, GLenum type, ArrayBufferView? pixels);
-        gl.texImage2D(
-          gl.TEXTURE_2D,
-          0,
-          format,
-          width,
-          height,
-          border,
-          format,
-          gl.UNSIGNED_BYTE,
-          null
-        );
+        gl.texImage2D(gl.TEXTURE_2D, 0, format, width, height, border, format, gl.UNSIGNED_BYTE, null);
       } else {
         //  void texImage2D(GLenum target, GLint level, GLenum internalformat, GLenum format, GLenum type, ImageData? pixels);
-        gl.texImage2D(
-          gl.TEXTURE_2D,
-          0,
-          format,
-          gl.RGBA,
-          gl.UNSIGNED_BYTE,
-          uniform.value.baseTexture.source
-        );
+        gl.texImage2D(gl.TEXTURE_2D, 0, format, gl.RGBA, gl.UNSIGNED_BYTE, uniform.value.baseTexture.source);
       }
       gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, magFilter);
       gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MIN_FILTER, minFilter);
@@ -191,6 +182,9 @@ export class NormalShader {
     this.textureCount += 1;
   }
 
+  /**
+   * TBD.
+   */
   syncUniforms() {
     this.textureCount = 1;
     let uniform;
@@ -209,13 +203,7 @@ export class NormalShader {
       } else if (uniform.glValueLength === 2) {
         uniform.glFunc.call(gl, uniform.uniformLocation, uniform.value.x, uniform.value.y);
       } else if (uniform.glValueLength === 3) {
-        uniform.glFunc.call(
-          gl,
-          uniform.uniformLocation,
-          uniform.value.x,
-          uniform.value.y,
-          uniform.value.z
-        );
+        uniform.glFunc.call(gl, uniform.uniformLocation, uniform.value.x, uniform.value.y, uniform.value.z);
       } else if (uniform.glValueLength === 4) {
         uniform.glFunc.call(
           gl,
@@ -244,6 +232,9 @@ export class NormalShader {
     }
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.gl.deleteProgram(this.program);
     this.uniforms = null;

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

@@ -1,15 +1,13 @@
-/**
- * @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 { generateShaderID } from '../../../util/math';
 import { compileProgram } from '../util';
 
 // the next one is used for rendering primitives
 
 export class PrimitiveShader {
+  /**
+   * TBD.
+   * @param gl - TBD.
+   */
   constructor(gl) {
     this.gl = gl;
     this._UID = generateShaderID();
@@ -43,6 +41,9 @@ export class PrimitiveShader {
     this.init();
   }
 
+  /**
+   * TBD.
+   */
   init() {
     const gl = this.gl;
     const program = compileProgram(gl, this.vertexSrc, this.fragmentSrc);
@@ -61,6 +62,9 @@ export class PrimitiveShader {
     this.program = program;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.gl.deleteProgram(this.program);
     this.uniforms = null;

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

@@ -1,15 +1,13 @@
-/**
- * @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 { generateShaderID } from '../../../util/math';
 import { compileProgram } from '../util';
 
 // the next one is used for rendering triangle strips
 
 export class StripShader {
+  /**
+   * TBD.
+   * @param gl - TBD.
+   */
   constructor(gl) {
     this.gl = gl;
     this._UID = generateShaderID();
@@ -47,6 +45,9 @@ export class StripShader {
     this.init();
   }
 
+  /**
+   * TBD.
+   */
   init() {
     const gl = this.gl;
     const program = compileProgram(gl, this.vertexSrc, this.fragmentSrc);
@@ -66,6 +67,9 @@ export class StripShader {
     this.program = program;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.gl.deleteProgram(this.program);
     this.uniforms = null;

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();