Class: P5AsciifyRendererManager

Defined in: renderers/RendererManager.ts:27

Manages the whole ASCII rendering pipeline.

Accessors

asciiDisplayRenderer

Get Signature

get asciiDisplayRenderer(): P5AsciifyDisplayRenderer

Defined in: renderers/RendererManager.ts:633

Returns the P5AsciifyDisplayRenderer instance which performs the final ASCII conversion.

Returns

P5AsciifyDisplayRenderer

---

hasEnabledRenderers

Get Signature

get hasEnabledRenderers(): boolean

Defined in: renderers/RendererManager.ts:673

Returns a boolean indicating whether any renderers are enabled in the pipeline.

Returns

boolean

---

renderers

Get Signature

get renderers(): object[]

Defined in: renderers/RendererManager.ts:628

Returns the list of renderers in the pipeline.

The first renderer in the list is executed last, and the last renderer in the list is executed first.

Returns

object[]

Methods

add()

add(name, type, options?): null | P5AsciifyRenderer<AsciiRendererOptions>

Defined in: renderers/RendererManager.ts:283

Adds a new renderer to the list of renderers.

Parameters

Parameter	Type	Description
name	string	The name of the renderer to add.
type	string	The type of the renderer to add.
options?	AsciiRendererOptions	The options to use for the renderer.

Returns

null | P5AsciifyRenderer<AsciiRendererOptions>

The ASCII renderer instance that was added.

Throws

If the renderer name is an empty string or the renderer type is invalid.

Example

let asciifier;
let brightnessAsciiRenderer;

function setupAsciify() {
  asciifier = p5asciify.asciifier();

  // Remove all existing default renderers provided by `p5.asciify`.
  asciifier.renderers().clear();

  // Add a new brightness renderer with custom options.
  brightnessAsciiRenderer = asciifier
    .renderers()
    .add("brightness", "brightness", {
      enabled: true,
      characterColor: "#FF0000",
      backgroundColor: "#0000FF",
      characterColorMode: "fixed",
      backgroundColorMode: "fixed",
    });
}

---

clear()

clear(): void

Defined in: renderers/RendererManager.ts:525

Clears the list of renderers. Can be useful when you want to start fresh without the default renderers provided by the library.

Returns

void

Example

function setupAsciify() {
  // Clear all existing renderers.
  p5asciify.asciifier().renderers().clear();

  // With no renderers, you can add your own custom renderer.
  // Otherwise, `p5.asciify` will now render the input image without any ASCII conversion.
}

---

disable()

disable(): void

Defined in: renderers/RendererManager.ts:591

Disables all renderers in the list of renderers at once.

Returns

void

Example

function setupAsciify() {
  // Disable all renderers in the list.
  p5asciify.asciifier().renderers().disable();
}

---

enable()

enable(): void

Defined in: renderers/RendererManager.ts:576

Enables all renderers in the list of renderers at once.

Returns

void

Example

function setupAsciify() {
  // Enable all default renderers provided by `p5.asciify`.
  p5asciify.asciifier().renderers().enable();
}

---

enabled()

enabled(enabled): void

Defined in: renderers/RendererManager.ts:607

Enables or disables all renderers in the list of renderers at once.

Parameters

Parameter	Type	Description
enabled	boolean	Whether to enable or disable all renderers.

Returns

void

Example

function setupAsciify() {
  // Enable all default renderers provided by `p5.asciify`.
  p5asciify.asciifier().renderers().enabled(true);
}

---

get()

get(rendererName): null | P5AsciifyRenderer<AsciiRendererOptions>

Defined in: renderers/RendererManager.ts:368

Gets the ASCII renderer instance with the given name.

Parameters

Parameter	Type	Description
rendererName	string	The name of the renderer to get.

Returns

null | P5AsciifyRenderer<AsciiRendererOptions>

The ASCII renderer instance with the given name.

Example

let brightnessRenderer;

function setupAsciify() {
  // Get the brightness renderer instance by name.
  brightnessRenderer = p5asciify.asciifier().renderers().get("brightness");

  // Use the brightness renderer instance to modify its properties during run-time,
  // instead of constantly calling `p5asciify.asciifier().renderers().get('brightness')`.
}

---

getAvailableRendererTypes()

getAvailableRendererTypes(): string[]

Defined in: renderers/RendererManager.ts:401

Gets a list of all available renderer types (built-in and plugins)

Returns

string[]

An array of available renderer type IDs

---

moveDown()

moveDown(renderer): void

Defined in: renderers/RendererManager.ts:422

Moves a renderer down in the list of renderers, meaning it will be rendered earlier in the pipeline.

Parameters

Parameter	Type	Description
renderer	string | P5AsciifyRenderer<AsciiRendererOptions>	The renderer to move down in the list.

Returns

void

Example

function setupAsciify() {
  // Move the `"brightness"` renderer down in the list of renderers.
  p5asciify.asciifier().renderers().moveDown("brightness");

  // Alternatively, you can also pass the renderer instance itself.
}

---

moveUp()

moveUp(renderer): void

Defined in: renderers/RendererManager.ts:458

Moves a renderer up in the list of renderers, meaning it will be rendered later in the pipeline.

Parameters

Parameter	Type	Description
renderer	string | P5AsciifyRenderer<AsciiRendererOptions>	The renderer to move up in the list.

Returns

void

Example

function setupAsciify() {
  // Move the `"brightness"` renderer up in the list of renderers.
  p5asciify.asciifier().renderers().moveUp("brightness");

  // Alternatively, you can also pass the renderer instance itself.
}

---

remove()

remove(renderer): void

Defined in: renderers/RendererManager.ts:494

Removes a renderer from the list of renderers.

Parameters

Parameter	Type	Description
renderer	string | P5AsciifyRenderer<AsciiRendererOptions>	The name of the renderer or the renderer instance itself.

Returns

void

Example

function setupAsciify() {
  // Remove the `"brightness"` renderer from the list of renderers.
  p5asciify.asciifier().renderers().remove("brightness");

  // Alternatively, you can also pass the renderer instance itself.
}

---

swap()

swap(renderer1, renderer2): void

Defined in: renderers/RendererManager.ts:545

Swaps the positions of two renderers in the renderer list.

Parameters

Parameter	Type	Description
renderer1	string | P5AsciifyRenderer<AsciiRendererOptions>	The name of the first renderer or the renderer instance itself.
renderer2	string | P5AsciifyRenderer<AsciiRendererOptions>	The name of the second renderer or the renderer instance itself.

Returns

void

Throws

If one or more renderers are not found.

Example

function setupAsciify() {
  // Swap the positions of the `"brightness"` and `"edge"` renderers.
  p5asciify.asciifier().renderers().swap("brightness", "edge");

  // Alternatively, you can also pass the renderer instances themselves.
}