Skip to content

textmode.js

Namespaces

NamespaceDescription
conversionAll media conversion related modules and types.
filtersAll filter related modules and types.
inputAll types and interfaces related to input event handling.
layeringAll modules and types related to multi-layered textmode rendering.
loadablesAll loadable assets related to textmode rendering.
loadingAll loading screen related modules and types.

Enumerations

EnumerationDescription
TextmodeErrorLevelError handling levels to control how errors are reported and handled.

Classes

ClassDescription
textmodeThe main entry point for the textmode.js library.
TextmodeColorRepresents a color in the textmode.js rendering system.
TextmodeFramebufferFramebuffer class for managing offscreen rendering targets initialized via Textmodifier.createFramebuffer.
TextmodeGridManages the grid of each TextmodeLayer instance.
TextmodifierManages textmode rendering on a HTMLCanvasElement and provides methods for drawing, font management, event handling, layer management, animation control, and more. The heart of the textmode.js library.

Interfaces

InterfaceDescription
TextmodePluginA plugin interface for extending the functionality of a Textmodifier instance.
TextmodePluginAPIAn extended API provided to plugins when they are installed on a Textmodifier instance.

Type Aliases

Type AliasDescription
TextmodeFramebufferOptionsOptions for creating a framebuffer. If not specified, width and height default to the current textmode grid size.
TextmodeOptionsOptions for creating a Textmodifier instance.