textmode.filters.js
Complete optional filter system for textmode.js, including 18 setup-compiled GPU effects, custom registration, layer/global/final queues, and automatic resource cleanup.
Built-in filters
The shipped filter names and their parameter types.
| Name | Description |
|---|---|
| BuiltInFilterParameterMap | Parameter types for every built-in filter. |
| BuiltInFilterName | Names installed synchronously by FiltersPlugin. |
Color adjustment filters
Configuration options for the bundled color-adjustment effects.
| Interface | Description |
|---|---|
| BrightnessOptions | Configuration options for the 'brightness' filter. |
| ContrastOptions | Configuration options for the 'contrast' filter. |
| GrayscaleOptions | Options for the built-in grayscale effect. |
| HueRotateOptions | Configuration options for the 'hueRotate' filter. |
| PosterizeOptions | Configuration options for the 'posterize' filter. |
| SaturationOptions | Configuration options for the 'saturation' filter. |
| SepiaOptions | Options for the built-in sepia effect. |
| ThresholdOptions | Options for the built-in threshold effect. |
Custom filters
Types used when registering bespoke GPU filters on the manager.
| Type Alias | Description |
|---|---|
| FilterName | Built-in names retain completion while arbitrary custom names remain valid. |
| TextmodeFilterShader | A precompiled textmode shader, inline fragment source, or shader URL accepted by custom registration. |
| TextmodeFilterUniformDefinitions | Uniform declarations for a custom filter, mapping GLSL names to public parameter names and defaults. |
Distortion filters
Configuration options for the bundled distortion effects.
| Interface | Description |
|---|---|
| ChromaticAberrationOptions | Configuration options for the 'chromaticAberration' filter. |
| GridDistortionOptions | Configuration options for the 'gridDistortion' filter. |
| PixelateOptions | Configuration options for the 'pixelate' filter. |
Filter management
The runtime that owns filter registration, queues, GPU resources, and cleanup.
| Class | Description |
|---|---|
| TextmodeFilterManager | Owns filter registration, queues, GPU resources, pass execution, and cleanup. |
Stylization filters
Configuration options for the bundled stylization effects.
| Interface | Description |
|---|---|
| BloomOptions | Configuration options for the 'bloom' filter. |
| CrtMattiasOptions | Configuration options for the 'crtMattias' filter. |
| FilmGrainOptions | Configuration options for the 'filmGrain' filter. |
| GlitchOptions | Configuration options for the 'glitch' filter. |
| ScanlinesOptions | Configuration options for the 'scanlines' filter. |
| VignetteOptions | Configuration options for the 'vignette' filter. |
Workflow
The plugin that installs the filter system on a textmode.js sketch.
| Variable | Description |
|---|---|
| FiltersPlugin | GPU-accelerated filters plugin. Installing it adds the complete 18-filter workflow to one Textmodifier. |