Reference
Alphabetical
Name |
Description |
|---|---|
Alignment of text or graphics in a box. |
|
Anchor describes a location inside a rectangular area using a combination of a vertical and a horizontal component. |
|
The interface to the underlying platform. |
|
Shared pointer to a backend instance. |
|
The background color. |
|
A mutable bitmap storing boolean pixels in row-major order. |
|
The mode how color is applied to the bitmap. |
|
The options to draw a bitmap. |
|
The mode how the bitmap is scaled. |
|
A mutable 2D buffer storing characters and colors for rendering. |
|
A view that uses a reference to the content. |
|
A view that uses a shared pointer to the content. |
|
The base class for all buffer views. |
|
Represents a character string with foreground and background colors. |
|
Represents optional ANSI text attributes such as bold, underline, or strikethrough. |
|
Combines a Color value with CharAttributes into one reusable text style. |
|
Defines a style for drawing tiles. |
|
Shared pointer for Char16Style |
|
A style how two characters are visually combined to a new one. |
|
Shared pointer for CharCombinationStyle |
|
A foreground/background color pair for terminal rendering. |
|
Shared implementation for foreground and background color values. |
|
Internal color identifiers used for ANSI conversion and parsing. |
|
A list of terminal colors. |
|
A foreground or background color. |
|
The type color. |
|
A configurable sequence of complete Color values with run-length style counts. |
|
Flags for crop edges and corners. |
|
A remapped buffer with cursor-style writing, wrapping, and scrollback behavior. |
|
Controls whether cursor writes wrap, scroll, or grow the buffer at the bottom edge. |
|
The shared interface for buffers and terminals that support cursor-based output. |
|
A direction in a 2D grid. |
|
The canonical enum values used by Direction. |
|
A bitmap font used to render stylized terminal text. |
|
A bitmap glyph that can be used by a terminal text font. |
|
Shared pointer to a terminal font. |
|
The foreground color. |
|
The mode how animated colors are applied to frames. |
|
The options to draw a frame. |
|
Various box styles |
|
Reads key presses from the console depending on the configured mode. |
|
Supported reading modes for the input backend. |
|
Definition of a single key mapping for a specific input mode. |
|
The input modes to which a key definition can apply. |
|
A list of input definitions. |
|
A simple representation of a key press. |
|
Supported key kinds. |
|
Represents margins (top, right, bottom, left) around a rectangle. |
|
A class that combines characters through an indexed result matrix. |
|
The cursor move mode. |
|
How paragraph rendering extends the background color beyond the visible text. |
|
The fallback to use when paragraph layout becomes impossible. |
|
Options that control paragraph wrapping, indentation, tab handling, and fallback behavior. |
|
The spacing between explicit newline-separated paragraphs. |
|
Represents a 2D integer position or vector (x, y). |
|
A readable buffer. |
|
A buffer optimized for row and column remapping operations. |
|
Axis-aligned rectangle represented by a top-left position and size. |
|
A class to use a simple map to combine styles. |
|
A non-negative 2D size (width × height). |
|
A terminal string represented as a sequence of Char values. |
|
A sequence of wrapped terminal text lines. |
|
The handling for tabs whose configured tab stop does not advance the current line. |
|
High-level terminal interface for screen control, color output, and key input. |
|
A terminal flag. |
|
A set of terminal flags. |
|
The output mode for the terminal. |
|
Screen clearing strategy used between rendered frames. |
|
Shared pointer to a terminal instance. |
|
Describes a text block to render into a Buffer. |
|
Options for text rendering. |
|
Supported text animation styles used by Buffer::drawText(). |
|
Defines a style for repeating a 3x3 tile pattern across a rectangle. |
|
Shared pointer for Tile9Style |
|
Settings controlling how Terminal::updateScreen() renders a buffer. |
|
Abstract writable terminal buffer interface. |
|
Short alias for Background. |
|
Short alias for Foreground. |
By Topic
Topic |
Description |
|---|---|
Bitmap is the low-level pixel container used by the library whenever a boolean mask needs to be rendered, copied, or transformed. A bitmap stores only on/off pixels; the actual terminal representation is chosen later by Buffer::drawBitmap() and BitmapDrawOptions. |
|
Buffer views expose a rectangular window onto a larger readable buffer. They are useful whenever the logical content is bigger than the visible terminal area, for example in scrollable panels, minimaps, editors, and diagnostic tools. |
|
The backend classes connect Terminal to the actual console, host environment, or test harness. Most applications use the built-in backend, while advanced integrations can inject a custom implementation. |
|
The buffer classes represent rendered terminal content in memory before it is written to the screen. ReadableBuffer provides the inspection API, WritableBuffer adds mutation and drawing operations, Buffer is the concrete 2D storage type used in most applications, and CursorBuffer adds cursor-based streaming output. |
|
The color classes provide access to the standard 16 terminal colors and their combinations. They are used to style terminal output, buffer cells, and text elements throughout the library. |
|
CursorWriter defines the shared streaming API used by Terminal and CursorBuffer. It focuses on incremental output, active color and attribute state, cursor movement, and wrapped paragraph printing. |
|
The drawing types define how frames, borders, filled areas, and character combinations are rendered into writable buffers. They are the main building blocks for boxes, panels, decorative borders, tiled fills, and line-art style layouts. |
|
The font classes allow you to render large bitmap-based text directly in the terminal. Fonts are primarily used for titles, banners, and other decorative elements in terminal interfaces. |
|
Char, CharAttributes, CharStyle, and String are the reusable terminal-text value types used to store styled characters, measure Unicode-aware width, and split or wrap terminal text before rendering. |
|
The geometry classes provide the building blocks for positioning and layout inside a terminal buffer. They describe sizes, positions, rectangles, and directions, and allow you to derive new regions from existing ones. |
|
The input classes provide access to keyboard input from the terminal. They are designed for interactive applications such as dashboards, tools, and terminal games that need immediate key handling. |
|
ParagraphOptions collects the low-level layout rules for wrapped terminal paragraphs. The same object model is used by Terminal::printParagraph(), TextOptions, and Text, so one paragraph configuration can be reused for direct terminal output and buffer-based text rendering. |
|
The terminal classes provide the runtime connection between your rendered content and the real console. Terminal manages initialization, refresh strategy, full-screen updates, input access, and direct output for interactive applications. |
|
Text, TextOptions, and TextAnimation render strings into rectangles, wrapped paragraphs, animated labels, and reusable text presets inside writable buffers. |