@vpmedia/phaser 1.95.0 → 1.97.0

package/types/phaser/display/webgl/abstract_filter.d.ts

@@ -1,8 +1,8 @@
 export class AbstractFilter {
     /**
-     * TBD.
-     * @param {string[]} fragmentSrc - TBD.
-     * @param {object} uniforms - TBD.
+     * Creates a new AbstractFilter instance.
+     * @param {string[]} fragmentSrc - The fragment shader source.
+     * @param {object} uniforms - The uniform variables for the shader.
      */
     constructor(fragmentSrc: string[], uniforms: object);
     passes: this[];
@@ -12,7 +12,7 @@ export class AbstractFilter {
     uniforms: any;
     fragmentSrc: string[];
     /**
-     * TBD.
+     * Initializes the filter.
      */
     syncUniforms(): void;
 }

package/types/phaser/display/webgl/base_texture.d.ts

@@ -1,8 +1,8 @@
 export class BaseTexture {
     /**
-     * TBD.
-     * @param {HTMLCanvasElement} source - TBD.
-     * @param {number} [scaleMode] - TBD.
+     * Updates the base texture with a new source.
+     * @param {HTMLCanvasElement} source - The new canvas element to use as the texture source.
+     * @param {number} [scaleMode] - The scale mode to use for the texture.
      */
     constructor(source: HTMLCanvasElement, scaleMode?: number);
     resolution: number;
@@ -18,21 +18,21 @@ export class BaseTexture {
     _powerOf2: boolean;
     _dirty: boolean[];
     /**
-     * TBD.
-     * @param {number} width - TBD.
-     * @param {number} height - TBD.
+     * Updates the base texture with new dimensions.
+     * @param {number} width - The new width of the texture.
+     * @param {number} height - The new height of the texture.
      */
     forceLoaded(width: number, height: number): void;
     /**
-     * TBD.
+     * Destroys the texture.
      */
     destroy(): void;
     /**
-     * TBD.
+     * Marks the texture as dirty.
      */
     dirty(): void;
     /**
-     * TBD.
+     * Unloads the texture from the GPU.
      */
     unloadFromGPU(): void;
 }

package/types/phaser/display/webgl/blend_manager.d.ts

@@ -2,18 +2,18 @@ export class WebGLBlendModeManager {
     gl: WebGLRenderingContext;
     currentBlendMode: number;
     /**
-     * TBD.
-     * @param {WebGLRenderingContext} gl - TBD.
+     * Initializes the blend mode manager with a WebGL context.
+     * @param {WebGLRenderingContext} gl - The WebGL rendering context.
      */
     setContext(gl: WebGLRenderingContext): void;
     /**
-     * TBD.
-     * @param {number} blendMode - TBD.
-     * @returns {boolean} TBD.
+     * Sets the blend mode for the specified WebGL context.
+     * @param {number} blendMode - The blend mode to set.
+     * @returns {boolean} True if the blend mode was set successfully, false otherwise.
      */
     setBlendMode(blendMode: number): boolean;
     /**
-     * TBD.
+     * Sets the blend mode for the WebGL context.
      */
     destroy(): void;
 }

package/types/phaser/display/webgl/earcut.d.ts

@@ -1,42 +1,42 @@
 /**
- * TBD.
- * @param {object} list - TBD.
- * @returns {object} TBD.
+ * Calculates the area of a triangle defined by three points.
+ * @param {object} list - The list of points to process.
+ * @returns {object} The processed earcut data structure.
  */
 export function sortLinked(list: object): object;
 /**
- * TBD.
- * @param {object} a - TBD.
- * @param {object} b - TBD.
- * @returns {number} TBD.
+ * Calculates the area of a triangle defined by three points.
+ * @param {object} a - The first point of the triangle.
+ * @param {object} b - The second point of the triangle.
+ * @returns {number} The calculated area of the triangle.
  */
 export function compareX(a: object, b: object): number;
 /**
- * TBD.
- * @param {number} x - TBD.
- * @param {number} y - TBD.
- * @param {number} minX - TBD.
- * @param {number} minY - TBD.
- * @param {number} size - TBD.
- * @returns {number} TBD.
+ * Determines if a point is inside a triangle.
+ * @param {number} x - The x-coordinate of the point to test.
+ * @param {number} y - The y-coordinate of the point to test.
+ * @param {number} minX - The minimum x-coordinate of the bounding box.
+ * @param {number} minY - The minimum y-coordinate of the bounding box.
+ * @param {number} size - The size of the bounding box.
+ * @returns {number} The calculated distance from the point to the triangle edge.
  */
 export function zOrder(x: number, y: number, minX: number, minY: number, size: number): number;
 /**
- * TBD.
- * @param {object} start - TBD.
- * @param {number} minX - TBD.
- * @param {number} minY - TBD.
- * @param {number} size - TBD.
+ * Calculates the orientation of three points (clockwise, counterclockwise, or collinear).
+ * @param {object} start - The starting point of the triangle edge.
+ * @param {number} minX - The minimum x-coordinate of the bounding box.
+ * @param {number} minY - The minimum y-coordinate of the bounding box.
+ * @param {number} size - The size of the bounding box.
  */
 export function indexCurve(start: object, minX: number, minY: number, size: number): void;
 /**
  * TBD.
  * @param {object} start - TBD.
- * @returns {object} TBD.
+ * @returns {object} The calculated point that is the closest to the triangle edge.
  */
 export function getLeftmost(start: object): object;
 /**
- * TBD.
+ * Determines if a point is inside the triangle defined by three points.
  * @param {number} ax - TBD.
  * @param {number} ay - TBD.
  * @param {number} bx - TBD.
@@ -58,50 +58,50 @@ export function pointInTriangle(ax: number, ay: number, bx: number, by: number,
 export function area(p: object, q: object, r: object): number;
 /**
  * TBD.
- * @param {object} p1 - TBD.
- * @param {object} p2 - TBD.
- * @returns {boolean} TBD.
+ * @param {object} p1 - The first point of the triangle.
+ * @param {object} p2 - The second point of the triangle.
+ * @returns {boolean} True if the point is inside the triangle, false otherwise.
  */
 export function equals(p1: object, p2: object): boolean;
 /**
- * TBD.
- * @param {object} p1 - TBD.
- * @param {object} q1 - TBD.
- * @param {object} p2 - TBD.
- * @param {object} q2 - TBD.
- * @returns {boolean} TBD.
+ * Determines if two line segments intersect.
+ * @param {object} p1 - The first point of the first line segment.
+ * @param {object} q1 - The second point of the first line segment.
+ * @param {object} p2 - The first point of the second line segment.
+ * @param {object} q2 - The second point of the second line segment.
+ * @returns {boolean} True if the line segments intersect, false otherwise.
  */
 export function intersects(p1: object, q1: object, p2: object, q2: object): boolean;
 /**
- * TBD.
- * @param {object} a - TBD.
- * @param {object} b - TBD.
- * @returns {boolean} TBD.
+ * Determines if two line segments intersect.
+ * @param {object} a - The first point of the line segment.
+ * @param {object} b - The second point of the line segment.
+ * @returns {boolean} True if the points are collinear, false otherwise.
  */
 export function intersectsPolygon(a: object, b: object): boolean;
 /**
- * TBD.
- * @param {object} a - TBD.
- * @param {object} b - TBD.
- * @returns {object} TBD.
+ * Calculates the cross product of three points.
+ * @param {object} a - The first point of the cross product.
+ * @param {object} b - The second point of the cross product.
+ * @returns {object} The calculated cross product result.
  */
 export function locallyInside(a: object, b: object): object;
 /**
- * TBD.
- * @param {object} a - TBD.
- * @param {object} b - TBD.
- * @returns {boolean} TBD.
+ * Determines if a point is inside the triangle defined by three points.
+ * @param {object} a - The first point of the triangle.
+ * @param {object} b - The second point of the triangle.
+ * @returns {boolean} True if the point is inside the triangle, false otherwise.
  */
 export function middleInside(a: object, b: object): boolean;
 /**
- * TBD.
- * @param {object} a - TBD.
- * @param {object} b - TBD.
- * @returns {boolean} TBD.
+ * Determines if a point is inside the triangle defined by three points.
+ * @param {object} a - The first point of the triangle.
+ * @param {object} b - The second point of the triangle.
+ * @returns {boolean} True if the point is inside the triangle, false otherwise.
  */
 export function isValidDiagonal(a: object, b: object): boolean;
 /**
- * TBD.
+ * Calculates the distance from a point to a triangle edge.
  * @param {object} a - TBD.
  * @param {object} b - TBD.
  * @returns {object} TBD.
@@ -138,78 +138,78 @@ export function isEar(ear: object): boolean;
 export function isEarHashed(ear: object, minX: number, minY: number, size: number): boolean;
 /**
  * TBD.
- * @param {object} data - TBD.
- * @param {number} start - TBD.
- * @param {number} end - TBD.
- * @param {number} dim - TBD.
- * @param {boolean} clockwise - TBD.
- * @returns {object} TBD.
+ * @param {object} data - The earcut data structure containing the points.
+ * @param {number} start - The starting index in the data structure.
+ * @param {number} end - The ending index in the data structure.
+ * @param {number} dim - The dimension of the data (2 or 3).
+ * @param {boolean} clockwise - Whether the triangles should be clockwise or counterclockwise.
+ * @returns {object} The processed earcut data structure with triangulation information.
  */
 export function linkedList(data: object, start: number, end: number, dim: number, clockwise: boolean): object;
 /**
- * TBD.
- * @param {object} start - TBD.
- * @param {object} end - TBD.
- * @returns {object} TBD.
+ * Calculates the minimum and maximum coordinates of a set of points.
+ * @param {object} start - The starting point in the data structure.
+ * @param {object} end - The ending point in the data structure.
+ * @returns {object} The calculated bounding box with min and max coordinates.
  */
 export function filterPoints(start: object, end: object): object;
 /**
- * TBD.
- * @param {object} hole - TBD.
- * @param {object} outerNode - TBD.
- * @returns {object} TBD.
+ * Calculates the minimum and maximum coordinates of a set of points.
+ * @param {object} hole - The hole to process.
+ * @param {object} outerNode - The outer node that contains the hole.
+ * @returns {object} The processed hole data structure.
  */
 export function findHoleBridge(hole: object, outerNode: object): object;
 /**
- * TBD.
- * @param {object} hole - TBD.
- * @param {object} outerNode - TBD.
+ * Processes a hole in the triangulation data structure.
+ * @param {object} hole - The hole to process.
+ * @param {object} outerNode - The outer node that contains the hole.
  */
 export function eliminateHole(hole: object, outerNode: object): void;
 /**
- * TBD.
- * @param {object} data - TBD.
- * @param {object} holeIndices - TBD.
- * @param {object} outerNode - TBD.
- * @param {object} dim - TBD.
- * @returns {object} TBD.
+ * Calculates the centroid of a polygon.
+ * @param {object} data - The earcut data structure containing the points.
+ * @param {object} holeIndices - The indices of the holes in the data structure.
+ * @param {object} outerNode - The outer node that contains the holes.
+ * @param {object} dim - The dimension of the data (2 or 3).
+ * @returns {object} The processed earcut data structure with holes included.
  */
 export function eliminateHoles(data: object, holeIndices: object, outerNode: object, dim: object): object;
 /**
- * TBD.
- * @param {object} start - TBD.
- * @param {object} triangles - TBD.
- * @param {number} dim - TBD.
- * @returns {object} TBD.
+ * Calculates the centroid of a polygon.
+ * @param {object} start - The starting point in the data structure.
+ * @param {object} triangles - The triangles to process.
+ * @param {number} dim - The dimension of the data (2 or 3).
+ * @returns {object} The processed triangulation data structure.
  */
 export function cureLocalIntersections(start: object, triangles: object, dim: number): object;
 /**
- * TBD.
- * @param {object} start - TBD.
- * @param {object} triangles - TBD.
- * @param {number} dim - TBD.
- * @param {number} minX - TBD.
- * @param {number} minY - TBD.
- * @param {number} size - TBD.
+ * Calculates the centroid of a polygon.
+ * @param {object} start - The starting point in the data structure.
+ * @param {object} triangles - The triangles to process.
+ * @param {number} dim - The dimension of the data (2 or 3).
+ * @param {number} minX - The minimum x-coordinate of the bounding box.
+ * @param {number} minY - The minimum y-coordinate of the bounding box.
+ * @param {number} size - The size of the bounding box.
  */
 export function splitEarcut(start: object, triangles: object, dim: number, minX: number, minY: number, size: number): void;
 /**
- * TBD.
- * @param {object} ear - TBD.
- * @param {object} triangles - TBD.
- * @param {number} dim - TBD.
- * @param {number} minX - TBD.
- * @param {number} minY - TBD.
- * @param {number} size - TBD.
- * @param {object} pass - TBD.
+ * Calculates the centroid of a polygon.
+ * @param {object} ear - The ear to process.
+ * @param {object} triangles - The triangles to process.
+ * @param {number} dim - The dimension of the data (2 or 3).
+ * @param {number} minX - The minimum x-coordinate of the bounding box.
+ * @param {number} minY - The minimum y-coordinate of the bounding box.
+ * @param {number} size - The size of the bounding box.
+ * @param {object} pass - The pass information for triangulation.
  */
 export function earcutLinked(ear: object, triangles: object, dim: number, minX: number, minY: number, size: number, pass: object): void;
 /**
- * TBD.
- * @param {object} data - TBD.
- * @param {object} holeIndices - TBD.
- * @param {number} dim - TBD.
- * @returns {object} TBD.
+ * Calculates the centroid of a polygon.
+ * @param {object} data - The earcut data structure containing the points.
+ * @param {object} holeIndices - The indices of the holes in the data structure.
+ * @param {number} dim - The dimension of the data (2 or 3).
+ * @returns {object} The processed earcut data structure with triangulation information.
  */
 export function triangulate(data: object, holeIndices: object, dim: number): object;
 //# sourceMappingURL=earcut.d.ts.map

package/types/phaser/display/webgl/earcut_node.d.ts

@@ -1,9 +1,9 @@
 export class Node {
     /**
-     * TBD.
-     * @param {number} i - TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
+     * Creates a new Node instance.
+     * @param {number} i - The vertice index in coordinates array.
+     * @param {number} x - The x coordinate of the vertex.
+     * @param {number} y - The y coordinate of the vertex.
      */
     constructor(i: number, x: number, y: number);
     i: number;

package/types/phaser/display/webgl/fast_sprite_batch.d.ts

@@ -1,7 +1,7 @@
 export class FastSpriteBatch {
     /**
-     * TBD.
-     * @param {WebGLRenderingContext & { id: number }} gl - TBD.
+     * Creates a new FastSpriteBatch instance.
+     * @param {WebGLRenderingContext & { id: number }} gl - The WebGL rendering context.
      */
     constructor(gl: WebGLRenderingContext & {
         id: number;
@@ -22,8 +22,8 @@ export class FastSpriteBatch {
     shader: any;
     matrix: any;
     /**
-     * TBD.
-     * @param {WebGLRenderingContext & { id: number }} gl - TBD.
+     * Sets the WebGL context for this batch.
+     * @param {WebGLRenderingContext & { id: number }} gl - The WebGL rendering context.
      */
     setContext(gl: WebGLRenderingContext & {
         id: number;
@@ -32,35 +32,35 @@ export class FastSpriteBatch {
         id: number;
     };
     /**
-     * TBD.
-     * @param {object} spriteBatch - TBD.
-     * @param {object} renderSession - TBD.
+     * Renders a sprite batch using WebGL.
+     * @param {object} spriteBatch - The sprite batch to render.
+     * @param {object} renderSession - The render session to use.
      */
     begin(spriteBatch: object, renderSession: object): void;
     /**
-     * TBD.
+     * Updates the sprite batch.
      */
     end(): void;
     /**
-     * TBD.
-     * @param {object} spriteBatch - TBD.
+     * Flushes the sprite batch to WebGL.
+     * @param {object} spriteBatch - The sprite batch to flush.
      */
     render(spriteBatch: object): void;
     /**
-     * TBD.
-     * @param {import('../../display/image.js').Image} sprite - TBD.
+     * Renders a sprite using WebGL.
+     * @param {import('../../display/image.js').Image} sprite - The sprite to render.
      */
     renderSprite(sprite: import("../../display/image.js").Image): void;
     /**
-     * TBD.
+     * Binds the sprite batch to the WebGL context.
      */
     flush(): void;
     /**
-     * TBD.
+     * Renders a sprite using the sprite batch.
      */
     stop(): void;
     /**
-     * TBD.
+     * Sets up the sprite batch for WebGL rendering.
      */
     start(): void;
 }

package/types/phaser/display/webgl/filter_manager.d.ts

@@ -3,34 +3,34 @@ export class WebGLFilterManager {
     offsetX: number;
     offsetY: number;
     /**
-     * TBD.
-     * @param {WebGLRenderingContext} gl - TBD.
+     * Initializes the filter manager with a WebGL context.
+     * @param {WebGLRenderingContext} gl - The WebGL rendering context.
      */
     setContext(gl: WebGLRenderingContext): void;
     gl: WebGLRenderingContext;
     texturePool: any[];
     /**
-     * TBD.
+     * Applies a filter to the specified texture.
      */
     begin(): void;
     /**
-     * TBD.
+     * Updates the filter texture for the specified size.
      */
     pushFilter(): void;
     /**
-     * TBD.
+     * Resizes the filter manager to the specified dimensions.
      */
     popFilter(): void;
     /**
-     * TBD.
+     * Destroys this filter manager and cleans up resources.
      */
     applyFilterPass(): void;
     /**
-     * TBD.
+     * Initializes the filter manager.
      */
     initShaderBuffers(): void;
     /**
-     * TBD.
+     * Sets up the filter manager for WebGL rendering.
      */
     destroy(): void;
 }

package/types/phaser/display/webgl/filter_texture.d.ts

@@ -1,10 +1,10 @@
 export class FilterTexture {
     /**
-     * TBD.
-     * @param {WebGLRenderingContext} gl - TBD.
-     * @param {number} width - TBD.
-     * @param {number} height - TBD.
-     * @param {number} scaleMode - TBD.
+     * Creates a new FilterTexture instance.
+     * @param {WebGLRenderingContext} gl - The WebGL rendering context.
+     * @param {number} width - The width of the filter texture.
+     * @param {number} height - The height of the filter texture.
+     * @param {number} scaleMode - The scale mode to use.
      */
     constructor(gl: WebGLRenderingContext, width: number, height: number, scaleMode: number);
     gl: WebGLRenderingContext;
@@ -12,19 +12,19 @@ export class FilterTexture {
     texture: WebGLTexture;
     renderBuffer: WebGLRenderbuffer;
     /**
-     * TBD.
+     * Destroys this filter texture and cleans up resources.
      */
     clear(): void;
     /**
-     * TBD.
-     * @param {number} width - TBD.
-     * @param {number} height - TBD.
+     * Updates the size of this filter texture.
+     * @param {number} width - The new width of the filter texture.
+     * @param {number} height - The new height of the filter texture.
      */
     resize(width: number, height: number): void;
     width: any;
     height: number;
     /**
-     * TBD.
+     * Updates the resolution of this filter texture.
      */
     destroy(): void;
 }

package/types/phaser/display/webgl/graphics_data.d.ts

@@ -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: WebGLRenderingContext);
     gl: WebGLRenderingContext;
@@ -14,13 +14,13 @@ export class GraphicsData {
     alpha: number;
     dirty: boolean;
     /**
-     * TBD.
+     * Destroys this graphics data and cleans up resources.
      */
     reset(): void;
     glPoints: Float32Array<ArrayBuffer>;
     glIndicies: Uint16Array<ArrayBuffer>;
     /**
-     * TBD.
+     * Updates the graphics data for WebGL rendering.
      */
     upload(): void;
 }

package/types/phaser/display/webgl/render_texture.d.ts

@@ -1,11 +1,11 @@
 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: number, height: number, renderer: import("./renderer.js").WebGLRenderer | import("../canvas/renderer.js").CanvasRenderer, scaleMode: number, resolution?: number);
     resolution: number;
@@ -14,34 +14,34 @@ export class RenderTexture extends Texture {
     render: () => void;
     projection: Point;
     /**
-     * TBD.
+     * Destroys this render texture and cleans up resources.
      */
     resize(): void;
     /**
-     * TBD.
+     * Updates the size of this render texture.
      */
     clear(): void;
     /**
-     * TBD.
+     * Updates the resolution of this render texture.
      */
     renderWebGL(): void;
     /**
-     * TBD.
+     * Updates the scale mode of this render texture.
      */
     renderCanvas(): void;
     /**
-     * TBD.
-     * @returns {HTMLImageElement} TBD.
+     * Gets the HTML image element for this render texture.
+     * @returns {HTMLImageElement} The HTML image element.
      */
     getImage(): HTMLImageElement;
     /**
-     * TBD.
-     * @returns {string} TBD.
+     * Gets the base64 string representation of this render texture.
+     * @returns {string} The base64 string representation.
      */
     getBase64(): string;
     /**
-     * TBD.
-     * @returns {HTMLCanvasElement} TBD.
+     * Gets the canvas element for this render texture.
+     * @returns {HTMLCanvasElement} The canvas element.
      */
     getCanvas(): HTMLCanvasElement;
 }