textmode.js

Appearance

Quick Actions

Open in ChatGPTOpen in ClaudeOpen in Perplexity

textmode.js / TextmodeOptions

Type Alias: TextmodeOptions ​

ts
type TextmodeOptions = object;

Options when creating a Textmodifier instance via textmode.create.

Properties ​

canvas? ​

ts
optional canvas?: HTMLCanvasElement | HTMLVideoElement;

Existing HTMLCanvasElement or HTMLVideoElement to use instead of letting textmode.js create a canvas.

Note: If using overlay mode, this should be the target canvas or video element to overlay on. textmode.js will create its own canvas applied on top of the target element, always matching its size and position.

fontSize? ​

ts
optional fontSize?: number;

The font size to use for text rendering. Defaults to 16.

fontSource? ​

ts
optional fontSource?: string;

URL or path to a custom font file (.otf, .ttf, or .woff).

frameRate? ​

ts
optional frameRate?: number;

Maximum frames per second for auto rendering. Defaults to 60.

gl? ​

ts
optional gl?: WebGL2RenderingContext;

Use an external WebGL2 context instead of creating a new one. Useful for integrating with three.js, Babylon.js, hydra-synth, or other WebGL libraries that share the same canvas.

height? ​

ts
optional height?: number;

The height of the canvas when creating a new canvas. Defaults to 600.

loadingScreen? ​

ts
optional loadingScreen?: LoadingScreenOptions;

Configure the built-in loading screen experience.

overlay? ​

ts
optional overlay?: boolean;

Render textmode.js as an overlay on top of an existing canvas or video element.

Overlay mode creates a textmode <canvas> that follows the target element's size and position. The target content is exposed as an adjustable media.TextmodeImage through Textmodifier.overlay and can be drawn with Textmodifier.image.

This is useful for applying textmode conversion to p5.js sketches, videos, and other canvas-based renderers. Manual textmode canvas resizing is not recommended in overlay mode because the target element controls the size.

plugins? ​

ts
optional plugins?: TextmodePlugin[];

List of plugins to install when the Textmodifier instance is created.

seed? ​

ts
optional seed?: TextmodeRandomSeed;

Seed used by the instance-scoped random generator.

Set this when a sketch should produce the same random sequence each time it runs.

width? ​

ts
optional width?: number;

The width of the canvas when creating a new canvas. Defaults to 800.