@vpmedia/phaser 1.94.0 → 1.96.0

package/types/phaser/display/image.d.ts

@@ -1,113 +1,126 @@
 export class Image extends DisplayObject {
     /**
-     * TBD.
-     * @param {import('../core/game.js').Game} game - TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @param {string} key - TBD.
-     * @param {string | number} frame - TBD.
-     */
-    constructor(game: import("../core/game.js").Game, x: number, y: number, key: string, frame?: string | number);
+     * Creates a new Image instance.
+     * @param {import('../core/game.js').Game} game - The game instance this image belongs to.
+     * @param {number} x - The x position of the image.
+     * @param {number} y - The y position of the image.
+     * @param {string | number | Texture} key - The texture key or texture to use.
+     * @param {string | number} frame - The frame identifier (name or index) to use.
+     */
+    constructor(game: import("../core/game.js").Game, x: number, y: number, key: string | number | Texture, frame?: string | number);
+    /** @type {number} */
     type: number;
-    key: string;
+    /** @type {string | number | Texture} */
+    key: string | number | Texture;
     texture: any;
+    /** @type {number} */
     tint: number;
+    /** @type {number} */
     cachedTint: number;
-    tintedTexture: any;
+    /** @type {Texture | null} */
+    tilingTexture: Texture | null;
+    /** @type {Texture | null} */
+    tintedTexture: Texture | null;
+    /** @type {number} */
     blendMode: number;
     shader: any;
     _frame: Rectangle | import("../core/frame.js").Frame;
+    /** @type {boolean} */
     pendingDestroy: boolean;
+    /** @type {EventManager} */
     events: EventManager;
+    /** @type {AnimationManager} */
     animations: AnimationManager;
     renderOrderID: number;
     /**
-     * TBD.
-     * @param {string | number | Texture} key - TBD.
-     * @param {string | number | null | undefined} frame - TBD.
-     * @param {boolean} stopAnimation - TBD.
+     * Loads a texture for this image.
+     * @param {string | number | Texture} key - The texture key or texture to use.
+     * @param {string | number | null | undefined} frame - The frame identifier (name or index) to use.
+     * @param {boolean} stopAnimation - Whether to stop the animation when changing textures.
      */
     loadTexture(key: string | number | Texture, frame?: string | number | null | undefined, stopAnimation?: boolean): void;
     customRender: boolean;
     /**
-     * TBD.
-     * @param {import('../core/frame.js').Frame} frame - TBD.
+     * Sets the current frame of this image.
+     * @param {import('../core/frame.js').Frame} frame - The frame to set.
      */
     setFrame(frame: import("../core/frame.js").Frame): void;
     refreshTexture: boolean;
     /**
-     * TBD.
-     * @param {DisplayObject} parent - TBD.
-     * @param {number} width - TBD.
-     * @param {number} height - TBD.
+     * Resizes the frame of this image.
+     * @param {DisplayObject} parent - The parent display object.
+     * @param {number} width - The new width of the frame.
+     * @param {number} height - The new height of the frame.
      */
     resizeFrame(parent: DisplayObject, width: number, height: number): void;
     /**
-     * TBD.
+     * Resets the frame of this image to its original frame.
      */
     resetFrame(): void;
     /**
-     * TBD.
+     * Sets the current frame index of this image.
+     * @param {number} value - The new frame index to set.
      */
     set frame(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the current frame index of this image.
+     * @returns {number} The current frame index.
      */
     get frame(): number;
     /**
-     * TBD.
+     * Sets the current frame name of this image.
+     * @param {string} value - The new frame name to set.
      */
     set frameName(value: string);
     /**
-     * TBD.
-     * @returns {string} TBD.
+     * Gets the current frame name of this image.
+     * @returns {string} The current frame name.
      */
     get frameName(): string;
     /**
-     * TBD.
-     * @param {Rectangle} rect - TBD.
-     * @param {boolean} copy - TBD.
+     * Crops the texture of this image.
+     * @param {Rectangle} rect - The rectangle to crop to.
+     * @param {boolean} copy - Whether to copy the rect or use it directly.
      */
     crop(rect: Rectangle, copy?: boolean): void;
     cropRect: Rectangle;
     _crop: any;
     /**
-     * TBD.
+     * Updates the crop rectangle of this image.
      */
     updateCrop(): void;
     /**
-     * TBD.
+     * Called when the texture of this image is updated.
      */
     onTextureUpdate(): void;
     /**
-     * TBD.
-     * @param {Texture} texture - TBD.
-     * @param {boolean} destroyBase - TBD.
+     * Sets the texture for this image.
+     * @param {Texture} texture - The new texture to set.
+     * @param {boolean} destroyBase - Whether to destroy the base texture.
      */
     setTexture(texture: Texture, destroyBase?: boolean): void;
     /**
-     * TBD.
-     * @param {import('../geom/matrix.js').Matrix} matrix - TBD.
-     * @returns {Rectangle} TBD.
+     * Gets the bounds of this image.
+     * @param {import('../geom/matrix.js').Matrix} matrix - The transformation matrix to use.
+     * @returns {Rectangle} The bounds rectangle of this image.
      */
     getBounds(matrix?: import("../geom/matrix.js").Matrix): Rectangle;
     /**
-     * TBD.
-     * @param {object} renderSession - TBD.
-     * @param {import('../geom/matrix.js').Matrix} matrix - TBD.
+     * Renders this image using WebGL.
+     * @param {object} renderSession - The WebGL rendering session.
+     * @param {import('../geom/matrix.js').Matrix} matrix - The transformation matrix to use.
      */
     renderWebGL(renderSession: object, matrix?: import("../geom/matrix.js").Matrix): void;
     /**
-     * TBD.
-     * @param {object} renderSession - TBD.
-     * @param {import('../geom/matrix.js').Matrix} matrix - TBD.
+     * Renders this image using Canvas.
+     * @param {object} renderSession - The Canvas rendering session.
+     * @param {import('../geom/matrix.js').Matrix} matrix - The transformation matrix to use.
      */
     renderCanvas(renderSession: object, matrix?: import("../geom/matrix.js").Matrix): void;
 }
 import { DisplayObject } from './display_object.js';
+import { Texture } from './webgl/texture.js';
 import { Rectangle } from '../geom/rectangle.js';
 import { EventManager } from '../core/event_manager.js';
 import { AnimationManager } from '../core/animation_manager.js';
-import { Texture } from './webgl/texture.js';
 //# sourceMappingURL=image.d.ts.map

package/types/phaser/display/image.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../src/phaser/display/image.js"],"names":[],"mappings":"AASA;IACE;;;;;;;OAOG;IACH,kBANW,OAAO,iBAAiB,EAAE,IAAI,KAC9B,MAAM,KACN,MAAM,OACN,MAAM,UACN,MAAM,GAAG,MAAM,EA0BzB;IAtBC,aAAiB;IAEjB,YAAc;IACd,aAAwD;IAKxD,aAAoB;IACpB,mBAAoB;IACpB,mBAAyB;IACzB,kBAA6B;IAC7B,YAAkB;IAClB,qDAAkB;IAClB,wBAA2B;IAK3B,qBAAoC;IACpC,6BAA4C;IAqC1C,sBAAuB;IAiB3B;;;;;OAKG;IACH,iBAJW,MAAM,GAAG,MAAM,GAAG,OAAO,UACzB,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,kBAClC,OAAO,QAsCjB;IAzBC,sBAAyB;IA2B3B;;;OAGG;IACH,gBAFW,OAAO,kBAAkB,EAAE,KAAK,QAyC1C;IAFG,wBAA0B;IAI9B;;;;;OAKG;IACH,oBAJW,aAAa,SACb,MAAM,UACN,MAAM,QAKhB;IAED;;OAEG;IACH,mBAIC;IAUD;;OAEG;IACH,iBATa,MAAM,EAWlB;IAbD;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAiBD;;OAEG;IACH,qBATa,MAAM,EAWlB;IAbD;;;OAGG;IACH,iBAFa,MAAM,CAIlB;IAWD;;;;OAIG;IACH,WAHW,SAAS,SACT,OAAO,QAiBjB;IAVK,oBAAsE;IAMxE,WAAiB;IAMrB;;OAEG;IACH,mBA2BC;IAkCD;;OAEG;IACH,wBAQC;IAED;;;;OAIG;IACH,oBAHW,OAAO,gBACP,OAAO,QAIjB;IAED;;;;OAIG;IACH,mBAHW,OAAO,mBAAmB,EAAE,MAAM,GAChC,SAAS,CAIrB;IAUD;;;;OAIG;IACH,2BAHW,MAAM,WACN,OAAO,mBAAmB,EAAE,MAAM,QAI5C;IAED;;;;OAIG;IACH,4BAHW,MAAM,WACN,OAAO,mBAAmB,EAAE,MAAM,QAI5C;CACF;8BApX6B,qBAAqB;0BAFzB,sBAAsB;6BADnB,0BAA0B;iCAFtB,8BAA8B;wBAOvC,oBAAoB"}
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../src/phaser/display/image.js"],"names":[],"mappings":"AASA;IACE;;;;;;;OAOG;IACH,kBANW,OAAO,iBAAiB,EAAE,IAAI,KAC9B,MAAM,KACN,MAAM,OACN,MAAM,GAAG,MAAM,GAAG,OAAO,UACzB,MAAM,GAAG,MAAM,EAwCzB;IApCC,qBAAqB;IACrB,MADW,MAAM,CACA;IAGjB,wCAAwC;IACxC,KADW,MAAM,GAAG,MAAM,GAAG,OAAO,CACtB;IACd,aAAwD;IAOxD,qBAAqB;IACrB,MADW,MAAM,CACG;IACpB,qBAAqB;IACrB,YADW,MAAM,CACG;IACpB,6BAA6B;IAC7B,eADW,OAAO,GAAG,IAAI,CACA;IACzB,6BAA6B;IAC7B,eADW,OAAO,GAAG,IAAI,CACA;IACzB,qBAAqB;IACrB,WADW,MAAM,CACY;IAC7B,YAAkB;IAClB,qDAAkB;IAClB,sBAAsB;IACtB,gBADW,OAAO,CACS;IAK3B,2BAA2B;IAC3B,QADW,YAAY,CACa;IACpC,+BAA+B;IAC/B,YADW,gBAAgB,CACiB;IAqC1C,sBAAuB;IAiB3B;;;;;OAKG;IACH,iBAJW,MAAM,GAAG,MAAM,GAAG,OAAO,UACzB,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,kBAClC,OAAO,QAsCjB;IAzBC,sBAAyB;IA2B3B;;;OAGG;IACH,gBAFW,OAAO,kBAAkB,EAAE,KAAK,QAyC1C;IAFG,wBAA0B;IAI9B;;;;;OAKG;IACH,oBAJW,aAAa,SACb,MAAM,UACN,MAAM,QAKhB;IAED;;OAEG;IACH,mBAIC;IAUD;;;OAGG;IACH,iBAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAkBD;;;OAGG;IACH,qBAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,iBAFa,MAAM,CAIlB;IAYD;;;;OAIG;IACH,WAHW,SAAS,SACT,OAAO,QAiBjB;IAVK,oBAAsE;IAMxE,WAAiB;IAMrB;;OAEG;IACH,mBA2BC;IAoCD;;OAEG;IACH,wBAQC;IAED;;;;OAIG;IACH,oBAHW,OAAO,gBACP,OAAO,QAIjB;IAED;;;;OAIG;IACH,mBAHW,OAAO,mBAAmB,EAAE,MAAM,GAChC,SAAS,CAIrB;IAUD;;;;OAIG;IACH,2BAHW,MAAM,WACN,OAAO,mBAAmB,EAAE,MAAM,QAI5C;IAED;;;;OAIG;IACH,4BAHW,MAAM,WACN,OAAO,mBAAmB,EAAE,MAAM,QAI5C;CACF;8BAtY6B,qBAAqB;wBAE3B,oBAAoB;0BAJlB,sBAAsB;6BADnB,0BAA0B;iCAFtB,8BAA8B"}