textmode.js 0.8.0-beta.3 → 0.8.1-beta.1

package/dist/types/textmode/mixins/interfaces/IAnimationMixin.d.ts

@@ -142,7 +142,7 @@ export interface IAnimationMixin {
      * @returns True if the render loop is currently active, false otherwise.
      *
      * @example
-     * ```javascript
+     * ```js
      * const textmodifier = textmode.create(canvas);
      *
      * // Check loop status in different states

package/dist/types/textmode/mixins/interfaces/IRenderingMixin.d.ts

@@ -1,5 +1,4 @@
 import type { GLFramebuffer, GLShader, TextmodeFramebufferOptions, UniformValue } from '../../../rendering/webgl';
-import type { TextmodeSource } from '../../loadables/TextmodeSource';
 import type { TextmodeImage } from '../../loadables/TextmodeImage';
 import type { TextmodeColor } from '../../TextmodeColor';
 import type { TextmodeVideo } from '../../loadables';
@@ -84,11 +83,9 @@ export interface IRenderingMixin {
      */
     createFramebuffer(options: TextmodeFramebufferOptions): GLFramebuffer;
     /**
-     * Draw a TextmodeFramebuffer or TextmodeSource (TextmodeImage/TextmodeVideo) to the current render target.
+     * Draw a TextmodeFramebuffer, TextmodeImage, or TextmodeVideo to the current render target.
      *
      * @param source The TextmodeFramebuffer or TextmodeSource to render
-     * @param x X position on the grid where to place the content *(top-left corner)*
-     * @param y Y position on the grid where to place the content *(top-left corner)*
      * @param width Width to potentially scale the content
      * @param height Height to potentially scale the content
      *
@@ -121,7 +118,7 @@ export interface IRenderingMixin {
      * });
      * ```
      */
-    image(source: GLFramebuffer | TextmodeSource, width?: number, height?: number): void;
+    image(source: GLFramebuffer | TextmodeImage | TextmodeVideo, width?: number, height?: number): void;
     /**
      * Load an image and return a TextmodeImage that can be drawn with image().
      *
@@ -148,10 +145,8 @@ export interface IRenderingMixin {
      * t.draw(() => {
      *     t.background(0);
      *
-     *     if (img) {
-     *         // Draw the loaded image
-     *         t.image(img);
-     *     }
+     *     // Draw the loaded image
+     *     t.image(img);
      * });
      * ```
      */
@@ -182,10 +177,8 @@ export interface IRenderingMixin {
      * t.draw(() => {
      *     t.background(0);
      *
-     *     if (video) {
-     *         // Draw the loaded video
-     *         t.image(video);
-     *     }
+     *     // Draw the loaded video
+     *     t.image(video);
      * });
      * ```
      */
@@ -706,7 +699,10 @@ export interface IRenderingMixin {
      */
     line(x1: number, y1: number, x2: number, y2: number): void;
     /**
-     * Set the background color for the canvas.
+     * Set the background color of the layer currently drawing to.
+     *
+     * Used to clear the layer to a specific color at the start of its drawing cycle.
+     *
      * @param value A {@link TextmodeColor}, hex string, grayscale value, or single RGB channel
      * @param g Optional green component when providing RGB channels or alpha when used with grayscale
      * @param b Optional blue component when providing RGB channels
@@ -739,7 +735,9 @@ export interface IRenderingMixin {
      */
     background(value: number | string | TextmodeColor, g?: number, b?: number, a?: number): void;
     /**
-     * Clear the canvas.
+     * Clear the layer currently drawing to.
+     *
+     * Used to clear the layer at the start of its drawing cycle.
      *
      * @example
      * ```javascript
@@ -839,6 +837,8 @@ export interface IRenderingMixin {
      * Set the character to be used for subsequent rendering operations.
      * Accepts a single character string.
      *
+     * @param character The character to set for rendering
+     *
      * @example
      * ```javascript
      * const t = textmode.create({

package/dist/types/textmode/mixins/interfaces/ITouchMixin.d.ts

@@ -13,7 +13,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a touch starts.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.touchStarted((data) => {
      *   console.log(`Touch ${data.touch.id} began at ${data.touch.x}, ${data.touch.y}`);
      * });
@@ -29,7 +29,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a touch moves.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.touchMoved((data) => {
      *   const { touch, previousTouch } = data;
      *   if (previousTouch) {
@@ -48,7 +48,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a touch ends.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.touchEnded((data) => {
      *   console.log(`Touch ${data.touch.id} finished at ${data.touch.x}, ${data.touch.y}`);
      * });
@@ -64,7 +64,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a touch is cancelled.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.touchCancelled((data) => {
      *   console.warn(`Touch ${data.touch.id} cancelled by the browser`);
      * });
@@ -80,7 +80,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a tap gesture is detected.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.tap((data) => {
      *   console.log(`Tapped at ${data.touch.x}, ${data.touch.y}`);
      * });
@@ -96,7 +96,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a double tap is detected.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.doubleTap((data) => {
      *   console.log('Double tap detected', data.touch);
      * });
@@ -112,7 +112,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a long press gesture is detected.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.longPress((data) => {
      *   console.log(`Long press for ${Math.round(data.duration)}ms`);
      * });
@@ -128,7 +128,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a swipe gesture is detected.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.swipe((data) => {
      *   console.log(`Swipe ${data.direction} with distance ${data.distance}`);
      * });
@@ -144,7 +144,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a pinch gesture is detected.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.pinch((data) => {
      *   console.log(`Pinch scale: ${data.scale.toFixed(2)}`);
      * });
@@ -160,7 +160,7 @@ export interface ITouchMixin {
      * @param callback The function to call when a rotation gesture is detected.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.rotateGesture((data) => {
      *   console.log(`Rotated ${data.deltaRotation.toFixed(1)}°`);
      * });
@@ -174,7 +174,7 @@ export interface ITouchMixin {
      * available. Use this inside a draw loop to react to active multi-touch scenarios.
      *
      * @example
-     * ```javascript
+     * ```js
      * t.draw(() => {
      *   for (const touch of t.touches) {
      *     t.point();

package/package.json

@@ -1,72 +1,72 @@
-{
-  "name": "textmode.js",
-  "version": "0.8.0-beta.3",
-  "description": "textmode.js is a lightweight creative coding library for creating real-time ASCII art on the web.",
-  "type": "module",
-  "types": "./dist/types/index.d.ts",
-  "main": "./dist/textmode.umd.js",
-  "module": "./dist/textmode.esm.js",
-  "exports": {
-    ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/textmode.esm.js",
-      "require": "./dist/textmode.umd.js"
-    }
-  },
-  "scripts": {
-    "dev": "vite --port 5177 --host",
-    "build": "vite build && tsc",
-    "build:full": "vite build && tsc",
-    "build:docs": "typedoc",
-    "dev:docs": "typedoc --watch",
-    "preview": "vite preview",
-    "test": "vitest",
-    "test:ui": "vitest --ui",
-    "test:run": "vitest run",
-    "test:coverage": "vitest --coverage",
-    "format": "prettier --write \"src/**/*.{ts,js}\"",
-    "format:check": "prettier --check \"src/**/*.{ts,js}\""
-  },
-  "devDependencies": {
-    "@mapwhit/glsl-minify": "^1.0.0",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@types/jsdom": "^21.1.7",
-    "@types/node": "^24.0.13",
-    "@vitest/ui": "^3.1.2",
-    "jsdom": "^26.1.0",
-    "prettier": "^3.7.4",
-    "terser": "^5.43.1",
-    "tslib": "^2.8.1",
-    "typedoc": "^0.28.13",
-    "typedoc-plugin-markdown": "^4.7.0",
-    "typedoc-vitepress-theme": "^1.1.2",
-    "typescript": "^5.9.2",
-    "vite": "^6.3.4",
-    "vite-plugin-glsl": "^1.5.1",
-    "vitest": "^3.1.2"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/humanbydefinition/textmode.js.git"
-  },
-  "keywords": [
-    "ascii",
-    "petscii",
-    "textmode",
-    "canvas",
-    "webgl",
-    "creative-coding",
-    "art",
-    "design",
-    "graphics"
-  ],
-  "author": "humanbydefinition",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/humanbydefinition/textmode.js/issues"
-  },
-  "homepage": "https://code.textmode.art",
-  "files": [
-    "dist"
-  ]
-}
+{
+  "name": "textmode.js",
+  "version": "0.8.1-beta.1",
+  "description": "textmode.js is a lightweight creative coding library for creating real-time ASCII art on the web.",
+  "type": "module",
+  "types": "./dist/types/index.d.ts",
+  "main": "./dist/textmode.umd.js",
+  "module": "./dist/textmode.esm.js",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/textmode.esm.js",
+      "require": "./dist/textmode.umd.js"
+    }
+  },
+  "scripts": {
+    "dev": "vite --port 5177 --host",
+    "build": "vite build && tsc",
+    "build:full": "vite build && tsc",
+    "build:docs": "typedoc",
+    "dev:docs": "typedoc --watch",
+    "preview": "vite preview",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:run": "vitest run",
+    "test:coverage": "vitest --coverage",
+    "format": "prettier --write \"src/**/*.{ts,js}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,js}\""
+  },
+  "devDependencies": {
+    "@mapwhit/glsl-minify": "^1.0.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@types/jsdom": "^21.1.7",
+    "@types/node": "^24.0.13",
+    "@vitest/ui": "^3.1.2",
+    "jsdom": "^26.1.0",
+    "prettier": "^3.7.4",
+    "terser": "^5.43.1",
+    "tslib": "^2.8.1",
+    "typedoc": "^0.28.13",
+    "typedoc-plugin-markdown": "^4.7.0",
+    "typedoc-vitepress-theme": "^1.1.2",
+    "typescript": "^5.9.2",
+    "vite": "^6.3.4",
+    "vite-plugin-glsl": "^1.5.1",
+    "vitest": "^3.1.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/humanbydefinition/textmode.js.git"
+  },
+  "keywords": [
+    "ascii",
+    "petscii",
+    "textmode",
+    "canvas",
+    "webgl",
+    "creative-coding",
+    "art",
+    "design",
+    "graphics"
+  ],
+  "author": "humanbydefinition",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/humanbydefinition/textmode.js/issues"
+  },
+  "homepage": "https://code.textmode.art",
+  "files": [
+    "dist"
+  ]
+}