Interface: P5AsciifyRendererPlugin

Defined in: plugins/RendererPlugin.ts:12

Interface that all p5.asciify renderer plugins must implement.

Properties

Property	Modifier	Type	Description	Defined in
author	readonly	string	Author of the plugin	plugins/RendererPlugin.ts:26
description	readonly	string	Description of what the renderer does	plugins/RendererPlugin.ts:20
id	readonly	string	Unique identifier for the renderer type	plugins/RendererPlugin.ts:14
name	readonly	string	Human-readable name of the renderer	plugins/RendererPlugin.ts:17
version	readonly	string	Version of the plugin	plugins/RendererPlugin.ts:23

Methods

create()

create(p, captureFramebuffer, grid, fontManager, options?): P5AsciifyRenderer2D<AsciiRendererOptions> | P5AsciifyRenderer<AsciiRendererOptions> | P5AsciifyAbstractFeatureRenderer2D<FeatureAsciiRendererOptions>

Defined in: plugins/RendererPlugin.ts:37

Creates a new instance of the renderer.

Parameters

Parameter	Type	Description
p	p5	The p5 instance.
captureFramebuffer	any	The framebuffer containing the content to asciify.
grid	P5AsciifyGrid	The grid to use for the asciification.
fontManager	P5AsciifyFontManager	The font manager to use.
options?	FeatureAsciiRendererOptions	Optional options for the renderer.

Returns

P5AsciifyRenderer2D<AsciiRendererOptions> | P5AsciifyRenderer<AsciiRendererOptions> | P5AsciifyAbstractFeatureRenderer2D<FeatureAsciiRendererOptions>

A new instance of the renderer.