And of course the stubs still need to be there...
[kugel-rb.git] / manual / plugins / bmpviewer.tex
blob5e36db19792eb2360f65078616c1ea77268fcaaa
1 % $Id$ %
2 \subsection{BMP viewer}
3 This plugin opens \fname{.bmp} files from the \setting{File Browser} to display them\nopt{lcd_color}{ using Rockbox's greyscale library}.
4 \opt{swcodec}{
5 \par
6 \note{
7 When an audio file is playing the size of the image is limited as
8 the decoding process needs to share memory with audio tracks. To be able to
9 view a bigger file you may need to stop playback.}
11 \nopt{large_plugin_buffer}{%
12 \note{This plugin will cause playback to stop.}%
15 \begin{table}
16 \begin{btnmap}{}{}
17 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
18 ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
19 ,MROBE100_PAD,PBELL_VIBE500_PAD}
20 {\ButtonUp\ / \ButtonDown}%
21 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu\ / \ButtonPlay}%
22 \opt{IRIVER_H10_PAD}{\ButtonScrollUp\ / \ButtonScrollDown} %
23 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
24 ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
25 ,MROBE100_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,PBELL_VIBE500_PAD}
26 {/ \ButtonLeft\ / \ButtonRight}
27 \opt{COWON_D2_PAD}{}
28 \opt{HAVEREMOTEKEYMAP}{& }
29 & Move around in zoomed in image\\
30 \opt{RECORDER_PAD}{\ButtonPlay}
31 \opt{ONDIO_PAD,COWON_D2_PAD}{\ButtonMenu}
32 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
33 ,SANSA_FUZE_PAD,SANSA_C200_PAD,MROBE100_PAD}{\ButtonSelect}
34 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd}
35 \opt{IRIVER_H10_PAD}{\ButtonPlay}
36 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp}
37 \opt{PBELL_VIBE500_PAD}{\ButtonRec+\ButtonUp}
38 \opt{HAVEREMOTEKEYMAP}{& }
39 & Zoom in\\
40 \opt{RECORDER_PAD}{\ButtonOn}
41 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown}
42 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
43 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack}
44 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD}{Long \ButtonSelect}
45 \opt{IRIVER_H10_PAD}{Long \ButtonPlay}
46 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
47 \opt{MROBE100_PAD}{\ButtonPlay}
48 \opt{PBELL_VIBE500_PAD}{\ButtonRec+\ButtonDown}
49 \opt{HAVEREMOTEKEYMAP}{& }
50 & Zoom out\\
51 \opt{RECORDER_PAD}{\ButtonFThree}
52 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight}
53 \opt{IRIVER_H100_PAD}{\ButtonOn}
54 \opt{IRIVER_H300_PAD}{\ButtonRec}
55 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonRight}
56 \opt{IAUDIO_X5_PAD}{\ButtonPlay}
57 \opt{IRIVER_H10_PAD}{\ButtonFF}
58 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
59 \opt{SANSA_C200_PAD}{\ButtonVolUp}
60 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonRight}
61 \opt{GIGABEAT_S_PAD}{\ButtonNext}
62 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonRight}
63 \opt{PBELL_VIBE500_PAD}{\ButtonRec+\ButtonRight}
64 \opt{HAVEREMOTEKEYMAP}{& }
65 & Next bmp in directory\\
66 \opt{RECORDER_PAD}{\ButtonFTwo}
67 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft}
68 \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonRec}
69 \opt{IRIVER_H300_PAD}{\ButtonOn}
70 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonLeft}
71 \opt{IRIVER_H10_PAD}{\ButtonRew}
72 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollBack}
73 \opt{SANSA_C200_PAD}{\ButtonVolDown}
74 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonLeft}
75 \opt{GIGABEAT_S_PAD}{\ButtonPrev}
76 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonLeft}
77 \opt{PBELL_VIBE500_PAD}{\ButtonRec+\ButtonLeft}
78 \opt{HAVEREMOTEKEYMAP}{& }
79 & Previous bmp in directory\\
80 \opt{SANSA_E200_PAD,SANSA_C200_PAD}{%currently only defined for the sansa pads
81 \ButtonRec
82 \opt{HAVEREMOTEKEYMAP}{& }
83 & Toggle slide show mode\\
85 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
86 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonMenu}
87 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonPower}
88 \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
89 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,PBELL_VIBE500_PAD}{\ButtonMenu}
90 \opt{COWON_D2_PAD}{\ButtonPower}
91 \opt{HAVEREMOTEKEYMAP}{&
92 \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop}
94 & Show menu / Abort \\
95 \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,PBELL_VIBE500_PAD}{
96 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonPlay}
97 \opt{GIGABEAT_PAD,MROBE100_PAD}{\ButtonPower}
98 \opt{GIGABEAT_S_PAD}{\ButtonBack}
99 \opt{PBELL_VIBE500_PAD}{\ButtonCancel}
100 \opt{HAVEREMOTEKEYMAP}{& }
101 & Quit the viewer \\
103 \end{btnmap}
104 \end{table}
106 The menu has the following entries.
107 \begin{description}
108 \item[Return.] Returns you to the image
109 \item[Toggle Slideshow Mode.] Enables or disables the slideshow mode.
110 \item[Change Slideshow Timeout.] You can set the timeout for the slideshow
111 between 1 second and 20 seconds.
112 \opt{large_plugin_buffer}{
113 \item[Show Playback Menu.] From the playback menu you can control the
114 playback of the currently loaded playlist and change the volume of your \dap.
116 \item[Quit.] Quits the viewer and returns to the \setting{File Browser}.
117 \end{description}