textmode.js 0.2.0-beta.4 → 0.2.0

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

@@ -11,11 +11,11 @@ export interface RenderingCapabilities {
     /**
      * Set a custom shader for subsequent rendering operations.
      * Pass null to return to the default shader.
-     * @param shader The custom shader to use, or null to use the default shader
+     * @param shader The custom shader to use
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -38,7 +38,7 @@ export interface RenderingCapabilities {
      * });
      * ```
      */
-    shader(shader: GLShader | null): void;
+    shader(shader: GLShader): void;
     /**
      * Set a uniform value for the current custom shader.
      * @param name The name of the uniform variable
@@ -46,7 +46,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -70,7 +70,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -97,11 +97,11 @@ export interface RenderingCapabilities {
      * The fragment shader will automatically receive the standard vertex shader inputs
      * and must output to all 5 MRT attachments.
      * @param fragmentSource The fragment shader source code
-     * @returns A compiled shader ready for use with shader()
+     * @returns A compiled shader ready for use with {@link shader}
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -157,7 +157,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -182,7 +182,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -201,7 +201,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -220,7 +220,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -239,7 +239,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -248,7 +248,8 @@ export interface RenderingCapabilities {
      *   t.background(0);
      *
      *   t.push(); // Save current state
-     *   // todo...
+     *   t.charColor(255, 0, 0); // Red characters
+     *   t.rect(10, 10, 5, 5);
      *   t.pop(); // Restore previous state
      * });
      * ```
@@ -260,7 +261,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -269,7 +270,9 @@ export interface RenderingCapabilities {
      *   t.background(0);
      *
      *   t.push(); // Save current state
-     *   // todo...
+     *   t.charColor(0, 255, 0); // Green characters
+     *   t.char('█');
+     *   t.rect(5, 5, 3, 3);
      *   t.pop(); // Restore previous state
      * });
      * ```
@@ -277,14 +280,14 @@ export interface RenderingCapabilities {
     pop(): void;
     /**
      * Draw a rectangle with the current settings.
-     * @param x X-coordinate of the rectangle
-     * @param y Y-coordinate of the rectangle
+     * @param x X-coordinate of the rectangle *(top-left corner)*
+     * @param y Y-coordinate of the rectangle *(top-left corner)*
      * @param width Width of the rectangle
      * @param height Height of the rectangle
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -293,7 +296,10 @@ export interface RenderingCapabilities {
      *   // Set the background color to black
      *   t.background(0);
      *
-     *   // todo...
+     *   // Draw a filled rectangle with default character
+     *   t.char('█');
+     *   t.charColor(255, 255, 255); // White
+     *   t.rect(10, 10, 15, 8);
      * });
      * ```
      */
@@ -307,7 +313,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -316,7 +322,11 @@ export interface RenderingCapabilities {
      *   // Set the background color to black
      *   t.background(0);
      *
-     *   // todo
+     *   // Draw a diagonal line
+     *   t.char('-');
+     *   t.charColor(0, 255, 255); // Cyan
+     *   t.lineWeight(1);
+     *   t.line(5, 5, 25, 15);
      * });
      * ```
      */
@@ -330,7 +340,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -347,7 +357,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *  width: 800,
      *  height: 600,
      * })
@@ -365,7 +375,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *  width: 800,
      *  height: 600,
      * })
@@ -392,7 +402,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -400,7 +410,11 @@ export interface RenderingCapabilities {
      * t.draw(() => {
      *   t.background(0);
      *
-     *   // todo
+     *   // Draw a smooth S-curve
+     *   t.char('*');
+     *   t.charColor(255, 100, 255); // Magenta
+     *   t.lineWeight(2);
+     *   t.bezierCurve(5, 20, 15, 5, 25, 35, 35, 20);
      * });
      * ```
      */
@@ -411,7 +425,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -429,11 +443,10 @@ export interface RenderingCapabilities {
      * @param r Red component (0-255)
      * @param g Green component (0-255)
      * @param b Blue component (0-255)
-     * @param a Alpha component (0-255)
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -451,11 +464,10 @@ export interface RenderingCapabilities {
      * @param r Red component (0-255)
      * @param g Green component (0-255)
      * @param b Blue component (0-255)
-     * @param a Alpha component (0-255)
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -474,7 +486,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -493,7 +505,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -512,14 +524,14 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
      *
      * t.draw(() => {
      *   t.background(0);
-     *   t.charRotation(45); // Rotate character 45 degrees
+     *   t.charRotation(90); // Rotate character 90 degrees
      *   t.rect(10, 10, 5, 5);
      * });
      * ```
@@ -531,7 +543,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -553,7 +565,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -576,7 +588,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })
@@ -599,7 +611,7 @@ export interface RenderingCapabilities {
      *
      * @example
      * ```javascript
-     * const t = await textmode.create({
+     * const t = textmode.create({
      *   width: 800,
      *   height: 600,
      * })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "textmode.js",
-  "version": "0.2.0-beta.4",
-  "description": "Apply real-time ASCII conversion to any HTML canvas.",
+  "version": "0.2.0",
+  "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",
@@ -55,14 +55,18 @@
     "petscii",
     "textmode",
     "canvas",
-    "webgl"
+    "webgl",
+    "creative-coding",
+    "art",
+    "design",
+    "graphics"
   ],
   "author": "humanbydefinition",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/humanbydefinition/textmode.js/issues"
   },
-  "homepage": "https://github.com/humanbydefinition/textmode.js",
+  "homepage": "https://code.textmode.art",
   "files": [
     "dist"
   ]