@vpmedia/phaser 1.95.0 → 1.96.0

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

@@ -1,7 +1,7 @@
 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: import("../../core/game.js").Game);
     /** @type {number} */
@@ -31,50 +31,50 @@ export class WebGLRenderer {
     blendModeManager: WebGLBlendModeManager;
     renderSession: {};
     /**
-     * TBD.
+     * Destroys this renderer and cleans up resources.
      */
     destroy(): void;
     gl: WebGLRenderingContext & {
         id: number;
     };
     /**
-     * TBD.
+     * Initializes the WebGL registry.
      */
     initRegistry(): void;
     /**
-     * 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: import("../../core/game.js").Game): void;
     glContextId: any;
     /**
-     * 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: import("../../core/stage.js").Stage): void;
     /**
-     * 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: import("../../display/display_object.js").DisplayObject, projection: Point, buffer: object, matrix: import("../../geom/matrix.js").Matrix): void;
     /**
-     * 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: number, height: number): void;
     /**
-     * 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: import("./base_texture.js").BaseTexture): boolean;
     /**
-     * TBD.
+     * Maps blend modes to WebGL rendering operations.
      */
     mapBlendModes(): void;
 }

package/types/phaser/display/webgl/shader/complex.d.ts

@@ -1,7 +1,7 @@
 export class ComplexPrimitiveShader {
     /**
-     * TBD.
-     * @param {WebGLRenderingContext} gl - TBD.
+     * Creates a new ComplexShader instance.
+     * @param {WebGLRenderingContext} gl - The WebGL rendering context.
      */
     constructor(gl: WebGLRenderingContext);
     gl: WebGLRenderingContext;
@@ -11,7 +11,7 @@ export class ComplexPrimitiveShader {
     fragmentSrc: string[];
     vertexSrc: string[];
     /**
-     * TBD.
+     * Destroys this shader and cleans up resources.
      */
     init(): void;
     projectionVector: WebGLUniformLocation;
@@ -24,7 +24,7 @@ export class ComplexPrimitiveShader {
     translationMatrix: WebGLUniformLocation;
     alpha: WebGLUniformLocation;
     /**
-     * TBD.
+     * Binds this shader to the WebGL context.
      */
     destroy(): void;
     uniforms: any;

package/types/phaser/display/webgl/shader/fast.d.ts

@@ -1,7 +1,7 @@
 export class FastShader {
     /**
-     * TBD.
-     * @param {WebGLRenderingContext} gl - TBD.
+     * Creates a new FastShader instance.
+     * @param {WebGLRenderingContext} gl - The WebGL rendering context.
      */
     constructor(gl: WebGLRenderingContext);
     gl: WebGLRenderingContext;
@@ -12,7 +12,7 @@ export class FastShader {
     fragmentSrc: string[];
     vertexSrc: string[];
     /**
-     * TBD.
+     * Creates a new FastShader instance.
      */
     init(): void;
     uSampler: WebGLUniformLocation;
@@ -28,7 +28,7 @@ export class FastShader {
     colorAttribute: number;
     attributes: number[];
     /**
-     * TBD.
+     * Destroys this shader and cleans up resources.
      */
     destroy(): void;
     uniforms: any;

package/types/phaser/display/webgl/shader/normal.d.ts

@@ -1,7 +1,7 @@
 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: WebGLRenderingContext & {
         id: number;
@@ -21,7 +21,7 @@ export class NormalShader {
     uniforms: {};
     attributes: any[];
     /**
-     * TBD.
+     * Destroys this shader and cleans up resources.
      */
     init(): void;
     uSampler: WebGLUniformLocation;
@@ -32,20 +32,20 @@ export class NormalShader {
     aTextureCoord: number;
     colorAttribute: number;
     /**
-     * TBD.
+     * Binds this shader to the WebGL context.
      */
     initUniforms(): void;
     /**
-     * TBD.
-     * @param {object} uniform - TBD.
+     * Sets a uniform value for this shader.
+     * @param {object} uniform - The uniform to set.
      */
     initSampler2D(uniform: object): void;
     /**
-     * TBD.
+     * Sets the shader to use for rendering.
      */
     syncUniforms(): void;
     /**
-     * TBD.
+     * Destroys this shader and cleans up resources.
      */
     destroy(): void;
 }

package/types/phaser/display/webgl/shader/primitive.d.ts

@@ -1,7 +1,7 @@
 export class PrimitiveShader {
     /**
-     * TBD.
-     * @param {WebGLRenderingContext} gl - TBD.
+     * Creates a new PrimitiveShader instance.
+     * @param {WebGLRenderingContext} gl - The WebGL rendering context.
      */
     constructor(gl: WebGLRenderingContext);
     gl: WebGLRenderingContext;
@@ -11,7 +11,7 @@ export class PrimitiveShader {
     fragmentSrc: string[];
     vertexSrc: string[];
     /**
-     * TBD.
+     * Destroys this shader and cleans up resources.
      */
     init(): void;
     projectionVector: WebGLUniformLocation;
@@ -24,7 +24,7 @@ export class PrimitiveShader {
     translationMatrix: WebGLUniformLocation;
     alpha: WebGLUniformLocation;
     /**
-     * TBD.
+     * Binds this shader to the WebGL context.
      */
     destroy(): void;
     uniforms: any;

package/types/phaser/display/webgl/shader/strip.d.ts

@@ -1,7 +1,7 @@
 export class StripShader {
     /**
-     * TBD.
-     * @param {WebGLRenderingContext} gl - TBD.
+     * Creates a new StripShader instance.
+     * @param {WebGLRenderingContext} gl - The WebGL rendering context.
      */
     constructor(gl: WebGLRenderingContext);
     gl: WebGLRenderingContext;
@@ -11,7 +11,7 @@ export class StripShader {
     fragmentSrc: string[];
     vertexSrc: string[];
     /**
-     * TBD.
+     * Destroys this shader and cleans up resources.
      */
     init(): void;
     uSampler: WebGLUniformLocation;
@@ -24,7 +24,7 @@ export class StripShader {
     translationMatrix: WebGLUniformLocation;
     alpha: WebGLUniformLocation;
     /**
-     * TBD.
+     * Binds this shader to the WebGL context.
      */
     destroy(): void;
     uniforms: any;

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

@@ -12,27 +12,27 @@ export class WebGLShaderManager {
     tempAttribState: any[];
     stack: any[];
     /**
-     * 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: WebGLRenderingContext & {
         id: number;
     }): void;
     /**
-     * TBD.
-     * @param {number[]} attribs - TBD.
+     * Sets up the shader manager for WebGL rendering.
+     * @param {number[]} attribs - The attribute locations to set up.
      */
     setAttribs(attribs: number[]): void;
     /**
-     * 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: NormalShader): boolean;
     _currentId: any;
     currentShader: NormalShader;
     /**
-     * TBD.
+     * Destroys the manager.
      */
     destroy(): void;
 }

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

@@ -16,8 +16,8 @@ export class WebGLSpriteBatch {
     sprites: any[];
     defaultShader: AbstractFilter;
     /**
-     * TBD.
-     * @param {WebGLRenderingContext & { id: number }} gl - TBD.
+     * Renders a sprite using WebGL.
+     * @param {WebGLRenderingContext & { id: number }} gl - The WebGL rendering context.
      */
     setContext(gl: WebGLRenderingContext & {
         id: number;
@@ -29,47 +29,47 @@ export class WebGLSpriteBatch {
     indexBuffer: WebGLBuffer;
     currentBlendMode: number;
     /**
-     * TBD.
-     * @param {object} renderSession - TBD.
+     * Renders the sprite batch using WebGL.
+     * @param {object} renderSession - The render session to use.
      */
     begin(renderSession: object): void;
     renderSession: any;
     shader: any;
     /**
-     * TBD.
+     * Updates the sprite batch.
      */
     end(): void;
     /**
-     * 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: import("../../display/image.js").Image, matrix: import("../../geom/matrix.js").Matrix): void;
     /**
-     * TBD.
+     * Binds the sprite batch to the WebGL context.
      */
     renderTilingSprite(): void;
     /**
-     * TBD.
+     * Updates the sprite batch.
      */
     flush(): void;
     /**
-     * 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: import("./base_texture.js").BaseTexture, size: number, startIndex: number): void;
     /**
-     * TBD.
+     * Destroys this sprite batch and cleans up resources.
      */
     stop(): void;
     /**
-     * TBD.
+     * Renders the sprite batch using Canvas.
      */
     start(): void;
     /**
-     * TBD.
+     * Destroys the sprite batch instance.
      */
     destroy(): void;
 }

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

@@ -3,34 +3,34 @@ export class WebGLStencilManager {
     reverse: boolean;
     count: number;
     /**
-     * TBD.
-     * @param {WebGLRenderingContext} gl - TBD.
+     * Binds the stencil buffer for rendering.
+     * @param {WebGLRenderingContext} gl - The WebGL rendering context.
      */
     setContext(gl: WebGLRenderingContext): void;
     gl: WebGLRenderingContext;
     /**
-     * TBD.
+     * Sets up the stencil buffer for rendering.
      */
     destroy(): void;
     /**
-     * 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: import("../graphics.js").Graphics, webGLData: import("./graphics_data.js").GraphicsData, renderSession: object): void;
     /**
-     * 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: import("../graphics.js").Graphics, webGLData: import("./graphics_data.js").GraphicsData, renderSession: object): void;
     /**
-     * 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: import("../graphics.js").Graphics, webGLData: import("./graphics_data.js").GraphicsData, renderSession: object): void;
 }

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

@@ -10,11 +10,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: import("./base_texture.js").BaseTexture, frame?: Rectangle | null | undefined, crop?: Rectangle | null | undefined, trim?: Rectangle | null | undefined);
     noFrame: boolean;
@@ -40,22 +40,22 @@ export class Texture {
     /** @type {Rectangle} */
     crop: Rectangle;
     /**
-     * TBD.
+     * Destroys this texture and cleans up resources.
      */
     onBaseTextureLoaded(): void;
     /**
-     * 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?: boolean): void;
     /**
-     * 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: Rectangle): void;
     /**
-     * TBD.
+     * Updates the texture UVs based on the crop frame.
      */
     _updateUvs(): void;
 }