Glossary

Below are definitions of terms used across the library’s public interface, exception messages, CLI help text and the documentation.

Note

For contributors, these terms are also used in the source code, as variable names, in comments, docstrings, etc.

active terminal

The first terminal device discovered upon loading the package. See here.

alignment

The position to place a rendered image within its padding.

allowance

The amount of space to be left un-used in a given maximum size.

alpha threshold

Alpha ratio/value above which a pixel is taken as opaque (applies only to text-based render styles).

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.

automatic size
automatic sizing

The form of sizing wherein the image size is computed based on the available size or the image’s original size.

See also: Size.

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 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 in the terminal emulator.

See also: get_cell_ratio() and set_cell_ratio().

dynamic size
dynamic sizing

The form of sizing wherein the image size is automatically computed at render-time.

See also: size.

fixed size
fixed sizing

The form of sizing wherein the image size is set to a specific value which won’t change until it is re-set.

See also: set_size(), width and height.

horizontal alignment

The position to place a rendered image within its padding width.

horizontal allowance

The amount of columns to be left un-used in a given maximum amount of columns.

padding
padding width

Amount of columns within which to fit an image. Excess columns on either or both sides of the image (depending on the horizontal alignment) will be filled with spaces.

padding height

Amount of columns within which to fit an image. Excess columns on either or both sides of the image (depending on the vertical alignment) will be filled with spaces.

pixel ratio

It is equvalent to the cell ratio multiplied by 2, since there are two pixels (arranged vertically) in one character cell.

render
rendered
rendering

To convert image pixel data into a string (optionally including escape sequences to produce colour and transparency).

rendered height

The amount of lines that’ll be occupied by a rendered image when drawn onto a terminal screen.

rendered size

The amount of space (columns and lines) that’ll be occupied by a rendered image when drawn onto a terminal screen.

This is determined by the size and scale of an image.

rendered width

The amount of columns that’ll be occupied by a rendered image when drawn onto a terminal screen.

scale

The fraction of an image’s size that’ll actually be used to render it.

See also: Image scale.

source

The resource from which an image is derived.

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 position to place a rendered image within its padding height.

vertical allowance

The amount of lines to be left un-used in a given maximum amount of lines.