@vpmedia/phaser 1.94.0 → 1.96.0

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

@@ -5,8 +5,8 @@ import { triangulate } from './earcut.js';
 import { GraphicsData } from './graphics_data.js';
 
 /**
- * TBD.
- * @returns {number} TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @returns {number} The number of vertices in the graphics data.
  */
 export const getStencilBufferLimit = () => {
   if (!window.PhaserRegistry.stencilBufferLimit) {
@@ -16,8 +16,8 @@ export const getStencilBufferLimit = () => {
 };
 
 /**
- * TBD.
- * @returns {object[]} TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @returns {object[]} The graphics data array.
  */
 export const getGraphicsDataPool = () => {
   if (!window.PhaserRegistry.graphicsDataPool) {
@@ -27,10 +27,10 @@ export const getGraphicsDataPool = () => {
 };
 
 /**
- * TBD.
- * @param {object} webGL - TBD.
- * @param {number} type - TBD.
- * @returns {object} TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @param {object} webGL - The WebGL context.
+ * @param {number} type - The type of graphics data to create.
+ * @returns {object} The newly created graphics data object.
  */
 export const switchMode = (webGL, type) => {
   let webGLData;
@@ -51,9 +51,9 @@ export const switchMode = (webGL, type) => {
 };
 
 /**
- * TBD.
- * @param {object} graphicsData - TBD.
- * @param {GraphicsData} webGLData - TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @param {object} graphicsData - The graphics data to update.
+ * @param {GraphicsData} webGLData - The WebGL graphics data object.
  */
 export const buildLine = (graphicsData, webGLData) => {
   // TODO OPTIMISE!
@@ -216,9 +216,9 @@ export const buildLine = (graphicsData, webGLData) => {
 };
 
 /**
- * TBD.
- * @param {object} graphicsData - TBD.
- * @param {GraphicsData} webGLData - TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @param {object} graphicsData - The graphics data to update.
+ * @param {GraphicsData} webGLData - The WebGL graphics data object.
  */
 export const buildRectangle = (graphicsData, webGLData) => {
   //
@@ -260,14 +260,14 @@ export const buildRectangle = (graphicsData, webGLData) => {
 };
 
 /**
- * TBD.
- * @param {number} fromX - TBD.
- * @param {number} fromY - TBD.
- * @param {number} cpX - TBD.
- * @param {number} cpY - TBD.
- * @param {number} toX - TBD.
- * @param {number} toY - TBD.
- * @returns {number[]} TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @param {number} fromX - The starting x-coordinate.
+ * @param {number} fromY - The starting y-coordinate.
+ * @param {number} cpX - The control point x-coordinate.
+ * @param {number} cpY - The control point y-coordinate.
+ * @param {number} toX - The ending x-coordinate.
+ * @param {number} toY - The ending y-coordinate.
+ * @returns {number[]} The calculated points for the quadratic bezier curve.
  */
 export const quadraticBezierCurve = (fromX, fromY, cpX, cpY, toX, toY) => {
   let xa;
@@ -299,9 +299,9 @@ export const quadraticBezierCurve = (fromX, fromY, cpX, cpY, toX, toY) => {
 };
 
 /**
- * TBD.
- * @param {object} graphicsData - TBD.
- * @param {GraphicsData} webGLData - TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @param {object} graphicsData - The graphics data to update.
+ * @param {GraphicsData} webGLData - The WebGL graphics data object.
  */
 export const buildRoundedRectangle = (graphicsData, webGLData) => {
   const rrectData = graphicsData.shape;
@@ -349,9 +349,9 @@ export const buildRoundedRectangle = (graphicsData, webGLData) => {
 };
 
 /**
- * TBD.
- * @param {object} graphicsData - TBD.
- * @param {GraphicsData} webGLData - TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @param {object} graphicsData - The graphics data to update.
+ * @param {GraphicsData} webGLData - The WebGL graphics data object.
  */
 export const buildCircle = (graphicsData, webGLData) => {
   // need to convert points to a nice regular data
@@ -400,9 +400,9 @@ export const buildCircle = (graphicsData, webGLData) => {
 };
 
 /**
- * TBD.
- * @param {object} graphicsData - TBD.
- * @param {GraphicsData} webGLData - TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @param {object} graphicsData - The graphics data to update.
+ * @param {GraphicsData} webGLData - The WebGL graphics data object.
  */
 export const buildComplexPoly = (graphicsData, webGLData) => {
   // TODO - no need to copy this as it gets turned into a Float32Array anyways..
@@ -444,7 +444,7 @@ export const buildComplexPoly = (graphicsData, webGLData) => {
 };
 
 /**
- * TBD.
+ * Updates the graphics data for WebGL rendering.
  * @param {object} graphicsData - TBD.
  * @param {GraphicsData} webGLData - TBD.
  * @returns {boolean} TBD.
@@ -484,8 +484,8 @@ export const buildPoly = (graphicsData, webGLData) => {
 
 /**
  * TBD.
- * @param {object} graphics - TBD.
- * @param {WebGLRenderingContext & { id: number }} gl - TBD.
+ * @param {import('../graphics.js').Graphics} graphics - The graphics object to update.
+ * @param {WebGLRenderingContext & { id: number }} gl - The WebGL rendering context.
  */
 export const updateGraphics = (graphics, gl) => {
   const stencilBufferLimit = getStencilBufferLimit();
@@ -572,9 +572,9 @@ export const updateGraphics = (graphics, gl) => {
 };
 
 /**
- * TBD.
- * @param {object} graphics - TBD.
- * @param {object} renderSession - TBD.
+ * Updates the graphics data for WebGL rendering.
+ * @param {import('../graphics.js').Graphics} graphics - The graphics object to update.
+ * @param {object} renderSession - The rendering session.
  */
 export const renderGraphics = (graphics, renderSession) => {
   const gl = renderSession.gl;

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

@@ -1,7 +1,7 @@
 export class GraphicsData {
   /**
-   * TBD.
-   * @param {WebGLRenderingContext} gl - TBD.
+   * Creates a new GraphicsData instance.
+   * @param {WebGLRenderingContext} gl - The WebGL rendering context.
    */
   constructor(gl) {
     this.gl = gl;
@@ -17,7 +17,7 @@ export class GraphicsData {
   }
 
   /**
-   * TBD.
+   * Destroys this graphics data and cleans up resources.
    */
   reset() {
     this.points = [];
@@ -27,7 +27,7 @@ export class GraphicsData {
   }
 
   /**
-   * TBD.
+   * Updates the graphics data for WebGL rendering.
    */
   upload() {
     const gl = this.gl;

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

@@ -1,9 +1,9 @@
 import { updateGraphics } from './graphics.js';
 
 /**
- * TBD.
- * @param {object} maskData - TBD.
- * @param {object} renderSession - TBD.
+ * Sets up the mask manager for WebGL rendering.
+ * @param {object} maskData - The mask data to apply.
+ * @param {object} renderSession - The rendering session.
  */
 export const pushMask = (maskData, renderSession) => {
   const gl = renderSession.gl;
@@ -21,9 +21,9 @@ export const pushMask = (maskData, renderSession) => {
 };
 
 /**
- * TBD.
- * @param {object} maskData - TBD.
- * @param {object} renderSession - TBD.
+ * Sets up the mask manager for WebGL rendering.
+ * @param {object} maskData - The mask data to apply.
+ * @param {object} renderSession - The rendering session.
  */
 export const popMask = (maskData, renderSession) => {
   const gl = renderSession.gl;

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

@@ -8,12 +8,12 @@ import { Texture } from './texture.js';
 
 export class RenderTexture extends Texture {
   /**
-   * TBD.
-   * @param {number} width - TBD.
-   * @param {number} height - TBD.
-   * @param {import('./renderer.js').WebGLRenderer|import('../canvas/renderer.js').CanvasRenderer} renderer - TBD.
-   * @param {number} scaleMode - TBD.
-   * @param {number} resolution - TBD.
+   * Creates a new RenderTexture instance.
+   * @param {number} width - The width of the render texture.
+   * @param {number} height - The height of the render texture.
+   * @param {import('./renderer.js').WebGLRenderer|import('../canvas/renderer.js').CanvasRenderer} renderer - The renderer to use.
+   * @param {number} scaleMode - The scale mode to use.
+   * @param {number} resolution - The resolution to use.
    */
   constructor(width, height, renderer, scaleMode, resolution = 1) {
     const w = width || 100;
@@ -51,36 +51,36 @@ export class RenderTexture extends Texture {
   }
 
   /**
-   * TBD.
+   * Destroys this render texture and cleans up resources.
    */
   resize() {
     // TODO
   }
 
   /**
-   * TBD.
+   * Updates the size of this render texture.
    */
   clear() {
     // TODO
   }
 
   /**
-   * TBD.
+   * Updates the resolution of this render texture.
    */
   renderWebGL() {
     // TODO
   }
 
   /**
-   * TBD.
+   * Updates the scale mode of this render texture.
    */
   renderCanvas() {
     // TODO
   }
 
   /**
-   * TBD.
-   * @returns {HTMLImageElement} TBD.
+   * Gets the HTML image element for this render texture.
+   * @returns {HTMLImageElement} The HTML image element.
    */
   getImage() {
     const image = new Image();
@@ -89,16 +89,16 @@ export class RenderTexture extends Texture {
   }
 
   /**
-   * TBD.
-   * @returns {string} TBD.
+   * Gets the base64 string representation of this render texture.
+   * @returns {string} The base64 string representation.
    */
   getBase64() {
     return this.getCanvas().toDataURL();
   }
 
   /**
-   * TBD.
-   * @returns {HTMLCanvasElement} TBD.
+   * Gets the canvas element for this render texture.
+   * @returns {HTMLCanvasElement} The canvas element.
    */
   getCanvas() {
     // TODO

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

@@ -33,10 +33,11 @@ import { getWebGLContextErrorCode, getWebGLContextErrorName } from './util.js';
 
 export class WebGLRenderer {
   /**
-   * TBD.
-   * @param {import('../../core/game.js').Game} game - TBD.
+   * Creates a new WebGLRenderer instance.
+   * @param {import('../../core/game.js').Game} game - The game instance.
    */
   constructor(game) {
+    /** @type {number} */
     this.type = RENDER_WEBGL;
     this.resolution = game.config.resolution;
     this.autoResize = false;
@@ -77,7 +78,7 @@ export class WebGLRenderer {
   }
 
   /**
-   * TBD.
+   * Destroys this renderer and cleans up resources.
    */
   destroy() {
     window.PhaserRegistry.GL_CONTEXTS[this.glContextId] = null;
@@ -105,7 +106,7 @@ export class WebGLRenderer {
   }
 
   /**
-   * TBD.
+   * Initializes the WebGL registry.
    */
   initRegistry() {
     if (!window.PhaserRegistry.GL_CONTEXT_ID) {
@@ -120,8 +121,8 @@ export class WebGLRenderer {
   }
 
   /**
-   * TBD.
-   * @param {import('../../core/game.js').Game} game - TBD.
+   * Initializes the WebGL context for rendering.
+   * @param {import('../../core/game.js').Game} game - The game instance.
    * @throws {Error}
    */
   initContext(game) {
@@ -165,8 +166,8 @@ export class WebGLRenderer {
   }
 
   /**
-   * TBD.
-   * @param {import('../../core/stage.js').Stage} stage - TBD.
+   * Renders the stage to WebGL.
+   * @param {import('../../core/stage.js').Stage} stage - The root stage to render.
    */
   render(stage) {
     if (this.contextLost) {
@@ -187,11 +188,11 @@ export class WebGLRenderer {
   }
 
   /**
-   * TBD.
-   * @param {import('../../display/display_object.js').DisplayObject} displayObject - TBD.
-   * @param {Point} projection - TBD.
-   * @param {object} buffer - TBD.
-   * @param {import('../../geom/matrix.js').Matrix} matrix - TBD.
+   * Renders a display object to WebGL.
+   * @param {import('../../display/display_object.js').DisplayObject} displayObject - The display object to render.
+   * @param {Point} projection - The projection matrix.
+   * @param {object} buffer - The render buffer.
+   * @param {import('../../geom/matrix.js').Matrix} matrix - The transformation matrix.
    */
   renderDisplayObject(displayObject, projection, buffer, matrix) {
     this.renderSession.blendModeManager.setBlendMode(BLEND_NORMAL);
@@ -214,9 +215,9 @@ export class WebGLRenderer {
   }
 
   /**
-   * TBD.
-   * @param {number} width - TBD.
-   * @param {number} height - TBD.
+   * Resizes the WebGL canvas to the specified dimensions.
+   * @param {number} width - The new width of the canvas.
+   * @param {number} height - The new height of the canvas.
    */
   resize(width, height) {
     this.width = width * this.resolution;
@@ -233,9 +234,9 @@ export class WebGLRenderer {
   }
 
   /**
-   * TBD.
-   * @param {import('./base_texture.js').BaseTexture} texture - TBD.
-   * @returns {boolean} TBD.
+   * Updates a texture in the WebGL context.
+   * @param {import('./base_texture.js').BaseTexture} texture - The base texture to update.
+   * @returns {boolean} Whether the update was successful.
    */
   updateTexture(texture) {
     if (!texture.hasLoaded) {
@@ -276,7 +277,7 @@ export class WebGLRenderer {
   }
 
   /**
-   * TBD.
+   * Maps blend modes to WebGL rendering operations.
    */
   mapBlendModes() {
     if (window.PhaserRegistry.blendModesWebGL) {

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

@@ -5,8 +5,8 @@ import { compileProgram } from '../util.js';
 
 export class ComplexPrimitiveShader {
   /**
-   * TBD.
-   * @param {WebGLRenderingContext} gl - TBD.
+   * Creates a new ComplexShader instance.
+   * @param {WebGLRenderingContext} gl - The WebGL rendering context.
    */
   constructor(gl) {
     this.gl = gl;
@@ -44,7 +44,7 @@ export class ComplexPrimitiveShader {
   }
 
   /**
-   * TBD.
+   * Destroys this shader and cleans up resources.
    */
   init() {
     const gl = this.gl;
@@ -66,7 +66,7 @@ export class ComplexPrimitiveShader {
   }
 
   /**
-   * TBD.
+   * Binds this shader to the WebGL context.
    */
   destroy() {
     this.gl.deleteProgram(this.program);

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

@@ -5,8 +5,8 @@ import { compileProgram } from '../util.js';
 
 export class FastShader {
   /**
-   * TBD.
-   * @param {WebGLRenderingContext} gl - TBD.
+   * Creates a new FastShader instance.
+   * @param {WebGLRenderingContext} gl - The WebGL rendering context.
    */
   constructor(gl) {
     this.gl = gl;
@@ -56,7 +56,7 @@ export class FastShader {
   }
 
   /**
-   * TBD.
+   * Creates a new FastShader instance.
    */
   init() {
     const gl = this.gl;
@@ -96,7 +96,7 @@ export class FastShader {
   }
 
   /**
-   * TBD.
+   * Destroys this shader and cleans up resources.
    */
   destroy() {
     this.gl.deleteProgram(this.program);

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

@@ -25,8 +25,8 @@ const defaultVertexSrc = [
 
 export class NormalShader {
   /**
-   * TBD.
-   * @param {WebGLRenderingContext & { id: number }} gl - TBD.
+   * Creates a new NormalShader instance.
+   * @param {WebGLRenderingContext & { id: number }} gl - The WebGL rendering context.
    */
   constructor(gl) {
     this.gl = gl;
@@ -53,7 +53,7 @@ export class NormalShader {
   }
 
   /**
-   * TBD.
+   * Destroys this shader and cleans up resources.
    */
   init() {
     const gl = this.gl;
@@ -89,7 +89,7 @@ export class NormalShader {
   }
 
   /**
-   * TBD.
+   * Binds this shader to the WebGL context.
    */
   initUniforms() {
     this.textureCount = 1;
@@ -133,8 +133,8 @@ export class NormalShader {
   }
 
   /**
-   * TBD.
-   * @param {object} uniform - TBD.
+   * Sets a uniform value for this shader.
+   * @param {object} uniform - The uniform to set.
    */
   initSampler2D(uniform) {
     if (!uniform.value || !uniform.value.baseTexture || !uniform.value.baseTexture.hasLoaded) {
@@ -186,7 +186,7 @@ export class NormalShader {
   }
 
   /**
-   * TBD.
+   * Sets the shader to use for rendering.
    */
   syncUniforms() {
     this.textureCount = 1;
@@ -236,7 +236,7 @@ export class NormalShader {
   }
 
   /**
-   * TBD.
+   * Destroys this shader and cleans up resources.
    */
   destroy() {
     this.gl.deleteProgram(this.program);

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

@@ -5,8 +5,8 @@ import { compileProgram } from '../util.js';
 
 export class PrimitiveShader {
   /**
-   * TBD.
-   * @param {WebGLRenderingContext} gl - TBD.
+   * Creates a new PrimitiveShader instance.
+   * @param {WebGLRenderingContext} gl - The WebGL rendering context.
    */
   constructor(gl) {
     this.gl = gl;
@@ -43,7 +43,7 @@ export class PrimitiveShader {
   }
 
   /**
-   * TBD.
+   * Destroys this shader and cleans up resources.
    */
   init() {
     const gl = this.gl;
@@ -64,7 +64,7 @@ export class PrimitiveShader {
   }
 
   /**
-   * TBD.
+   * Binds this shader to the WebGL context.
    */
   destroy() {
     this.gl.deleteProgram(this.program);

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

@@ -5,8 +5,8 @@ import { compileProgram } from '../util.js';
 
 export class StripShader {
   /**
-   * TBD.
-   * @param {WebGLRenderingContext} gl - TBD.
+   * Creates a new StripShader instance.
+   * @param {WebGLRenderingContext} gl - The WebGL rendering context.
    */
   constructor(gl) {
     this.gl = gl;
@@ -47,7 +47,7 @@ export class StripShader {
   }
 
   /**
-   * TBD.
+   * Destroys this shader and cleans up resources.
    */
   init() {
     const gl = this.gl;
@@ -69,7 +69,7 @@ export class StripShader {
   }
 
   /**
-   * TBD.
+   * Binds this shader to the WebGL context.
    */
   destroy() {
     this.gl.deleteProgram(this.program);

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

@@ -6,7 +6,7 @@ import { StripShader } from './shader/strip.js';
 
 export class WebGLShaderManager {
   /**
-   * TBD.
+   * Initializes the shader manager with a WebGL context.
    */
   constructor() {
     this.gl = null;
@@ -25,8 +25,8 @@ export class WebGLShaderManager {
   }
 
   /**
-   * TBD.
-   * @param {WebGLRenderingContext & { id: number }} gl - TBD.
+   * Initializes the shader manager with a WebGL context.
+   * @param {WebGLRenderingContext & { id: number }} gl - The WebGL rendering context.
    */
   setContext(gl) {
     this.gl = gl;
@@ -39,8 +39,8 @@ export class WebGLShaderManager {
   }
 
   /**
-   * TBD.
-   * @param {number[]} attribs - TBD.
+   * Sets up the shader manager for WebGL rendering.
+   * @param {number[]} attribs - The attribute locations to set up.
    */
   setAttribs(attribs) {
     // reset temp state
@@ -67,9 +67,9 @@ export class WebGLShaderManager {
   }
 
   /**
-   * TBD.
-   * @param {NormalShader} shader - TBD.
-   * @returns {boolean} TBD.
+   * Sets up the shader manager for WebGL rendering.
+   * @param {NormalShader} shader - The shader to set up.
+   * @returns {boolean} Whether the shader setup was successful.
    */
   setShader(shader) {
     if (this._currentId === shader._UID) {
@@ -83,7 +83,7 @@ export class WebGLShaderManager {
   }
 
   /**
-   * TBD.
+   * Destroys the manager.
    */
   destroy() {
     this.attribState = null;