@vpmedia/phaser 1.94.0 → 1.96.0

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

@@ -27,11 +27,12 @@ import { getSmoothingPrefix } from './util.js';
 
 export class CanvasRenderer {
   /**
-   * TBD.
-   * @param {import('../../core/game.js').Game} game - TBD.
+   * Creates a new CanvasRenderer instance.
+   * @param {import('../../core/game.js').Game} game - The game instance.
    */
   constructor(game) {
     detectCapabilities(game);
+    /** @type {number} */
     this.type = RENDER_CANVAS;
     this.resolution = game.config.resolution;
     this.clearBeforeRender = game.config.clearBeforeRender;
@@ -61,8 +62,8 @@ export class CanvasRenderer {
   }
 
   /**
-   * TBD.
-   * @param {import('../../core/stage.js').Stage} root - TBD.
+   * Renders the stage to canvas.
+   * @param {import('../../core/stage.js').Stage} root - The root stage to render.
    */
   render(root) {
     if (!this.context) {
@@ -86,8 +87,8 @@ export class CanvasRenderer {
   }
 
   /**
-   * TBD.
-   * @param {boolean} removeView - TBD.
+   * Destroys this renderer and cleans up resources.
+   * @param {boolean} removeView - Whether to remove the view from the DOM.
    */
   destroy(removeView = true) {
     if (removeView && this.view.parent) {
@@ -99,9 +100,9 @@ export class CanvasRenderer {
   }
 
   /**
-   * TBD.
-   * @param {number} width - TBD.
-   * @param {number} height - TBD.
+   * Resizes the 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;
@@ -118,10 +119,10 @@ export class CanvasRenderer {
   }
 
   /**
-   * TBD.
-   * @param {import('../../display/image.js').Image} displayObject - TBD.
-   * @param {CanvasRenderingContext2D} context - TBD.
-   * @param {import('../../geom/matrix.js').Matrix} matrix - TBD.
+   * Renders a display object to canvas.
+   * @param {import('../../display/image.js').Image} displayObject - The display object to render.
+   * @param {CanvasRenderingContext2D} context - The canvas rendering context.
+   * @param {import('../../geom/matrix.js').Matrix} matrix - The transformation matrix.
    */
   renderDisplayObject(displayObject, context, matrix) {
     this.renderSession.context = context || this.context;
@@ -130,7 +131,7 @@ export class CanvasRenderer {
   }
 
   /**
-   * TBD.
+   * Maps blend modes to canvas rendering operations.
    */
   mapBlendModes() {
     if (window.PhaserRegistry.blendModesCanvas) {
@@ -159,8 +160,8 @@ export class CanvasRenderer {
   }
 
   /**
-   * 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.
    */
   initContext(game) {
     // stub

package/src/phaser/display/canvas/tinter.js

@@ -3,10 +3,10 @@ import { hex2rgb } from '../../util/math.js';
 import { create, removeByCanvas } from './pool.js';
 
 /**
- * TBD.
- * @param {object} sprite - TBD.
- * @param {object} color - TBD.
- * @returns {object} TBD.
+ * Tints a sprite with the given color.
+ * @param {object} sprite - The sprite to tint.
+ * @param {object} color - The color to tint with.
+ * @returns {object} The tinted sprite.
  */
 export const getTintedTexture = (sprite, color) => {
   const canvas = sprite.tintedTexture || create('CanvasTinter', 1, 1);
@@ -15,11 +15,11 @@ export const getTintedTexture = (sprite, color) => {
 };
 
 /**
- * TBD.
- * @param {object} texture - TBD.
- * @param {object} color - TBD.
- * @param {HTMLCanvasElement} canvas - TBD.
- * @throws {Error} TBD.
+ * Tints a texture with the given color.
+ * @param {object} texture - The texture to tint.
+ * @param {object} color - The color to tint with.
+ * @param {HTMLCanvasElement} canvas - The canvas to render to.
+ * @throws {Error} If the operation fails.
  */
 export const tintWithMultiply = (texture, color, canvas) => {
   const context = canvas.getContext('2d', { willReadFrequently: false });
@@ -41,11 +41,11 @@ export const tintWithMultiply = (texture, color, canvas) => {
 };
 
 /**
- * TBD.
- * @param {object} texture - TBD.
- * @param {object} color - TBD.
- * @param {HTMLCanvasElement} canvas - TBD.
- * @throws {Error} TBD.
+ * Tints a texture with the given color.
+ * @param {object} texture - The texture to tint.
+ * @param {object} color - The color to tint with.
+ * @param {HTMLCanvasElement} canvas - The canvas to render to.
+ * @throws {Error} If the operation fails.
  */
 export const tintWithPerPixel = (texture, color, canvas) => {
   const context = canvas.getContext('2d', { willReadFrequently: false });
@@ -79,9 +79,9 @@ export const tintWithPerPixel = (texture, color, canvas) => {
 };
 
 /**
- * TBD.
- * @returns {boolean} TBD.
- * @throws {Error} TBD.
+ * Checks if the tinter can handle the given texture.
+ * @returns {boolean} True if the tinter can handle the texture, false otherwise.
+ * @throws {Error} If the operation fails.
  */
 export const checkInverseAlpha = () => {
   // Check for DOM
@@ -121,9 +121,9 @@ export const checkInverseAlpha = () => {
 };
 
 /**
- * TBD.
- * @returns {boolean} TBD.
- * @throws {Error} TBD.
+ * Checks if the tinter can handle the given texture.
+ * @returns {boolean} True if the tinter can handle the texture, false otherwise.
+ * @throws {Error} If the operation fails.
  */
 export const canUseNewCanvasBlendModes = () => {
   // Check for DOM
@@ -163,8 +163,8 @@ export const canUseNewCanvasBlendModes = () => {
 };
 
 /**
- * TBD.
- * @param {import('../../core/game.js').Game} game - TBD.
+ * Creates a new Tinter instance.
+ * @param {import('../../core/game.js').Game} game - The game instance.
  */
 export const detectCapabilities = (game) => {
   if (!window.PhaserRegistry) {

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

@@ -1,13 +1,13 @@
 import { create as createCanvas } from './pool.js';
 
 /**
- * TBD.
- * @param {object} parent - TBD.
- * @param {number} width - TBD.
- * @param {number} height - TBD.
- * @param {string} id - TBD.
- * @param {boolean} skipPool - TBD.
- * @returns {HTMLCanvasElement} TBD.
+ * Creates a new HTML canvas element.
+ * @param {object} parent - The parent element to append the canvas to.
+ * @param {number} width - The width of the canvas.
+ * @param {number} height - The height of the canvas.
+ * @param {string} id - The ID to assign to the canvas.
+ * @param {boolean} skipPool - Whether to skip using the canvas pool.
+ * @returns {HTMLCanvasElement} The created HTML canvas element.
  */
 export const create = (parent, width, height, id, skipPool) => {
   width = width || 256;
@@ -23,10 +23,10 @@ export const create = (parent, width, height, id, skipPool) => {
 };
 
 /**
- * TBD.
- * @param {HTMLCanvasElement} canvas - TBD.
- * @param {string} color - TBD.
- * @returns {object} TBD.
+ * Sets the background color of a canvas element.
+ * @param {HTMLCanvasElement} canvas - The canvas element to modify.
+ * @param {string} color - The background color to set.
+ * @returns {HTMLCanvasElement} The modified canvas element.
  */
 export const setBackgroundColor = (canvas, color) => {
   color = color || 'rgb(0,0,0)';
@@ -35,10 +35,10 @@ export const setBackgroundColor = (canvas, color) => {
 };
 
 /**
- * TBD.
- * @param {HTMLCanvasElement} canvas - TBD.
- * @param {string} value - TBD.
- * @returns {object} TBD.
+ * Sets the touch action property of a canvas element.
+ * @param {HTMLCanvasElement} canvas - The canvas element to modify.
+ * @param {string} value - The touch action value to set.
+ * @returns {HTMLCanvasElement} The modified canvas element.
  */
 export const setTouchAction = (canvas, value = 'none') => {
   value = value || 'none';
@@ -50,10 +50,10 @@ export const setTouchAction = (canvas, value = 'none') => {
 };
 
 /**
- * TBD.
- * @param {HTMLCanvasElement} canvas - TBD.
- * @param {string} value - TBD.
- * @returns {object} TBD.
+ * Sets the user select property of a canvas element.
+ * @param {HTMLCanvasElement} canvas - The canvas element to modify.
+ * @param {string} value - The user select value to set.
+ * @returns {HTMLCanvasElement} The modified canvas element.
  */
 export const setUserSelect = (canvas, value = 'none') => {
   value = value || 'none';
@@ -68,11 +68,11 @@ export const setUserSelect = (canvas, value = 'none') => {
 };
 
 /**
- * TBD.
- * @param {HTMLCanvasElement} canvas - TBD.
- * @param {object} parent - TBD.
- * @param {boolean} overflowHidden - TBD.
- * @returns {object} TBD.
+ * Adds a canvas element to the DOM.
+ * @param {HTMLCanvasElement} canvas - The canvas element to add.
+ * @param {object} parent - The parent element to append the canvas to.
+ * @param {boolean} overflowHidden - Whether to set overflow hidden on the parent.
+ * @returns {HTMLCanvasElement} The added canvas element.
  */
 export const addToDOM = (canvas, parent, overflowHidden = true) => {
   let target;
@@ -97,8 +97,8 @@ export const addToDOM = (canvas, parent, overflowHidden = true) => {
 };
 
 /**
- * TBD.
- * @param {HTMLCanvasElement} canvas - TBD.
+ * Removes a canvas element from the DOM.
+ * @param {HTMLCanvasElement} canvas - The canvas element to remove.
  */
 export const removeFromDOM = (canvas) => {
   if (canvas && canvas.parentNode) {
@@ -107,15 +107,15 @@ export const removeFromDOM = (canvas) => {
 };
 
 /**
- * TBD.
- * @param {object} context - TBD.
- * @param {number} translateX - TBD.
- * @param {number} translateY - TBD.
- * @param {number} scaleX - TBD.
- * @param {number} scaleY - TBD.
- * @param {number} skewX - TBD.
- * @param {number} skewY - TBD.
- * @returns {object} TBD.
+ * Sets the transformation matrix on a canvas rendering context.
+ * @param {CanvasRenderingContext2D} context - The canvas rendering context.
+ * @param {number} translateX - The X translation value.
+ * @param {number} translateY - The Y translation value.
+ * @param {number} scaleX - The X scale value.
+ * @param {number} scaleY - The Y scale value.
+ * @param {number} skewX - The X skew value.
+ * @param {number} skewY - The Y skew value.
+ * @returns {CanvasRenderingContext2D} The modified rendering context.
  */
 export const setTransform = (context, translateX, translateY, scaleX, scaleY, skewX, skewY) => {
   context.setTransform(scaleX, skewX, skewY, scaleY, translateX, translateY);
@@ -123,9 +123,9 @@ export const setTransform = (context, translateX, translateY, scaleX, scaleY, sk
 };
 
 /**
- * TBD.
- * @param {object} context - TBD.
- * @returns {object} TBD.
+ * Gets the smoothing prefix for a canvas rendering context.
+ * @param {CanvasRenderingContext2D} context - The canvas rendering context.
+ * @returns {string | null} The smoothing property name or null if not found.
  */
 export const getSmoothingPrefix = (context) => {
   const VENDORS = ['i', 'webkitI', 'msI', 'mozI', 'oI'];
@@ -139,10 +139,10 @@ export const getSmoothingPrefix = (context) => {
 };
 
 /**
- * TBD.
- * @param {object} context - TBD.
- * @param {number} value - TBD.
- * @returns {object} TBD.
+ * Sets the smoothing enabled property on a canvas rendering context.
+ * @param {object} context - The canvas rendering context.
+ * @param {number} value - The smoothing enabled value to set.
+ * @returns {object} The modified rendering context.
  */
 export const setSmoothingEnabled = (context, value) => {
   const s = getSmoothingPrefix(context);