@vpmedia/phaser 1.94.0 → 1.96.0

package/types/phaser/core/cache.d.ts

@@ -10,8 +10,8 @@ export const XML: 8;
 export const RENDER_TEXTURE: 9;
 export class Cache {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
+     * Creates a new Cache instance.
+     * @param {import('./game.js').Game} game - The game instance.
      */
     constructor(game: import("./game.js").Game);
     game: import("./game.js").Game;
@@ -34,158 +34,158 @@ export class Cache {
     onSoundUnlock: Signal;
     _cacheMap: {}[];
     /**
-     * TBD.
+     * Adds the default image to the cache.
      */
     addDefaultImage(): void;
     /**
-     * TBD.
+     * Adds the missing image to the cache.
      */
     addMissingImage(): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {HTMLImageElement} data - TBD.
-     * @returns {object} TBD.
+     * Adds an image to the cache.
+     * @param {string} key - The unique key for this cache entry.
+     * @param {string} url - The URL the image was loaded from.
+     * @param {HTMLImageElement} data - The image data to cache.
+     * @returns {object} The cached image object.
      */
     addImage(key: string, url: string, data: HTMLImageElement): object;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {HTMLCanvasElement} data - TBD.
-     * @param {object} atlasData - TBD.
+     * Adds a texture atlas to the cache.
+     * @param {string} key - The unique key for this cache entry.
+     * @param {string} url - The URL the atlas was loaded from.
+     * @param {HTMLCanvasElement} data - The canvas data for the atlas.
+     * @param {object} atlasData - The atlas data to cache.
      */
     addTextureAtlas(key: string, url: string, data: HTMLCanvasElement, atlasData: object): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {object} data - TBD.
+     * Adds sound data to the cache.
+     * @param {string} key - The unique key for this cache entry.
+     * @param {string} url - The URL the sound was loaded from.
+     * @param {object} data - The sound data to cache.
      */
     addSound(key: string, url: string, data: object): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {string} data - TBD.
+     * Adds text data to the cache.
+     * @param {string} key - The unique key for this cache entry.
+     * @param {string} url - The URL the text was loaded from.
+     * @param {string} data - The text data to cache.
      */
     addText(key: string, url: string, data: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {HTMLCanvasElement} data - TBD.
-     * @param {object} atlasData - TBD.
-     * @param {string} atlasType - TBD.
-     * @param {number} xSpacing - TBD.
-     * @param {number} ySpacing - TBD.
+     * Adds a bitmap font to the cache.
+     * @param {string} key - The unique key for this cache entry.
+     * @param {string} url - The URL the bitmap font was loaded from.
+     * @param {HTMLCanvasElement} data - The canvas data for the font.
+     * @param {object} atlasData - The bitmap font atlas data to cache.
+     * @param {string} atlasType - The type of the atlas data ('json' or 'xml').
+     * @param {number} xSpacing - Horizontal spacing between characters.
+     * @param {number} ySpacing - Vertical spacing between characters.
      */
     addBitmapFont(key: string, url: string, data: HTMLCanvasElement, atlasData: object, atlasType: string, xSpacing?: number, ySpacing?: number): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {object} data - TBD.
+     * Adds JSON data to the cache.
+     * @param {string} key - The unique key for this cache entry.
+     * @param {string} url - The URL the JSON was loaded from.
+     * @param {object} data - The JSON data to cache.
      */
     addJSON(key: string, url: string, data: object): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {XMLDocument} data - TBD.
+     * Adds XML data to the cache.
+     * @param {string} key - The unique key for this cache entry.
+     * @param {string} url - The URL the XML was loaded from.
+     * @param {XMLDocument} data - The XML data to cache.
      */
     addXML(key: string, url: string, data: XMLDocument): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} property - TBD.
-     * @param {any} value - TBD.
+     * Updates a sound property in the cache.
+     * @param {string} key - The unique key for the cached sound.
+     * @param {string} property - The property to update.
+     * @param {any} value - The new value for the property.
      */
     updateSound(key: string, property: string, value: any): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {AudioBuffer} data - TBD.
+     * Marks a sound as decoded in the cache.
+     * @param {string} key - The unique key for the cached sound.
+     * @param {AudioBuffer} data - The decoded audio buffer.
      */
     decodedSound(key: string, data: AudioBuffer): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a sound has been decoded in the cache.
+     * @param {string} key - The unique key for the cached sound.
+     * @returns {boolean} True if the sound is decoded, false otherwise.
      */
     isSoundDecoded(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a sound is ready to play (decoded and not locked).
+     * @param {string} key - The unique key for the cached sound.
+     * @returns {boolean} True if the sound is ready, false otherwise.
      */
     isSoundReady(key: string): boolean;
     /**
-     * TBD.
-     * @param {number} cache - TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a cache entry exists.
+     * @param {number} cache - The cache type (CANVAS, IMAGE, etc.).
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkKey(cache: number, key: string): boolean;
     /**
-     * TBD.
-     * @param {string} url - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a URL has been resolved and cached.
+     * @param {string} url - The URL to check.
+     * @returns {boolean} True if the URL has been resolved and cached, false otherwise.
      */
     checkURL(url: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a canvas cache entry exists.
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkCanvasKey(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if an image cache entry exists.
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkImageKey(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a texture cache entry exists.
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkTextureKey(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a sound cache entry exists.
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkSoundKey(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a text cache entry exists.
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkTextKey(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a bitmap data cache entry exists.
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkBitmapDataKey(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a bitmap font cache entry exists.
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkBitmapFontKey(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a JSON cache entry exists.
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkJSONKey(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if an XML cache entry exists.
+     * @param {string} key - The unique key for the cache entry.
+     * @returns {boolean} True if the entry exists, false otherwise.
      */
     checkXMLKey(key: string): boolean;
     /**
@@ -266,144 +266,144 @@ export class Cache {
      */
     getRenderTexture(key: string): import("../display/webgl/render_texture.js").RenderTexture;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {number} cache - TBD.
-     * @returns {BaseTexture} TBD.
+     * Gets the base texture of a cache entry.
+     * @param {string} key - The unique key for the cache entry.
+     * @param {number} cache - The cache type (CANVAS, IMAGE, etc.).
+     * @returns {BaseTexture} The base texture.
      */
     getBaseTexture(key: string, cache?: number): BaseTexture;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {number} cache - TBD.
-     * @returns {Frame} TBD.
+     * Gets a frame from the cache.
+     * @param {string} key - The unique key for the cache entry.
+     * @param {number} cache - The cache type (CANVAS, IMAGE, etc.).
+     * @returns {Frame} The frame.
      */
     getFrame(key: string, cache?: number): Frame;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {number} cache - TBD.
-     * @returns {number} TBD.
+     * Gets the frame count of a cache entry.
+     * @param {string} key - The unique key for the cache entry.
+     * @param {number} cache - The cache type (CANVAS, IMAGE, etc.).
+     * @returns {number} The number of frames.
      */
     getFrameCount(key: string, cache?: number): number;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {number} cache - TBD.
-     * @returns {FrameData} TBD.
+     * Gets the frame data of a cache entry.
+     * @param {string} key - The unique key for the cache entry.
+     * @param {number} cache - The cache type (CANVAS, IMAGE, etc.).
+     * @returns {FrameData} The frame data.
      */
     getFrameData(key: string, cache?: number): FrameData;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {number} cache - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a cache entry has frame data.
+     * @param {string} key - The unique key for the cache entry.
+     * @param {number} cache - The cache type (CANVAS, IMAGE, etc.).
+     * @returns {boolean} True if the entry has frame data, false otherwise.
      */
     hasFrameData(key: string, cache?: number): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {FrameData} frameData - TBD.
-     * @param {number} cache - TBD.
+     * Updates the frame data of a cache entry.
+     * @param {string} key - The unique key for the cache entry.
+     * @param {FrameData} frameData - The new frame data.
+     * @param {number} cache - The cache type (CANVAS, IMAGE, etc.).
      */
     updateFrameData(key: string, frameData: FrameData, cache?: number): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {number} index - TBD.
-     * @param {number} cache - TBD.
-     * @returns {Frame} TBD.
+     * Gets a frame by index from the cache.
+     * @param {string} key - The unique key for the cache entry.
+     * @param {number} index - The index of the frame to get.
+     * @param {number} cache - The cache type (CANVAS, IMAGE, etc.).
+     * @returns {Frame} The frame at the specified index.
      */
     getFrameByIndex(key: string, index: number, cache?: number): Frame;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} name - TBD.
-     * @param {number} cache - TBD.
-     * @returns {Frame} TBD.
+     * Gets a frame by name from the cache.
+     * @param {string} key - The unique key for the cache entry.
+     * @param {string} name - The name of the frame to get.
+     * @param {number} cache - The cache type (CANVAS, IMAGE, etc.).
+     * @returns {Frame} The frame with the specified name.
      */
     getFrameByName(key: string, name: string, cache?: number): Frame;
     /**
-     * TBD.
-     * @param {string} url - TBD.
-     * @returns {string} TBD.
+     * Gets the resolved URL from cache.
+     * @param {string} url - The original URL to resolve.
+     * @returns {string} The resolved URL or null if not found.
      */
     getURL(url: string): string;
     /**
-     * TBD.
-     * @param {object} cache - TBD.
-     * @returns {string[]} TBD.
+     * Gets all keys from a cache type.
+     * @param {object} cache - The cache type (CANVAS, IMAGE, etc.).
+     * @returns {string[]} An array of cache keys.
      */
     getKeys(cache?: object): string[];
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes a canvas cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeCanvas(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {boolean} destroyBaseTexture - TBD.
+     * Removes an image cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
+     * @param {boolean} destroyBaseTexture - Whether to destroy the base texture (default: true).
      */
     removeImage(key: string, destroyBaseTexture?: boolean): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes a sound cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeSound(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes a text cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeText(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes a bitmap data cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeBitmapData(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes a bitmap font cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeBitmapFont(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes a JSON cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeJSON(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes an XML cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeXML(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes a render texture cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeRenderTexture(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes a sprite sheet cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeSpriteSheet(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Removes a texture atlas cache entry.
+     * @param {string} key - The unique key for the cache entry to remove.
      */
     removeTextureAtlas(key: string): void;
     /**
-     * TBD.
+     * Clears all GL textures from the cache.
      */
     clearGLTextures(): void;
     /**
-     * TBD.
-     * @param {string} url - TBD.
-     * @param {object} data - TBD.
-     * @returns {string} TBD.
+     * Resolves a URL and stores it in the cache.
+     * @param {string} url - The URL to resolve.
+     * @param {object} data - The data to associate with the resolved URL.
+     * @returns {string} The resolved URL or null if not enabled.
      */
     _resolveURL(url: string, data: object): string;
     /**
-     * TBD.
+     * Destroys the cache and cleans up resources.
      */
     destroy(): void;
 }

package/types/phaser/core/device.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/device.js"],"names":[],"mappings":"AAAA;IAKI;;OAEG;IACH,SAFU,OAAO,CAEG;IACpB;;OAEG;IACH,KAFU,OAAO,CAED;IAChB;;OAEG;IACH,SAFU,OAAO,CAEG;IACpB;;OAEG;IACH,UAFU,OAAO,CAEI;IACrB;;OAEG;IACH,OAFU,OAAO,CAEC;IAClB;;OAEG;IACH,OAFU,OAAO,CAEC;IAClB;;OAEG;IACH,SAFU,OAAO,CAEG;IACpB;;OAEG;IACH,cAFU,OAAO,CAEQ;IACzB;;OAEG;IACH,QAFU,OAAO,CAEE;IACnB;;OAEG;IACH,OAFU,OAAO,CAEC;IAClB;;OAEG;IACH,WAFU,OAAO,CAEK;IACtB,gBAAsB;IACtB;;OAEG;IACH,QAFU,OAAO,CAEE;IACnB;;OAEG;IACH,SAFU,OAAO,CAEG;IACpB;;OAEG;IACH,MAFU,OAAO,CAEA;IACjB;;OAEG;IACH,QAFU,OAAO,CAEE;IACnB;;OAEG;IACH,YAFU,OAAO,CAEM;IACvB;;OAEG;IACH,mBAFU,MAAM,CAEW;IAC3B;;OAEG;IACH,kBAFU,MAAM,CAEU;IAC1B;;OAEG;IACH,oBAFU,OAAO,CAEc;IAC/B;;OAEG;IACH,eAFU,OAAO,CAES;IAC1B;;OAEG;IACH,uBAFU;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAEH;IAC/B;;OAEG;IACH,uBAFU;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAEH;CAElC"}
+{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/device.js"],"names":[],"mappings":"AAAA;IAMI;;OAEG;IACH,SAFU,OAAO,CAEG;IACpB;;OAEG;IACH,KAFU,OAAO,CAED;IAChB;;OAEG;IACH,SAFU,OAAO,CAEG;IACpB;;OAEG;IACH,UAFU,OAAO,CAEI;IACrB;;OAEG;IACH,OAFU,OAAO,CAEC;IAClB;;OAEG;IACH,OAFU,OAAO,CAEC;IAClB;;OAEG;IACH,SAFU,OAAO,CAEG;IACpB;;OAEG;IACH,cAFU,OAAO,CAEQ;IACzB;;OAEG;IACH,QAFU,OAAO,CAEE;IACnB;;OAEG;IACH,OAFU,OAAO,CAEC;IAClB;;OAEG;IACH,WAFU,OAAO,CAEK;IACtB,gBAAsB;IACtB;;OAEG;IACH,QAFU,OAAO,CAEE;IACnB;;OAEG;IACH,SAFU,OAAO,CAEG;IACpB;;OAEG;IACH,MAFU,OAAO,CAEA;IACjB;;OAEG;IACH,QAFU,OAAO,CAEE;IACnB;;OAEG;IACH,YAFU,OAAO,CAEM;IACvB;;OAEG;IACH,mBAFU,MAAM,CAEW;IAC3B;;OAEG;IACH,kBAFU,MAAM,CAEU;IAC1B;;OAEG;IACH,oBAFU,OAAO,CAEc;IAC/B;;OAEG;IACH,eAFU,OAAO,CAES;IAC1B;;OAEG;IACH,uBAFU;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAEH;IAC/B;;OAEG;IACH,uBAFU;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAEH;CAElC"}

package/types/phaser/core/dom.d.ts

@@ -11,84 +11,91 @@ export class DOM {
     scrollXProvider: () => number;
     scrollYProvider: () => number;
     /**
-     * TBD.
-     * @param {HTMLCanvasElement} element - TBD.
-     * @param {Point} point - TBD.
-     * @returns {Point} TBD.
+     * Gets the offset position of an element relative to the document.
+     * @param {HTMLCanvasElement} element - The element to get the offset for.
+     * @param {Point} point - Optional Point object to store the result.
+     * @returns {Point} The offset position of the element.
      */
     getOffset(element: HTMLCanvasElement, point?: Point): Point;
     /**
-     * TBD.
-     * @param {HTMLCanvasElement} element - TBD.
-     * @param {number} cushion - TBD.
-     * @returns {boolean} TBD.
+     * Gets the bounding rectangle of an element with optional cushion.
+     * @param {HTMLCanvasElement} element - The element to get bounds for.
+     * @param {number} cushion - Optional padding to add around the element.
+     * @returns {boolean} True if bounds were successfully retrieved, false otherwise.
      */
     getBounds(element: HTMLCanvasElement, cushion?: number): boolean;
     /**
-     * TBD.
-     * @param {DOMRect} coords - TBD.
-     * @param {number} cushion - TBD.
-     * @returns {object} TBD.
+     * Calibrates DOM rectangle coordinates with optional cushion.
+     * @param {DOMRect} coords - The DOM rectangle coordinates to calibrate.
+     * @param {number} cushion - Optional padding to add around the rectangle.
+     * @returns {{width: number, height: number, left: number, right: number, top: number, bottom: number}} The calibrated rectangle.
      */
-    calibrate(coords: DOMRect, cushion?: number): object;
+    calibrate(coords: DOMRect, cushion?: number): {
+        width: number;
+        height: number;
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    };
     /**
-     * TBD.
-     * @param {string} primaryFallback - TBD.
-     * @returns {string} TBD.
+     * Gets the screen orientation.
+     * @param {string} primaryFallback - The fallback method to use if screen orientation API is not available.
+     * @returns {string} The screen orientation ('portrait-primary', 'landscape-primary', etc.).
      */
     getScreenOrientation(primaryFallback: string): string;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the horizontal scroll position of the window.
+     * @returns {number} The horizontal scroll position in pixels.
      */
     get scrollX(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the vertical scroll position of the window.
+     * @returns {number} The vertical scroll position in pixels.
      */
     get scrollY(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the width of the window's client area.
+     * @returns {number} The width of the client area in pixels.
      */
     get clientWidth(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the height of the window's client area.
+     * @returns {number} The height of the client area in pixels.
      */
     get clientHeight(): number;
 }
 declare class VisualBoundsDesktopRectangle {
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the horizontal scroll position of the window.
+     * @returns {number} The horizontal scroll position in pixels.
      */
     get x(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the vertical scroll position of the window.
+     * @returns {number} The vertical scroll position in pixels.
      */
     get y(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the width of the window.
+     * @returns {number} The width of the window in pixels.
      */
     get width(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the height of the window.
+     * @returns {number} The height of the window in pixels.
      */
     get height(): number;
 }
 declare class VisualBoundsRectangle {
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the horizontal scroll position of the document.
+     * @returns {number} The horizontal scroll position in pixels.
      */
     get x(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the vertical scroll position of the document.
+     * @returns {number} The vertical scroll position in pixels.
      */
     get y(): number;
     /**
@@ -104,23 +111,23 @@ declare class VisualBoundsRectangle {
 }
 declare class LayoutBoundsDesktopRectangle {
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the horizontal scroll position of the window.
+     * @returns {number} The horizontal scroll position in pixels.
      */
     get x(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the vertical scroll position of the window.
+     * @returns {number} The vertical scroll position in pixels.
      */
     get y(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the width of the window.
+     * @returns {number} The width of the window in pixels.
      */
     get width(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the height of the window.
+     * @returns {number} The height of the window in pixels.
      */
     get height(): number;
 }

package/types/phaser/core/dom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/dom.js"],"names":[],"mappings":"AAqLA;IACE;;;OAGG;IACH,oBAFW,OAAO,aAAa,EAAE,MAAM,EActC;IAXC,wBAG6D;IAC7D,mEAA0G;IAC1G,mEAA0G;IAC1G,wCAAmD;IACnD,8BAC0G;IAC1G,8BACyG;IAG3G;;;;;OAKG;IACH,mBAJW,iBAAiB,UACjB,KAAK,GACH,KAAK,CAYjB;IAED;;;;;OAKG;IACH,mBAJW,iBAAiB,YACjB,MAAM,GACJ,OAAO,CAQnB;IAED;;;;;OAKG;IACH,kBAJW,OAAO,YACP,MAAM,GACJ,MAAM,CAclB;IAED;;;;OAIG;IACH,sCAHW,MAAM,GACJ,MAAM,CA8BlB;IAED;;;OAGG;IACH,eAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,eAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,mBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,oBAFa,MAAM,CAIlB;CACF;AA5TD;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAIlB;CACF;AAoCD;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAIlB;CACF;AAlED;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAIlB;CACF;AAoCD;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAMlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAMlB;CACF;AAKD;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAKlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAKlB;CACF;sBAnLqB,kBAAkB"}
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/dom.js"],"names":[],"mappings":"AAqLA;IACE;;;OAGG;IACH,oBAFW,OAAO,aAAa,EAAE,MAAM,EActC;IAXC,wBAG6D;IAC7D,mEAA0G;IAC1G,mEAA0G;IAC1G,wCAAmD;IACnD,8BAC0G;IAC1G,8BACyG;IAG3G;;;;;OAKG;IACH,mBAJW,iBAAiB,UACjB,KAAK,GACH,KAAK,CAYjB;IAED;;;;;OAKG;IACH,mBAJW,iBAAiB,YACjB,MAAM,GACJ,OAAO,CAQnB;IAED;;;;;OAKG;IACH,kBAJW,OAAO,YACP,MAAM,GACJ;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,CAcrG;IAED;;;;OAIG;IACH,sCAHW,MAAM,GACJ,MAAM,CA8BlB;IAED;;;OAGG;IACH,eAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,eAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,mBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,oBAFa,MAAM,CAIlB;CACF;AA5TD;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAIlB;CACF;AAoCD;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAIlB;CACF;AAlED;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAIlB;CACF;AAoCD;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAMlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAMlB;CACF;AAKD;IACE;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,MAAM,CAKlB;IAED;;;OAGG;IACH,cAFa,MAAM,CAKlB;CACF;sBAnLqB,kBAAkB"}