@makefully/platypus 4.1.21 → 4.1.23

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makefully/platypus",
-    "version": "4.1.21",
+    "version": "4.1.23",
     "description": "2D tile-based HTML5 game engine with a component-based entity model",
     "license": "MIT",
     "contributors": [

package/src/Game.js

@@ -1,6 +1,6 @@
 /* global document, platypus, window */
 import {Application} from 'springroll';
-import {CullerPlugin, Application as PixiApplication, Ticker, extensions} from 'pixi.js';
+import {CullerPlugin, Application as PixiApplication, Rectangle, Ticker, extensions} from 'pixi.js';
 import {arrayCache, greenSlice, greenSplice, union} from './utils/array.js';
 import Data from './Data.js';
 import Entity from './Entity.js';
@@ -823,6 +823,110 @@ class Game extends Messenger {
         }
         return entities;
     }
+
+    /**
+     * Captures a screenshot of the currently visible game viewport (the canvas /
+     * camera view), not the full stage or world bounds.
+     *
+     * Uses the same crop approach as Paco's ScreenShooter: after camera
+     * transforms, the visible area is stage space (0, 0, screenWidth, screenHeight).
+     * Extracting only that frame avoids pulling in off-screen world content and
+     * avoids GPU texture-size failures when a full level's stage bounds are huge.
+     *
+     * @param {Object} [options]
+     * @param {string} [options.format='png'] Image format for data URLs (`png`, `jpg`/`jpeg`, `webp`).
+     * @param {number} [options.quality] Encoder quality for lossy formats (0–1).
+     * @param {boolean} [options.render=true] Render the stage before capturing.
+     * @param {string} [options.as='dataURL'] Return type: `dataURL` or `canvas`.
+     * @return {Promise<string|HTMLCanvasElement|null>} Screenshot, or null if unavailable.
+     **/
+    async captureViewport (options = {}) {
+        const
+            {
+                format = 'png',
+                quality,
+                render = true,
+                as = 'dataURL'
+            } = options,
+            {renderer, stage} = this;
+
+        if (!renderer || !stage) {
+            return null;
+        }
+
+        if (render) {
+            renderer.render(stage);
+        }
+
+        const
+            width = Math.max(1, renderer.screen.width | 0),
+            height = Math.max(1, renderer.screen.height | 0),
+            resolution = renderer.resolution || 1,
+            backgroundColor = this.options?.display?.backgroundColor,
+            hasBackground = typeof backgroundColor === 'number' && backgroundColor >= 0,
+            // Opaque clear — transparent extracts read as a black shot in Notefully.
+            clearColor = hasBackground ? backgroundColor : 0x000000,
+            mime = format === 'jpg' || format === 'jpeg'
+                ? 'image/jpeg'
+                : format === 'webp'
+                    ? 'image/webp'
+                    : 'image/png',
+            toOutput = (canvas) => {
+                if (as === 'canvas') {
+                    return canvas;
+                }
+
+                return typeof quality === 'number'
+                    ? canvas.toDataURL(mime, quality)
+                    : canvas.toDataURL(mime);
+            };
+
+        try {
+            // Screen-sized framed extract (viewport only).
+            return toOutput(renderer.extract.canvas({
+                target: stage,
+                frame: new Rectangle(0, 0, width, height),
+                resolution,
+                clearColor
+            }));
+        } catch (err) {
+            platypus.debug.warn('Game.captureViewport framed extract failed; trying bounds crop.', err);
+        }
+
+        // Paco ScreenShooter fallback: full extract, then crop the screen origin.
+        try {
+            const
+                bounds = stage.getBounds(),
+                full = renderer.extract.canvas(stage),
+                dest = document.createElement('canvas'),
+                ctx = dest.getContext('2d');
+
+            dest.width = width;
+            dest.height = height;
+
+            if (hasBackground) {
+                ctx.fillStyle = `#${backgroundColor.toString(16).padStart(6, '0')}`;
+                ctx.fillRect(0, 0, width, height);
+            }
+
+            ctx.drawImage(
+                full,
+                -bounds.x,
+                -bounds.y,
+                width,
+                height,
+                0,
+                0,
+                width,
+                height
+            );
+
+            return toOutput(dest);
+        } catch (err) {
+            platypus.debug.warn('Game.captureViewport failed.', err);
+            return null;
+        }
+    }
     
     /**
     * This method destroys the game.