FS#8961 - Anti-Aliased Fonts.
[kugel-rb.git] / firmware / export / scroll_engine.h
blob762761f2139f119ccb3dff2a30b7804890a38531
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2007 Michael Sevakis
12 * LCD scrolling driver and scheduler
14 * Much collected and combined from the various Rockbox LCD drivers.
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License
18 * as published by the Free Software Foundation; either version 2
19 * of the License, or (at your option) any later version.
21 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
22 * KIND, either express or implied.
24 ****************************************************************************/
25 #ifndef __SCROLL_ENGINE_H__
26 #define __SCROLL_ENGINE_H__
28 #include <lcd.h>
29 #include "file.h"
31 void scroll_init(void);
32 void lcd_scroll_stop(struct viewport* vp);
33 void lcd_scroll_stop_line(struct viewport* vp, int y);
34 void lcd_scroll_fn(void);
35 #ifdef HAVE_REMOTE_LCD
36 void lcd_remote_scroll_fn(void);
37 void lcd_remote_scroll_stop(struct viewport* vp);
38 void lcd_remote_scroll_stop_line(struct viewport* vp, int y);
39 #endif
41 /* internal usage, but in multiple drivers */
42 #define SCROLL_SPACING 3
43 #ifdef HAVE_LCD_BITMAP
44 #define SCROLL_LINE_SIZE (MAX_PATH + SCROLL_SPACING + 3*LCD_WIDTH/2 + 2)
45 #else
46 #define SCROLL_LINE_SIZE (MAX_PATH + SCROLL_SPACING + 3*LCD_WIDTH + 2)
47 #endif
49 struct scrollinfo
51 struct viewport* vp;
52 char line[SCROLL_LINE_SIZE];
53 int len; /* length of line in chars */
54 int y; /* Position of the line on the screen (char co-ordinates) */
55 int offset;
56 int startx;
57 #ifdef HAVE_LCD_BITMAP
58 int width; /* length of line in pixels */
59 int style; /* line style */
60 #endif/* HAVE_LCD_BITMAP */
61 bool backward; /* scroll presently forward or backward? */
62 bool bidir;
63 long start_tick;
66 struct scroll_screen_info
68 struct scrollinfo * const scroll;
69 const int num_scroll; /* number of scrollable lines (also number of scroll structs) */
70 int lines; /* Number of currently scrolling lines */
71 long ticks; /* # of ticks between updates*/
72 long delay; /* ticks delay before start */
73 int bidir_limit; /* percent */
74 #ifdef HAVE_LCD_CHARCELLS
75 long jump_scroll_delay; /* delay between jump scroll jumps */
76 int jump_scroll; /* 0=off, 1=once, ..., JUMP_SCROLL_ALWAYS */
77 #endif
78 #if defined(HAVE_LCD_BITMAP) || defined(HAVE_REMOTE_LCD)
79 int step; /* pixels per scroll step */
80 #endif
81 #if defined(HAVE_REMOTE_LCD)
82 long last_scroll;
83 #endif
86 /** main lcd **/
87 #ifdef HAVE_LCD_BITMAP
88 #define LCD_SCROLLABLE_LINES ((LCD_HEIGHT+4)/5 < 32 ? (LCD_HEIGHT+4)/5 : 32)
89 #else
90 #define LCD_SCROLLABLE_LINES LCD_HEIGHT * 2
91 #endif
93 extern struct scroll_screen_info lcd_scroll_info;
95 /** remote lcd **/
96 #ifdef HAVE_REMOTE_LCD
97 #define LCD_REMOTE_SCROLLABLE_LINES \
98 (((LCD_REMOTE_HEIGHT+4)/5 < 32) ? (LCD_REMOTE_HEIGHT+4)/5 : 32)
99 extern struct scroll_screen_info lcd_remote_scroll_info;
100 #endif
102 #endif /* __SCROLL_ENGINE_H__ */