summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSolomon Peachy <pizza@shaftnet.org>2020-07-17 10:31:31 -0400
committerSolomon Peachy <pizza@shaftnet.org>2020-07-24 21:20:13 +0000
commit658026e6267277b27d297c481728f74d160a8481 (patch)
tree915a9d2bb48469bdd5b9127dc19a61f230721a6c /docs
parent8cb555460ff79e636a7907fb2589e16db98c8600 (diff)
downloadrockbox-658026e6267277b27d297c481728f74d160a8481.tar.gz
rockbox-658026e6267277b27d297c481728f74d160a8481.tar.bz2
rockbox-658026e6267277b27d297c481728f74d160a8481.zip
[4/4] Remove HAVE_LCD_BITMAP, as it's now the only choice.
Note: I left behind lcd_bitmap in features.txt, because removing it would require considerable work in the manual and the translations. Change-Id: Ia8ca7761f610d9332a0d22a7d189775fb15ec88a
Diffstat (limited to 'docs')
-rw-r--r--docs/PLUGIN_API59
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)
\description
unsigned short *bidi_l2v( const unsigned char *str, int orientation )
- \conditions defined(HAVE_LCD_BITMAP)
\param str
\param orientation
\return
@@ -332,7 +331,7 @@ bool button_hold(void)
\description
struct event_queue *button_queue
- \conditions defined(HAVE_LCD_BITMAP) )) && (defined(HAVE_LCD_ENABLE
+ \conditions (defined(HAVE_LCD_ENABLE))
\return
\description
@@ -351,7 +350,6 @@ void cancel_cpu_boost(void)
\description Unboosts the CPU for the current thread
const unsigned char *font_get_bits( struct font *pf, unsigned short char_code )
- \conditions defined(HAVE_LCD_BITMAP)
\param pf
\param char_code
\return
@@ -601,14 +599,12 @@ void flush_icache(void)
\description
struct font* font_get(int font)
- \conditions defined(HAVE_LCD_BITMAP)
\param font
\return the font structure for =font=
\description If the requested font isn't loaded/compiled-in, decrement the font number and try again.
\see [S[firmware/export/font.h]]
int font_getstringsize(const unsigned char *str, int *w, int *h, int fontnumber)
- \conditions defined(HAVE_LCD_BITMAP)
\param str
\param w
\param h
@@ -617,14 +613,12 @@ int font_getstringsize(const unsigned char *str, int *w, int *h, int fontnumber)
\description
int font_get_width(struct font* pf, unsigned short char_code)
- \conditions defined(HAVE_LCD_BITMAP)
\param pf
\param char_code
\return
\description
struct font* font_load(const char *path)
- \conditions defined(HAVE_LCD_BITMAP)
\param path
\return
\description Load font =path= and returns a struct font pointer for it
@@ -678,7 +672,6 @@ struct system_status *global_status
\see [S[apps/settings.h]]
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)
- \conditions defined(HAVE_LCD_BITMAP)
\param screen
\param x
\param y
@@ -808,7 +801,7 @@ int kbd_input(char* buffer, int buflen)
void lcd_bitmap(const fb_data *src, int x, int y, int width, int height)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1)
+ \conditions (LCD_DEPTH > 1)
\param src
\param x
\param y
@@ -818,7 +811,7 @@ void lcd_bitmap(const fb_data *src, int x, int y, int width, int height)
void lcd_bitmap_part(const fb_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1)
+ \conditions (LCD_DEPTH > 1)
\param src
\param src_x
\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
void lcd_bitmap_transparent(const fb_data *src, int x, int y, int width, int height)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH == 16)
+ \conditions (LCD_DEPTH >= 16)
\param src
\param x
\param y
@@ -841,7 +834,7 @@ void lcd_bitmap_transparent(const fb_data *src, int x, int y, int width, int hei
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)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH == 16)
+ \conditions (LCD_DEPTH >= 16)
\param src
\param src_x
\param src_y
@@ -854,7 +847,7 @@ void lcd_bitmap_transparent_part(const fb_data *src, int src_x, int src_y, int s
void lcd_blit_grey_phase(unsigned char *values, unsigned char *phases, int bx, int by, int bwidth, int bheight, int stride)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) )) && ((LCD_DEPTH < 4) && !defined(SIMULATOR
+ \conditions ((LCD_DEPTH < 4) && !defined(SIMULATOR))
\param values
\param phases
\param bx
@@ -866,7 +859,7 @@ void lcd_blit_grey_phase(unsigned char *values, unsigned char *phases, int bx, i
void lcd_blit_mono(const unsigned char *data, int x, int by, int width, int bheight, int stride)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) )) && ((LCD_DEPTH < 4) && !defined(SIMULATOR
+ \conditions ((LCD_DEPTH < 4) && !defined(SIMULATOR))
\param data
\param x
\param by
@@ -877,7 +870,7 @@ void lcd_blit_mono(const unsigned char *data, int x, int by, int width, int bhei
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)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH == 16)
+ \conditions (LCD_DEPTH >= 16)
\param src[3]
\param src_x
\param src_y
@@ -894,7 +887,6 @@ void lcd_clear_display(void)
void lcd_drawline(int x1, int y1, int x2, int y2)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param x1 X top coordinate
\param y1 Y top coordinate
\param x2 X bottom coordinate
@@ -903,14 +895,12 @@ void lcd_drawline(int x1, int y1, int x2, int y2)
void lcd_drawpixel(int x, int y)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param x
\param y
\description Draws a pixel at (=x=, =y=) within current drawing mode
void lcd_drawrect(int x, int y, int width, int height)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param x
\param y
\param width
@@ -919,7 +909,6 @@ void lcd_drawrect(int x, int y, int width, int height)
void lcd_fillrect(int x, int y, int width, int height)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param x
\param y
\param width
@@ -928,7 +917,6 @@ void lcd_fillrect(int x, int y, int width, int height)
fb_data* lcd_framebuffer
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\return
\description Pointer to the framebuffer
\see [S[firmware/export/lcd.h]]
@@ -943,32 +931,30 @@ int lcd_getstringsize(const unsigned char *str, int *w, int *h)
fb_data* lcd_get_backdrop(void)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1)
+ \conditions (LCD_DEPTH > 1)
\return Pointer to framebuffer data
\description Gets the current backdrop
\see lcd_framebuffer
unsigned lcd_get_background(void)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1)
+ \conditions (LCD_DEPTH > 1)
\return
\description
int lcd_get_drawmode(void)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\return current LCD drawing mode
\description
unsigned lcd_get_foreground(void)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1)
+ \conditions (LCD_DEPTH > 1)
\return
\description
void lcd_hline(int x1, int x2, int y)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param x1 X start coordinate
\param x2 X end coordinate
\param y Y coordinate
@@ -976,7 +962,6 @@ void lcd_hline(int x1, int x2, int y)
void lcd_mono_bitmap(const unsigned char *src, int x, int y, int width, int height)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param src
\param x
\param y
@@ -986,7 +971,6 @@ void lcd_mono_bitmap(const unsigned char *src, int x, int y, int width, int heig
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)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param src
\param src_x
\param src_y
@@ -1230,20 +1214,19 @@ void lcd_remote_vline(int x, int y1, int y2)
void lcd_setfont(int font)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param font
\description Set default font
void lcd_set_backdrop(fb_data* backdrop)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1)
+ \conditions (LCD_DEPTH > 1)
\param backdrop Pointer to backdrop image
\description Set the backdrop to =backdrop=
\see lcd_framebuffer
void lcd_set_background(unsigned foreground)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1)
+ \conditions (LCD_DEPTH > 1)
\param foreground
\description
@@ -1254,19 +1237,18 @@ void lcd_set_contrast(int x)
void lcd_set_drawmode(int mode)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param mode
\description
void lcd_set_foreground(unsigned foreground)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) && (LCD_DEPTH > 1)
+ \conditions (LCD_DEPTH > 1)
\param foreground
\description
void lcd_set_invert_display(bool yesno)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) )) && (defined(HAVE_LCD_INVERT
+ \conditions (defined(HAVE_LCD_INVERT))
\param yesno
\description
@@ -1280,7 +1262,6 @@ void lcd_update(void)
void lcd_update_rect(int x, int y, int width, int height)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param x measured in pixels
\param y measured in pixels
\param width measured in pixels
@@ -1289,7 +1270,6 @@ void lcd_update_rect(int x, int y, int width, int height)
void lcd_vline(int x, int y1, int y2)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP)
\param x X coordinate
\param y1 Y start coordinate
\param y2 Y end coordinate
@@ -1297,7 +1277,7 @@ void lcd_vline(int x, int y1, int y2)
void lcd_yuv_set_options(unsigned options)
\group lcd
- \conditions defined(HAVE_LCD_BITMAP) )) && (LCD_DEPTH == 16) && (defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) || defined(IRIVER_H10) || defined(COWON_D2
+ \conditions (LCD_DEPTH >= 16) && (defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) || defined(IRIVER_H10) || defined(COWON_D2))
\param options
\description
@@ -1762,7 +1742,6 @@ struct dirent* readdir(DIR* dir)
\description
int read_bmp_file(const char* filename, struct bitmap *bm, int maxsize, int format)
- \conditions (defined(HAVE_LCD_BITMAP))
\param filename
\param bm
\param maxsize
@@ -1820,7 +1799,6 @@ struct screen* screens[NB_SCREENS]
\description
void screen_clear_area(struct screen * display, int xstart, int ystart, int width, int height)
- \conditions defined(HAVE_LCD_BITMAP)
\param display
\param xstart
\param ystart
@@ -1829,7 +1807,6 @@ void screen_clear_area(struct screen * display, int xstart, int ystart, int widt
\description
void screen_dump_set_hook(void (*hook)(int fh))
- \conditions (defined(HAVE_LCD_BITMAP))
\param hook
\description
@@ -1962,14 +1939,14 @@ bool simplelist_show_list(struct simplelist_info *info)
void sim_lcd_ex_init(int shades, unsigned long (*getpixel)(int, int))
\group special simulator hooks
- \conditions (defined(SIMULATOR)) && (defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8)
+ \conditions (defined(SIMULATOR) && LCD_DEPTH < 8))
\param shades
\param getpixel
\description
void sim_lcd_ex_update_rect(int x, int y, int width, int height)
\group special simulator hooks
- \conditions (defined(SIMULATOR)) && (defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8)
+ \conditions (defined(SIMULATOR) LCD_DEPTH < 8))
\param x
\param y
\param width