@oliversalzburg/js-utils 0.0.4 → 0.0.5

package/mkdocs.yml

@@ -0,0 +1,52 @@
+copyright: Oliver Salzburg
+dev_addr: 0.0.0.0:8000
+docs_dir: docs
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/oliversalzburg/
+markdown_extensions:
+  - abbr
+  - admonition
+  - pymdownx.details
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences:
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tilde
+  - toc:
+      permalink: true
+plugins:
+  - search
+repo_name: oliversalzburg/js-utils
+repo_url: https://github.com/oliversalzburg/js-utils
+site_name: JS Utils
+theme:
+  favicon: assets/images/favicon.ico
+  features:
+    - content.code.copy
+    - navigation.instant
+    - navigation.sections
+    - navigation.tabs
+    - navigation.tabs.sticky
+  icon:
+    repo: fontawesome/brands/github
+  name: material
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      accent: amber
+      primary: indigo
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      accent: indigo
+      primary: amber
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode

package/output/core.d.ts

@@ -1,4 +1,21 @@
 /**
  * Describes a function that is a constructor for T.
  */
-export type ConstructorOf<T = Record<string, unknown>> = new (...args: any[]) => T;
+export type ConstructorOf<T = Record<string, unknown>> = new (...args: Array<any>) => T;
+/**
+ * Describes literally any function.
+ */
+export type AnyFunction = (...args: Array<any>) => any;
+/**
+ * Any constructor
+ */
+export type AnyConstructor = new (...args: Array<any>) => any;
+/**
+ * Describes a function returning an instance of T.
+ */
+export type FunctionReturning<T = any> = (...args: Array<any>) => T;
+/**
+ * Describes a class "mixin", which is a function that returns a dynamically
+ * constructed class, based on the passed parameters.
+ */
+export type Mixin<T extends FunctionReturning> = InstanceType<ReturnType<T>>;

package/output/core.js

@@ -1,2 +1,3 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 export {};
 //# sourceMappingURL=core.js.map

package/output/core.js.map

@@ -1 +1 @@
-{"version":3,"file":"core.js","sourceRoot":"","sources":["../source/core.ts"],"names":[],"mappings":""}
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../source/core.ts"],"names":[],"mappings":"AAAA,uDAAuD"}

package/output/error-serializer.d.ts

@@ -6,7 +6,7 @@ export type SerializedError = Record<string, Record<string, string> | string | u
 /**
  * Determine if the given unknown subject is an `Error` instance.
  * @param subject The object to inspect.
- * @returns `true` if the subject is an `Error`, `false´ otherwise.
+ * @returns `true` if the subject is an `Error`, `false` otherwise.
  */
 export declare const isError: (subject: unknown) => subject is Error;
 /**

package/output/error-serializer.js

@@ -5,7 +5,7 @@ import { UnknownError } from "./errors/UnknownError.js";
 /**
  * Determine if the given unknown subject is an `Error` instance.
  * @param subject The object to inspect.
- * @returns `true` if the subject is an `Error`, `false´ otherwise.
+ * @returns `true` if the subject is an `Error`, `false` otherwise.
  */
 export const isError = (subject) => {
     return subject instanceof Error || types.isNativeError(subject);

package/output/errors/AbstractError.d.ts

@@ -24,11 +24,19 @@ export declare class AbstractError extends Error {
      */
     code: string;
     /**
-     * Constructs a new AbstractError.
+     * Constructs a new {@link AbstractError}.
      * @param code The main identification code for the error.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */
     constructor(code: string, message: string, status: number);
+    /**
+     * Checks if an object is an instance of {@link AbstractError}, or one of its subclasses.
+     * @param error The object to check.
+     * @param allowForeignModule Only check for similar looking error codes.
+     * You're going to want to use this if you're dealing with a setup where
+     * multiple versions of js-utils are loaded.
+     * @returns `true` if the object is an {@link AbstractError}, `false` otherwise.
+     */
     static isAbstractError(error: unknown, allowForeignModule?: boolean): error is AbstractError;
 }

package/output/errors/AbstractError.js

@@ -23,7 +23,7 @@ export class AbstractError extends Error {
      */
     code;
     /**
-     * Constructs a new AbstractError.
+     * Constructs a new {@link AbstractError}.
      * @param code The main identification code for the error.
      * @param message The main error message.
      * @param status The HTTP status code to return.
@@ -38,11 +38,19 @@ export class AbstractError extends Error {
         // location we're actually interested in.
         Error.captureStackTrace(this, AbstractError);
     }
+    /**
+     * Checks if an object is an instance of {@link AbstractError}, or one of its subclasses.
+     * @param error The object to check.
+     * @param allowForeignModule Only check for similar looking error codes.
+     * You're going to want to use this if you're dealing with a setup where
+     * multiple versions of js-utils are loaded.
+     * @returns `true` if the object is an {@link AbstractError}, `false` otherwise.
+     */
     static isAbstractError(error, allowForeignModule = true) {
         if (error instanceof AbstractError) {
             return true;
         }
-        // When multiple versions of core-models3 are loaded at runtime, the
+        // When multiple versions of js-utils are loaded at runtime, the
         // prototypes of errors don't align. In that case, we just analyze the
         // error code.
         if (allowForeignModule) {

package/output/errors/AbstractError.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractError.js","sourceRoot":"","sources":["../../source/errors/AbstractError.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC;;;;OAIG;IACH,MAAM,CAAS;IAEf;;;OAGG;IACH,KAAK,CAAe;IAEpB;;;OAGG;IACH,IAAI,CAAgB;IAEpB;;OAEG;IACH,IAAI,CAAS;IAEb;;;;;OAKG;IACH,YAAY,IAAY,EAAE,OAAe,EAAE,MAAc;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,qGAAqG;QACrG,yCAAyC;QACzC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,KAAc,EAAE,kBAAkB,GAAG,IAAI;QAC9D,IAAI,KAAK,YAAY,aAAa,EAAE;YAClC,OAAO,IAAI,CAAC;SACb;QAED,oEAAoE;QACpE,sEAAsE;QACtE,cAAc;QACd,IAAI,kBAAkB,EAAE;YACtB,MAAM,WAAW,GAAG,KAAgC,CAAC;YACrD,IACE,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK;gBACvB,MAAM,IAAI,WAAW;gBACrB,OAAO,WAAW,CAAC,IAAI,KAAK,QAAQ,EACpC;gBACA,MAAM,UAAU,GAAG,KAAyB,CAAC;gBAC7C,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;oBACrC,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}
+{"version":3,"file":"AbstractError.js","sourceRoot":"","sources":["../../source/errors/AbstractError.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC;;;;OAIG;IACH,MAAM,CAAS;IAEf;;;OAGG;IACH,KAAK,CAAe;IAEpB;;;OAGG;IACH,IAAI,CAAgB;IAEpB;;OAEG;IACH,IAAI,CAAS;IAEb;;;;;OAKG;IACH,YAAY,IAAY,EAAE,OAAe,EAAE,MAAc;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,qGAAqG;QACrG,yCAAyC;QACzC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,eAAe,CAAC,KAAc,EAAE,kBAAkB,GAAG,IAAI;QAC9D,IAAI,KAAK,YAAY,aAAa,EAAE;YAClC,OAAO,IAAI,CAAC;SACb;QAED,gEAAgE;QAChE,sEAAsE;QACtE,cAAc;QACd,IAAI,kBAAkB,EAAE;YACtB,MAAM,WAAW,GAAG,KAAgC,CAAC;YACrD,IACE,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK;gBACvB,MAAM,IAAI,WAAW;gBACrB,OAAO,WAAW,CAAC,IAAI,KAAK,QAAQ,EACpC;gBACA,MAAM,UAAU,GAAG,KAAyB,CAAC;gBAC7C,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;oBACrC,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/output/errors/InternalError.d.ts

@@ -5,10 +5,15 @@ import { AbstractError } from "./AbstractError.js";
  */
 export declare class InternalError extends AbstractError {
     /**
-     * Constructs a new `InternalError`.
+     * Constructs a new {@link InternalError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */
     constructor(message: string, status?: number);
+    /**
+     * Converts an error into an {@link InternalError}.
+     * @param error The error to convert.
+     * @returns An {@link InternalError} that represents the given error.
+     */
     static fromError(error: Error): InternalError;
 }

package/output/errors/InternalError.js

@@ -5,7 +5,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export class InternalError extends AbstractError {
     /**
-     * Constructs a new `InternalError`.
+     * Constructs a new {@link InternalError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */
@@ -16,6 +16,11 @@ export class InternalError extends AbstractError {
         // constructor instead of the code location we're actually interested in.
         Error.captureStackTrace(this, InternalError);
     }
+    /**
+     * Converts an error into an {@link InternalError}.
+     * @param error The error to convert.
+     * @returns An {@link InternalError} that represents the given error.
+     */
     static fromError(error) {
         // Create a _real_ `InternalError` instance, which we will return later.
         const internalError = new InternalError(error.message);

package/output/errors/InternalError.js.map

@@ -1 +1 @@
-{"version":3,"file":"InternalError.js","sourceRoot":"","sources":["../../source/errors/InternalError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAE1C,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAE5B,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,KAAY;QAC3B,wEAAwE;QACxE,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,kEAAkE;QAClE,mEAAmE;QACnE,0BAA0B;QAC1B,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACtE,uBAAuB;QACvB,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;QAC5B,0CAA0C;QAC1C,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAElC,OAAO,aAAa,CAAC;IACvB,CAAC;CACF"}
+{"version":3,"file":"InternalError.js","sourceRoot":"","sources":["../../source/errors/InternalError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAE1C,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAE5B,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,KAAY;QAC3B,wEAAwE;QACxE,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,kEAAkE;QAClE,mEAAmE;QACnE,0BAA0B;QAC1B,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACtE,uBAAuB;QACvB,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;QAC5B,0CAA0C;QAC1C,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAElC,OAAO,aAAa,CAAC;IACvB,CAAC;CACF"}

package/output/errors/InvalidArgumentError.d.ts

@@ -5,7 +5,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export declare class InvalidArgumentError extends AbstractError {
     /**
-     * Constructs a new `InvalidArgumentError`.
+     * Constructs a new {@link InvalidArgumentError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/InvalidArgumentError.js

@@ -5,7 +5,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export class InvalidArgumentError extends AbstractError {
     /**
-     * Constructs a new `InvalidArgumentError`.
+     * Constructs a new {@link InvalidArgumentError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/InvalidOperationError.d.ts

@@ -5,7 +5,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export declare class InvalidOperationError extends AbstractError {
     /**
-     * Constructs a new `InvalidOperationError`.
+     * Constructs a new {@link InvalidOperationError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/InvalidOperationError.js

@@ -5,7 +5,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export class InvalidOperationError extends AbstractError {
     /**
-     * Constructs a new `InvalidOperationError`.
+     * Constructs a new {@link InvalidOperationError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/NotImplementedError.d.ts

@@ -4,7 +4,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export declare class NotImplementedError extends AbstractError {
     /**
-     * Constructs a new `NotImplementedError`.
+     * Constructs a new {@link NotImplementedError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/NotImplementedError.js

@@ -4,7 +4,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export class NotImplementedError extends AbstractError {
     /**
-     * Constructs a new `NotImplementedError`.
+     * Constructs a new {@link NotImplementedError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/PermissionViolationError.d.ts

@@ -5,7 +5,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export declare class PermissionViolationError extends AbstractError {
     /**
-     * Constructs a new `PermissionViolationError`.
+     * Constructs a new {@link PermissionViolationError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/PermissionViolationError.js

@@ -5,7 +5,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export class PermissionViolationError extends AbstractError {
     /**
-     * Constructs a new `PermissionViolationError`.
+     * Constructs a new {@link PermissionViolationError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/ResourceConflictError.d.ts

@@ -4,7 +4,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export declare class ResourceConflictError extends AbstractError {
     /**
-     * Constructs a new `ResourceConflictError`.
+     * Constructs a new {@link ResourceConflictError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/ResourceConflictError.js

@@ -4,7 +4,7 @@ import { AbstractError } from "./AbstractError.js";
  */
 export class ResourceConflictError extends AbstractError {
     /**
-     * Constructs a new `ResourceConflictError`.
+     * Constructs a new {@link ResourceConflictError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/UnknownError.d.ts

@@ -4,11 +4,11 @@ import { AbstractError } from "./AbstractError.js";
  * real `Error` instance.
  * Like when you catch a `throw "boom"`, we will convert the caught `"boom"`
  * into an `UnknownError`.
- * To enrich an `Error`-like object that was caught, use the `InternalError`.
+ * To enrich an `Error`-like object that was caught, use the {@link InternalError}.
  */
 export declare class UnknownError extends AbstractError {
     /**
-     * Constructs a new `UnknownError`.
+     * Constructs a new {@link UnknownError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/errors/UnknownError.js

@@ -4,11 +4,11 @@ import { AbstractError } from "./AbstractError.js";
  * real `Error` instance.
  * Like when you catch a `throw "boom"`, we will convert the caught `"boom"`
  * into an `UnknownError`.
- * To enrich an `Error`-like object that was caught, use the `InternalError`.
+ * To enrich an `Error`-like object that was caught, use the {@link InternalError}.
  */
 export class UnknownError extends AbstractError {
     /**
-     * Constructs a new `UnknownError`.
+     * Constructs a new {@link UnknownError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/output/graphics/canvas.d.ts

@@ -0,0 +1,80 @@
+/// <reference types="@types/web" />
+/**
+ * A wrapper around {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement HTMLCanvasElement}
+ * to provide some convience for double-buffered drawing.
+ */
+export declare class Canvas {
+    readonly canvas: HTMLCanvasElement;
+    readonly width: number;
+    readonly height: number;
+    readonly context: CanvasRenderingContext2D;
+    readonly pixMap: ImageData;
+    readonly buffer: Uint8ClampedArray;
+    /**
+     * Constructs a new {@link Canvas}.
+     * @param canvas The canvas to wrap.
+     * @param width The width of the canvas.
+     * @param height The height of the canvas.
+     */
+    constructor(canvas: HTMLCanvasElement, width: number, height: number);
+    /**
+     * Draws the backbuffer onto the canvas.
+     */
+    update(): void;
+    /**
+     * Returns the color of a pixel in the backbuffer.
+     * @param x The X coordinate to retrieve.
+     * @param y The X coordinate to retrieve.
+     * @returns The color of the pixel at the given local.
+     */
+    getPixel32(x: number, y: number): number;
+    /**
+     * Colors a pixel in the backbuffer.
+     * @param x The X coordinate to color.
+     * @param y The Y coordinate to color.
+     * @param color The color to place at the coordinate.
+     */
+    setPixel32(x: number, y: number, color: number): void;
+    /**
+     * Fills the entire backbuffer with the given color.
+     * @param color The color to fill the backbuffer with.
+     */
+    clearWith(color: number): void;
+}
+/**
+ * Linearly blends a new pixel with an existing color value in a {@link Canvas}.
+ * @param canvas The {@link 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.
+ * @param color The color of the pixel.
+ * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ */
+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 {@link Canvas}.
+ * @param canvas The {@link 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.
+ * @param color The color of the pixel.
+ * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ */
+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 {@link Canvas}.
+ * @param canvas The {@link 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.
+ * @param color The color of the pixel.
+ * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ */
+export declare const putPixel32Sub: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;
+/**
+ * Linearly blends a new pixel with an existing color value in a {@link Canvas}.
+ * Compared to {@link putPixel32}, this function supports sub-pixel placement, but is dramatically slower.
+ * @param canvas The {@link 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.
+ * @param color The color of the pixel.
+ * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ */
+export declare const putSubPixel32: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;

package/output/graphics/canvas.js

@@ -0,0 +1,164 @@
+import { mustExist } from "../nil.js";
+import { blend, blendAdditive, blendSubtractive, fromRGBA, getA, getB, getG, getR, } from "./core.js";
+/**
+ * A wrapper around {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement HTMLCanvasElement}
+ * to provide some convience for double-buffered drawing.
+ */
+export class Canvas {
+    canvas;
+    width;
+    height;
+    context;
+    pixMap;
+    buffer;
+    /**
+     * Constructs a new {@link Canvas}.
+     * @param canvas The canvas to wrap.
+     * @param width The width of the canvas.
+     * @param height The height of the canvas.
+     */
+    constructor(canvas, width, height) {
+        this.canvas = canvas;
+        this.width = width;
+        this.height = height;
+        this.context = mustExist(this.canvas.getContext("2d"), "Unable to create rendering context.");
+        this.pixMap = this.context.createImageData(width, height);
+        this.buffer = this.pixMap.data;
+        this.context.font = "12px sans-serif";
+    }
+    /**
+     * Draws the backbuffer onto the canvas.
+     */
+    update() {
+        this.context.putImageData(this.pixMap, 0, 0);
+    }
+    /**
+     * Returns the color of a pixel in the backbuffer.
+     * @param x The X coordinate to retrieve.
+     * @param y The X coordinate to retrieve.
+     * @returns The color of the pixel at the given local.
+     */
+    getPixel32(x, y) {
+        const bufferOffset = Math.trunc((x + y * this.width) * 4);
+        return fromRGBA(this.buffer[bufferOffset + 0], this.buffer[bufferOffset + 1], this.buffer[bufferOffset + 2], this.buffer[bufferOffset + 3]);
+    }
+    /**
+     * Colors a pixel in the backbuffer.
+     * @param x The X coordinate to color.
+     * @param y The Y coordinate to color.
+     * @param color The color to place at the coordinate.
+     */
+    setPixel32(x, y, color) {
+        const bufferOffset = Math.trunc((x + y * this.width) * 4);
+        this.buffer[bufferOffset + 0] = getR(color);
+        this.buffer[bufferOffset + 1] = getG(color);
+        this.buffer[bufferOffset + 2] = getB(color);
+        this.buffer[bufferOffset + 3] = getA(color);
+    }
+    /**
+     * Fills the entire backbuffer with the given color.
+     * @param color The color to fill the backbuffer with.
+     */
+    clearWith(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] = r;
+            this.buffer[bufferOffset + 1] = g;
+            this.buffer[bufferOffset + 2] = b;
+            this.buffer[bufferOffset + 3] = a;
+        }
+    }
+}
+/**
+ * Linearly blends a new pixel with an existing color value in a {@link Canvas}.
+ * @param canvas The {@link 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.
+ * @param color The color of the pixel.
+ * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ */
+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 {@link Canvas}.
+ * @param canvas The {@link 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.
+ * @param color The color of the pixel.
+ * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ */
+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 {@link Canvas}.
+ * @param canvas The {@link 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.
+ * @param color The color of the pixel.
+ * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ */
+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);
+};
+/**
+ * Linearly blends a new pixel with an existing color value in a {@link Canvas}.
+ * Compared to {@link putPixel32}, this function supports sub-pixel placement, but is dramatically slower.
+ * @param canvas The {@link 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.
+ * @param color The color of the pixel.
+ * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ */
+export const putSubPixel32 = (canvas, x, y, color, alpha) => {
+    if (canvas.width < x || x < 0 || canvas.height < y || y < 0) {
+        return;
+    }
+    const xweight = x - Math.trunc(x);
+    const yweight = y - Math.trunc(y);
+    const xweightn = 1 - xweight;
+    const yweightn = 1 - yweight;
+    const alpha0 = xweightn * yweightn * alpha;
+    const alpha1 = xweight * yweightn * alpha;
+    const alpha2 = xweightn * yweight * alpha;
+    const alpha3 = xweight * yweight * alpha;
+    putPixel32(canvas, x + 0, y + 0, color, alpha0);
+    putPixel32(canvas, x + 1, y + 0, color, alpha1);
+    putPixel32(canvas, x + 0, y + 1, color, alpha2);
+    putPixel32(canvas, x + 1, y + 1, color, alpha3);
+};
+//# sourceMappingURL=canvas.js.map

package/output/graphics/canvas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"canvas.js","sourceRoot":"","sources":["../../source/graphics/canvas.ts"],"names":[],"mappings":"AAAA,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;;;GAGG;AACH,MAAM,OAAO,MAAM;IACR,MAAM,CAAoB;IAC1B,KAAK,CAAS;IACd,MAAM,CAAS;IACf,OAAO,CAA2B;IAClC,MAAM,CAAY;IAClB,MAAM,CAAoB;IAEnC;;;;;OAKG;IACH,YAAY,MAAyB,EAAE,KAAa,EAAE,MAAc;QAClE,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,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,qCAAqC,CAAC,CAAC;QAC9F,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;;;;;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;;;;;;;GAOG;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;;;;;;;GAOG;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;;;;;;;GAOG;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;;;;;;;;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,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"}