Glossary¶
Below are definitions of terms used in the CLI help text, info/warning/error messages and the documentation.
Note
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 at startup.
At times, this may also be used to refer to the TTY device itself.
- alignment¶
- allowance¶
The amount of space to be left unused on the terminal screen.
- alpha threshold¶
Alpha ratio/value above which a pixel is taken as opaque (applies only to text-based render styles).
See also
- animated¶
Having multiple frames.
The frames of an animated image are generally meant to be displayed in rapid succession, to give the effect of animation.
- available height¶
The remainder after vertical allowance is subtracted from the maximum amount of lines.
- available size¶
The remainder after allowances are subtracted from the maximum frame size.
- available width¶
The remainder after horizontal allowance is subtracted from the maximum amount of columns.
- cell ratio¶
The aspect ratio (i.e the ratio of width to height) of a character cell on a terminal screen.
See also
- horizontal alignment¶
The horizontal position of a primary render output within its padding width.
See also
- horizontal allowance¶
The amount of columns to be left unused on the terminal screen.
See also
- padding¶
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.
See also
- 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.
See also
- render¶
- rendered¶
- rendering¶
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 style¶
- render styles¶
- style¶
- styles¶
A specific technique for rendering or displaying pixel data (including images) in a terminal emulator.
See also
- 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.
- scale¶
The fraction/ratio of an image’s size that’ll actually be used to render it.
- source¶
The resource from which an image instance is initialized.
See also
- 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¶
The vertical position of a primary render output within its padding height.
See also
- vertical allowance¶
The amount of lines to be left unused on the terminal screen.
See also