graphico 0.0.2 → 0.0.4

package/dist/canvas.js

@@ -13,13 +13,9 @@ var Canvas = /** @class */ (function () {
         if (options === void 0) { options = {}; }
         var _this = this;
         /**
-         * Whether or not the control is focused
+         * Can be used to render 2D graphics onto the canvas
          */
-        this.focused = false;
-        /**
-         * Frame counter, increments every frame
-         */
-        this.frame = 0;
+        this.graphics = [];
         /**
          * Contains a list of current keys pressed
          */
@@ -36,41 +32,55 @@ var Canvas = /** @class */ (function () {
          * Contains the mouse Y-coordinate, in pixels
          */
         this.mouseY = 0;
+        /**
+         * Represents the animation ID handle to cancel the animation
+         */
+        this.animation = 0;
+        /**
+         * The last frame's high resolution timestamp
+         */
+        this.lastFrame = 0;
+        /**
+         * Determine whether the client is focused or not
+         */
+        this.focused = false;
         this.config = Canvas.setDefaults(options, Canvas.defaults);
-        var canvas = document.createElement('canvas');
-        var graphics = canvas.getContext('2d');
-        if (graphics) {
-            this.graphics = graphics;
-        }
-        else {
-            throw new Error('Could not initialize canvas graphics.');
-        }
-        // Set static properties
-        this.config.parent.appendChild(canvas);
-        canvas.tabIndex = 1; // For element focus
-        canvas.style.outline = 'none';
-        canvas.style.imageRendering = 'pixelated';
-        // Set custom properties
-        canvas.width = this.config.width;
-        canvas.height = this.config.height;
-        canvas.style.width = "".concat(this.config.width * this.config.scale, "px");
-        canvas.style.height = "".concat(this.config.height * this.config.scale, "px");
-        canvas.style.background = this.config.background.toString();
-        canvas.style.border = "".concat(this.config.scale, "px solid ").concat(this.config.border);
-        canvas.style.cursor = this.config.showMouse ? 'default' : 'none';
-        // Initialize main sequence
-        if (this.config.framesPerSecond > 0) {
-            setInterval(function () {
-                if (!_this.focused) {
-                    return;
-                }
-                _this.frame++;
-                _this.log(_this.frame);
-                _this.config.loop(_this.frame, _this.keys, _this.mouseButtons, _this.mouseX, _this.mouseY);
-            }, 1000 / this.config.framesPerSecond);
+        this.width = this.config.width;
+        this.height = this.config.height;
+        // Create the container <div> element and set properties
+        var container = document.createElement('div');
+        container.tabIndex = 1; // For element focus
+        container.style.outline = 'none';
+        container.style.width = "".concat(this.config.width * this.config.scale, "px");
+        container.style.height = "".concat(this.config.height * this.config.scale, "px");
+        container.style.border = "".concat(this.config.scale, "px solid ").concat(this.config.border);
+        container.style.background = this.config.background;
+        container.style.cursor = this.config.showMouse ? 'default' : 'none';
+        container.style.position = 'relative';
+        this.config.parent.appendChild(container);
+        // Create canvas layers
+        for (var i = 0; i < this.config.numLayers; i++) {
+            var canvas = document.createElement('canvas');
+            var graphics = canvas.getContext('2d', { 'willReadFrequently': this.config.acceleration === 'software' });
+            if (graphics) {
+                this.graphics.push(graphics);
+            }
+            else {
+                throw new Error('Could not initialize canvas graphics.');
+            }
+            // Set properties for canvas
+            canvas.style.imageRendering = 'pixelated';
+            canvas.style.boxSizing = 'border-box';
+            canvas.width = this.config.width;
+            canvas.height = this.config.height;
+            canvas.style.width = '100%';
+            canvas.style.height = '100%';
+            canvas.style.position = 'absolute';
+            graphics.imageSmoothingEnabled = false;
+            container.appendChild(canvas);
         }
         // Event listeners
-        canvas.addEventListener('mousemove', function (e) {
+        container.addEventListener('mousemove', function (e) {
             if (!_this.focused) {
                 return;
             }
@@ -79,7 +89,7 @@ var Canvas = /** @class */ (function () {
             _this.log(e.type, _this.mouseX, _this.mouseY);
             _this.config.mousemove(_this.mouseX, _this.mouseY);
         });
-        canvas.addEventListener('keydown', function (e) {
+        container.addEventListener('keydown', function (e) {
             if (!_this.focused) {
                 return;
             }
@@ -91,7 +101,7 @@ var Canvas = /** @class */ (function () {
                 _this.config.keydown(key);
             }
         });
-        canvas.addEventListener('keyup', function (e) {
+        container.addEventListener('keyup', function (e) {
             if (!_this.focused) {
                 return;
             }
@@ -103,7 +113,7 @@ var Canvas = /** @class */ (function () {
                 _this.config.keyup(key);
             }
         });
-        canvas.addEventListener('mousedown', function (e) {
+        container.addEventListener('mousedown', function (e) {
             if (!_this.focused) {
                 return;
             }
@@ -114,7 +124,7 @@ var Canvas = /** @class */ (function () {
                 _this.config.mousedown(button);
             }
         });
-        canvas.addEventListener('mouseup', function (e) {
+        container.addEventListener('mouseup', function (e) {
             if (!_this.focused) {
                 return;
             }
@@ -126,20 +136,52 @@ var Canvas = /** @class */ (function () {
                 _this.config.mouseup(button);
             }
         });
-        canvas.addEventListener('focusin', function (e) {
+        container.addEventListener('focusin', function (e) {
             _this.focused = true;
-            canvas.style.borderColor = _this.config.border;
+            container.style.borderColor = _this.config.border;
             _this.log(e.type, _this.focused);
+            _this.animation = requestAnimationFrame(function (time) { return _this.startAnimate(time); });
         });
-        canvas.addEventListener('focusout', function (e) {
+        container.addEventListener('focusout', function (e) {
             _this.focused = false;
-            canvas.style.borderColor = _this.config.borderBlur;
+            container.style.borderColor = _this.config.borderBlur;
             _this.log(e.type, _this.focused);
+            cancelAnimationFrame(_this.animation);
+        });
+        window.addEventListener('blur', function (e) {
+            _this.log(e.type);
+            cancelAnimationFrame(_this.animation);
         });
-        canvas.addEventListener('contextmenu', function (e) { return e.preventDefault(); });
+        container.addEventListener('contextmenu', function (e) { return e.preventDefault(); });
         // Focus on the canvas
-        canvas.focus();
+        container.focus();
     }
+    /**
+     * Start the animation.
+     */
+    Canvas.prototype.startAnimate = function (time) {
+        var _this = this;
+        this.log('startAnimate', time);
+        this.lastFrame = time;
+        this.animation = requestAnimationFrame(function (time) { return _this.animate(time); });
+    };
+    /**
+     * Run the main animation loop.
+     */
+    Canvas.prototype.animate = function (time) {
+        var _this = this;
+        var _a;
+        var currentFrame = time;
+        var dt = currentFrame - this.lastFrame;
+        this.lastFrame = currentFrame;
+        this.log('animate', dt, currentFrame);
+        var drawables = (_a = this.config.loop(dt)) !== null && _a !== void 0 ? _a : [];
+        for (var _i = 0, drawables_1 = drawables; _i < drawables_1.length; _i++) {
+            var drawable = drawables_1[_i];
+            this.draw(drawable);
+        }
+        this.animation = requestAnimationFrame(function (time) { return _this.animate(time); });
+    };
     /**
      * Determine whether a key is currently pressed.
      * @param key The key to check
@@ -156,18 +198,98 @@ var Canvas = /** @class */ (function () {
     Canvas.prototype.isMouseButtonDown = function (button) {
         return this.mouseButtons.includes(button);
     };
+    /**
+     * Get the current cursor position.
+     * @returns Cursor position as `[x, y]`
+     */
+    Canvas.prototype.getMousePosition = function () {
+        return [this.mouseX, this.mouseY];
+    };
+    /**
+     * Get the color of the selected pixel.
+     * @param x The pixel's x-coordinate
+     * @param y The pixel's y-coordinate
+     * @param layer The zero-indexed layer to get data from
+     * @returns `[red, green, blue, alpha]`
+     */
+    Canvas.prototype.getPixel = function (x, y, layer) {
+        if (layer === void 0) { layer = 0; }
+        var data = this.graphics[layer].getImageData(x, y, 1, 1).data;
+        this.log(this.graphics[layer].getImageData(x, y, 2, 2));
+        ;
+        return [data[0], data[1], data[2], data[3]];
+    };
+    /**
+     * Set the color of the selected pixel.
+     * @param x The pixel's x-coordinate
+     * @param y The pixel's y-coordinate
+     * @param color `[red, green, blue, alpha]`
+     * @param layer The zero-indexed layer to set data to
+     */
+    Canvas.prototype.setPixel = function (x, y, color, layer) {
+        if (layer === void 0) { layer = 0; }
+        var data = this.graphics[layer].getImageData(x, y, 1, 1);
+        data.data[0] = color[0];
+        data.data[1] = color[1];
+        data.data[2] = color[2];
+        data.data[3] = color[3];
+        this.log(data);
+        this.graphics[layer].putImageData(data, x, y);
+    };
+    /**
+     * Take a screenshot of the canvas contents and save to a .png file.
+     * @param name The file name of the screenshot
+     */
+    Canvas.prototype.screenshot = function (name) {
+        if (name === void 0) { name = 'screenshot'; }
+        // Create an offscreen canvas
+        var screen = new Canvas({
+            parent: document.createElement('div'),
+            height: this.config.height,
+            width: this.config.width,
+            scale: this.config.scale,
+        });
+        // Draw the background and each layer
+        screen.graphics[0].fillStyle = this.config.background;
+        screen.graphics[0].fillRect(0, 0, screen.width, screen.height);
+        for (var _i = 0, _a = this.graphics; _i < _a.length; _i++) {
+            var graphic = _a[_i];
+            screen.graphics[0].drawImage(graphic.canvas, 0, 0);
+        }
+        // Generate a data URL and set it as the download parameter for <a>
+        var dataURL = screen.graphics[0].canvas.toDataURL();
+        var downloadLink = document.createElement('a');
+        downloadLink.setAttribute('href', dataURL);
+        downloadLink.setAttribute('download', name);
+        downloadLink.click();
+        // Remove all keys and mouse buttons down because we lose focus
+        this.keys.splice(0);
+        this.mouseButtons.splice(0);
+    };
     /**
      * Draw an object onto the canvas.
      * @param drawable Any drawable object
+     * @param layer The zero-indexed layer to draw to
      */
-    Canvas.prototype.draw = function (drawable) {
-        drawable.draw(this.graphics);
+    Canvas.prototype.draw = function (drawable, layer) {
+        if (layer === void 0) { layer = 0; }
+        drawable.draw(this.graphics[layer]);
     };
     /**
      * Completely clears the canvas.
+     * @param layer The zero-indexed layer to clear, if unset, will clear all layers
      */
-    Canvas.prototype.clear = function () {
-        this.graphics.clearRect(0, 0, this.config.width, this.config.height);
+    Canvas.prototype.clear = function (layer) {
+        if (layer === void 0) { layer = -1; }
+        if (layer < 0) {
+            for (var _i = 0, _a = this.graphics; _i < _a.length; _i++) {
+                var graphic = _a[_i];
+                graphic.clearRect(0, 0, this.config.width, this.config.height);
+            }
+        }
+        else {
+            this.graphics[layer].clearRect(0, 0, this.config.width, this.config.height);
+        }
     };
     /**
      * Log a message to the debug console.
@@ -206,7 +328,8 @@ var Canvas = /** @class */ (function () {
         border: 'transparent',
         borderBlur: 'transparent',
         showMouse: true,
-        framesPerSecond: 60,
+        numLayers: 1,
+        acceleration: 'hardware',
         keydown: function () { return; },
         keyup: function () { return; },
         mousemove: function () { return; },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphico",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Canvas 2D rendering toolkit for games and visual projects",
   "homepage": "https://npm.nicfv.com/",
   "bin": "",

package/types/canvas.d.ts

@@ -14,14 +14,6 @@ export declare class Canvas {
      * Can be used to render 2D graphics onto the canvas
      */
     private readonly graphics;
-    /**
-     * Whether or not the control is focused
-     */
-    private focused;
-    /**
-     * Frame counter, increments every frame
-     */
-    private frame;
     /**
      * Contains a list of current keys pressed
      */
@@ -30,6 +22,14 @@ export declare class Canvas {
      * Contains a list of current mouse buttons pressed
      */
     private readonly mouseButtons;
+    /**
+     * The width of the canvas, in pixels
+     */
+    readonly width: number;
+    /**
+     * The height of the canvas, in pixels
+     */
+    readonly height: number;
     /**
      * Contains the mouse X-coordinate, in pixels
      */
@@ -38,11 +38,31 @@ export declare class Canvas {
      * Contains the mouse Y-coordinate, in pixels
      */
     private mouseY;
+    /**
+     * Represents the animation ID handle to cancel the animation
+     */
+    private animation;
+    /**
+     * The last frame's high resolution timestamp
+     */
+    private lastFrame;
+    /**
+     * Determine whether the client is focused or not
+     */
+    private focused;
     /**
      * Create a new canvas with the provided options
      * @param options Configuration options
      */
     constructor(options?: Partial<Options>);
+    /**
+     * Start the animation.
+     */
+    private startAnimate;
+    /**
+     * Run the main animation loop.
+     */
+    private animate;
     /**
      * Determine whether a key is currently pressed.
      * @param key The key to check
@@ -55,15 +75,43 @@ export declare class Canvas {
      * @returns True if `button` is down
      */
     isMouseButtonDown(button: number): boolean;
+    /**
+     * Get the current cursor position.
+     * @returns Cursor position as `[x, y]`
+     */
+    getMousePosition(): [number, number];
+    /**
+     * Get the color of the selected pixel.
+     * @param x The pixel's x-coordinate
+     * @param y The pixel's y-coordinate
+     * @param layer The zero-indexed layer to get data from
+     * @returns `[red, green, blue, alpha]`
+     */
+    getPixel(x: number, y: number, layer?: number): [number, number, number, number];
+    /**
+     * Set the color of the selected pixel.
+     * @param x The pixel's x-coordinate
+     * @param y The pixel's y-coordinate
+     * @param color `[red, green, blue, alpha]`
+     * @param layer The zero-indexed layer to set data to
+     */
+    setPixel(x: number, y: number, color: [number, number, number, number], layer?: number): void;
+    /**
+     * Take a screenshot of the canvas contents and save to a .png file.
+     * @param name The file name of the screenshot
+     */
+    screenshot(name?: string): void;
     /**
      * Draw an object onto the canvas.
      * @param drawable Any drawable object
+     * @param layer The zero-indexed layer to draw to
      */
-    draw(drawable: Drawable): void;
+    draw(drawable: Drawable, layer?: number): void;
     /**
      * Completely clears the canvas.
+     * @param layer The zero-indexed layer to clear, if unset, will clear all layers
      */
-    clear(): void;
+    clear(layer?: number): void;
     /**
      * Log a message to the debug console.
      */
@@ -114,9 +162,15 @@ export interface Options {
      */
     readonly showMouse: boolean;
     /**
-     * The number of frames to render every second
+     * The number of layers in this canvas
      */
-    readonly framesPerSecond: number;
+    readonly numLayers: number;
+    /**
+     * Uses hardware (GPU) or software (CPU) acceleration
+     * - For pixel manipulation, software acceleration is recommended
+     * - Otherwise, hardware acceleration is recommended (default)
+     */
+    readonly acceleration: 'hardware' | 'software';
     /**
      * Event listener for when a key is pressed
      * @param key The key that was pressed
@@ -144,16 +198,11 @@ export interface Options {
      */
     readonly mouseup: (button: number) => void;
     /**
-     * Event listener for a the main loop, only called when:
-     * - `framesPerSecond` > 0
-     * - The canvas is focused
-     * @param frame The frame sequence number
-     * @param keys A list of keys that are currently pressed
-     * @param mouseButtons A list of buttons that are currently pressed
-     * @param x Cursor X-coordinate
-     * @param y Cursor Y-coordinate
+     * Event listener for a the main animation loop
+     * @param dt The number of milliseconds in between frames
+     * @returns An array of `Drawable` to render on layer 0, or void
      */
-    readonly loop: (frame: number, keys: string[], mouseButtons: number[], x: number, y: number) => void;
+    readonly loop: (dt: number) => Drawable[] | (void | never);
 }
 /**
  * Represents an object that can be drawn on the canvas.