textmode.js/dist/types/index.d.ts

textmode.js is a lightweight creative coding library for creating real-time ASCII art on the web.

import { Textmode } from './Textmode';
export { Textmodifier } from './textmode/Textmodifier';
export { GLFramebuffer as TextmodeFramebuffer } from './rendering';
export { TextmodeColor } from './textmode/TextmodeColor';
export { TextmodeCanvas } from './textmode/Canvas';
export { TextmodeGrid } from './textmode/Grid';
export type { TextmodeOptions } from './textmode/types';
export type { TextmodeFramebufferOptions } from './rendering/webgl';
/**
 * All media conversion related modules and types.
 *
 * Responsible for converting images and videos into textmode-renderable formats
 * using various conversion strategies, like brightness- or edge-detection-based conversion.
 *
 * `textmode.js` only comes with a built-in `'brightness'`-based conversion strategy,
 * but custom strategies can be registered via {@link TextmodeConversionManager.register}.
 */
export * as conversion from './textmode/conversion';
export type { TextmodePlugin, TextmodePluginAPI } from './textmode/managers/PluginManager';
/**
 * All filter related modules and types.
 *
 * Provides various image processing filters that can be applied in sequence on a layer's textmode-converted output,
 * such as blur, sharpen, edge detection, and color adjustments. Filters can also be applied globally to all layers as post-processing effects.
 *
 * While `textmode.js` only offers a basic set of filters, additional filters can be implemented and registered via the {@link TextmodeFilterManager},
 * which is accessible through {@link Textmodifier.filters}.
 */
export * as filters from './textmode/filters';
export { TextmodeErrorLevel } from './errors/ErrorHandler';
export { Textmode as textmode } from './Textmode';
/** All loading screen related modules and types. */
export * as loading from './textmode/loading';
/** All loadable assets related to textmode rendering. */
export * as loadables from './textmode/loadables';
/** All types and interfaces related to input event handling. */
export * as input from './textmode/managers';
/** All modules and types related to multi-layered textmode rendering. */
export * as layering from './textmode/layers';
/**
 * Exports the create, setErrorLevel, and version functions from the Textmode class for UMD compatibility,
 * so calls like `textmode.create()` can be used.
 */
/** @ignore */
export declare const create: typeof Textmode.create;
/** @ignore */
export declare const setErrorLevel: typeof Textmode.setErrorLevel;
/** @ignore */
export declare const version: string;