@vpmedia/phaser 1.94.0 → 1.96.0

package/src/phaser/display/graphics.js

@@ -26,36 +26,53 @@ import { textureFromCanvas } from './webgl/texture_util.js';
 
 export class Graphics extends DisplayObject {
   /**
-   * TBD.
-   * @param {import('../core/game.js').Game} game - TBD.
-   * @param {number} x - TBD.
-   * @param {number} y - TBD.
+   * Creates a new Graphics object.
+   * @param {import('../core/game.js').Game} game - The game instance.
+   * @param {number} x - The x coordinate of the graphics object.
+   * @param {number} y - The y coordinate of the graphics object.
    */
   constructor(game, x = 0, y = 0) {
     super(game);
+    /** @type {number} */
     this.type = GRAPHICS;
     this.position.setTo(x, y);
+    /** @type {boolean} */
     this.renderable = true;
+    /** @type {number} */
     this.fillAlpha = 1;
+    /** @type {number} */
     this.lineWidth = 0;
+    /** @type {number} */
     this.lineColor = 0;
     this.graphicsData = [];
+    /** @type {number} */
     this.tint = 0xffffff;
+    /** @type {number} */
     this.blendMode = BLEND_NORMAL;
+    /** @type {GraphicsData} */
     this.currentPath = null;
+    /** @type {object[]} */
     this._webGL = [];
+    /** @type {boolean} */
     this.isMask = false;
+    /** @type {number} */
     this.boundsPadding = 0;
+    /** @type {Rectangle} */
     this._localBounds = new Rectangle(0, 0, 1, 1);
+    /** @type {boolean} */
     this.dirty = true;
+    /** @type {boolean} */
     this._boundsDirty = false;
+    /** @type {boolean} */
     this._cacheAsBitmap = false;
+    /** @type {boolean} */
     this.webGLDirty = false;
+    /** @type {boolean} */
     this.cachedSpriteDirty = false;
   }
 
   /**
-   * TBD.
+   * Destroys the graphics object and clears all data.
    */
   destroy() {
     // TODO
@@ -64,11 +81,11 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} lineWidth - TBD.
-   * @param {number} color - TBD.
-   * @param {number} alpha - TBD.
-   * @returns {Graphics} TBD.
+   * Sets the line style for subsequent drawing operations.
+   * @param {number} lineWidth - The width of the line to draw.
+   * @param {number} color - The color of the line to draw.
+   * @param {number} alpha - The alpha (transparency) of the line to draw.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   lineStyle(lineWidth = 0, color = 0, alpha = 1) {
     this.lineWidth = lineWidth || 0;
@@ -89,10 +106,10 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} x - TBD.
-   * @param {number} y - TBD.
-   * @returns {Graphics} TBD.
+   * Moves the drawing cursor to the specified point.
+   * @param {number} x - The x coordinate to move to.
+   * @param {number} y - The y coordinate to move to.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   moveTo(x, y) {
     this.drawShape(new Polygon([x, y]));
@@ -100,10 +117,10 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} x - TBD.
-   * @param {number} y - TBD.
-   * @returns {Graphics} TBD.
+   * Draws a line from the current drawing position to the specified point.
+   * @param {number} x - The x coordinate to draw to.
+   * @param {number} y - The y coordinate to draw to.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   lineTo(x, y) {
     if (!this.currentPath) {
@@ -116,12 +133,12 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} cpX - TBD.
-   * @param {number} cpY - TBD.
-   * @param {number} toX - TBD.
-   * @param {number} toY - TBD.
-   * @returns {Graphics} TBD.
+   * Draws a quadratic curve from the current position to the specified point.
+   * @param {number} cpX - The x coordinate of the control point.
+   * @param {number} cpY - The y coordinate of the control point.
+   * @param {number} toX - The x coordinate to draw to.
+   * @param {number} toY - The y coordinate to draw to.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   quadraticCurveTo(cpX, cpY, toX, toY) {
     if (this.currentPath) {
@@ -153,14 +170,14 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} cpX - TBD.
-   * @param {number} cpY - TBD.
-   * @param {number} cpX2 - TBD.
-   * @param {number} cpY2 - TBD.
-   * @param {number} toX - TBD.
-   * @param {number} toY - TBD.
-   * @returns {Graphics} TBD.
+   * Draws a cubic Bezier curve from the current position to the specified point.
+   * @param {number} cpX - The x coordinate of the first control point.
+   * @param {number} cpY - The y coordinate of the first control point.
+   * @param {number} cpX2 - The x coordinate of the second control point.
+   * @param {number} cpY2 - The y coordinate of the second control point.
+   * @param {number} toX - The x coordinate to draw to.
+   * @param {number} toY - The y coordinate to draw to.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   bezierCurveTo(cpX, cpY, cpX2, cpY2, toX, toY) {
     if (this.currentPath) {
@@ -198,13 +215,13 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} x1 - TBD.
-   * @param {number} y1 - TBD.
-   * @param {number} x2 - TBD.
-   * @param {number} y2 - TBD.
-   * @param {number} radius - TBD.
-   * @returns {Graphics} TBD.
+   * Draws an arc from the current position to the specified point.
+   * @param {number} x1 - The x coordinate of the starting point.
+   * @param {number} y1 - The y coordinate of the starting point.
+   * @param {number} x2 - The x coordinate of the end point.
+   * @param {number} y2 - The y coordinate of the end point.
+   * @param {number} radius - The radius of the arc.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   arcTo(x1, y1, x2, y2, radius) {
     if (this.currentPath) {
@@ -250,15 +267,15 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} cx - TBD.
-   * @param {number} cy - TBD.
-   * @param {number} radius - TBD.
-   * @param {number} startAngle - TBD.
-   * @param {number} endAngle - TBD.
-   * @param {boolean} anticlockwise - TBD.
-   * @param {number} segments - TBD.
-   * @returns {Graphics} TBD.
+   * Draws an arc with the specified center, radius, and angles.
+   * @param {number} cx - The x coordinate of the center point.
+   * @param {number} cy - The y coordinate of the center point.
+   * @param {number} radius - The radius of the arc.
+   * @param {number} startAngle - The starting angle in radians.
+   * @param {number} endAngle - The ending angle in radians.
+   * @param {boolean} anticlockwise - Whether to draw the arc anticlockwise.
+   * @param {number} segments - The number of segments to use for drawing the arc.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   arc(cx, cy, radius, startAngle, endAngle, anticlockwise = false, segments = 40) {
     //  If we do this we can never draw a full circle
@@ -304,10 +321,10 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} color - TBD.
-   * @param {number} alpha - TBD.
-   * @returns {Graphics} TBD.
+   * Begins filling with the specified color and alpha.
+   * @param {number} color - The fill color to use.
+   * @param {number} alpha - The fill alpha (transparency) to use.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   beginFill(color = 0, alpha = 1) {
     this.filling = true;
@@ -324,8 +341,8 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @returns {Graphics} TBD.
+   * Ends the current fill operation.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   endFill() {
     this.filling = false;
@@ -335,12 +352,12 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} x - TBD.
-   * @param {number} y - TBD.
-   * @param {number} width - TBD.
-   * @param {number} height - TBD.
-   * @returns {Graphics} TBD.
+   * Draws a rectangle with the specified properties.
+   * @param {number} x - The x coordinate of the rectangle.
+   * @param {number} y - The y coordinate of the rectangle.
+   * @param {number} width - The width of the rectangle.
+   * @param {number} height - The height of the rectangle.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   drawRect(x, y, width, height) {
     this.drawShape(new Rectangle(x, y, width, height));
@@ -348,13 +365,13 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} x - TBD.
-   * @param {number} y - TBD.
-   * @param {number} width - TBD.
-   * @param {number} height - TBD.
-   * @param {number} radius - TBD.
-   * @returns {Graphics} TBD.
+   * Draws a rounded rectangle with the specified properties.
+   * @param {number} x - The x coordinate of the rectangle.
+   * @param {number} y - The y coordinate of the rectangle.
+   * @param {number} width - The width of the rectangle.
+   * @param {number} height - The height of the rectangle.
+   * @param {number} radius - The radius of the rounded corners.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   drawRoundedRect(x, y, width, height, radius) {
     this.drawShape(new RoundedRectangle(x, y, width, height, radius));
@@ -362,11 +379,11 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} x - TBD.
-   * @param {number} y - TBD.
-   * @param {number} diameter - TBD.
-   * @returns {Graphics} TBD.
+   * Draws a circle with the specified properties.
+   * @param {number} x - The x coordinate of the center point.
+   * @param {number} y - The y coordinate of the center point.
+   * @param {number} diameter - The diameter of the circle.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   drawCircle(x, y, diameter) {
     this.drawShape(new Circle(x, y, diameter));
@@ -374,12 +391,12 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number} x - TBD.
-   * @param {number} y - TBD.
-   * @param {number} width - TBD.
-   * @param {number} height - TBD.
-   * @returns {Graphics} TBD.
+   * Draws an ellipse with the specified properties.
+   * @param {number} x - The x coordinate of the center point.
+   * @param {number} y - The y coordinate of the center point.
+   * @param {number} width - The width of the ellipse.
+   * @param {number} height - The height of the ellipse.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   drawEllipse(x, y, width, height) {
     this.drawShape(new Ellipse(x, y, width, height));
@@ -387,9 +404,9 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {Polygon} path - TBD.
-   * @returns {Graphics} TBD.
+   * Draws a polygon with the specified path.
+   * @param {Polygon} path - The polygon to draw.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   drawPolygon(path) {
     let points;
@@ -412,8 +429,8 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @returns {Graphics} TBD.
+   * Clears all graphics data.
+   * @returns {Graphics} This Graphics object for chaining.
    */
   clear() {
     this.lineWidth = 0;
@@ -427,7 +444,7 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
+   * Generates a texture from the graphics object (not implemented).
    */
   generateTexture() {
     // TODO
@@ -435,8 +452,8 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {object} renderSession - TBD.
+   * Renders the graphics object using WebGL.
+   * @param {object} renderSession - The render session to use.
    */
   renderWebGL(renderSession) {
     // if the sprite is not visible or the alpha is 0 then no need to render this element
@@ -495,8 +512,8 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {object} renderSession - TBD.
+   * Renders the graphics object using Canvas.
+   * @param {object} renderSession - The render session to use.
    */
   renderCanvas(renderSession) {
     // if the sprite is not visible or the alpha is 0 then no need to render this element
@@ -551,9 +568,9 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {import('../geom/matrix.js').Matrix} matrix - TBD.
-   * @returns {Rectangle} TBD.
+   * Gets the bounds of the graphics object.
+   * @param {import('../geom/matrix.js').Matrix} matrix - The transformation matrix to use.
+   * @returns {Rectangle} The bounds rectangle of the graphics object.
    */
   getBounds(matrix = null) {
     if (!this.renderable) {
@@ -612,8 +629,8 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @returns {Rectangle} TBD.
+   * Gets the local bounds of the graphics object.
+   * @returns {Rectangle} The local bounds rectangle of the graphics object.
    */
   getLocalBounds() {
     const matrixCache = this.worldTransform;
@@ -630,10 +647,10 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {Point} point - TBD.
-   * @param {Point} tempPoint - TBD.
-   * @returns {boolean} TBD.
+   * Checks if the graphics object contains a point.
+   * @param {Point} point - The point to check.
+   * @param {Point} tempPoint - A temporary point object to use.
+   * @returns {boolean} True if the graphics object contains the point, otherwise false.
    */
   containsPoint(point, tempPoint) {
     this.worldTransform.applyInverse(point, tempPoint);
@@ -650,7 +667,7 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
+   * Updates the local bounds of the graphics object.
    */
   updateLocalBounds() {
     let minX = Infinity;
@@ -731,7 +748,7 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
+   * Generates a cached sprite representation of the graphics object.
    */
   generateCachedSprite() {
     const bounds = this.getLocalBounds();
@@ -757,7 +774,7 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
+   * Updates the cached sprite texture.
    */
   updateCachedSpriteTexture() {
     const cachedSprite = this._cachedSprite;
@@ -776,7 +793,7 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
+   * Destroys the cached sprite.
    */
   destroyCachedSprite() {
     if (!this._cachedSprite) {
@@ -787,9 +804,9 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {object} shape - TBD.
-   * @returns {GraphicsData} TBD.
+   * Draws a shape with the specified properties.
+   * @param {object} shape - The shape to draw.
+   * @returns {GraphicsData} The graphics data for the drawn shape.
    */
   drawShape(shape) {
     if (this.currentPath) {
@@ -824,7 +841,7 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
+   * Performs post-update operations for the graphics object.
    */
   postUpdate() {
     if (this._boundsDirty) {
@@ -837,9 +854,9 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {Point[]} points - TBD.
-   * @param {boolean} cull - TBD.
+   * Draws a triangle with the specified points and culling options.
+   * @param {Point[]} points - The points of the triangle.
+   * @param {boolean} cull - Whether to perform backface culling.
    */
   drawTriangle(points, cull = false) {
     const triangle = new Polygon(points);
@@ -857,10 +874,10 @@ export class Graphics extends DisplayObject {
   }
 
   /**
-   * TBD.
-   * @param {number[]|Point[]} vertices - TBD.
-   * @param {number[]} indices - TBD.
-   * @param {boolean} cull - TBD.
+   * Draws triangles with the specified vertices and indices.
+   * @param {number[]|Point[]} vertices - The vertices of the triangles.
+   * @param {number[]} indices - The indices of the vertices to use.
+   * @param {boolean} cull - Whether to perform backface culling.
    */
   drawTriangles(vertices, indices, cull = false) {
     const point1 = new Point();

package/src/phaser/display/graphics_data.js

@@ -2,14 +2,14 @@ import { clone } from './graphics_data_util.js';
 
 export class GraphicsData {
   /**
-   * TBD.
-   * @param {number} lineWidth - TBD.
-   * @param {number} lineColor - TBD.
-   * @param {number} lineAlpha - TBD.
-   * @param {number} fillColor - TBD.
-   * @param {number} fillAlpha - TBD.
-   * @param {boolean} fill - TBD.
-   * @param {object} shape - TBD.
+   * Creates a new GraphicsData object.
+   * @param {number} lineWidth - The line width.
+   * @param {number} lineColor - The line color.
+   * @param {number} lineAlpha - The line alpha.
+   * @param {number} fillColor - The fill color.
+   * @param {number} fillAlpha - The fill alpha.
+   * @param {boolean} fill - Whether to fill the shape.
+   * @param {object} shape - The shape to draw.
    */
   constructor(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) {
     this.lineWidth = lineWidth;
@@ -25,8 +25,8 @@ export class GraphicsData {
   }
 
   /**
-   * TBD.
-   * @returns {GraphicsData} TBD.
+   * Clones this GraphicsData object.
+   * @returns {GraphicsData} A new cloned GraphicsData object.
    */
   clone() {
     return clone(this);

package/src/phaser/display/graphics_data_util.js

@@ -1,9 +1,9 @@
 import { GraphicsData } from './graphics_data.js';
 
 /**
- * TBD.
- * @param {GraphicsData} source - TBD.
- * @returns {GraphicsData} TBD.
+ * Clones a GraphicsData object.
+ * @param {GraphicsData} source - The source GraphicsData to clone.
+ * @returns {GraphicsData} A new cloned GraphicsData object.
  */
 export const clone = (source) => {
   return new GraphicsData(