====== Image driver ======

This driver is intended to create various raster formats, at the moment there is support for binary PPM (portable pixmap) and PNG.

The driver creates the output file(s) specified with the -o switch. The parameter is used as a format string for sprintf(), if you specify '%d' in the output file, files with a sequence number will be created.

The output file is first created with a '.tmp' extension, this temporary file will be written and closed, and finally (atomically) renamed. This way you can be shure that you will always get a complete file, but its contents changes whenever a widget gets updatet.

----

===== Display Section =====

<code>
Display <name> {
    Driver     'Image'
    Format     <string>
    Size       <string>
    Font       <string>
    Pixel      <string>
    Gap        <string>
    Border     <number>
    Foreground <color>
    Background <color>
    Basecolor  <color>
}
</code>


----

===== Parameters =====

|**Driver**|'Image'|
|**Format**|either 'PPM' or 'PNG'|
|**Size**|size of the virtual display in **pixels**, specified as <width>x<height>|
|**Font**|font size, specified as <width>x<height> (only '5x8' and '6x8' supported at the moment)|
|**Pixel**|<pixelsize>+<pixelgap>, e.g. '5+1' (see [[:X11|X11]] for detailed explanation)|
|**Gap**|<row gap>x<column gap>, e.g. '3x3'(see [[:X11|X11]] for detailed explanation)|
|**Border**|border width in pixels|
|**Foreground**|color of active pixels (RRGGBBAA or RRGGBB), default is opaque black '000000ff' (see [[:colors]] for details)|
|**Background**|color of inactive pixels (RRGGBBAA or RRGGBB), default is transparent 'ffffff00' (see [[:colors]] for details)|
|**Basecolor**|color of virtual backlight (RRGGBB), default is white 'ffffff' (see [[:colors]] for details)|

This may look weird, but it is weird. It's explained in detail on the [[:X11|X11]] driver page.

----

===== Example =====

<code>
Display Image {
    Driver     'Image'
    Format     'PNG'
    Size       '120x32'
    Font       '6x8'
    Pixel      '4+1'
    Gap        '-1x-1'
    Border      20
    Foreground '#000000'
    Background '#80d000'
    Halfground '#70c000'
}
</code>


----

===== Web display =====

''Note: These instructions are quite old, so I'm not sure if they still work. Could someone please confirm or correct? Thanks!''

To display this png file continuosly in a web page, follow these instructions:

  * Copy the sample png.html to an appropriate place under your htdocs.
  * Copy the sample nph-png perl script into your cgi-bin directory, and adjust png.html to contain this directory.
  * Adjust nph-png to contain the path/filename of the outputfile (s -o above).
  * Start lcd4linux -o path/filename.png.
  * If you are on a slow connection to your webserver you might also adjust the $DELAY in nph-png or in lcd4linux.conf.

Note: depending on your webervers configuration, you must rename nph-png to nph-png.pl or npg-png.cgi.

----