Difference between revisions of "Pi:console image"

From SpecNext official Wiki
Jump to: navigation, search
(Created page with "Available options: -h, --help Show this help -a, --alpha Use the alpha channel (if applicable) -c, --dontclear Do not clear the screen before and af...")
 
Line 1: Line 1:
Available options:
+
== Abstract ==
  -h, --help         Show this help
+
 
  -a, --alpha         Use the alpha channel (if applicable)
+
`nextpi-console_image` is designed to allow easy showing (and relevent manipulation) of JPEG / PNG and BMP images on the NextPi console screen.
  -c, --dontclear     Do not clear the screen before and after displaying the image
+
 
  -u, --donthide     Do not hide the cursor before and after displaying the image
+
== Prerequisits ==
  -i, --noinfo       Supress image information
+
 
  -f, --shrink       Shrink (using a simple resizing routine) the image to fit onto screen if necessary
+
Version: 1.92D
  -k, --colorshrink   Shrink (using a 'color average' resizing routine) the image to fit onto screen if necessary
+
Hardware Setup: Monitor attached to "Debug Video" port on Spectrum Next.
  -e, --enlarge       Enlarge the image to fit the whole screen if necessary
+
 
  -l, --widthonly     Fit the image horizontally
+
== Backend ==
  -t, --heightonly   Fit the image vertically
+
* Binary: fbv
  -x <percent>, --smartfit <percent>  Show image by covering the whole screen if less than <percent>% is out of screen
+
* Source: https://github.com/smokku/fbv
  -r, --ignore-aspect Ignore the image aspect while resizing
+
 
  -s <delay>, --delay <d> Slideshow, 'delay' is the slideshow delay in tenths of seconds.
+
== Options ==
  -n imagename(s)     Image name(s) shown in help
+
<code>-h, --help</code> Show this help
  -o <mode>, --orientation <mode> Show image in specific orientation (0 = no rotation, 1 = 90° rotation, 2 = 180° rotation, 3 = 270° rotation)
+
 
  -y, --skiptty   Shows the image only once and skips tty input mode.
+
<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 above are the all those as supported by the backend.

Revision as of 13:22, 5 January 2024

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

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

Backend

Options

-h, --help Show this help

-a, --alpha Use the alpha channel (if applicable)

-c, --dontclear Do not clear the screen before and after displaying the image

-u, --donthide Do not hide the cursor before and after displaying the image

-i, --noinfo Supress image information

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

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

-e, --enlarge Enlarge the image to fit the whole screen if necessary

-l, --widthonly Fit the image horizontally

-t, --heightonly Fit the image vertically

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

-r, --ignore-aspect Ignore the image aspect while resizing

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

-n imagename(s) Image name(s) shown in help

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

-y, --skiptty 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 above are the all those as supported by the backend.