textmode.js / TextmodeFramebufferOptions

Type Alias: TextmodeFramebufferOptions

type TextmodeFramebufferOptions = object;

Options for creating a framebuffer via Textmodifier.createFramebuffer. If not specified, width and height default to the current textmode grid size.

Properties

attachments?

optional attachments?: number;

Number of color attachments (1-8)

Defaults to 3 for textmode framebuffers (character/transform data, charColor, cellColor). You probably do not want to go below 3 for textmode rendering, otherwise rendering will not function correctly.

Going above 3 is only recommended for advanced use cases involving custom shaders that utilize additional attachments.

---

depth?

optional depth?: boolean;

Whether to allocate a depth attachment. Defaults to true.

---

filter?

optional filter?: "nearest" | "linear";

Texture sampling mode. Defaults to 'nearest'.

---

height?

optional height?: number;

Height of the framebuffer in grid cells

---

width?

optional width?: number;

Width of the framebuffer in grid cells