p5.asciify/dist/types/renderers/types.d.ts

Apply real-time ASCII conversion to your favorite p5.js sketches instantly.

import p5 from 'p5';
/**
 * Base ASCII renderer options, applicable to all ASCII renderers.
 */
export interface AsciiRendererOptions {
    /** Whether the renderer is enabled. */
    enabled?: boolean;
}
/**
 * Base options for all feature-based ASCII renderers that extend the {@link P5AsciifyAbstractFeatureRenderer2D} class.
 */
export interface FeatureAsciiRendererOptions extends AsciiRendererOptions {
    /** The character set to use for the ASCII renderer. */
    characters?: string;
    /** The color of the ASCII characters. Only used when `characterColorMode` is set to `fixed`. */
    characterColor?: string | [number, number, number] | p5.Color;
    /** The character color mode. Can be either `sampled` or `fixed`. */
    characterColorMode?: number | string;
    /** The cell background color. Only used when `characterColorMode` is set to `fixed`. */
    backgroundColor?: string | [number, number, number] | p5.Color;
    /** The background color mode. Can be either `sampled` or `fixed`. */
    backgroundColorMode?: number | string;
    /** Swap the cells ASCII character colors with its cell background colors. */
    invert?: boolean;
    /** The rotation angle of all characters affected by a given renderer. */
    rotation?: number | p5.Color;
    /** Flip the ASCII characters horizontally. */
    flipHorizontally?: boolean;
    /** Flip the ASCII characters vertically. */
    flipVertically?: boolean;
}
/**
 * Options specific to the {@link P5AsciifyBrightnessRenderer} class.
 */
export interface BrightnessAsciiRendererOptions extends FeatureAsciiRendererOptions {
    /** The range of brightness values to map to ASCII characters. */
    brightnessRange?: [number, number];
}
/**
 * Options specific to the {@link P5AsciifyEdgeRenderer} class.
 */
export interface EdgeAsciiRendererOptions extends FeatureAsciiRendererOptions {
    /** The threshold for the Sobel edge detection algorithm. */
    sobelThreshold?: number;
    /** The threshold for the ASCII character sampling algorithm. */
    sampleThreshold?: number;
}