textmode.js 0.2.1-beta.2 → 0.2.1-beta.3

package/dist/types/textmode/mixins/MouseMixin.d.ts

@@ -4,18 +4,111 @@ import type { MousePosition, MouseEventHandler } from '../managers';
  * Capabilities provided by the MouseMixin
  */
 export interface MouseCapabilities {
-    /** Get the current mouse position in grid coordinates */
-    readonly mouse: MousePosition;
-    /** Set a callback for when the mouse is clicked */
+    /**
+     * Set a callback function that will be called when the mouse is clicked.
+     *
+     * @param callback The function to call when the mouse is clicked
+     *
+     * @example
+     * ```javascript
+     * const t = textmode.create({ width: 800, height: 600 });
+     *
+     * t.mouseClicked((data) => {
+     *   console.log(`Clicked at grid position: ${data.position.x}, ${data.position.y}`);
+     *   console.log(`Button: ${data.button}`); // 0=left, 1=middle, 2=right
+     * });
+     * ```
+     */
     mouseClicked(callback: MouseEventHandler): void;
-    /** Set a callback for when the mouse is pressed down */
+    /**
+     * Set a callback function that will be called when the mouse is pressed down.
+     *
+     * @param callback The function to call when the mouse is pressed
+     *
+     * @example
+     * ```javascript
+     * const t = textmode.create({ width: 800, height: 600 });
+     *
+     * t.mousePressed((data) => {
+     *   console.log(`Mouse pressed at: ${data.position.x}, ${data.position.y}`);
+     * });
+     * ```
+     */
     mousePressed(callback: MouseEventHandler): void;
-    /** Set a callback for when the mouse is released */
+    /**
+     * Set a callback function that will be called when the mouse is released.
+     *
+     * @param callback The function to call when the mouse is released
+     *
+     * @example
+     * ```javascript
+     * const t = textmode.create({ width: 800, height: 600 });
+     *
+     * t.mouseReleased((data) => {
+     *   console.log(`Mouse released at: ${data.position.x}, ${data.position.y}`);
+     * });
+     * ```
+     */
     mouseReleased(callback: MouseEventHandler): void;
-    /** Set a callback for when the mouse moves */
+    /**
+     * Set a callback function that will be called when the mouse moves.
+     *
+     * @param callback The function to call when the mouse moves
+     *
+     * @example
+     * ```javascript
+     * const t = textmode.create({ width: 800, height: 600 });
+     *
+     * t.mouseMoved((data) => {
+     *   if (data.position.x !== -1 && data.position.y !== -1) {
+     *     console.log(`Mouse moved to: ${data.position.x}, ${data.position.y}`);
+     *     console.log(`Previous position: ${data.previousPosition.x}, ${data.previousPosition.y}`);
+     *   }
+     * });
+     * ```
+     */
     mouseMoved(callback: MouseEventHandler): void;
-    /** Set a callback for when the mouse wheel is scrolled */
+    /**
+     * Set a callback function that will be called when the mouse wheel is scrolled.
+     *
+     * @param callback The function to call when the mouse wheel is scrolled
+     *
+     * @example
+     * ```javascript
+     * const t = textmode.create({ width: 800, height: 600 });
+     *
+     * t.mouseScrolled((data) => {
+     *   console.log(`Mouse scrolled at: ${data.position.x}, ${data.position.y}`);
+     *   console.log(`Scroll delta: ${data.delta?.x}, ${data.delta?.y}`);
+     * });
+     * ```
+     */
     mouseScrolled(callback: MouseEventHandler): void;
+    /**
+     * Get the current mouse position in grid coordinates.
+     *
+     * Returns the mouse position as grid cell coordinates *(column, row)*.
+     *
+     * If the mouse is outside the grid or the instance is not ready,
+     * it returns `{ x: -1, y: -1 }`.
+     *
+     * @example
+     * ```javascript
+     * const t = textmode.create({ width: 800, height: 600 });
+     *
+     * t.draw(() => {
+     *   const mousePos = t.mouse;
+     *
+     *   if (mousePos.x !== -1 && mousePos.y !== -1) {
+     *     // Mouse is over the grid
+     *     t.char('*');
+     *     t.charColor(255, 0, 0);
+     *     t.point(mousePos.x, mousePos.y);
+     *   }
+     * });
+     * ```
+     */
+    get mouse(): MousePosition;
 }
 /**
  * Mixin that adds mouse tracking capabilities to Textmodifier.

package/dist/types/textmode/mixins/RenderingMixin.d.ts

@@ -1,10 +1,15 @@
 import type { Mixin } from './TextmodifierMixin';
 import type { GLShader } from '../../rendering/webgl/Shader';
 import type { GLFramebuffer } from '../../rendering';
-export interface UserFramebufferOptions {
+/**
+ * Options for creating a framebuffer.
+ */
+export type TextmodeFramebufferOptions = {
+    /** Width of the framebuffer in grid cells */
     width: number;
+    /** Height of the framebuffer in grid cells */
     height: number;
-}
+};
 /**
  * Supported uniform value types for shader parameters
  */
@@ -45,56 +50,56 @@ export interface RenderingCapabilities {
      */
     shader(shader: GLShader): void;
     /**
-         * Create a new framebuffer for offscreen rendering.
-         *
-         * The framebuffer uses the same 5-attachment MRT structure as the main
-         * rendering pipeline, allowing all standard drawing operations to work
-         * seamlessly when rendering to the framebuffer.
-         *
-         * @param options Configuration options for the framebuffer
-         * @returns A new UserFramebuffer instance
-         *
-         * @example
-         * ```javascript
-         * const t = textmode.create({
-         *   width: 800,
-         *   height: 600,
-         * });
-         *
-         * // Create a framebuffer with 50x30 grid cells
-         * const fb = t.createFramebuffer({
-         *   width: 50,
-         *   height: 30
-         * });
-         *
-         * t.draw(() => {
-         *   // Render to framebuffer
-         *   fb.begin();
-         *   t.background(255, 0, 0);
-         *   t.charColor(255);
-         *   t.rect(10, 10, 20, 10);
-         *   fb.end();
-         *
-         *   // Render framebuffer to main canvas
-         *   t.background(0);
-         *   t.image(fb, 0, 0);
-         * });
-         * ```
-         */
-    createFramebuffer(options: UserFramebufferOptions): GLFramebuffer;
+     * Create a new framebuffer for offscreen rendering.
+     *
+     * The framebuffer uses the same 5-attachment MRT structure as the main
+     * rendering pipeline, allowing all standard drawing operations to work
+     * seamlessly when rendering to the framebuffer.
+     *
+     * @param options Configuration options for the framebuffer.
+     * @returns A new Framebuffer instance.
+     *
+     * @example
+     * ```javascript
+     * const t = textmode.create({
+     *   width: 800,
+     *   height: 600,
+     * });
+     *
+     * // Create a framebuffer with 50x30 grid cells
+     * const fb = t.createFramebuffer({
+     *   width: 50,
+     *   height: 30
+     * });
+     *
+     * t.draw(() => {
+     *   // Render to framebuffer
+     *   fb.begin();
+     *   t.background(255, 0, 0);
+     *   t.charColor(255);
+     *   t.rect(10, 10, 20, 10);
+     *   fb.end();
+     *
+     *   // Render framebuffer to main canvas
+     *   t.background(0);
+     *   t.image(fb, 0, 0);
+     * });
+     * ```
+     */
+    createFramebuffer(options: TextmodeFramebufferOptions): GLFramebuffer;
     /**
      * Render a framebuffer to the current render target.
      *
      * This method takes the 5 MRT attachments from the source framebuffer
-     * and renders them as a textmode rectangle at the specified position.
+     * and renders them at the specified position.
      * The framebuffer content will be processed through the same rendering
      * pipeline as normal drawing operations.
      *
      * @param framebuffer The framebuffer to render
-     * @param x X position on the grid where to place the framebuffer content
-     * @param y Y position on the grid where to place the framebuffer content
-     * @param width Optional width to scale the framebuffer content (defaults to framebuffer width)
-     * @param height Optional height to scale the framebuffer content (defaults to framebuffer height)
+     * @param x X position on the grid where to place the framebuffer content *(top-left corner)*
+     * @param y Y position on the grid where to place the framebuffer content *(top-left corner)*
+     * @param width Optional width to scale the framebuffer content *(defaults to framebuffer width)*
+     * @param height Optional height to scale the framebuffer content *(defaults to framebuffer height)*
      *
      * @example
      * ```javascript
@@ -403,6 +408,8 @@ export interface RenderingCapabilities {
      *
      * t.draw(() => {
      *   t.background(0);
+     *
+     *   t.char('*');
      *   t.point(10, 10);
      * });
      * ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textmode.js",
-  "version": "0.2.1-beta.2",
+  "version": "0.2.1-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",
@@ -40,7 +40,7 @@
     "jsdom": "^26.1.0",
     "terser": "^5.43.1",
     "tslib": "^2.8.1",
-    "typedoc": "^0.28.7",
+    "typedoc": "^0.28.13",
     "typedoc-plugin-markdown": "^4.7.0",
     "typescript": "^5.9.2",
     "vite": "^6.3.4",