excalibur 0.25.2 → 0.25.3

package/build/dist/Util/WebAudio.js

@@ -0,0 +1,62 @@
+import { AudioContextFactory } from '../Resources/Sound/AudioContext';
+import { Logger } from './Log';
+/**
+ * Patch for detecting legacy web audio in browsers
+ * @internal
+ * @param source
+ */
+function isLegacyWebAudioSource(source) {
+    return !!source.playbackState;
+}
+export class WebAudio {
+    /**
+     * Play an empty sound to unlock Safari WebAudio context. Call this function
+     * right after a user interaction event.
+     * @source https://paulbakaus.com/tutorials/html5/web-audio-on-ios/
+     */
+    static unlock() {
+        const promise = new Promise((resolve, reject) => {
+            if (WebAudio._UNLOCKED || !AudioContextFactory.create()) {
+                return resolve(true);
+            }
+            const unlockTimeoutTimer = setTimeout(() => {
+                Logger.getInstance().warn('Excalibur was unable to unlock the audio context, audio probably will not play in this browser.');
+                resolve(false);
+            }, 200);
+            const audioContext = AudioContextFactory.create();
+            audioContext.resume().then(() => {
+                // create empty buffer and play it
+                const buffer = audioContext.createBuffer(1, 1, 22050);
+                const source = audioContext.createBufferSource();
+                let ended = false;
+                source.buffer = buffer;
+                source.connect(audioContext.destination);
+                source.onended = () => (ended = true);
+                source.start(0);
+                // by checking the play state after some time, we know if we're really unlocked
+                setTimeout(() => {
+                    if (isLegacyWebAudioSource(source)) {
+                        if (source.playbackState === source.PLAYING_STATE || source.playbackState === source.FINISHED_STATE) {
+                            WebAudio._UNLOCKED = true;
+                        }
+                    }
+                    else {
+                        if (audioContext.currentTime > 0 || ended) {
+                            WebAudio._UNLOCKED = true;
+                        }
+                    }
+                }, 0);
+                clearTimeout(unlockTimeoutTimer);
+                resolve(true);
+            }, () => {
+                reject();
+            });
+        });
+        return promise;
+    }
+    static isUnlocked() {
+        return this._UNLOCKED;
+    }
+}
+WebAudio._UNLOCKED = false;
+//# sourceMappingURL=WebAudio.js.map

package/build/dist/Util/WebAudio.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebAudio.js","sourceRoot":"","sources":["../../../src/engine/Util/WebAudio.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAQ/B;;;;GAIG;AACH,SAAS,sBAAsB,CAAC,MAAW;IACzC,OAAO,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;AAChC,CAAC;AAED,MAAM,OAAO,QAAQ;IAGnB;;;;OAIG;IACH,MAAM,CAAC,MAAM;QACX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACvD,IAAI,QAAQ,CAAC,SAAS,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,EAAE;gBACvD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;aACtB;YACD,MAAM,kBAAkB,GAAG,UAAU,CAAC,GAAG,EAAE;gBACzC,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,iGAAiG,CAAC,CAAC;gBAC7H,OAAO,CAAC,KAAK,CAAC,CAAC;YACjB,CAAC,EAAE,GAAG,CAAC,CAAC;YAER,MAAM,YAAY,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC;YAClD,YAAY,CAAC,MAAM,EAAE,CAAC,IAAI,CACxB,GAAG,EAAE;gBACH,kCAAkC;gBAClC,MAAM,MAAM,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;gBACtD,MAAM,MAAM,GAAG,YAAY,CAAC,kBAAkB,EAAE,CAAC;gBACjD,IAAI,KAAK,GAAG,KAAK,CAAC;gBAElB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;gBACvB,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;gBACzC,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;gBAEtC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAEhB,+EAA+E;gBAC/E,UAAU,CAAC,GAAG,EAAE;oBACd,IAAI,sBAAsB,CAAC,MAAM,CAAC,EAAE;wBAClC,IAAI,MAAM,CAAC,aAAa,KAAK,MAAM,CAAC,aAAa,IAAI,MAAM,CAAC,aAAa,KAAK,MAAM,CAAC,cAAc,EAAE;4BACnG,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC;yBAC3B;qBACF;yBAAM;wBACL,IAAI,YAAY,CAAC,WAAW,GAAG,CAAC,IAAI,KAAK,EAAE;4BACzC,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC;yBAC3B;qBACF;gBACH,CAAC,EAAE,CAAC,CAAC,CAAC;gBAEN,YAAY,CAAC,kBAAkB,CAAC,CAAC;gBACjC,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,EACD,GAAG,EAAE;gBACH,MAAM,EAAE,CAAC;YACX,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,UAAU;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;;AA1Dc,kBAAS,GAAY,KAAK,CAAC"}

package/build/dist/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
@@ -546,14 +546,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);
 };
 
@@ -585,14 +601,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 () {
@@ -688,7 +706,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', {
@@ -1312,9 +1330,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'
 });
 
 
@@ -5542,12 +5562,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
@@ -5592,6 +5614,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);
@@ -5623,7 +5646,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]]
  */
@@ -5631,6 +5679,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
 
@@ -7451,6 +7500,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;
@@ -9425,7 +9475,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({
@@ -10165,11 +10216,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;
@@ -14645,7 +14693,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();
             }
@@ -26352,7 +26400,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);
@@ -26986,6 +27041,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
@@ -27550,6 +27606,7 @@ O|===|* >________________>\n\
         // Flush any pending drawings
         this.graphicsContext.flush();
         this.graphicsContext.endDrawLifecycle();
+        this._checkForScreenShots();
     }
     /**
      * @internal
@@ -27758,12 +27815,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.
@@ -30121,7 +30200,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