excalibur 0.25.2 → 0.25.3

package/build/dist/Drawing/SpriteSheet.js

@@ -0,0 +1,413 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Sprite } from './Sprite';
+import { Animation } from './Animation';
+import { Color } from '../Color';
+import * as Effects from './SpriteEffects';
+import { Texture } from './Texture';
+import { Logger } from '../Util/Log';
+import { BaseAlign, TextAlign } from '../Graphics/FontCommon';
+import { obsolete } from '../Util/Decorators';
+import { vec } from '../Math/vector';
+/**
+ * Sprite sheets are a useful mechanism for slicing up image resources into
+ * separate sprites or for generating in game animations. [[Sprite|Sprites]] are organized
+ * in row major order in the [[SpriteSheet]].
+ * @deprecated Will be removed in v0.26.0
+ */
+export class SpriteSheet {
+    /**
+     * @param imageOrConfigOrSprites The backing image texture to build the SpriteSheet, option bag, or sprite list
+     * @param columns   The number of columns in the image texture
+     * @param rows      The number of rows in the image texture
+     * @param spWidth   The width of each individual sprite in pixels
+     * @param spHeight  The height of each individual sprite in pixels
+     * @param spacing   The spacing between every sprite in a spritesheet
+     */
+    constructor(imageOrConfigOrSprites, columns, rows, spWidth, spHeight, spacing) {
+        this._sprites = [];
+        this._image = null;
+        this._columns = 0;
+        this._rows = 0;
+        this._spWidth = 0;
+        this._spHeight = 0;
+        this._spacing = 0;
+        let loadFromImage = false;
+        if (imageOrConfigOrSprites instanceof Array) {
+            this._sprites = imageOrConfigOrSprites;
+        }
+        else {
+            if (imageOrConfigOrSprites && !(imageOrConfigOrSprites instanceof Texture)) {
+                this._columns = imageOrConfigOrSprites.columns;
+                this._rows = imageOrConfigOrSprites.rows;
+                this._spWidth = imageOrConfigOrSprites.spWidth;
+                this._spHeight = imageOrConfigOrSprites.spHeight;
+                this._image = imageOrConfigOrSprites.image;
+                this._spacing = imageOrConfigOrSprites.spacing || 0;
+            }
+            else {
+                this._image = imageOrConfigOrSprites;
+                this._columns = columns;
+                this._rows = rows;
+                this._spWidth = spWidth;
+                this._spHeight = spHeight;
+                this._spacing = spacing || 0;
+            }
+            this._sprites = new Array(this._columns * this._rows);
+            loadFromImage = true;
+        }
+        // Inspect actual image dimensions with preloading
+        if (this.image instanceof Texture) {
+            let isWidthError = false;
+            let isHeightError = false;
+            if (this.image.isLoaded()) {
+                isWidthError = this.spWidth * this.columns > this.image.image.naturalWidth;
+                isHeightError = this.spHeight * this.rows > this.image.image.naturalHeight;
+                if (isWidthError) {
+                    throw new RangeError(`SpriteSheet specified is wider, ` +
+                        `${this.columns} cols x ${this.spWidth} pixels > ${this.image.image.naturalWidth} ` +
+                        `pixels than image width`);
+                }
+                if (isHeightError) {
+                    throw new RangeError(`SpriteSheet specified is taller, ` +
+                        `${this.rows} rows x ${this.spHeight} pixels > ${this.image.image.naturalHeight} ` +
+                        `pixels than image height`);
+                }
+            }
+        }
+        if (loadFromImage) {
+            const spacing = this.getSpacingDimensions();
+            for (let row = 0; row < this.rows; row++) {
+                for (let col = 0; col < this.columns; col++) {
+                    this._sprites[col + row * this.columns] = new Sprite(this.image, col * this.spWidth + spacing.margin * col + spacing.left, row * this.spHeight + spacing.margin * row + spacing.top, this.spWidth, this.spHeight);
+                }
+            }
+        }
+    }
+    /**
+     * Gets the raw spacing dimensions for the sprites in the sheet, which can be a fixed number or custom dimensions.
+     */
+    get spacing() {
+        return this._spacing;
+    }
+    /**
+     * Get a copy of the backing sprite array
+     */
+    get sprites() {
+        return [...this._sprites];
+    }
+    /**
+     * The backing texture used for the sprite sheet
+     */
+    get image() {
+        return this._image;
+    }
+    /**
+     * The number of columns in the sheet
+     */
+    get columns() {
+        return this._columns;
+    }
+    /**
+     * The number of rows in the sheet
+     */
+    get rows() {
+        return this._rows;
+    }
+    /**
+     * The width of the individual sprites
+     */
+    get spWidth() {
+        return this._spWidth;
+    }
+    /**
+     * The height of the individual sprites
+     */
+    get spHeight() {
+        return this._spHeight;
+    }
+    /**
+     * Gets the calculated spacing dimensions based on whether spacing
+     * is a fixed number or has different values for each dimension
+     */
+    getSpacingDimensions() {
+        var _a, _b, _c;
+        if (typeof this.spacing === 'number') {
+            return {
+                left: this.spacing,
+                top: this.spacing,
+                margin: this.spacing
+            };
+        }
+        else {
+            return {
+                left: (_a = this.spacing.left) !== null && _a !== void 0 ? _a : 0,
+                top: (_b = this.spacing.top) !== null && _b !== void 0 ? _b : 0,
+                margin: (_c = this.spacing.margin) !== null && _c !== void 0 ? _c : 0
+            };
+        }
+    }
+    /**
+     * Create an animation from the this SpriteSheet by listing out the
+     * sprite indices. Sprites are organized in row major order in the SpriteSheet.
+     * @param engine   Reference to the current game [[Engine]]
+     * @param indices  An array of sprite indices to use in the animation
+     * @param speed    The number in milliseconds to display each frame in the animation
+     */
+    getAnimationByIndices(engine, indices, speed) {
+        let images = indices.map((index) => {
+            return this.sprites[index];
+        });
+        images = images.map(function (i) {
+            return i.clone();
+        });
+        return new Animation(engine, images, speed);
+    }
+    /**
+     * Create an animation from the this SpriteSheet by specifying the range of
+     * images with the beginning (inclusive) and ending (exclusive) index
+     * For example `getAnimationBetween(engine, 0, 5, 200)` returns an animation with 5 frames.
+     * @param engine      Reference to the current game Engine
+     * @param beginIndex  The index to start taking frames (inclusive)
+     * @param endIndex    The index to stop taking frames (exclusive)
+     * @param speed       The number in milliseconds to display each frame in the animation
+     */
+    getAnimationBetween(engine, beginIndex, endIndex, speed) {
+        let images = this.sprites.slice(beginIndex, endIndex);
+        images = images.map(function (i) {
+            return i.clone();
+        });
+        return new Animation(engine, images, speed);
+    }
+    /**
+     * Treat the entire SpriteSheet as one animation, organizing the frames in
+     * row major order.
+     * @param engine  Reference to the current game [[Engine]]
+     * @param speed   The number in milliseconds to display each frame the animation
+     */
+    getAnimationForAll(engine, speed) {
+        const sprites = this.sprites.map(function (i) {
+            return i.clone();
+        });
+        return new Animation(engine, sprites, speed);
+    }
+    /**
+     * Retrieve a specific sprite from the SpriteSheet by its index. Sprites are organized
+     * in row major order in the SpriteSheet.
+     * @param index  The index of the sprite
+     */
+    getSprite(index) {
+        if (index >= 0 && index < this.sprites.length) {
+            return this.sprites[index];
+        }
+        else {
+            throw new Error('Invalid index: ' + index);
+        }
+    }
+    /**
+     * Get an animation with bespoke sprite coordinates. This is useful if the SpriteSheet is
+     * packed and not a uniform width or height. The resulting [[Animation]] will have the height and width of the
+     * largest dimension (width, height) from among the sprite coordinates
+     * @param engine
+     * @param spriteCoordinates
+     * @param speed
+     */
+    getAnimationByCoords(engine, spriteCoordinates, speed) {
+        let maxWidth = 0;
+        let maxHeight = 0;
+        const sprites = new Array(spriteCoordinates.length);
+        for (let i = 0; i < spriteCoordinates.length; i++) {
+            const coord = spriteCoordinates[i];
+            // no need to pass image again if using a spritesheet
+            coord.image = coord.image || this.image;
+            maxWidth = Math.max(maxWidth, coord.drawWidth);
+            maxHeight = Math.max(maxHeight, coord.drawHeight);
+            sprites[i] = new Sprite(coord);
+        }
+        const anim = new Animation(engine, sprites, speed);
+        anim.drawWidth = maxWidth;
+        anim.drawHeight = maxHeight;
+        return anim;
+    }
+}
+/**
+ * Sprite fonts are a used in conjunction with a [[Label]] to specify
+ * a particular bitmap as a font. Note that some font features are not
+ * supported by Sprite fonts.
+ * @deprecated Will be removed into v0.26.0
+ */
+let SpriteFont = class SpriteFont extends SpriteSheet {
+    /**
+     * @param imageOrConfig   The backing image texture to build the SpriteFont or the sprite font option bag
+     * @param alphabet        A string representing all the characters in the image, in row major order.
+     * @param caseInsensitive  Indicate whether this font takes case into account
+     * @param columns         The number of columns of characters in the image
+     * @param rows            The number of rows of characters in the image
+     * @param spWidth         The width of each character in pixels
+     * @param spHeight        The height of each character in pixels
+     */
+    constructor(imageOrConfig, alphabet, caseInsensitive, columns, rows, spWidth, spHeight, spacing) {
+        super(imageOrConfig instanceof Texture
+            ? {
+                image: imageOrConfig,
+                spWidth: spWidth,
+                spHeight: spHeight,
+                rows: rows,
+                columns: columns,
+                spacing: spacing || 0
+            }
+            : imageOrConfig);
+        this._currentColor = Color.Black;
+        this._currentOpacity = 1.0;
+        this._spriteRecord = {};
+        // text shadow
+        this._textShadowOn = false;
+        this._textShadowDirty = true;
+        this._textShadowColor = Color.Black;
+        this._textShadowSprites = {};
+        this._shadowOffsetX = 5;
+        this._shadowOffsetY = 5;
+        if (imageOrConfig && !(imageOrConfig instanceof Texture)) {
+            alphabet = imageOrConfig.alphabet;
+            caseInsensitive = imageOrConfig.caseInsensitive;
+        }
+        this.alphabet = alphabet;
+        this.caseInsensitive = caseInsensitive;
+        this._spriteRecord = this.getTextSprites();
+    }
+    /**
+     * Returns a dictionary that maps each character in the alphabet to the appropriate [[Sprite]].
+     */
+    getTextSprites() {
+        const lookup = {};
+        for (let i = 0; i < this.alphabet.length; i++) {
+            let char = this.alphabet[i];
+            if (this.caseInsensitive) {
+                char = char.toLowerCase();
+            }
+            lookup[char] = this.sprites[i].clone();
+        }
+        return lookup;
+    }
+    /**
+     * Sets the text shadow for sprite fonts
+     * @param offsetX      The x offset in pixels to place the shadow
+     * @param offsetY      The y offset in pixels to place the shadow
+     * @param shadowColor  The color of the text shadow
+     */
+    setTextShadow(offsetX, offsetY, shadowColor) {
+        this._textShadowOn = true;
+        this._shadowOffsetX = offsetX;
+        this._shadowOffsetY = offsetY;
+        this._textShadowColor = shadowColor.clone();
+        this._textShadowDirty = true;
+        for (const character in this._spriteRecord) {
+            this._textShadowSprites[character] = this._spriteRecord[character].clone();
+        }
+    }
+    /**
+     * Toggles text shadows on or off
+     */
+    useTextShadow(on) {
+        this._textShadowOn = on;
+        if (on) {
+            this.setTextShadow(5, 5, this._textShadowColor);
+        }
+    }
+    /**
+     * Draws the current sprite font
+     */
+    draw(ctx, text, x, y, options) {
+        options = this._parseOptions(options);
+        if (this._currentColor.toString() !== options.color.toString() || this._currentOpacity !== options.opacity) {
+            this._currentOpacity = options.opacity;
+            this._currentColor = options.color;
+            for (const char in this._spriteRecord) {
+                this._spriteRecord[char].clearEffects();
+                this._spriteRecord[char].fill(options.color);
+                this._spriteRecord[char].opacity(options.opacity);
+            }
+        }
+        if (this._textShadowOn && this._textShadowDirty && this._textShadowColor) {
+            for (const characterShadow in this._textShadowSprites) {
+                this._textShadowSprites[characterShadow].clearEffects();
+                this._textShadowSprites[characterShadow].addEffect(new Effects.Fill(this._textShadowColor.clone()));
+            }
+            this._textShadowDirty = false;
+        }
+        // find the current length of text in pixels
+        const sprite = this.sprites[0];
+        // find the current height fo the text in pixels
+        const height = sprite.height;
+        // calculate appropriate scale for font size
+        const scale = options.fontSize / height;
+        const length = text.length * sprite.width * scale + text.length * options.letterSpacing;
+        let currX = x;
+        if (options.textAlign === TextAlign.Left || options.textAlign === TextAlign.Start) {
+            currX = x;
+        }
+        else if (options.textAlign === TextAlign.Right || options.textAlign === TextAlign.End) {
+            currX = x - length;
+        }
+        else if (options.textAlign === TextAlign.Center) {
+            currX = x - length / 2;
+        }
+        let currY = y - height * scale;
+        if (options.baseAlign === BaseAlign.Top || options.baseAlign === BaseAlign.Hanging) {
+            currY = y;
+        }
+        else if (options.baseAlign === BaseAlign.Ideographic ||
+            options.baseAlign === BaseAlign.Bottom ||
+            options.baseAlign === BaseAlign.Alphabetic) {
+            currY = y - height * scale;
+        }
+        else if (options.baseAlign === BaseAlign.Middle) {
+            currY = y - (height * scale) / 2;
+        }
+        for (let i = 0; i < text.length; i++) {
+            let character = text[i];
+            if (this.caseInsensitive) {
+                character = character.toLowerCase();
+            }
+            try {
+                // if text shadow
+                if (this._textShadowOn) {
+                    this._textShadowSprites[character].drawAroundAnchor = false;
+                    this._textShadowSprites[character].scale = vec(scale, scale);
+                    this._textShadowSprites[character].draw(ctx, currX + this._shadowOffsetX, currY + this._shadowOffsetY);
+                }
+                const charSprite = this._spriteRecord[character];
+                charSprite.drawAroundAnchor = false;
+                charSprite.scale = vec(scale, scale);
+                charSprite.draw(ctx, currX, currY);
+                currX += charSprite.drawWidth + options.letterSpacing;
+            }
+            catch (e) {
+                Logger.getInstance().error(`SpriteFont Error drawing char ${character}`);
+            }
+        }
+    }
+    _parseOptions(options) {
+        return {
+            fontSize: options.fontSize || 10,
+            letterSpacing: options.letterSpacing || 0,
+            color: options.color || Color.Black,
+            textAlign: typeof options.textAlign === undefined ? TextAlign.Left : options.textAlign,
+            baseAlign: typeof options.baseAlign === undefined ? BaseAlign.Bottom : options.baseAlign,
+            maxWidth: options.maxWidth || -1,
+            opacity: options.opacity || 0
+        };
+    }
+};
+SpriteFont = __decorate([
+    obsolete({
+        message: 'SpriteSheet will be removed in v0.26.0',
+        alternateMethod: 'Use Graphics.SpriteSheet'
+    })
+], SpriteFont);
+export { SpriteFont };
+//# sourceMappingURL=SpriteSheet.js.map

package/build/dist/Drawing/SpriteSheet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpriteSheet.js","sourceRoot":"","sources":["../../../src/engine/Drawing/SpriteSheet.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,MAAM,EAAc,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAkBrC;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IAoCtB;;;;;;;OAOG;IACH,YACE,sBAA4D,EAC5D,OAAgB,EAChB,IAAa,EACb,OAAgB,EAChB,QAAiB,EACjB,OAA+C;QAjDzC,aAAQ,GAAa,EAAE,CAAC;QACxB,WAAM,GAAmB,IAAI,CAAC;QAC9B,aAAQ,GAAW,CAAC,CAAC;QACrB,UAAK,GAAW,CAAC,CAAC;QAClB,aAAQ,GAAW,CAAC,CAAC;QACrB,cAAS,GAAW,CAAC,CAAC;QACtB,aAAQ,GAA0C,CAAC,CAAC;QA6C1D,IAAI,aAAa,GAAY,KAAK,CAAC;QACnC,IAAI,sBAAsB,YAAY,KAAK,EAAE;YAC3C,IAAI,CAAC,QAAQ,GAAG,sBAAsB,CAAC;SACxC;aAAM;YACL,IAAI,sBAAsB,IAAI,CAAC,CAAC,sBAAsB,YAAY,OAAO,CAAC,EAAE;gBAC1E,IAAI,CAAC,QAAQ,GAAG,sBAAsB,CAAC,OAAO,CAAC;gBAC/C,IAAI,CAAC,KAAK,GAAG,sBAAsB,CAAC,IAAI,CAAC;gBACzC,IAAI,CAAC,QAAQ,GAAG,sBAAsB,CAAC,OAAO,CAAC;gBAC/C,IAAI,CAAC,SAAS,GAAG,sBAAsB,CAAC,QAAQ,CAAC;gBACjD,IAAI,CAAC,MAAM,GAAG,sBAAsB,CAAC,KAAK,CAAC;gBAC3C,IAAI,CAAC,QAAQ,GAAG,sBAAsB,CAAC,OAAO,IAAI,CAAC,CAAC;aACrD;iBAAM;gBACL,IAAI,CAAC,MAAM,GAAY,sBAAsB,CAAC;gBAC9C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;gBACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;gBAClB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;gBACxB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;gBAC1B,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,CAAC,CAAC;aAC9B;YACD,IAAI,CAAC,QAAQ,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACtD,aAAa,GAAG,IAAI,CAAC;SACtB;QAED,kDAAkD;QAClD,IAAI,IAAI,CAAC,KAAK,YAAY,OAAO,EAAE;YACjC,IAAI,YAAY,GAAY,KAAK,CAAC;YAClC,IAAI,aAAa,GAAY,KAAK,CAAC;YACnC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE;gBACzB,YAAY,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC;gBAC3E,aAAa,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC;gBAC3E,IAAI,YAAY,EAAE;oBAChB,MAAM,IAAI,UAAU,CAClB,kCAAkC;wBAChC,GAAG,IAAI,CAAC,OAAO,WAAW,IAAI,CAAC,OAAO,aAAa,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG;wBACnF,yBAAyB,CAC5B,CAAC;iBACH;gBACD,IAAI,aAAa,EAAE;oBACjB,MAAM,IAAI,UAAU,CAClB,mCAAmC;wBACjC,GAAG,IAAI,CAAC,IAAI,WAAW,IAAI,CAAC,QAAQ,aAAa,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,GAAG;wBAClF,0BAA0B,CAC7B,CAAC;iBACH;aACF;SACF;QAED,IAAI,aAAa,EAAE;YACjB,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAE5C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;gBACxC,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;oBAC3C,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,MAAM,CAClD,IAAI,CAAC,KAAK,EACV,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,EACxD,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,GAAG,EACxD,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,QAAQ,CACd,CAAC;iBACH;aACF;SACF;IACH,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,oBAAoB;;QACzB,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE;YACpC,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,OAAO;gBAClB,GAAG,EAAE,IAAI,CAAC,OAAO;gBACjB,MAAM,EAAE,IAAI,CAAC,OAAO;aACrB,CAAC;SACH;aAAM;YACL,OAAO;gBACL,IAAI,EAAE,MAAA,IAAI,CAAC,OAAO,CAAC,IAAI,mCAAI,CAAC;gBAC5B,GAAG,EAAE,MAAA,IAAI,CAAC,OAAO,CAAC,GAAG,mCAAI,CAAC;gBAC1B,MAAM,EAAE,MAAA,IAAI,CAAC,OAAO,CAAC,MAAM,mCAAI,CAAC;aACjC,CAAC;SACH;IACH,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,MAAc,EAAE,OAAiB,EAAE,KAAa;QAC3E,IAAI,MAAM,GAAa,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC;YAC7B,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;OAQG;IACI,mBAAmB,CAAC,MAAc,EAAE,UAAkB,EAAE,QAAgB,EAAE,KAAa;QAC5F,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACtD,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC;YAC7B,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,MAAc,EAAE,KAAa;QACrD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;YAC1C,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,KAAa;QAC5B,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAC5B;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,KAAK,CAAC,CAAC;SAC5C;IACH,CAAC;IAED;;;;;;;OAOG;IACI,oBAAoB,CAAC,MAAc,EAAE,iBAA+B,EAAE,KAAa;QACxF,IAAI,QAAQ,GAAW,CAAC,CAAC;QACzB,IAAI,SAAS,GAAW,CAAC,CAAC;QAC1B,MAAM,OAAO,GAAa,IAAI,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACjD,MAAM,KAAK,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;YACnC,qDAAqD;YACrD,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC;YACxC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;YAC/C,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;YAClD,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,MAAM,IAAI,GAAG,IAAI,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAEnD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAoBD;;;;;GAKG;AAKH,IAAa,UAAU,GAAvB,MAAa,UAAW,SAAQ,WAAW;IA4BzC;;;;;;;;OAQG;IACH,YACE,aAAuC,EACvC,QAAiB,EACjB,eAAyB,EACzB,OAAgB,EAChB,IAAa,EACb,OAAgB,EAChB,QAAiB,EACjB,OAA+C;QAE/C,KAAK,CACH,aAAa,YAAY,OAAO;YAC9B,CAAC,CAAC;gBACA,KAAK,EAAE,aAAa;gBACpB,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,QAAQ;gBAClB,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,OAAO;gBAChB,OAAO,EAAE,OAAO,IAAI,CAAC;aACtB;YACD,CAAC,CAAC,aAAa,CAClB,CAAC;QAzDI,kBAAa,GAAU,KAAK,CAAC,KAAK,CAAC;QACnC,oBAAe,GAAW,GAAG,CAAC;QAC9B,kBAAa,GAA2B,EAAE,CAAC;QAEnD,cAAc;QACN,kBAAa,GAAY,KAAK,CAAC;QAC/B,qBAAgB,GAAY,IAAI,CAAC;QACjC,qBAAgB,GAAU,KAAK,CAAC,KAAK,CAAC;QACtC,uBAAkB,GAA8B,EAAE,CAAC;QACnD,mBAAc,GAAW,CAAC,CAAC;QAC3B,mBAAc,GAAW,CAAC,CAAC;QAiDjC,IAAI,aAAa,IAAI,CAAC,CAAC,aAAa,YAAY,OAAO,CAAC,EAAE;YACxD,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;YAClC,eAAe,GAAG,aAAa,CAAC,eAAe,CAAC;SACjD;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,MAAM,MAAM,GAA8B,EAAE,CAAC;QAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC7C,IAAI,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC5B,IAAI,IAAI,CAAC,eAAe,EAAE;gBACxB,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;aAC3B;YACD,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;SACxC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAe,EAAE,OAAe,EAAE,WAAkB;QACvE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;QAC9B,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC;QAC5C,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE;YAC1C,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;SAC5E;IACH,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,EAAW;QAC9B,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,EAAE,EAAE;YACN,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACjD;IACH,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,GAA6B,EAAE,IAAY,EAAE,CAAS,EAAE,CAAS,EAAE,OAA0B;QACvG,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAEtC,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,eAAe,KAAK,OAAO,CAAC,OAAO,EAAE;YAC1G,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;YACvC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC;YACnC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;gBACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC;gBACxC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC7C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;aACnD;SACF;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACxE,KAAK,MAAM,eAAe,IAAI,IAAI,CAAC,kBAAkB,EAAE;gBACrD,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,YAAY,EAAE,CAAC;gBACxD,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;aACrG;YACD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;SAC/B;QAED,4CAA4C;QAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAE/B,gDAAgD;QAChD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAE7B,4CAA4C;QAC5C,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAC;QAExC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;QAExF,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,EAAE;YACjF,KAAK,GAAG,CAAC,CAAC;SACX;aAAM,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,GAAG,EAAE;YACvF,KAAK,GAAG,CAAC,GAAG,MAAM,CAAC;SACpB;aAAM,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE;YACjD,KAAK,GAAG,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC;SACxB;QAED,IAAI,KAAK,GAAG,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;QAC/B,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,GAAG,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,OAAO,EAAE;YAClF,KAAK,GAAG,CAAC,CAAC;SACX;aAAM,IACL,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,WAAW;YAC3C,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,MAAM;YACtC,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,UAAU,EAC1C;YACA,KAAK,GAAG,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;SAC5B;aAAM,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE;YACjD,KAAK,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;SAClC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACpC,IAAI,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,IAAI,CAAC,eAAe,EAAE;gBACxB,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;aACrC;YACD,IAAI;gBACF,iBAAiB;gBACjB,IAAI,IAAI,CAAC,aAAa,EAAE;oBACtB,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,gBAAgB,GAAG,KAAK,CAAC;oBAC5D,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;oBAC7D,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,CAAC,cAAc,EAAE,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;iBACxG;gBAED,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;gBACjD,UAAU,CAAC,gBAAgB,GAAG,KAAK,CAAC;gBACpC,UAAU,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBACrC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;gBACnC,KAAK,IAAI,UAAU,CAAC,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC;aACvD;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,iCAAiC,SAAS,EAAE,CAAC,CAAC;aAC1E;SACF;IACH,CAAC;IAEO,aAAa,CAAC,OAA0B;QAC9C,OAAO;YACL,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;YAChC,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,CAAC;YACzC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK;YACnC,SAAS,EAAE,OAAO,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS;YACtF,SAAS,EAAE,OAAO,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS;YACxF,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC;YAChC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,CAAC;SAC9B,CAAC;IACJ,CAAC;CACF,CAAA;AA5MY,UAAU;IAJtB,QAAQ,CAAC;QACR,OAAO,EAAE,wCAAwC;QACjD,eAAe,EAAE,0BAA0B;KAC5C,CAAC;GACW,UAAU,CA4MtB;SA5MY,UAAU"}

package/build/dist/Drawing/Texture.js

@@ -0,0 +1,69 @@
+import { Resource } from '../Resources/Resource';
+import { Sprite } from './Sprite';
+/**
+ * The [[Texture]] object allows games built in Excalibur to load image resources.
+ * [[Texture]] is an [[Loadable]] which means it can be passed to a [[Loader]]
+ * to pre-load before starting a level or game.
+ * @deprecated
+ */
+export class Texture {
+    /**
+     * @param path       Path to the image resource or a base64 string representing an image "data:image/png;base64,iVB..."
+     * @param bustCache  Optionally load texture with cache busting
+     */
+    constructor(path, bustCache = true) {
+        this.path = path;
+        this.bustCache = bustCache;
+        this._sprite = null;
+        this.loaded = new Promise(resolve => {
+            this._loadedResolve = resolve;
+        });
+        this._resource = new Resource(path, 'blob', bustCache);
+        this._sprite = new Sprite(this, 0, 0, 0, 0);
+    }
+    get image() {
+        return this.data;
+    }
+    /**
+     * Returns true if the Texture is completely loaded and is ready
+     * to be drawn.
+     */
+    isLoaded() {
+        return !!this.data;
+    }
+    /**
+     * Begins loading the texture and returns a promise to be resolved on completion
+     */
+    async load() {
+        try {
+            // Load base64 or blob if needed
+            let url;
+            if (!this.path.includes('data:image/')) {
+                const blob = await this._resource.load();
+                url = URL.createObjectURL(blob);
+            }
+            else {
+                url = this.path;
+            }
+            // Decode the image
+            const image = new Image();
+            image.src = url;
+            await image.decode();
+            // Set results
+            this.data = image;
+            this.width = this._sprite.width = image.naturalWidth;
+            this.height = this._sprite.height = image.naturalHeight;
+            this._sprite = new Sprite(this, 0, 0, this.width, this.height);
+        }
+        catch (_a) {
+            await Promise.reject('Error loading texture');
+        }
+        // todo emit complete
+        this._loadedResolve(this.data);
+        return this.data;
+    }
+    asSprite() {
+        return this._sprite;
+    }
+}
+//# sourceMappingURL=Texture.js.map

package/build/dist/Drawing/Texture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Texture.js","sourceRoot":"","sources":["../../../src/engine/Drawing/Texture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;GAKG;AACH,MAAM,OAAO,OAAO;IA2BlB;;;OAGG;IACH,YAAmB,IAAY,EAAS,YAAY,IAAI;QAArC,SAAI,GAAJ,IAAI,CAAQ;QAAS,cAAS,GAAT,SAAS,CAAO;QAnBhD,YAAO,GAAW,IAAI,CAAC;QAWxB,WAAM,GAAG,IAAI,OAAO,CAAmB,OAAO,CAAC,EAAE;YACtD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;QAChC,CAAC,CAAC,CAAC;QAOD,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAhBD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAgBD;;;OAGG;IACI,QAAQ;QACb,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI;QACf,IAAI;YACF,gCAAgC;YAChC,IAAI,GAAW,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;gBACtC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;gBACzC,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;aACjC;iBAAM;gBACL,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;aACjB;YAED,mBAAmB;YACnB,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;YAC1B,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;YAChB,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC;YAErB,cAAc;YACd,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;YAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,YAAY,CAAC;YACrD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC;YACxD,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SAChE;QAAC,WAAM;YACN,MAAM,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;SAC/C;QACD,qBAAqB;QACrB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF"}

package/build/dist/Engine.d.ts

@@ -629,11 +629,14 @@ export declare class Engine extends Class implements CanInitialize, CanUpdate, C
      * Returns the Engine's running status, Useful for checking whether engine is running or paused.
      */
     isRunning(): boolean;
+    private _screenShotRequests;
     /**
      * Takes a screen shot of the current viewport and returns it as an
      * HTML Image Element.
+     * @param preserveHiDPIResolution in the case of HiDPI return the full scaled backing image, by default false
      */
-    screenshot(): HTMLImageElement;
+    screenshot(preserveHiDPIResolution?: boolean): Promise<HTMLImageElement>;
+    private _checkForScreenShots;
     /**
      * Another option available to you to load resources into the game.
      * Immediately after calling this the game will pause and the loading screen