Below are definitions of terms used across the API, exception messages and the documentation.
For contributors, some of these terms are also used in the source code, as variable names, in comments, docstrings, etc.
- active terminal#
The terminal emulator connected to the first TTY device discovered upon loading the
At times, this may also be used to refer to the TTY device itself.
- alpha threshold#
Alpha ratio/value above which a pixel is taken as opaque (applies only to Text-based Render Styles).
Having multiple frames.
The frames of an animated image are generally meant to be displayed in rapid succession, to give the effect of animation.
- automatic size#
- automatic sizing#
A form of sizing wherein an image’s size is computed based on a combination of a frame size, the image’s original size and a given width or height.
- cell ratio#
The aspect ratio (i.e the ratio of width to height) of a character cell on a terminal screen.
Refers to an attribute, property or setting set on a class which applies to that class and all its subclasses on which the attribute, property or setting is unset.
- dynamic size#
- dynamic sizing#
A form of sizing wherein the image size is automatically computed at render-time.
This only works with automatic sizing.
- fixed size#
- fixed sizing#
A form of sizing wherein the image size is set to a specific value which won’t change until it is re-set.
- frame height#
The height of the area used in automatic sizing.
- frame size#
The dimensions of the area used in automatic sizing.
- frame width#
The width of the area used in automatic sizing.
- horizontal alignment#
- manual size#
- manual sizing#
A form of sizing wherein both the width and the height are specified to set the image size.
This form of sizing does not preserve image aspect ratio and can only be used with fixed sizing.
Amount of lines and columns within which to fit a primary render output.
- padding height#
Amount of lines within which to fit a primary render output.
Excess lines on either or both sides of the render output (depending on the vertical alignment) will be filled with spaces.
- padding width#
Amount of columns within which to fit a primary render output.
Excess columns on either or both sides of the render output (depending on the horizontal alignment) will be filled with spaces.
- pixel ratio#
The aspect ratio with which one rendered pixel is drawn/displayed on the terminal screen.
For Graphics-based Render Styles, this is ideally
For Text-based Render Styles, this is equvalent to the cell ratio multiplied by 2, since there are technically two times more pixels along the vertical axis than along the horizontal axis in one character cell.
The process of encoding pixel data into a byte/character string (possibly including escape sequences to reproduce colour and transparency).
This string is also called the primary render output and excludes padding.
- render method#
- render methods#
A unique implementation of a render style.
- render style#
- render styles#
A specific technique for rendering or displaying pixel data (including images) in a terminal emulator.
A render style (or simply style) is implemented by a class, often refered to as a render style class (or simply style class).
- rendered height#
The amount of lines that’ll be occupied by a primary render output when drawn (written) onto a terminal screen.
- rendered size#
The amount of space (columns and lines) that’ll be occupied by a primary render output when drawn (written) onto a terminal screen.
- rendered width#
The amount of columns that’ll be occupied by a primary render output when drawn (written) onto a terminal screen.
The resource from which an image instance is initialized.
- terminal height#
The amount of lines on a terminal screen at a time i.e without scrolling.
- terminal size#
The amount of columns and lines on a terminal screen at a time i.e without scrolling.
- terminal width#
The amount of columns on a terminal screen at a time.
- vertical alignment#