summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNils Wallménius <nils@rockbox.org>2006-11-13 15:14:28 +0000
committerNils Wallménius <nils@rockbox.org>2006-11-13 15:14:28 +0000
commitda55588fc7e0134decd4ba8cc573f507302a5664 (patch)
tree348137ec71582f1b2436252cd657d372bdde729c
parent6a27006a5ddf70926f9d45a0ce17a26473ecc403 (diff)
Add a description of the bacdrop functionality and include description of relevant options for greyscale targets too
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11522 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/advanced_topics/main.tex22
-rw-r--r--manual/appendix/config_file_options.tex5
-rw-r--r--manual/appendix/wps_tags.tex4
-rwxr-xr-xmanual/configure_rockbox/display_options.tex9
4 files changed, 29 insertions, 11 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 5b12ef7033..f870af70ef 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -38,6 +38,19 @@ If your language is not yet supported and you want to write your own language
file find the instructions on the Rockbox website:
\wikilink{HowtoUpdateLangfile}
+\nopt{archos}{%
+ \subsection{\label{ref:LoadingBackdrops}Loading Backdrops}
+ Rockbox supports showing an image as a backdrop in the \setting{File Browser}
+ and the menus. The backdrop image must be a \fname{.bmp} file of the exact
+ same dimensions as the display in your \dap{} (\genericimg{} with the last
+ number giving the colour depth in bits). To use an image as a backdrop browse
+ to it in the \setting{File Browser} and open the \setting{File Menu}
+ (see \reference{ref:Filemenu}) on it and select the option
+ \setting{Set As Backdrop}. If you want rockbox to remember your
+ backdrop the next time you start your \dap{} the backdrop must be placed in
+ the \fname{/.rockbox/backdrops} folder.
+}%
+
\section{\label{ref:ConfiguringtheWPS}Configuring the WPS}
\subsection{WPS -- General Info}
@@ -197,19 +210,20 @@ displaying images:
\item Load and always show the image, using the \config{\%x} tag
\item Preload the image with \config{\%xl} and show it with \config{\%xd}.
This way you can have your images displayed conditionally.
- \opt{HAVE_LCD_COLOR}{
+ \nopt{archos}{%
\item Load an image and show as backdrop using the \config{\%X} tag. The
image must be of the same exact dimensions as your display.
- }
+ }%
\end{enumerate}
-\optv{HAVE_LCD_COLOR}{
+\optv{SWCODEC}{% This doesn't depend on SWCODEC but we don't have a \noptv
+ % command.
Example on background image use:
\begin{example}
%X|background.bmp|
\end{example}
The image with filename \fname{background.bmp} is loaded and used in the WPS.
-}
+}%
Example on bitmap preloading and use:
\begin{example}
diff --git a/manual/appendix/config_file_options.tex b/manual/appendix/config_file_options.tex
index dc7dd82a8d..6be2435b6b 100644
--- a/manual/appendix/config_file_options.tex
+++ b/manual/appendix/config_file_options.tex
@@ -183,8 +183,11 @@
disk poweroff & on, off & N/A\\
}%
- \opt{HAVE_LCD_COLOR}{
+ \nopt{archos}{%
backdrop & /path/filename.bmp & N/A\\
+ }%
+
+ \opt{HAVE_LCD_COLOR}{
foreground color & 000000 to FFFFFF & RRGGBB\\
background color & 000000 to FFFFFF & RRGGBB\\
}
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 6d449aee4e..33f4d79e59 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -165,11 +165,11 @@ Ffwd{\textbar}Rew{\textgreater}}
\section{Images}
\begin{table}
\begin{tagmap}{}{}
- \opt{h300,x5,ipodcolor,ipodvideo}{
+ \nopt{archos}{%
\config{\%X{\textbar}filename.bmp{\textbar}}
& Load and set a backdrop image for the WPS. %
This image must be exactly the same size as your LCD.\\
- }
+ }%
\config{\%P{\textbar}filename.bmp{\textbar}}
& Load a Progress bar image for the WPS. Use \config{\%pb} tag to show the
progress bar\\
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex
index 8333e217e2..69fa4bbfd1 100755
--- a/manual/configure_rockbox/display_options.tex
+++ b/manual/configure_rockbox/display_options.tex
@@ -94,12 +94,13 @@
of inverted text (\setting{Bar (inverse)} option) or a small arrow to the
left of the menu text (\setting{Pointer} option).
- \opt{HAVE_LCD_COLOR}{
+ \nopt{archos}{%
\item[Clear Backdrop:]
- Rockbox allows you to select bitmap pictures to use as backdrops.
- These backdrops are set in the \setting{File Menu}, see
- \reference{ref:Filemenu}.
+ Rockbox allows you to select bitmap pictures to use as backdrops,
+ see \reference{ref:LoadingBackdrops} for further information.
This option allows you to clear the backdrops that you set.
+ }%
+ \opt{HAVE_LCD_COLOR}{
\item[Set Background Colour:]
Sets the background colour for the LCD display.
\item[Set Foreground Colour:]