excalibur 0.25.2 → 0.25.3

package/build/dist/index.js

@@ -0,0 +1,74 @@
+/**
+ * The current Excalibur version string
+ * @description `'0.25.3'` gets replaced by Webpack on build
+ */
+export const EX_VERSION = '0.25.3';
+import { polyfill } from './Polyfill';
+polyfill();
+// This file is used as the bundle entry point and exports everything
+// that will be exposed as the `ex` global variable.
+export * from './Flags';
+export * from './Id';
+export * from './Engine';
+export * from './Screen';
+export { Actor } from './Actor';
+export * from './Math/Index';
+export * from './Camera';
+export * from './Class';
+export * from './Configurable';
+export * from './Debug/index';
+export * from './EventDispatcher';
+export * from './Events/MediaEvents';
+export * from './Events';
+export * from './Label';
+export { FontStyle, FontUnit, TextAlign, BaseAlign } from './Graphics/FontCommon';
+export * from './Loader';
+export { Particle, ParticleEmitter, EmitterType } from './Particles';
+export * from './Collision/Physics';
+export * from './Scene';
+export { TileMap, Cell } from './TileMap';
+export * from './Timer';
+export * from './Trigger';
+export * from './ScreenElement';
+export * from './Actions/Index';
+export * from './Collision/Index';
+// ex.LegacyDrawing namespace
+import * as legacyDrawing from './Drawing/Index';
+export { legacyDrawing as LegacyDrawing };
+export * from './Interfaces/Index';
+export * from './Resources/Index';
+export * from './EntityComponentSystem/index';
+export * from './Color';
+export * from './Graphics/index';
+// ex.Events namespace
+import * as events from './Events';
+export { events as Events };
+// ex.Input namespace
+import * as input from './Input/Index';
+export { input as Input };
+export { PointerComponent } from './Input/Index';
+export { PointerSystem } from './Input/PointerSystem';
+// ex.Traits namespace
+import * as traits from './Traits/Index';
+export { traits as Traits };
+// ex.Util namespaces
+import * as util from './Util/Index';
+export { util as Util };
+export * from './Util/Browser';
+export * from './Util/Decorators';
+export * from './Util/Detector';
+export * from './Util/CullingBox';
+export * from './Util/EasingFunctions';
+export * from './Util/Observable';
+export * from './Util/Log';
+export * from './Util/SortedList';
+export * from './Util/Pool';
+export * from './Util/Fps';
+export * from './Util/Clock';
+export * from './Util/WebAudio';
+// ex.Deprecated
+export * from './Promises';
+// import * as deprecated from './Deprecated';
+// export { deprecated as Deprecated };
+// export * from './Deprecated';
+//# sourceMappingURL=index.js.map

package/build/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/engine/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,QAAQ,EAAE,CAAC;AAEX,qEAAqE;AACrE,oDAAoD;AACpD,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,KAAK,EAAa,MAAM,SAAS,CAAC;AAC3C,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClF,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAqC,WAAW,EAAE,MAAM,aAAa,CAAC;AACxG,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAyB,MAAM,WAAW,CAAC;AACjE,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAEhC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAElC,6BAA6B;AAC7B,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,aAAa,IAAI,aAAa,EAAE,CAAC;AAC1C,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAElC,cAAc,+BAA+B,CAAC;AAE9C,cAAc,SAAS,CAAC;AAExB,cAAc,kBAAkB,CAAC;AAEjC,sBAAsB;AACtB,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,CAAC;AAE5B,qBAAqB;AACrB,OAAO,KAAK,KAAK,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,KAAK,IAAI,KAAK,EAAE,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,sBAAsB;AACtB,OAAO,KAAK,MAAM,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,CAAC;AAE5B,qBAAqB;AACrB,OAAO,KAAK,IAAI,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;AAExB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAEhC,gBAAgB;AAChB,cAAc,YAAY,CAAC;AAC3B,8CAA8C;AAC9C,uCAAuC;AACvC,gCAAgC"}

package/build/esm/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

package/build/esm/Graphics/Context/texture-loader.d.ts

@@ -4,6 +4,7 @@ import { HTMLImageSource } from './ExcaliburGraphicsContext';
  * Manages loading image sources into webgl textures, a unique id is associated with all sources
  */
 export declare class TextureLoader {
+    private static _LOGGER;
     /**
      * Sets the default filtering for the Excalibur texture loader, default [[ImageFiltering.Blended]]
      */
@@ -12,6 +13,7 @@ export declare class TextureLoader {
     private static _POT_CTX;
     private static _GL;
     private static _TEXTURE_MAP;
+    private static _MAX_TEXTURE_SIZE;
     static register(context: WebGLRenderingContext): void;
     /**
      * Get the WebGL Texture from a source image
@@ -36,4 +38,10 @@ export declare class TextureLoader {
      * @param image
      */
     static toPowerOfTwoImage(image: HTMLImageSource): HTMLImageSource;
+    /**
+     * Takes an image and returns if it meets size criteria for hardware
+     * @param image
+     * @returns if the image will be supported at runtime
+     */
+    static checkImageSizeSupportedAndLog(image: HTMLImageSource): boolean;
 }

package/build/esm/excalibur.js

@@ -1,5 +1,5 @@
 /*!
- * excalibur - 0.25.2 - 2022-1-21
+ * excalibur - 0.25.3 - 2022-2-5
  * https://github.com/excaliburjs/Excalibur
  * Copyright (c) 2022 Excalibur.js <https://github.com/excaliburjs/Excalibur/graphs/contributors>
  * Licensed BSD-2-Clause
@@ -533,14 +533,30 @@ module.exports = function (exec) {
 };
 
 
+/***/ }),
+
+/***/ 7188:
+/***/ ((module, __unused_webpack_exports, __webpack_require__) => {
+
+var fails = __webpack_require__(4229);
+
+module.exports = !fails(function () {
+  var test = (function () { /* empty */ }).bind();
+  // eslint-disable-next-line no-prototype-builtins -- safe
+  return typeof test != 'function' || test.hasOwnProperty('prototype');
+});
+
+
 /***/ }),
 
 /***/ 266:
-/***/ ((module) => {
+/***/ ((module, __unused_webpack_exports, __webpack_require__) => {
+
+var NATIVE_BIND = __webpack_require__(7188);
 
 var call = Function.prototype.call;
 
-module.exports = call.bind ? call.bind(call) : function () {
+module.exports = NATIVE_BIND ? call.bind(call) : function () {
   return call.apply(call, arguments);
 };
 
@@ -572,14 +588,16 @@ module.exports = {
 /***/ }),
 
 /***/ 5968:
-/***/ ((module) => {
+/***/ ((module, __unused_webpack_exports, __webpack_require__) => {
+
+var NATIVE_BIND = __webpack_require__(7188);
 
 var FunctionPrototype = Function.prototype;
 var bind = FunctionPrototype.bind;
 var call = FunctionPrototype.call;
-var uncurryThis = bind && bind.bind(call, call);
+var uncurryThis = NATIVE_BIND && bind.bind(call, call);
 
-module.exports = bind ? function (fn) {
+module.exports = NATIVE_BIND ? function (fn) {
   return fn && uncurryThis(fn);
 } : function (fn) {
   return fn && function () {
@@ -675,7 +693,7 @@ var DESCRIPTORS = __webpack_require__(7400);
 var fails = __webpack_require__(4229);
 var createElement = __webpack_require__(2635);
 
-// Thank's IE8 for his funny defineProperty
+// Thanks to IE8 for its funny defineProperty
 module.exports = !DESCRIPTORS && !fails(function () {
   // eslint-disable-next-line es/no-object-defineproperty -- required for testing
   return Object.defineProperty(createElement('div'), 'a', {
@@ -1298,9 +1316,11 @@ var store = __webpack_require__(5353);
 (module.exports = function (key, value) {
   return store[key] || (store[key] = value !== undefined ? value : {});
 })('versions', []).push({
-  version: '3.20.2',
+  version: '3.21.0',
   mode: IS_PURE ? 'pure' : 'global',
-  copyright: '© 2022 Denis Pushkarev (zloirock.ru)'
+  copyright: '© 2014-2022 Denis Pushkarev (zloirock.ru)',
+  license: 'https://github.com/zloirock/core-js/blob/v3.21.0/LICENSE',
+  source: 'https://github.com/zloirock/core-js'
 });
 
 
@@ -5521,12 +5541,14 @@ var ImageFiltering;
 ;// CONCATENATED MODULE: ./Graphics/Context/texture-loader.ts
 
 
+
 /**
  * Manages loading image sources into webgl textures, a unique id is associated with all sources
  */
 class TextureLoader {
     static register(context) {
         TextureLoader._GL = context;
+        TextureLoader._MAX_TEXTURE_SIZE = context.getParameter(context.MAX_TEXTURE_SIZE);
     }
     /**
      * Get the WebGL Texture from a source image
@@ -5571,6 +5593,7 @@ class TextureLoader {
         // No texture exists create a new one
         tex = gl.createTexture();
         const source = TextureLoader.toPowerOfTwoImage(image);
+        TextureLoader.checkImageSizeSupportedAndLog(image);
         gl.bindTexture(gl.TEXTURE_2D, tex);
         gl.pixelStorei(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, true);
         gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_S, gl.CLAMP_TO_EDGE);
@@ -5602,7 +5625,32 @@ class TextureLoader {
         }
         return image;
     }
+    /**
+     * Takes an image and returns if it meets size criteria for hardware
+     * @param image
+     * @returns if the image will be supported at runtime
+     */
+    static checkImageSizeSupportedAndLog(image) {
+        var _a;
+        const originalSrc = (_a = image.dataset.originalSrc) !== null && _a !== void 0 ? _a : 'internal canvas bitmap';
+        if (image.width > TextureLoader._MAX_TEXTURE_SIZE || image.height > TextureLoader._MAX_TEXTURE_SIZE) {
+            TextureLoader._LOGGER.error(`The image [${originalSrc}] provided to Excalibur is too large for the device's maximum texture size of ` +
+                `(${TextureLoader._MAX_TEXTURE_SIZE}x${TextureLoader._MAX_TEXTURE_SIZE}) please resize to an image `
+                + `for excalibur to render properly.\n\nImages will likely render as black rectangles.\n\n` +
+                `Read more here: https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/WebGL_best_practices#understand_system_limits`);
+            return false;
+        }
+        else if (image.width > 4096 || image.height > 4096) {
+            // https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/WebGL_best_practices#understand_system_limits
+            TextureLoader._LOGGER.warn(`The image [${originalSrc}] provided to excalibur is too large may not work on all mobile devices, ` +
+                `it is recommended you resize images to a maximum (4096x4096).\n\n` +
+                `Images will likely render as black rectangles on some mobile platforms.\n\n` +
+                `Read more here: https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/WebGL_best_practices#understand_system_limits`);
+        }
+        return true;
+    }
 }
+TextureLoader._LOGGER = Logger.getInstance();
 /**
  * Sets the default filtering for the Excalibur texture loader, default [[ImageFiltering.Blended]]
  */
@@ -5610,6 +5658,7 @@ TextureLoader.filtering = ImageFiltering.Blended;
 TextureLoader._POT_CANVAS = document.createElement('canvas');
 TextureLoader._POT_CTX = TextureLoader._POT_CANVAS.getContext('2d');
 TextureLoader._TEXTURE_MAP = new Map();
+TextureLoader._MAX_TEXTURE_SIZE = 0;
 
 ;// CONCATENATED MODULE: ./Graphics/Raster.ts
 
@@ -7430,6 +7479,7 @@ class ImageSource {
             // Decode the image
             const image = new Image();
             image.src = url;
+            image.setAttribute('data-original-src', this.path);
             await image.decode();
             // Set results
             this.data = image;
@@ -9404,7 +9454,8 @@ class ImageRenderer {
         this._gl = gl;
         this._context = context;
         // Transform shader source
-        this._maxTextures = gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS);
+        // FIXME: PIXEL 6 complains `ERROR: Expression too complex.` if we use it's reported max texture units, 125 seems to work for now...
+        this._maxTextures = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), 125);
         const transformedFrag = this._transformFragmentSource(image_renderer_frag, this._maxTextures);
         // Compile shader
         this._shader = new Shader({
@@ -10144,11 +10195,8 @@ class ExcaliburGraphicsContextWebGL {
      */
     checkIfResolutionSupported(dim) {
         // Slight hack based on this thread https://groups.google.com/g/webgl-dev-list/c/AHONvz3oQTo
-        const gl = this.__gl;
-        // If any dimension is greater than max texture size (divide by 4 bytes per pixel)
-        const maxDim = gl.getParameter(gl.MAX_TEXTURE_SIZE) / 4;
         let supported = true;
-        if (dim.width > maxDim || dim.height > maxDim) {
+        if (dim.width > 4096 || dim.height > 4096) {
             supported = false;
         }
         return supported;
@@ -14624,7 +14672,7 @@ const CollisionJumpTable = {
             let normal = separation.axis;
             let tangent = normal.perpendicular();
             // Point Contact A -> B
-            if (polyB.worldPos.sub(polyA.worldPos).dot(normal) < 0) {
+            if (polyB.center.sub(polyA.center).dot(normal) < 0) {
                 normal = normal.negate();
                 tangent = normal.perpendicular();
             }
@@ -26331,7 +26379,14 @@ class PointerEventReceiver extends Class {
      */
     init() {
         // Disabling the touch action avoids browser/platform gestures from firing on the canvas
-        this.engine.canvas.style.touchAction = 'none';
+        // It is important on mobile to have touch action 'none'
+        // https://stackoverflow.com/questions/48124372/pointermove-event-not-working-with-touch-why-not
+        if (this.target === this.engine.canvas) {
+            this.engine.canvas.style.touchAction = 'none';
+        }
+        else {
+            document.body.style.touchAction = 'none';
+        }
         // Preferred pointer events
         if (window.PointerEvent) {
             this.target.addEventListener('pointerdown', this._boundHandle);
@@ -26965,6 +27020,7 @@ class Engine extends Class {
         this._isReadyPromise = new Promise(resolve => {
             this._isReadyResolve = resolve;
         });
+        this._screenShotRequests = [];
         options = { ...Engine._DEFAULT_ENGINE_OPTIONS, ...options };
         Flags.freeze();
         // Initialize browser events facade
@@ -27529,6 +27585,7 @@ O|===|* >________________>\n\
         // Flush any pending drawings
         this.graphicsContext.flush();
         this.graphicsContext.endDrawLifecycle();
+        this._checkForScreenShots();
     }
     /**
      * @internal
@@ -27737,12 +27794,34 @@ O|===|* >________________>\n\
     /**
      * 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() {
-        const result = new Image();
-        const raw = this.canvas.toDataURL('image/png');
-        result.src = raw;
-        return result;
+    screenshot(preserveHiDPIResolution = false) {
+        const screenShotPromise = new Promise((resolve) => {
+            this._screenShotRequests.push({ preserveHiDPIResolution, resolve });
+        });
+        return screenShotPromise;
+    }
+    _checkForScreenShots() {
+        // We must grab the draw buffer before we yield to the browser
+        // the draw buffer is cleared after compositing
+        // the reason for the asynchrony is setting `preserveDrawingBuffer: true`
+        // forces the browser to copy buffers which can have a mass perf impact on mobile
+        for (const request of this._screenShotRequests) {
+            const finalWidth = request.preserveHiDPIResolution ? this.canvas.width : this.screen.resolution.width;
+            const finalHeight = request.preserveHiDPIResolution ? this.canvas.height : this.screen.resolution.height;
+            const screenshot = document.createElement('canvas');
+            screenshot.width = finalWidth;
+            screenshot.height = finalHeight;
+            const ctx = screenshot.getContext('2d');
+            ctx.drawImage(this.canvas, 0, 0, finalWidth, finalHeight);
+            const result = new Image();
+            const raw = screenshot.toDataURL('image/png');
+            result.src = raw;
+            request.resolve(result);
+        }
+        // Reset state
+        this._screenShotRequests.length = 0;
     }
     /**
      * Another option available to you to load resources into the game.
@@ -30100,7 +30179,7 @@ Promises_Promise = Promise_1 = Promises_decorate([
  * The current Excalibur version string
  * @description `process.env.__EX_VERSION` gets replaced by Webpack on build
  */
-const EX_VERSION = "0.25.2";
+const EX_VERSION = "0.25.3";
 
 polyfill();
 // This file is used as the bundle entry point and exports everything