Interface: AsciiEffect

Defined in: attributes/shape/effects/implementations/ascii.ts:48

ASCII art: the content is divided into a grid of cells, each cell's tone is matched to a glyph, and that glyph is drawn in its place.

The glyphs come from a texture baked once per charset/font/size — the first effect to use the renderer's resource hook.

Extends

background: Color

Defined in: attributes/shape/effects/implementations/ascii.ts:59

Colour behind the glyphs. Fully transparent leaves the backdrop showing.

charset: string

Defined in: attributes/shape/effects/implementations/ascii.ts:53

A named ramp, or a custom string ordered least-ink-first.

colored: boolean

Defined in: attributes/shape/effects/implementations/ascii.ts:61

Tint each glyph with its own cell's colour instead of using ink.

fontFamily: string

Defined in: attributes/shape/effects/implementations/ascii.ts:55

Family the glyphs are baked in. Best results from a monospace face.

ink: Color

Defined in: attributes/shape/effects/implementations/ascii.ts:57

Colour of the glyphs when colored is false.

optional mode?: EffectMode

Defined in: attributes/shape/effects/effect-data.ts:83

size: number

Defined in: attributes/shape/effects/implementations/ascii.ts:51

Cell size in px — the width of one character.

type: "ascii"

Defined in: attributes/shape/effects/implementations/ascii.ts:49