View source for Pi:console image

== Abstract ==

`nextpi-console_image` is designed to allow easy showing (and relevent manipulation) of JPEG / PNG and BMP images on the NextPi console screen.

== Prerequisits ==

* NextPi Version: 1.92D
*Hardware Setup: Monitor attached to "Debug Video" port on Spectrum Next.

== Backend ==
* Binary: fbv
* Source: https://github.com/smokku/fbv

== Options ==
<code>-h, --help</code> Show this help

<code>-a, --alpha</code> Use the alpha channel (if applicable)

<code>-c, --dontclear</code> Do not clear the screen before and after displaying the image

<code>-u, --donthide</code> Do not hide the cursor before and after displaying the image

<code>-i, --noinfo</code> Supress image information

<code>-f, --shrink</code> Shrink (using a simple resizing routine) the image to fit onto screen if necessary

<code>-k, --colorshrink</code> Shrink (using a 'color average' resizing routine) the image to fit onto screen if necessary

<code>-e, --enlarge</code> Enlarge the image to fit the whole screen if necessary

<code>-l, --widthonly</code> Fit the image horizontally

<code>-t, --heightonly</code> Fit the image vertically

<code>-x <percent>, --smartfit <percent>  </code> Show image by covering the whole screen if less than <percent>% is out of screen

<code>-r, --ignore-aspect</code> Ignore the image aspect while resizing

<code>-s <delay>, --delay <d></code> Slideshow, 'delay' is the slideshow delay in tenths of seconds.

<code>-n imagename(s)</code> Image name(s) shown in help

<code>-o <mode>, --orientation <mode></code> Show image in specific orientation (0 = no rotation, 1 = 90° rotation, 2 = 180° rotation, 3 = 270° rotation)

<code>-y, --skiptty</code> Shows the image only once and skips tty input mode.

== Potential Features ==

There are no anticipated new features planned for this CLI API, or reasons expected to require to change the backend. 

The options listed include all those as supported by the backend for this reason.