diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/PLUGIN_API | 59 |
1 files changed, 18 insertions, 41 deletions
diff --git a/docs/PLUGIN_API b/docs/PLUGIN_API index 7cd04cc410..b61e383977 100644 --- a/docs/PLUGIN_API +++ b/docs/PLUGIN_API | |||
@@ -185,7 +185,6 @@ unsigned int battery_voltage(void) | |||
185 | \description | 185 | \description |
186 | 186 | ||
187 | unsigned short *bidi_l2v( const unsigned char *str, int orientation ) | 187 | unsigned short *bidi_l2v( const unsigned char *str, int orientation ) |
188 | \conditions defined(HAVE_LCD_BITMAP) | ||
189 | \param str | 188 | \param str |
190 | \param orientation | 189 | \param orientation |
191 | \return | 190 | \return |
@@ -332,7 +331,7 @@ bool button_hold(void) | |||
332 | \description | 331 | \description |
333 | 332 | ||
334 | struct event_queue *button_queue | 333 | struct event_queue *button_queue |
335 | \conditions defined(HAVE_LCD_BITMAP) )) && (defined(HAVE_LCD_ENABLE | 334 | \conditions (defined(HAVE_LCD_ENABLE)) |
336 | \return | 335 | \return |
337 | \description | 336 | \description |
338 | 337 | ||
@@ -351,7 +350,6 @@ void cancel_cpu_boost(void) | |||
351 | \description Unboosts the CPU for the current thread | 350 | \description Unboosts the CPU for the current thread |
352 | 351 | ||
353 | const unsigned char *font_get_bits( struct font *pf, unsigned short char_code ) | 352 | const unsigned char *font_get_bits( struct font *pf, unsigned short char_code ) |
354 | \conditions defined(HAVE_LCD_BITMAP) | ||
355 | \param pf | 353 | \param pf |
356 | \param char_code | 354 | \param char_code |
357 | \return | 355 | \return |
@@ -601,14 +599,12 @@ void flush_icache(void) | |||
601 | \description | 599 | \description |
602 | 600 | ||
603 | struct font* font_get(int font) | 601 | struct font* font_get(int font) |
604 | \conditions defined(HAVE_LCD_BITMAP) | ||
605 | \param font | 602 | \param font |
606 | \return the font structure for =font= | 603 | \return the font structure for =font= |
607 | \description If the requested font isn't loaded/compiled-in, decrement the font number and try again. | 604 | \description If the requested font isn't loaded/compiled-in, decrement the font number and try again. |
608 | \see [S[firmware/export/font.h]] | 605 | \see [S[firmware/export/font.h]] |
609 | 606 | ||
610 | int font_getstringsize(const unsigned char *str, int *w, int *h, int fontnumber) | 607 | int font_getstringsize(const unsigned char *str, int *w, int *h, int fontnumber) |
611 | \conditions defined(HAVE_LCD_BITMAP) | ||
612 | \param str | 608 | \param str |
613 | \param w | 609 | \param w |
614 | \param h | 610 | \param h |
@@ -617,14 +613,12 @@ int font_getstringsize(const unsigned char *str, int *w, int *h, int fontnumber) | |||
617 | \description | 613 | \description |
618 | 614 | ||
619 | int font_get_width(struct font* pf, unsigned short char_code) | 615 | int font_get_width(struct font* pf, unsigned short char_code) |
620 | \conditions defined(HAVE_LCD_BITMAP) | ||
621 | \param pf | 616 | \param pf |
622 | \param char_code | 617 | \param char_code |
623 | \return | 618 | \return |
624 | \description | 619 | \description |
625 | 620 | ||
626 | struct font* font_load(const char *path) | 621 | struct font* font_load(const char *path) |
627 | \conditions defined(HAVE_LCD_BITMAP) | ||
628 | \param path | 622 | \param path |
629 | \return | 623 | \return |
630 | \description Load font =path= and returns a struct font pointer for it | 624 | \description Load font =path= and returns a struct font pointer for it |
@@ -678,7 +672,6 @@ struct system_status *global_status | |||
678 | \see [S[apps/settings.h]] | 672 | \see [S[apps/settings.h]] |
679 | 673 | ||
680 | void gui_scrollbar_draw(struct screen * screen, int x, int y, int width, int height, int items, int min_shown, int max_shown, unsigned flags) | 674 | void gui_scrollbar_draw(struct screen * screen, int x, int y, int width, int height, int items, int min_shown, int max_shown, unsigned flags) |
681 | \conditions defined(HAVE_LCD_BITMAP) | ||
682 | \param screen | 675 | \param screen |
683 | \param x | 676 | \param x |
684 | \param y | 677 | \param y |
@@ -808,7 +801,7 @@ int kbd_input(char* buffer, int buflen) | |||
808 | 801 | ||
809 | void lcd_bitmap(const fb_data *src, int x, int y, int width, int height) | 802 | void lcd_bitmap(const fb_data *src, int x, int y, int width, int height) |
810 | \group lcd | 803 | \group lcd |
811 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1) | 804 | \conditions (LCD_DEPTH > 1) |
812 | \param src | 805 | \param src |
813 | \param x | 806 | \param x |
814 | \param y | 807 | \param y |
@@ -818,7 +811,7 @@ void lcd_bitmap(const fb_data *src, int x, int y, int width, int height) | |||
818 | 811 | ||
819 | void lcd_bitmap_part(const fb_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height) | 812 | void lcd_bitmap_part(const fb_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height) |
820 | \group lcd | 813 | \group lcd |
821 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1) | 814 | \conditions (LCD_DEPTH > 1) |
822 | \param src | 815 | \param src |
823 | \param src_x | 816 | \param src_x |
824 | \param src_y | 817 | \param src_y |
@@ -831,7 +824,7 @@ void lcd_bitmap_part(const fb_data *src, int src_x, int src_y, int stride, int x | |||
831 | 824 | ||
832 | void lcd_bitmap_transparent(const fb_data *src, int x, int y, int width, int height) | 825 | void lcd_bitmap_transparent(const fb_data *src, int x, int y, int width, int height) |
833 | \group lcd | 826 | \group lcd |
834 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH == 16) | 827 | \conditions (LCD_DEPTH >= 16) |
835 | \param src | 828 | \param src |
836 | \param x | 829 | \param x |
837 | \param y | 830 | \param y |
@@ -841,7 +834,7 @@ void lcd_bitmap_transparent(const fb_data *src, int x, int y, int width, int hei | |||
841 | 834 | ||
842 | void lcd_bitmap_transparent_part(const fb_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height) | 835 | void lcd_bitmap_transparent_part(const fb_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height) |
843 | \group lcd | 836 | \group lcd |
844 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH == 16) | 837 | \conditions (LCD_DEPTH >= 16) |
845 | \param src | 838 | \param src |
846 | \param src_x | 839 | \param src_x |
847 | \param src_y | 840 | \param src_y |
@@ -854,7 +847,7 @@ void lcd_bitmap_transparent_part(const fb_data *src, int src_x, int src_y, int s | |||
854 | 847 | ||
855 | void lcd_blit_grey_phase(unsigned char *values, unsigned char *phases, int bx, int by, int bwidth, int bheight, int stride) | 848 | void lcd_blit_grey_phase(unsigned char *values, unsigned char *phases, int bx, int by, int bwidth, int bheight, int stride) |
856 | \group lcd | 849 | \group lcd |
857 | \conditions defined(HAVE_LCD_BITMAP) )) && ((LCD_DEPTH < 4) && !defined(SIMULATOR | 850 | \conditions ((LCD_DEPTH < 4) && !defined(SIMULATOR)) |
858 | \param values | 851 | \param values |
859 | \param phases | 852 | \param phases |
860 | \param bx | 853 | \param bx |
@@ -866,7 +859,7 @@ void lcd_blit_grey_phase(unsigned char *values, unsigned char *phases, int bx, i | |||
866 | 859 | ||
867 | void lcd_blit_mono(const unsigned char *data, int x, int by, int width, int bheight, int stride) | 860 | void lcd_blit_mono(const unsigned char *data, int x, int by, int width, int bheight, int stride) |
868 | \group lcd | 861 | \group lcd |
869 | \conditions defined(HAVE_LCD_BITMAP) )) && ((LCD_DEPTH < 4) && !defined(SIMULATOR | 862 | \conditions ((LCD_DEPTH < 4) && !defined(SIMULATOR)) |
870 | \param data | 863 | \param data |
871 | \param x | 864 | \param x |
872 | \param by | 865 | \param by |
@@ -877,7 +870,7 @@ void lcd_blit_mono(const unsigned char *data, int x, int by, int width, int bhei | |||
877 | 870 | ||
878 | void lcd_blit_yuv(unsigned char * const src[3], int src_x, int src_y, int stride, int x, int y, int width, int height) | 871 | void lcd_blit_yuv(unsigned char * const src[3], int src_x, int src_y, int stride, int x, int y, int width, int height) |
879 | \group lcd | 872 | \group lcd |
880 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH == 16) | 873 | \conditions (LCD_DEPTH >= 16) |
881 | \param src[3] | 874 | \param src[3] |
882 | \param src_x | 875 | \param src_x |
883 | \param src_y | 876 | \param src_y |
@@ -894,7 +887,6 @@ void lcd_clear_display(void) | |||
894 | 887 | ||
895 | void lcd_drawline(int x1, int y1, int x2, int y2) | 888 | void lcd_drawline(int x1, int y1, int x2, int y2) |
896 | \group lcd | 889 | \group lcd |
897 | \conditions defined(HAVE_LCD_BITMAP) | ||
898 | \param x1 X top coordinate | 890 | \param x1 X top coordinate |
899 | \param y1 Y top coordinate | 891 | \param y1 Y top coordinate |
900 | \param x2 X bottom coordinate | 892 | \param x2 X bottom coordinate |
@@ -903,14 +895,12 @@ void lcd_drawline(int x1, int y1, int x2, int y2) | |||
903 | 895 | ||
904 | void lcd_drawpixel(int x, int y) | 896 | void lcd_drawpixel(int x, int y) |
905 | \group lcd | 897 | \group lcd |
906 | \conditions defined(HAVE_LCD_BITMAP) | ||
907 | \param x | 898 | \param x |
908 | \param y | 899 | \param y |
909 | \description Draws a pixel at (=x=, =y=) within current drawing mode | 900 | \description Draws a pixel at (=x=, =y=) within current drawing mode |
910 | 901 | ||
911 | void lcd_drawrect(int x, int y, int width, int height) | 902 | void lcd_drawrect(int x, int y, int width, int height) |
912 | \group lcd | 903 | \group lcd |
913 | \conditions defined(HAVE_LCD_BITMAP) | ||
914 | \param x | 904 | \param x |
915 | \param y | 905 | \param y |
916 | \param width | 906 | \param width |
@@ -919,7 +909,6 @@ void lcd_drawrect(int x, int y, int width, int height) | |||
919 | 909 | ||
920 | void lcd_fillrect(int x, int y, int width, int height) | 910 | void lcd_fillrect(int x, int y, int width, int height) |
921 | \group lcd | 911 | \group lcd |
922 | \conditions defined(HAVE_LCD_BITMAP) | ||
923 | \param x | 912 | \param x |
924 | \param y | 913 | \param y |
925 | \param width | 914 | \param width |
@@ -928,7 +917,6 @@ void lcd_fillrect(int x, int y, int width, int height) | |||
928 | 917 | ||
929 | fb_data* lcd_framebuffer | 918 | fb_data* lcd_framebuffer |
930 | \group lcd | 919 | \group lcd |
931 | \conditions defined(HAVE_LCD_BITMAP) | ||
932 | \return | 920 | \return |
933 | \description Pointer to the framebuffer | 921 | \description Pointer to the framebuffer |
934 | \see [S[firmware/export/lcd.h]] | 922 | \see [S[firmware/export/lcd.h]] |
@@ -943,32 +931,30 @@ int lcd_getstringsize(const unsigned char *str, int *w, int *h) | |||
943 | 931 | ||
944 | fb_data* lcd_get_backdrop(void) | 932 | fb_data* lcd_get_backdrop(void) |
945 | \group lcd | 933 | \group lcd |
946 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1) | 934 | \conditions (LCD_DEPTH > 1) |
947 | \return Pointer to framebuffer data | 935 | \return Pointer to framebuffer data |
948 | \description Gets the current backdrop | 936 | \description Gets the current backdrop |
949 | \see lcd_framebuffer | 937 | \see lcd_framebuffer |
950 | 938 | ||
951 | unsigned lcd_get_background(void) | 939 | unsigned lcd_get_background(void) |
952 | \group lcd | 940 | \group lcd |
953 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1) | 941 | \conditions (LCD_DEPTH > 1) |
954 | \return | 942 | \return |
955 | \description | 943 | \description |
956 | 944 | ||
957 | int lcd_get_drawmode(void) | 945 | int lcd_get_drawmode(void) |
958 | \group lcd | 946 | \group lcd |
959 | \conditions defined(HAVE_LCD_BITMAP) | ||
960 | \return current LCD drawing mode | 947 | \return current LCD drawing mode |
961 | \description | 948 | \description |
962 | 949 | ||
963 | unsigned lcd_get_foreground(void) | 950 | unsigned lcd_get_foreground(void) |
964 | \group lcd | 951 | \group lcd |
965 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1) | 952 | \conditions (LCD_DEPTH > 1) |
966 | \return | 953 | \return |
967 | \description | 954 | \description |
968 | 955 | ||
969 | void lcd_hline(int x1, int x2, int y) | 956 | void lcd_hline(int x1, int x2, int y) |
970 | \group lcd | 957 | \group lcd |
971 | \conditions defined(HAVE_LCD_BITMAP) | ||
972 | \param x1 X start coordinate | 958 | \param x1 X start coordinate |
973 | \param x2 X end coordinate | 959 | \param x2 X end coordinate |
974 | \param y Y coordinate | 960 | \param y Y coordinate |
@@ -976,7 +962,6 @@ void lcd_hline(int x1, int x2, int y) | |||
976 | 962 | ||
977 | void lcd_mono_bitmap(const unsigned char *src, int x, int y, int width, int height) | 963 | void lcd_mono_bitmap(const unsigned char *src, int x, int y, int width, int height) |
978 | \group lcd | 964 | \group lcd |
979 | \conditions defined(HAVE_LCD_BITMAP) | ||
980 | \param src | 965 | \param src |
981 | \param x | 966 | \param x |
982 | \param y | 967 | \param y |
@@ -986,7 +971,6 @@ void lcd_mono_bitmap(const unsigned char *src, int x, int y, int width, int heig | |||
986 | 971 | ||
987 | void lcd_mono_bitmap_part(const unsigned char *src, int src_x, int src_y, int stride, int x, int y, int width, int height) | 972 | void lcd_mono_bitmap_part(const unsigned char *src, int src_x, int src_y, int stride, int x, int y, int width, int height) |
988 | \group lcd | 973 | \group lcd |
989 | \conditions defined(HAVE_LCD_BITMAP) | ||
990 | \param src | 974 | \param src |
991 | \param src_x | 975 | \param src_x |
992 | \param src_y | 976 | \param src_y |
@@ -1230,20 +1214,19 @@ void lcd_remote_vline(int x, int y1, int y2) | |||
1230 | 1214 | ||
1231 | void lcd_setfont(int font) | 1215 | void lcd_setfont(int font) |
1232 | \group lcd | 1216 | \group lcd |
1233 | \conditions defined(HAVE_LCD_BITMAP) | ||
1234 | \param font | 1217 | \param font |
1235 | \description Set default font | 1218 | \description Set default font |
1236 | 1219 | ||
1237 | void lcd_set_backdrop(fb_data* backdrop) | 1220 | void lcd_set_backdrop(fb_data* backdrop) |
1238 | \group lcd | 1221 | \group lcd |
1239 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1) | 1222 | \conditions (LCD_DEPTH > 1) |
1240 | \param backdrop Pointer to backdrop image | 1223 | \param backdrop Pointer to backdrop image |
1241 | \description Set the backdrop to =backdrop= | 1224 | \description Set the backdrop to =backdrop= |
1242 | \see lcd_framebuffer | 1225 | \see lcd_framebuffer |
1243 | 1226 | ||
1244 | void lcd_set_background(unsigned foreground) | 1227 | void lcd_set_background(unsigned foreground) |
1245 | \group lcd | 1228 | \group lcd |
1246 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1) | 1229 | \conditions (LCD_DEPTH > 1) |
1247 | \param foreground | 1230 | \param foreground |
1248 | \description | 1231 | \description |
1249 | 1232 | ||
@@ -1254,19 +1237,18 @@ void lcd_set_contrast(int x) | |||
1254 | 1237 | ||
1255 | void lcd_set_drawmode(int mode) | 1238 | void lcd_set_drawmode(int mode) |
1256 | \group lcd | 1239 | \group lcd |
1257 | \conditions defined(HAVE_LCD_BITMAP) | ||
1258 | \param mode | 1240 | \param mode |
1259 | \description | 1241 | \description |
1260 | 1242 | ||
1261 | void lcd_set_foreground(unsigned foreground) | 1243 | void lcd_set_foreground(unsigned foreground) |
1262 | \group lcd | 1244 | \group lcd |
1263 | \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1) | 1245 | \conditions (LCD_DEPTH > 1) |
1264 | \param foreground | 1246 | \param foreground |
1265 | \description | 1247 | \description |
1266 | 1248 | ||
1267 | void lcd_set_invert_display(bool yesno) | 1249 | void lcd_set_invert_display(bool yesno) |
1268 | \group lcd | 1250 | \group lcd |
1269 | \conditions defined(HAVE_LCD_BITMAP) )) && (defined(HAVE_LCD_INVERT | 1251 | \conditions (defined(HAVE_LCD_INVERT)) |
1270 | \param yesno | 1252 | \param yesno |
1271 | \description | 1253 | \description |
1272 | 1254 | ||
@@ -1280,7 +1262,6 @@ void lcd_update(void) | |||
1280 | 1262 | ||
1281 | void lcd_update_rect(int x, int y, int width, int height) | 1263 | void lcd_update_rect(int x, int y, int width, int height) |
1282 | \group lcd | 1264 | \group lcd |
1283 | \conditions defined(HAVE_LCD_BITMAP) | ||
1284 | \param x measured in pixels | 1265 | \param x measured in pixels |
1285 | \param y measured in pixels | 1266 | \param y measured in pixels |
1286 | \param width measured in pixels | 1267 | \param width measured in pixels |
@@ -1289,7 +1270,6 @@ void lcd_update_rect(int x, int y, int width, int height) | |||
1289 | 1270 | ||
1290 | void lcd_vline(int x, int y1, int y2) | 1271 | void lcd_vline(int x, int y1, int y2) |
1291 | \group lcd | 1272 | \group lcd |
1292 | \conditions defined(HAVE_LCD_BITMAP) | ||
1293 | \param x X coordinate | 1273 | \param x X coordinate |
1294 | \param y1 Y start coordinate | 1274 | \param y1 Y start coordinate |
1295 | \param y2 Y end coordinate | 1275 | \param y2 Y end coordinate |
@@ -1297,7 +1277,7 @@ void lcd_vline(int x, int y1, int y2) | |||
1297 | 1277 | ||
1298 | void lcd_yuv_set_options(unsigned options) | 1278 | void lcd_yuv_set_options(unsigned options) |
1299 | \group lcd | 1279 | \group lcd |
1300 | \conditions defined(HAVE_LCD_BITMAP) )) && (LCD_DEPTH == 16) && (defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) || defined(IRIVER_H10) || defined(COWON_D2 | 1280 | \conditions (LCD_DEPTH >= 16) && (defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) || defined(IRIVER_H10) || defined(COWON_D2)) |
1301 | \param options | 1281 | \param options |
1302 | \description | 1282 | \description |
1303 | 1283 | ||
@@ -1762,7 +1742,6 @@ struct dirent* readdir(DIR* dir) | |||
1762 | \description | 1742 | \description |
1763 | 1743 | ||
1764 | int read_bmp_file(const char* filename, struct bitmap *bm, int maxsize, int format) | 1744 | int read_bmp_file(const char* filename, struct bitmap *bm, int maxsize, int format) |
1765 | \conditions (defined(HAVE_LCD_BITMAP)) | ||
1766 | \param filename | 1745 | \param filename |
1767 | \param bm | 1746 | \param bm |
1768 | \param maxsize | 1747 | \param maxsize |
@@ -1820,7 +1799,6 @@ struct screen* screens[NB_SCREENS] | |||
1820 | \description | 1799 | \description |
1821 | 1800 | ||
1822 | void screen_clear_area(struct screen * display, int xstart, int ystart, int width, int height) | 1801 | void screen_clear_area(struct screen * display, int xstart, int ystart, int width, int height) |
1823 | \conditions defined(HAVE_LCD_BITMAP) | ||
1824 | \param display | 1802 | \param display |
1825 | \param xstart | 1803 | \param xstart |
1826 | \param ystart | 1804 | \param ystart |
@@ -1829,7 +1807,6 @@ void screen_clear_area(struct screen * display, int xstart, int ystart, int widt | |||
1829 | \description | 1807 | \description |
1830 | 1808 | ||
1831 | void screen_dump_set_hook(void (*hook)(int fh)) | 1809 | void screen_dump_set_hook(void (*hook)(int fh)) |
1832 | \conditions (defined(HAVE_LCD_BITMAP)) | ||
1833 | \param hook | 1810 | \param hook |
1834 | \description | 1811 | \description |
1835 | 1812 | ||
@@ -1962,14 +1939,14 @@ bool simplelist_show_list(struct simplelist_info *info) | |||
1962 | 1939 | ||
1963 | void sim_lcd_ex_init(int shades, unsigned long (*getpixel)(int, int)) | 1940 | void sim_lcd_ex_init(int shades, unsigned long (*getpixel)(int, int)) |
1964 | \group special simulator hooks | 1941 | \group special simulator hooks |
1965 | \conditions (defined(SIMULATOR)) && (defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8) | 1942 | \conditions (defined(SIMULATOR) && LCD_DEPTH < 8)) |
1966 | \param shades | 1943 | \param shades |
1967 | \param getpixel | 1944 | \param getpixel |
1968 | \description | 1945 | \description |
1969 | 1946 | ||
1970 | void sim_lcd_ex_update_rect(int x, int y, int width, int height) | 1947 | void sim_lcd_ex_update_rect(int x, int y, int width, int height) |
1971 | \group special simulator hooks | 1948 | \group special simulator hooks |
1972 | \conditions (defined(SIMULATOR)) && (defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8) | 1949 | \conditions (defined(SIMULATOR) LCD_DEPTH < 8)) |
1973 | \param x | 1950 | \param x |
1974 | \param y | 1951 | \param y |
1975 | \param width | 1952 | \param width |