textmode.synth.js / SynthSource

Class: SynthSource

A chainable synthesis source that accumulates transforms to be compiled into a shader.

This is the core class that enables hydra-like method chaining for generating procedural textmode visuals. Each method call adds a transform to the chain, which is later compiled into a GLSL shader.

Example

Chain utilities

Methods for reusing or copying an existing synthesis chain.

Method	Description
clone	Create a deep clone of this SynthSource. Useful when you want to create a modified version of an existing chain without affecting the original.
transform	Apply a registered transform by name with explicit arguments.

Color transforms

Methods that adjust, extract, or remap the colors produced by a source.

Method	Description
b	Extract the blue channel as a grayscale value.
brightness	Adjust brightness.
clamp	Clamp color values to a specified range for stability.
color	Multiply all channels by a scalar value (grayscale).
colorama	Apply colorama effect (hue rotation based on luminance).
contrast	Adjust contrast.
g	Extract the green channel as a grayscale value.
gamma	Apply gamma correction for nonlinear brightness control.
hue	Shift hue.
invert	Invert colors.
levels	Adjust input/output levels and gamma for precise tonal control.
luma	Apply threshold based on luminance.
posterize	Posterize colors to limited palette.
r	Extract the red channel as a grayscale value.
saturate	Adjust color saturation.
shift	Shift color channels by adding offset values.
thresh	Apply hard threshold.

Combining sources

Methods that blend, mask, or layer one synth source with another.

Method	Description
add	Add another source.
blend	Blend with another source.
burn	Color burn blend with another source.
darken	Darken blend with another source.
diff	Difference with another source.
dodge	Color dodge blend with another source.
hardlight	Hard light blend with another source.
layer	Layer another source on top.
lighten	Lighten blend with another source.
mask	Mask using another source.
mult	Multiply with another source.
overlay	Overlay blend with another source.
screen	Screen blend with another source.
softlight	Soft light blend with another source.
sub	Subtract another source.

Coordinate modulation

Methods that use one source to distort another source's coordinates.

Method	Description
modulate	Modulate coordinates using another source.
modulateHue	Modulate coordinates based on hue differences.
modulateKaleid	Modulate kaleidoscope using another source.
modulatePixelate	Modulate pixelation using another source.
modulateRepeat	Modulate repeat pattern with another source.
modulateRepeatX	Modulate X repeat with another source.
modulateRepeatY	Modulate Y repeat with another source.
modulateRotate	Modulate rotation using another source.
modulateScale	Modulate scale using another source.
modulateScrollX	Modulate X scroll using another source.
modulateScrollY	Modulate Y scroll using another source.

Coordinate transforms

Methods that reshape the sampling coordinates before a source is evaluated.

Method	Description
barrel	Barrel distortion (bulge outward).
fisheye	Fisheye lens distortion.
kaleid	Apply kaleidoscope effect.
mirror	Mirror coordinates across X and/or Y axes.
pinch	Pinch distortion (pull inward).
pixelate	Pixelate the output.
polar	Convert coordinates to polar space.
repeat	Repeat coordinates in both X and Y directions.
repeatX	Repeat coordinates in X direction.
repeatY	Repeat coordinates in Y direction.
rotate	Rotate coordinates.
scale	Scale coordinates.
scroll	Scroll coordinates in both X and Y directions.
scrollX	Scroll coordinates in X direction.
scrollY	Scroll coordinates in Y direction.
shear	Shear coordinates along X and Y axes.
swirl	Swirl distortion around a center.
twirl	Twirl distortion with radial falloff.

Determinism

Methods that make noise-based source chains reproducible.

Method	Description
seed	Set a seed for deterministic randomness in this source chain.

Output Channels

Methods that choose characters and route values to character and cell colors.

Method	Description
cellColor	Set the cell background colors using a color source chain.
char	Set the character indices using a character source chain. The number of characters is determined by charMap() if defined, otherwise falls back to the total characters in the layer's font.
charColor	Set the character foreground color using a color source chain.
charMap	Map character indices to a specific character set. This is the primary textmode-native way to define which characters to use.
paint	Set both character foreground and cell background color using the same source chain. This is a convenience method that combines .charColor() and .cellColor() in one call.

Sources & Sampling

Methods that begin a chain from procedural patterns, feedback, or a sampled source.

Method	Description
gradient	Generate a rotating radial gradient.
moire	Generate moire interference patterns.
noise	Generate Perlin noise patterns.
osc	Generate oscillating patterns using sine waves.
plasma	Generate plasma-like sine field patterns.
shape	Generate geometric shapes (polygons).
solid	Generate a solid grayscale color.
src	Sample the previous frame for feedback effects.
voronoi	Generate voronoi patterns.