@vpmedia/phaser 1.94.0 → 1.96.0

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

@@ -3,7 +3,7 @@ import { NormalShader } from './shader/normal.js';
 
 export class WebGLSpriteBatch {
   /**
-   * TBD.
+   * Creates a new SpriteBatch instance.
    */
   constructor() {
     this.vertSize = 5;
@@ -45,8 +45,8 @@ export class WebGLSpriteBatch {
   }
 
   /**
-   * TBD.
-   * @param {WebGLRenderingContext & { id: number }} gl - TBD.
+   * Renders a sprite using WebGL.
+   * @param {WebGLRenderingContext & { id: number }} gl - The WebGL rendering context.
    */
   setContext(gl) {
     this.gl = gl;
@@ -68,8 +68,8 @@ export class WebGLSpriteBatch {
   }
 
   /**
-   * TBD.
-   * @param {object} renderSession - TBD.
+   * Renders the sprite batch using WebGL.
+   * @param {object} renderSession - The render session to use.
    */
   begin(renderSession) {
     this.renderSession = renderSession;
@@ -78,16 +78,16 @@ export class WebGLSpriteBatch {
   }
 
   /**
-   * TBD.
+   * Updates the sprite batch.
    */
   end() {
     this.flush();
   }
 
   /**
-   * TBD.
-   * @param {import('../../display/image.js').Image} sprite - TBD.
-   * @param {import('../../geom/matrix.js').Matrix} matrix - TBD.
+   * Renders a sprite using the sprite batch.
+   * @param {import('../../display/image.js').Image} sprite - The sprite to render.
+   * @param {import('../../geom/matrix.js').Matrix} matrix - The transformation matrix.
    */
   render(sprite, matrix) {
     const texture = sprite.texture;
@@ -187,14 +187,14 @@ export class WebGLSpriteBatch {
   }
 
   /**
-   * TBD.
+   * Binds the sprite batch to the WebGL context.
    */
   renderTilingSprite() {
     // TODO
   }
 
   /**
-   * TBD.
+   * Updates the sprite batch.
    */
   flush() {
     // If the batch is length 0 then return as there is nothing to draw
@@ -293,10 +293,10 @@ export class WebGLSpriteBatch {
   }
 
   /**
-   * TBD.
-   * @param {import('./base_texture.js').BaseTexture} texture - TBD.
-   * @param {number} size - TBD.
-   * @param {number} startIndex - TBD.
+   * Updates the sprite batch with a new texture.
+   * @param {import('./base_texture.js').BaseTexture} texture - The texture to use.
+   * @param {number} size - The size of the batch.
+   * @param {number} startIndex - The start index in the batch.
    */
   renderBatch(texture, size, startIndex) {
     if (size === 0) {
@@ -320,7 +320,7 @@ export class WebGLSpriteBatch {
   }
 
   /**
-   * TBD.
+   * Destroys this sprite batch and cleans up resources.
    */
   stop() {
     this.flush();
@@ -328,14 +328,14 @@ export class WebGLSpriteBatch {
   }
 
   /**
-   * TBD.
+   * Renders the sprite batch using Canvas.
    */
   start() {
     this.dirty = true;
   }
 
   /**
-   * TBD.
+   * Destroys the sprite batch instance.
    */
   destroy() {
     this.vertices = null;

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

@@ -2,7 +2,7 @@ import { hex2rgb } from '../../util/math.js';
 
 export class WebGLStencilManager {
   /**
-   * TBD.
+   * Initializes the stencil manager.
    */
   constructor() {
     this.stencilStack = [];
@@ -11,15 +11,15 @@ export class WebGLStencilManager {
   }
 
   /**
-   * TBD.
-   * @param {WebGLRenderingContext} gl - TBD.
+   * Binds the stencil buffer for rendering.
+   * @param {WebGLRenderingContext} gl - The WebGL rendering context.
    */
   setContext(gl) {
     this.gl = gl;
   }
 
   /**
-   * TBD.
+   * Sets up the stencil buffer for rendering.
    */
   destroy() {
     this.stencilStack = null;
@@ -27,10 +27,10 @@ export class WebGLStencilManager {
   }
 
   /**
-   * TBD.
-   * @param {import('../graphics.js').Graphics} graphics - TBD.
-   * @param {import('./graphics_data.js').GraphicsData} webGLData - TBD.
-   * @param {object} renderSession - TBD.
+   * Renders the stencil buffer for graphics.
+   * @param {import('../graphics.js').Graphics} graphics - The graphics object to render.
+   * @param {import('./graphics_data.js').GraphicsData} webGLData - The WebGL graphics data.
+   * @param {object} renderSession - The rendering session.
    */
   pushStencil(graphics, webGLData, renderSession) {
     const gl = renderSession.gl;
@@ -85,10 +85,10 @@ export class WebGLStencilManager {
   }
 
   /**
-   * TBD.
-   * @param {import('../graphics.js').Graphics} graphics - TBD.
-   * @param {import('./graphics_data.js').GraphicsData} webGLData - TBD.
-   * @param {object} renderSession - TBD.
+   * Renders the stencil buffer for graphics.
+   * @param {import('../graphics.js').Graphics} graphics - The graphics object to render.
+   * @param {import('./graphics_data.js').GraphicsData} webGLData - The WebGL graphics data.
+   * @param {object} renderSession - The rendering session.
    */
   bindGraphics(graphics, webGLData, renderSession) {
     // if(this._currentGraphics === graphics)return;
@@ -132,10 +132,10 @@ export class WebGLStencilManager {
   }
 
   /**
-   * TBD.
-   * @param {import('../graphics.js').Graphics} graphics - TBD.
-   * @param {import('./graphics_data.js').GraphicsData} webGLData - TBD.
-   * @param {object} renderSession - TBD.
+   * Renders the stencil buffer for graphics.
+   * @param {import('../graphics.js').Graphics} graphics - The graphics object to render.
+   * @param {import('./graphics_data.js').GraphicsData} webGLData - The WebGL graphics data.
+   * @param {object} renderSession - The rendering session.
    */
   popStencil(graphics, webGLData, renderSession) {
     const gl = renderSession.gl;

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

@@ -2,7 +2,7 @@ import { Rectangle } from '../../geom/rectangle.js';
 
 export class TextureUvs {
   /**
-   * TBD.
+   * Creates a new Texture instance.
    */
   constructor() {
     this.x0 = 0;
@@ -18,11 +18,11 @@ export class TextureUvs {
 
 export class Texture {
   /**
-   * TBD.
-   * @param {import('./base_texture.js').BaseTexture} baseTexture - TBD.
-   * @param {Rectangle | null | undefined} frame - TBD.
-   * @param {Rectangle | null | undefined} crop - TBD.
-   * @param {Rectangle | null | undefined} trim - TBD.
+   * Creates a new Texture instance.
+   * @param {import('./base_texture.js').BaseTexture} baseTexture - The base texture to use.
+   * @param {Rectangle | null | undefined} frame - The frame rectangle.
+   * @param {Rectangle | null | undefined} crop - The crop rectangle.
+   * @param {Rectangle | null | undefined} trim - The trim rectangle.
    */
   constructor(baseTexture, frame = null, crop = null, trim = null) {
     this.noFrame = false;
@@ -63,7 +63,7 @@ export class Texture {
   }
 
   /**
-   * TBD.
+   * Destroys this texture and cleans up resources.
    */
   onBaseTextureLoaded() {
     if (this.noFrame) {
@@ -73,8 +73,8 @@ export class Texture {
   }
 
   /**
-   * TBD.
-   * @param {boolean} destroyBase - TBD.
+   * Destroys this texture and cleans up resources.
+   * @param {boolean} destroyBase - Whether to destroy the base texture as well.
    */
   destroy(destroyBase = false) {
     if (destroyBase) {
@@ -84,9 +84,9 @@ export class Texture {
   }
 
   /**
-   * TBD.
-   * @param {Rectangle} frame - TBD.
-   * @throws {Error}.
+   * Sets the frame of this texture.
+   * @param {Rectangle} frame - The new frame rectangle.
+   * @throws {Error} If the operation fails.
    */
   setFrame(frame) {
     this.noFrame = false;
@@ -124,7 +124,7 @@ export class Texture {
   }
 
   /**
-   * TBD.
+   * Updates the texture UVs based on the crop frame.
    */
   _updateUvs() {
     if (!this._uvs) {

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

@@ -2,10 +2,10 @@ import { BaseTexture } from './base_texture.js';
 import { Texture } from './texture.js';
 
 /**
- * TBD.
- * @param {HTMLCanvasElement} canvas - TBD.
- * @param {number} scaleMode - TBD.
- * @returns {object} TBD.
+ * Creates a new BaseTexture from a canvas element.
+ * @param {HTMLCanvasElement} canvas - The canvas element to use as the texture source.
+ * @param {number} [scaleMode] - The scale mode to use for the texture.
+ * @returns {BaseTexture} The newly created BaseTexture instance.
  */
 export const baseTextureFromCanvas = (canvas, scaleMode) => {
   if (canvas.width === 0) {
@@ -18,10 +18,10 @@ export const baseTextureFromCanvas = (canvas, scaleMode) => {
 };
 
 /**
- * TBD.
- * @param {HTMLCanvasElement} canvas - TBD.
- * @param {number} scaleMode - TBD.
- * @returns {object} TBD.
+ * Creates a new Texture from a canvas element.
+ * @param {HTMLCanvasElement} canvas - The canvas element to use as the texture source.
+ * @param {number} [scaleMode] - The scale mode to use for the texture.
+ * @returns {Texture} The newly created Texture instance.
  */
 export const textureFromCanvas = (canvas, scaleMode) => {
   return new Texture(baseTextureFromCanvas(canvas, scaleMode));

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

@@ -14,18 +14,18 @@ export const OUT_OF_MEMORY = 0x0505;
 export const CONTEXT_LOST_WEBGL = 0x9242;
 
 /**
- * TBD.
- * @param {WebGLRenderingContext} gl - TBD.
- * @returns {number} TBD.
+ * Gets the WebGL context error code.
+ * @param {WebGLRenderingContext} gl - The WebGL rendering context.
+ * @returns {number} The error code from the WebGL context.
  */
 export const getWebGLContextErrorCode = (gl) => {
   return gl?.getError() ?? 0;
 };
 
 /**
- * TBD.
- * @param {number} errorCode - TBD.
- * @returns {string} TBD.
+ * Gets the WebGL context error name from an error code.
+ * @param {number} errorCode - The error code to look up.
+ * @returns {string} The name of the WebGL error.
  */
 export const getWebGLContextErrorName = (errorCode) => {
   switch (errorCode) {
@@ -49,16 +49,16 @@ export const getWebGLContextErrorName = (errorCode) => {
 };
 
 /**
- * TBD.
+ * Initializes default shaders.
  */
 export const initDefaultShaders = () => {};
 
 /**
- * TBD.
- * @param {WebGLRenderingContext} gl - TBD.
- * @param {string[]|string} shaderSrc - TBD.
- * @param {object} shaderType - TBD.
- * @returns {WebGLShader} TBD.
+ * Compiles a WebGL shader.
+ * @param {WebGLRenderingContext} gl - The WebGL rendering context.
+ * @param {string[]|string} shaderSrc - The shader source code.
+ * @param {object} shaderType - The type of shader to compile.
+ * @returns {WebGLShader} The compiled WebGL shader or null if compilation failed.
  */
 export const compileShader = (gl, shaderSrc, shaderType) => {
   const src = Array.isArray(shaderSrc) ? shaderSrc.join('\n') : shaderSrc;
@@ -76,31 +76,31 @@ export const compileShader = (gl, shaderSrc, shaderType) => {
 };
 
 /**
- * TBD.
- * @param {WebGLRenderingContext} gl - TBD.
- * @param {string[]|string} shaderSrc - TBD.
- * @returns {WebGLShader} TBD.
+ * Compiles a WebGL vertex shader.
+ * @param {WebGLRenderingContext} gl - The WebGL rendering context.
+ * @param {string[]|string} shaderSrc - The vertex shader source code.
+ * @returns {WebGLShader} The compiled WebGL vertex shader or null if compilation failed.
  */
 export const compileVertexShader = (gl, shaderSrc) => {
   return compileShader(gl, shaderSrc, gl.VERTEX_SHADER);
 };
 
 /**
- * TBD.
- * @param {WebGLRenderingContext} gl - TBD.
- * @param {string[]|string} shaderSrc - TBD.
- * @returns {WebGLShader} TBD.
+ * Compiles a WebGL fragment shader.
+ * @param {WebGLRenderingContext} gl - The WebGL rendering context.
+ * @param {string[]|string} shaderSrc - The fragment shader source code.
+ * @returns {WebGLShader} The compiled WebGL fragment shader or null if compilation failed.
  */
 export const compileFragmentShader = (gl, shaderSrc) => {
   return compileShader(gl, shaderSrc, gl.FRAGMENT_SHADER);
 };
 
 /**
- * TBD.
- * @param {WebGLRenderingContext} gl - TBD.
- * @param {string[]|string} vertexSrc - TBD.
- * @param {string[]|string} fragmentSrc - TBD.
- * @returns {WebGLProgram} TBD.
+ * Compiles a WebGL shader program.
+ * @param {WebGLRenderingContext} gl - The WebGL rendering context.
+ * @param {string[]|string} vertexSrc - The vertex shader source code.
+ * @param {string[]|string} fragmentSrc - The fragment shader source code.
+ * @returns {WebGLProgram} The compiled WebGL shader program or null if compilation failed.
  */
 export const compileProgram = (gl, vertexSrc, fragmentSrc) => {
   const fragmentShader = compileFragmentShader(gl, fragmentSrc);