@oliversalzburg/js-utils 0.0.9 → 0.0.11

package/lib/errors/NotImplementedError.js

@@ -12,9 +12,11 @@ export class NotImplementedError extends AbstractError {
     constructor(message, status = 501) {
         super("ERR_OS_NOT_IMPLEMENTED", message, status);
         this.name = "NotImplementedError";
-        // Capture a new stacktrace, otherwise it will include our base-class
-        // constructor instead of the code location we're actually interested in.
-        Error.captureStackTrace(this, NotImplementedError);
+        if (typeof Error.captureStackTrace !== "undefined") {
+            // Capture a new stacktrace, otherwise it will include our base-class
+            // constructor instead of the code location we're actually interested in.
+            Error.captureStackTrace(this, NotImplementedError);
+        }
     }
 }
 //# sourceMappingURL=NotImplementedError.js.map

package/lib/errors/NotImplementedError.js.map

@@ -1 +1 @@
-{"version":3,"file":"NotImplementedError.js","sourceRoot":"","sources":["../../source/errors/NotImplementedError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,aAAa;IACpD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,wBAAwB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEjD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAElC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;IACrD,CAAC;CACF"}
+{"version":3,"file":"NotImplementedError.js","sourceRoot":"","sources":["../../source/errors/NotImplementedError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,aAAa;IACpD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,wBAAwB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEjD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAElC,IAAI,OAAO,KAAK,CAAC,iBAAiB,KAAK,WAAW,EAAE;YAClD,qEAAqE;YACrE,yEAAyE;YACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;SACpD;IACH,CAAC;CACF"}

package/lib/errors/PermissionViolationError.js

@@ -13,9 +13,11 @@ export class PermissionViolationError extends AbstractError {
     constructor(message, status = 403) {
         super("ERR_OS_PERMISSION_VIOLATION", message, status);
         this.name = "PermissionViolationError";
-        // Capture a new stacktrace, otherwise it will include our base-class
-        // constructor instead of the code location we're actually interested in.
-        Error.captureStackTrace(this, PermissionViolationError);
+        if (typeof Error.captureStackTrace !== "undefined") {
+            // Capture a new stacktrace, otherwise it will include our base-class
+            // constructor instead of the code location we're actually interested in.
+            Error.captureStackTrace(this, PermissionViolationError);
+        }
     }
 }
 //# sourceMappingURL=PermissionViolationError.js.map

package/lib/errors/PermissionViolationError.js.map

@@ -1 +1 @@
-{"version":3,"file":"PermissionViolationError.js","sourceRoot":"","sources":["../../source/errors/PermissionViolationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,OAAO,wBAAyB,SAAQ,aAAa;IACzD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,6BAA6B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEtD,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;QAEvC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IAC1D,CAAC;CACF"}
+{"version":3,"file":"PermissionViolationError.js","sourceRoot":"","sources":["../../source/errors/PermissionViolationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,OAAO,wBAAyB,SAAQ,aAAa;IACzD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,6BAA6B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEtD,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;QAEvC,IAAI,OAAO,KAAK,CAAC,iBAAiB,KAAK,WAAW,EAAE;YAClD,qEAAqE;YACrE,yEAAyE;YACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;SACzD;IACH,CAAC;CACF"}

package/lib/errors/ResourceConflictError.js

@@ -12,9 +12,11 @@ export class ResourceConflictError extends AbstractError {
     constructor(message, status = 409) {
         super("ERR_OS_RESOURCE_CONFLICT", message, status);
         this.name = "ResourceConflictError";
-        // Capture a new stacktrace, otherwise it will include our base-class
-        // constructor instead of the code location we're actually interested in.
-        Error.captureStackTrace(this, ResourceConflictError);
+        if (typeof Error.captureStackTrace !== "undefined") {
+            // Capture a new stacktrace, otherwise it will include our base-class
+            // constructor instead of the code location we're actually interested in.
+            Error.captureStackTrace(this, ResourceConflictError);
+        }
     }
 }
 //# sourceMappingURL=ResourceConflictError.js.map

package/lib/errors/ResourceConflictError.js.map

@@ -1 +1 @@
-{"version":3,"file":"ResourceConflictError.js","sourceRoot":"","sources":["../../source/errors/ResourceConflictError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IACtD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,0BAA0B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QAEpC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IACvD,CAAC;CACF"}
+{"version":3,"file":"ResourceConflictError.js","sourceRoot":"","sources":["../../source/errors/ResourceConflictError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IACtD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,0BAA0B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QAEpC,IAAI,OAAO,KAAK,CAAC,iBAAiB,KAAK,WAAW,EAAE;YAClD,qEAAqE;YACrE,yEAAyE;YACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;SACtD;IACH,CAAC;CACF"}

package/lib/errors/UnknownError.js

@@ -16,9 +16,11 @@ export class UnknownError extends AbstractError {
     constructor(message, status = 500) {
         super("ERR_OS_UNKNOWN", message, status);
         this.name = "UnknownError";
-        // Capture a new stacktrace, otherwise it will include our base-class
-        // constructor instead of the code location we're actually interested in.
-        Error.captureStackTrace(this, UnknownError);
+        if (typeof Error.captureStackTrace !== "undefined") {
+            // Capture a new stacktrace, otherwise it will include our base-class
+            // constructor instead of the code location we're actually interested in.
+            Error.captureStackTrace(this, UnknownError);
+        }
     }
 }
 //# sourceMappingURL=UnknownError.js.map

package/lib/errors/UnknownError.js.map

@@ -1 +1 @@
-{"version":3,"file":"UnknownError.js","sourceRoot":"","sources":["../../source/errors/UnknownError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,OAAO,YAAa,SAAQ,aAAa;IAC7C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEzC,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAE3B,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF"}
+{"version":3,"file":"UnknownError.js","sourceRoot":"","sources":["../../source/errors/UnknownError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,OAAO,YAAa,SAAQ,aAAa;IAC7C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEzC,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAE3B,IAAI,OAAO,KAAK,CAAC,iBAAiB,KAAK,WAAW,EAAE;YAClD,qEAAqE;YACrE,yEAAyE;YACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;SAC7C;IACH,CAAC;CACF"}

package/lib/graphics/canvas.d.ts

@@ -1,14 +1,26 @@
 /// <reference types="@types/web" />
+/**
+ * Construction options for a {@linkcode Canvas}.
+ * @group Graphics
+ */
+export interface CanvasOptions {
+    /**
+     * Was this {@linkcode Canvas} created with the ability to copy the front buffer back into
+     * the back buffer?
+     */
+    readonly supportReadBack: boolean;
+}
 /**
  * A wrapper around {@linkcode !HTMLCanvasElement}
  * to provide some convience for double-buffered drawing.
  * @group Graphics
  */
 export declare class Canvas {
+    #private;
     /**
-     * The {@linkcode !HTMLCanvasElement} we're interacting with.
+     * The {@linkcode !HTMLCanvasElement} we're interacting with in the DOM.
      */
-    readonly canvas: HTMLCanvasElement;
+    readonly canvasDom: HTMLCanvasElement;
     /**
      * The width of the canvas.
      */
@@ -18,37 +30,40 @@ export declare class Canvas {
      */
     readonly height: number;
     /**
-     * The {@linkcode !CanvasRenderingContext2D} we're using to draw to the canvas.
-     */
-    readonly context: CanvasRenderingContext2D;
-    /**
-     * The {@linkcode !ImageData} object
-     * that represents our frontbuffer, which is the canvas itself.
+     * The {@linkcode !OffscreenCanvasRenderingContext2D} we're using to draw to the canvas.
      */
-    pixMap: ImageData;
+    readonly context: OffscreenCanvasRenderingContext2D;
     /**
      * Our back buffer.
      */
     buffer: Uint8ClampedArray;
     /**
-     * Was this {@linkcode Canvas} created with the ability to copy the front buffer back into
-     * the back buffer?
+     * The configuration that was used for this canvas.
      */
-    readonly supportReadBack: boolean;
+    readonly options: Readonly<Partial<CanvasOptions>>;
     /**
      * Constructs a new {@linkcode Canvas}.
      * @param canvas The canvas to wrap.
      * @param width The width of the canvas.
      * @param height The height of the canvas.
-     * @param supportReadBack Should this canvas support reading back from the front buffer?
-     * You will need this, if you plan to use regular canvas drawing on the front buffer, and
-     * read the results back into the back buffer.
+     * @param options The configuration for this canvas.
      */
-    constructor(canvas: HTMLCanvasElement, width: number, height: number, supportReadBack?: boolean);
+    constructor(canvas: HTMLCanvasElement, width: number, height: number, options?: Partial<CanvasOptions>);
     /**
      * Draws the back buffer onto the canvas.
      */
     update(): void;
+    /**
+     * Draws the offscreen canvas into the DOM canvas.
+     */
+    render(): void;
+    /**
+     * Draws a slightly transparent, black rectangle over the canvas,
+     * and then reads the result back into the buffer.
+     * @param amount How much the screen should be faded to black. `0` is
+     * not at all, `255` makes it instantly black.
+     */
+    fade(amount?: number): void;
     /**
      * Reads the front buffer back into the back buffer.
      */
@@ -72,9 +87,24 @@ export declare class Canvas {
      * @param color The color to fill the back buffer with.
      */
     clearWith(color: number): void;
+    /**
+     * Fills the entire back buffer with the given color.
+     * @param color The color to fill the back buffer with.
+     */
+    blendWith(color: number): void;
 }
 /**
  * Linearly blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ *
+ * As this method is often called many times in render loops, only bounds
+ * checking is applied to the given coordinates.
+ *
+ * The coordinates are **expected to already be integers**. Supplying numbers with fractions
+ * has performance implications. Ensure you're working with integers, or truncate the
+ * coordinates before passing them in.
+ *
+ * The `alpha` value is expected to be an integer in the range from `0` to `255`.
+ * `0` meaning fully transparent, `255` meaning fully opaque.
  * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.
@@ -85,6 +115,16 @@ export declare class Canvas {
 export declare const putPixel32: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;
 /**
  * Additively blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ *
+ * As this method is often called many times in render loops, only bounds
+ * checking is applied to the given coordinates.
+ *
+ * The coordinates are **expected to already be integers**. Supplying numbers with fractions
+ * has performance implications. Ensure you're working with integers, or truncate the
+ * coordinates before passing them in.
+ *
+ * The `alpha` value is expected to be an integer in the range from `0` to `255`.
+ * `0` meaning fully transparent, `255` meaning fully opaque.
  * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.
@@ -95,6 +135,16 @@ export declare const putPixel32: (canvas: Canvas, x: number, y: number, color: n
 export declare const putPixel32Add: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;
 /**
  * Subtractively blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ *
+ * As this method is often called many times in render loops, only bounds
+ * checking is applied to the given coordinates.
+ *
+ * The coordinates are **expected to already be integers**. Supplying numbers with fractions
+ * has performance implications. Ensure you're working with integers, or truncate the
+ * coordinates before passing them in.
+ *
+ * The `alpha` value is expected to be an integer in the range from `0` to `255`.
+ * `0` meaning fully transparent, `255` meaning fully opaque.
  * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.

package/lib/graphics/canvas.js

@@ -8,9 +8,17 @@ import { blend, blendAdditive, blendSubtractive, fromRGBA, getA, getB, getG, get
  */
 export class Canvas {
     /**
-     * The {@linkcode !HTMLCanvasElement} we're interacting with.
+     * The {@linkcode !HTMLCanvasElement} we're interacting with in the DOM.
      */
-    canvas;
+    canvasDom;
+    /**
+     * The rendering context for the canvas located in the DOM.
+     */
+    #canvasDomContext;
+    /**
+     * The offscreen canvas we use for rendering.
+     */
+    #canvasOffscreen;
     /**
      * The width of the canvas.
      */
@@ -20,61 +28,78 @@ export class Canvas {
      */
     height;
     /**
-     * The {@linkcode !CanvasRenderingContext2D} we're using to draw to the canvas.
+     * The {@linkcode !OffscreenCanvasRenderingContext2D} we're using to draw to the canvas.
      */
     context;
     /**
-     * The {@linkcode !ImageData} object
-     * that represents our frontbuffer, which is the canvas itself.
+     * The {@linkcode !ImageData} object in our offscreen canvas. We usually interact with its
+     * {@linkcode Canvas.buffer buffer} directly.
      */
-    pixMap;
+    #imageData;
     /**
      * Our back buffer.
      */
     buffer;
     /**
-     * Was this {@linkcode Canvas} created with the ability to copy the front buffer back into
-     * the back buffer?
+     * The configuration that was used for this canvas.
      */
-    supportReadBack;
+    options;
     /**
      * Constructs a new {@linkcode Canvas}.
      * @param canvas The canvas to wrap.
      * @param width The width of the canvas.
      * @param height The height of the canvas.
-     * @param supportReadBack Should this canvas support reading back from the front buffer?
-     * You will need this, if you plan to use regular canvas drawing on the front buffer, and
-     * read the results back into the back buffer.
+     * @param options The configuration for this canvas.
      */
-    constructor(canvas, width, height, supportReadBack = false) {
-        this.canvas = canvas;
+    constructor(canvas, width, height, options = {}) {
         this.width = width;
         this.height = height;
-        this.context = mustExist(this.canvas.getContext("2d", {
+        this.options = options;
+        this.canvasDom = canvas;
+        this.#canvasDomContext = mustExist(this.canvasDom.getContext("bitmaprenderer", {
+            alpha: false,
+        }), "Unable to create rendering context for DOM canvas.");
+        this.#canvasOffscreen = new OffscreenCanvas(this.width, this.height);
+        this.context = mustExist(this.#canvasOffscreen.getContext("2d", {
             alpha: false,
             desynchronized: true,
-            willReadFrequently: supportReadBack,
-        }), "Unable to create rendering context.");
-        this.supportReadBack = supportReadBack;
-        this.pixMap = this.context.createImageData(width, height);
-        this.buffer = this.pixMap.data;
+            willReadFrequently: this.options.supportReadBack,
+        }), "Unable to create rendering context for offscreen canvas.");
+        this.#imageData = this.context.createImageData(width, height);
+        this.buffer = this.#imageData.data;
         this.context.font = "12px sans-serif";
     }
     /**
      * Draws the back buffer onto the canvas.
      */
     update() {
-        this.context.putImageData(this.pixMap, 0, 0);
+        this.context.putImageData(this.#imageData, 0, 0);
+    }
+    /**
+     * Draws the offscreen canvas into the DOM canvas.
+     */
+    render() {
+        const newFrame = this.#canvasOffscreen.transferToImageBitmap();
+        this.#canvasDomContext.transferFromImageBitmap(newFrame);
+    }
+    /**
+     * Draws a slightly transparent, black rectangle over the canvas,
+     * and then reads the result back into the buffer.
+     * @param amount How much the screen should be faded to black. `0` is
+     * not at all, `255` makes it instantly black.
+     */
+    fade(amount = 1) {
+        this.blendWith(fromRGBA(0, 0, 0, amount));
     }
     /**
      * Reads the front buffer back into the back buffer.
      */
     bufferReadBack() {
-        if (!this.supportReadBack) {
-            throw new InvalidOperationError("To use `bufferReadBack()`, you must construct the `Canvas` with `supportReadBack` set to `true`.");
+        if (!this.options.supportReadBack) {
+            throw new InvalidOperationError("To use `bufferReadBack()`, you must construct the `Canvas` with `options.supportReadBack` set to `true`.");
         }
-        this.pixMap = this.context.getImageData(0, 0, this.width, this.height);
-        this.buffer = this.pixMap.data;
+        this.#imageData = this.context.getImageData(0, 0, this.width, this.height);
+        this.buffer = this.#imageData.data;
     }
     /**
      * Returns the color of a pixel in the back buffer.
@@ -83,7 +108,7 @@ export class Canvas {
      * @returns The color of the pixel at the given local.
      */
     getPixel32(x, y) {
-        const bufferOffset = Math.trunc((x + y * this.width) * 4);
+        const bufferOffset = (x + y * this.width) * 4;
         return fromRGBA(this.buffer[bufferOffset + 0], this.buffer[bufferOffset + 1], this.buffer[bufferOffset + 2], this.buffer[bufferOffset + 3]);
     }
     /**
@@ -93,7 +118,7 @@ export class Canvas {
      * @param color The color to place at the coordinate.
      */
     setPixel32(x, y, color) {
-        const bufferOffset = Math.trunc((x + y * this.width) * 4);
+        const bufferOffset = (x + y * this.width) * 4;
         this.buffer[bufferOffset + 0] = getR(color);
         this.buffer[bufferOffset + 1] = getG(color);
         this.buffer[bufferOffset + 2] = getB(color);
@@ -115,9 +140,34 @@ export class Canvas {
             this.buffer[bufferOffset + 3] = a;
         }
     }
+    /**
+     * Fills the entire back buffer with the given color.
+     * @param color The color to fill the back buffer with.
+     */
+    blendWith(color) {
+        const r = getR(color);
+        const g = getG(color);
+        const b = getB(color);
+        const a = getA(color);
+        for (let bufferOffset = 0; bufferOffset < this.width * this.height * 4; bufferOffset += 4) {
+            this.buffer[bufferOffset + 0] = (a * r + (255 - a) * this.buffer[bufferOffset + 0]) >> 8;
+            this.buffer[bufferOffset + 1] = (a * g + (255 - a) * this.buffer[bufferOffset + 1]) >> 8;
+            this.buffer[bufferOffset + 2] = (a * b + (255 - a) * this.buffer[bufferOffset + 2]) >> 8;
+        }
+    }
 }
 /**
  * Linearly blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ *
+ * As this method is often called many times in render loops, only bounds
+ * checking is applied to the given coordinates.
+ *
+ * The coordinates are **expected to already be integers**. Supplying numbers with fractions
+ * has performance implications. Ensure you're working with integers, or truncate the
+ * coordinates before passing them in.
+ *
+ * The `alpha` value is expected to be an integer in the range from `0` to `255`.
+ * `0` meaning fully transparent, `255` meaning fully opaque.
  * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.
@@ -129,17 +179,22 @@ export const putPixel32 = (canvas, x, y, color, alpha) => {
     if (canvas.width < x || x < 0 || canvas.height < y || y < 0) {
         return;
     }
-    x = Math.trunc(x);
-    y = Math.trunc(y);
-    if (alpha > 255) {
-        alpha = 255;
-    }
     const srcColor = canvas.getPixel32(x, y);
     const newColor = blend(srcColor, color, alpha);
     canvas.setPixel32(x, y, newColor);
 };
 /**
  * Additively blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ *
+ * As this method is often called many times in render loops, only bounds
+ * checking is applied to the given coordinates.
+ *
+ * The coordinates are **expected to already be integers**. Supplying numbers with fractions
+ * has performance implications. Ensure you're working with integers, or truncate the
+ * coordinates before passing them in.
+ *
+ * The `alpha` value is expected to be an integer in the range from `0` to `255`.
+ * `0` meaning fully transparent, `255` meaning fully opaque.
  * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.
@@ -151,17 +206,22 @@ export const putPixel32Add = (canvas, x, y, color, alpha) => {
     if (canvas.width < x || x < 0 || canvas.height < y || y < 0) {
         return;
     }
-    x = Math.round(x);
-    y = Math.round(y);
-    if (alpha > 255) {
-        alpha = 255;
-    }
     const srcColor = canvas.getPixel32(x, y);
     const newColor = blendAdditive(srcColor, color, alpha);
     canvas.setPixel32(x, y, newColor);
 };
 /**
  * Subtractively blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ *
+ * As this method is often called many times in render loops, only bounds
+ * checking is applied to the given coordinates.
+ *
+ * The coordinates are **expected to already be integers**. Supplying numbers with fractions
+ * has performance implications. Ensure you're working with integers, or truncate the
+ * coordinates before passing them in.
+ *
+ * The `alpha` value is expected to be an integer in the range from `0` to `255`.
+ * `0` meaning fully transparent, `255` meaning fully opaque.
  * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.
@@ -173,11 +233,6 @@ export const putPixel32Sub = (canvas, x, y, color, alpha) => {
     if (canvas.width < x || x < 0 || canvas.height < y || y < 0) {
         return;
     }
-    x = Math.round(x);
-    y = Math.round(y);
-    if (alpha > 255) {
-        alpha = 255;
-    }
     const srcColor = canvas.getPixel32(x, y);
     const newColor = blendSubtractive(srcColor, color, alpha);
     canvas.setPixel32(x, y, newColor);

package/lib/graphics/canvas.js.map

@@ -1 +1 @@
-{"version":3,"file":"canvas.js","sourceRoot":"","sources":["../../source/graphics/canvas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EACL,KAAK,EACL,aAAa,EACb,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,IAAI,GACL,MAAM,WAAW,CAAC;AAEnB;;;;GAIG;AACH,MAAM,OAAO,MAAM;IACjB;;OAEG;IACM,MAAM,CAAoB;IAEnC;;OAEG;IACM,KAAK,CAAS;IAEvB;;OAEG;IACM,MAAM,CAAS;IAExB;;OAEG;IACM,OAAO,CAA2B;IAE3C;;;OAGG;IACH,MAAM,CAAY;IAElB;;OAEG;IACH,MAAM,CAAoB;IAE1B;;;OAGG;IACM,eAAe,CAAU;IAElC;;;;;;;;OAQG;IACH,YAAY,MAAyB,EAAE,KAAa,EAAE,MAAc,EAAE,eAAe,GAAG,KAAK;QAC3F,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,CAAC,OAAO,GAAG,SAAS,CACtB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE;YAC3B,KAAK,EAAE,KAAK;YACZ,cAAc,EAAE,IAAI;YACpB,kBAAkB,EAAE,eAAe;SACpC,CAAC,EACF,qCAAqC,CACtC,CAAC;QACF,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAE/B,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,iBAAiB,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,MAAM,IAAI,qBAAqB,CAC7B,kGAAkG,CACnG,CAAC;SACH;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACvE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,CAAS,EAAE,CAAS;QAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1D,OAAO,QAAQ,CACb,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,EAC7B,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,EAC7B,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,EAC7B,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,CAAS,EAAE,CAAS,EAAE,KAAa;QAC5C,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAAa;QACrB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,KAAK,IAAI,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,YAAY,IAAI,CAAC,EAAE;YACzF,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;SACnC;IACH,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,CAAS,EAAE,CAAS,EAAE,KAAa,EAAE,KAAa,EAAE,EAAE;IAC/F,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAElB,IAAI,KAAK,GAAG,GAAG,EAAE;QACf,KAAK,GAAG,GAAG,CAAC;KACb;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC/C,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAc,EACd,CAAS,EACT,CAAS,EACT,KAAa,EACb,KAAa,EACb,EAAE;IACF,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAElB,IAAI,KAAK,GAAG,GAAG,EAAE;QACf,KAAK,GAAG,GAAG,CAAC;KACb;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACvD,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAc,EACd,CAAS,EACT,CAAS,EACT,KAAa,EACb,KAAa,EACb,EAAE;IACF,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAElB,IAAI,KAAK,GAAG,GAAG,EAAE;QACf,KAAK,GAAG,GAAG,CAAC;KACb;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAc,EACd,CAAS,EACT,CAAS,EACT,KAAa,EACb,KAAa,EACb,EAAE;IACF,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC;IAC7B,MAAM,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC;IAE7B,MAAM,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAC3C,MAAM,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;IAC1C,MAAM,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,CAAC;IAC1C,MAAM,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;IAEzC,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAClD,CAAC,CAAC"}
+{"version":3,"file":"canvas.js","sourceRoot":"","sources":["../../source/graphics/canvas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EACL,KAAK,EACL,aAAa,EACb,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,IAAI,GACL,MAAM,WAAW,CAAC;AAcnB;;;;GAIG;AACH,MAAM,OAAO,MAAM;IACjB;;OAEG;IACM,SAAS,CAAoB;IAEtC;;OAEG;IACH,iBAAiB,CAA8B;IAE/C;;OAEG;IACH,gBAAgB,CAAkB;IAElC;;OAEG;IACM,KAAK,CAAS;IAEvB;;OAEG;IACM,MAAM,CAAS;IAExB;;OAEG;IACM,OAAO,CAAoC;IAEpD;;;OAGG;IACH,UAAU,CAAY;IAEtB;;OAEG;IACH,MAAM,CAAoB;IAE1B;;OAEG;IACM,OAAO,CAAmC;IAEnD;;;;;;OAMG;IACH,YACE,MAAyB,EACzB,KAAa,EACb,MAAc,EACd,UAAkC,EAAE;QAEpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAChC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,gBAAgB,EAAE;YAC1C,KAAK,EAAE,KAAK;SACb,CAAC,EACF,oDAAoD,CACrD,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,OAAO,GAAG,SAAS,CACtB,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE;YACrC,KAAK,EAAE,KAAK;YACZ,cAAc,EAAE,IAAI;YACpB,kBAAkB,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;SACjD,CAAC,EACF,0DAA0D,CAC3D,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAEnC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,iBAAiB,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,CAAC;QAC/D,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,MAAM,GAAG,CAAC;QACb,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YACjC,MAAM,IAAI,qBAAqB,CAC7B,0GAA0G,CAC3G,CAAC;SACH;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,CAAS,EAAE,CAAS;QAC7B,MAAM,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,QAAQ,CACb,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,EAC7B,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,EAC7B,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,EAC7B,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,CAAS,EAAE,CAAS,EAAE,KAAa;QAC5C,MAAM,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAAa;QACrB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,KAAK,IAAI,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,YAAY,IAAI,CAAC,EAAE;YACzF,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;SACnC;IACH,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAAa;QACrB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,KAAK,IAAI,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,YAAY,IAAI,CAAC,EAAE;YACzF,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzF,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzF,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC1F;IACH,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,CAAS,EAAE,CAAS,EAAE,KAAa,EAAE,KAAa,EAAE,EAAE;IAC/F,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC/C,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAc,EACd,CAAS,EACT,CAAS,EACT,KAAa,EACb,KAAa,EACb,EAAE;IACF,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACvD,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAc,EACd,CAAS,EACT,CAAS,EACT,KAAa,EACb,KAAa,EACb,EAAE;IACF,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAc,EACd,CAAS,EACT,CAAS,EACT,KAAa,EACb,KAAa,EACb,EAAE;IACF,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC;IAC7B,MAAM,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC;IAE7B,MAAM,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAC3C,MAAM,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;IAC1C,MAAM,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,CAAC;IAC1C,MAAM,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;IAEzC,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAClD,CAAC,CAAC"}

package/lib/graphics/render-loop.d.ts

@@ -4,6 +4,21 @@ import { Canvas } from "./canvas.js";
  * @group Graphics
  */
 export type RenderLoopCallback = (delta: number, timestamp: number) => unknown;
+/**
+ * Configuration for a {@linkcode RenderLoop},
+ * @group Graphics
+ */
+export interface RenderLoopOptions {
+    /**
+     * Should the current frames per second be rendered onto the canvas
+     * each frame?
+     */
+    drawFps: boolean;
+    /**
+     * Should the buffer be cleared or faded to black before each frame?
+     */
+    onRefresh: "clear";
+}
 /**
  * Conveniently provides a way to have a render loop called at
  * a constant frame rate.
@@ -14,15 +29,23 @@ export declare class RenderLoop {
     /**
      * The {@linkcode Canvas} we're rendering to.
      */
-    readonly canvas: Canvas | undefined;
+    readonly canvas: Canvas;
     /**
      * A function that we call when a new frame should be drawn.
      */
     readonly renderLoop: RenderLoopCallback;
     /**
-     * The timestamp we got for the previous frame.
+     * The configuration that was used for this render loop.
      */
-    private previousTimestamp;
+    readonly options: Readonly<Partial<RenderLoopOptions>>;
+    /**
+     * The time at which we drew the last frame to the offscreen buffer.
+     */
+    private previousTimestampDraw;
+    /**
+     * The time at which we rendered the last frame to the DOM.
+     */
+    private previousTimestampRender;
     /**
      * Our `#main` function bound to this classes
      * for easier invokation through external callers.
@@ -32,13 +55,23 @@ export declare class RenderLoop {
      * The ID of our {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame requestAnimationFrame} request.
      */
     private frameRequestId;
+    /**
+     * The ID of our {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/setTimeout setTimeout}-based
+     * offscreen rendering loop.
+     */
+    private drawTimeout;
+    /**
+     * Retrieves the amount of frames drawn to the DOM throughout the loops lifetime.
+     * @returns The frame count.
+     */
+    get frameCounter(): number;
     /**
      * Constructs a new {@linkcode RenderLoop}.
      * @param renderLoop The function to call when a new frame should be drawn.
-     * @param canvas When provided, the canvas is automatically updated
-     * after a frame was rendered.
+     * @param canvas The {@linkcode Canvas} we're rendering to.
+     * @param options The configuration for thie {@linkcode RenderLoop}.
      */
-    constructor(renderLoop: RenderLoopCallback, canvas?: Canvas);
+    constructor(renderLoop: RenderLoopCallback, canvas: Canvas, options?: Partial<RenderLoopOptions>);
     /**
      * Stop the render loop.
      */