rockbox/apps/plugins/imageviewer
Aidan MacDonald 005c414e5f Document intentional fallthroughs + fix harmless unintended ones
Change-Id: I1ca5b1027ec30cbf61093bab35b980196ed14e6b
2021-08-04 18:59:46 +00:00
..
bmp imageviewer: gif viewer based on giflib-5.0.2 2012-11-13 18:13:10 +01:00
gif imageviewer: Fix potential null pointer dereference 2020-06-30 21:12:12 +00:00
jpeg ImageViewer Fix jpeg decoder 2021-03-11 03:43:56 +00:00
png Limit more variables to file scope 2015-01-11 21:40:51 +01:00
ppm lcd-24bit: Introduce a 24-bit mid-level LCD driver 2014-06-21 00:15:53 +02:00
image_decoder.c imageviewer: gif viewer based on giflib-5.0.2 2012-11-13 18:13:10 +01:00
image_decoder.h imageviewer: gif viewer based on giflib-5.0.2 2012-11-13 18:13:10 +01:00
imageviewer.c Document intentional fallthroughs + fix harmless unintended ones 2021-08-04 18:59:46 +00:00
imageviewer.h imageviewer: gif viewer based on giflib-5.0.2 2012-11-13 18:13:10 +01:00
imageviewer.make Refactor and unify objcopy calls in the build system. Also now properly handles DEBUG builds on hosted targets to keep debug symbols if necessary. 2012-04-04 21:48:19 +02:00
imageviewer_button.h New port: Shanling Q1 native 2021-07-13 22:01:33 +01:00
readme.txt
SOURCES
SUBDIRS imageviewer: gif viewer based on giflib-5.0.2 2012-11-13 18:13:10 +01:00

this document describes how to add new image decoder.

1. create a directory which name is your image decoder's name and put source files
 under the directory.
'const struct image_decoder image_decoder' and 'IMGDEC_HEADER' must be declared in
 one of your source files.
see imageviewer.h for the detail of struct image_decoder.

2. add the directory name to apps/plugins/imageviewer/SUBDIR so that the decoder
 is built.
if the decoder is supported by particular targets, surround it with #if directive.
e.g. if the decoder supports color LCD targets only,
#ifdef HAVE_LCD_COLOR
bmp
#endif

3. append appropriate entry to enum image_type in image_decoder.h, decoder_names
 and ext_list in image_decoder.c so that the imageviewer plugin can recognize
 the decoder.
if the decoder is supported by particular targets, surround them with same #if
 directive in SUBDIR.

4. add entry to apps/plugins/viewers.config
 (in format: file_extension,viewer/imageviewer) so that the file with specified 
 file extension will be opened by image viewer plugin.
if the decoder is supported by particular targets, surround it with same #if
 directive in SUBDIR.

5. add entry to apps/plugins/CATEGORIES (in format: decoder_name,viewer) so
 that the build file is copied to viewers directory.
DON'T surround this with #if directive.


notes:
if you need to use greylib functions to draw image, add the functions to
 struct imgdec_api just like gray_bitmap_part because GREY_INFO_STRUCT is
 declared in imageviewer and is not available from the decoder.