summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorAlex Parker <rockbox@aeparker.com>2009-02-16 20:10:01 +0000
committerAlex Parker <rockbox@aeparker.com>2009-02-16 20:10:01 +0000
commit94194f3292d728ae81c5e94ab9193639156e01ad (patch)
treea1529c1e4111377b8a3c4ae81799eaff2c1a5e13 /manual
parent43a8e08a239d9149f21e439e768b56f363f3709d (diff)
downloadrockbox-94194f3292d728ae81c5e94ab9193639156e01ad.tar.gz
rockbox-94194f3292d728ae81c5e94ab9193639156e01ad.tar.bz2
rockbox-94194f3292d728ae81c5e94ab9193639156e01ad.zip
Add PictureFlow plugin to the manual
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@20021 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/plugins/images/ss-pictureflow-128x128x16.pngbin0 -> 17359 bytes
-rw-r--r--manual/plugins/images/ss-pictureflow-132x80x16.pngbin0 -> 13756 bytes
-rw-r--r--manual/plugins/images/ss-pictureflow-138x110x2.pngbin0 -> 7308 bytes
-rw-r--r--manual/plugins/images/ss-pictureflow-160x128x16.pngbin0 -> 20920 bytes
-rw-r--r--manual/plugins/images/ss-pictureflow-160x128x2.pngbin0 -> 9196 bytes
-rw-r--r--manual/plugins/images/ss-pictureflow-176x132x16.pngbin0 -> 24591 bytes
-rw-r--r--manual/plugins/images/ss-pictureflow-176x220x16.pngbin0 -> 36275 bytes
-rw-r--r--manual/plugins/images/ss-pictureflow-220x176x16.pngbin0 -> 36006 bytes
-rw-r--r--manual/plugins/images/ss-pictureflow-240x320x16.pngbin0 -> 66290 bytes
-rw-r--r--manual/plugins/images/ss-pictureflow-320x240x16.pngbin0 -> 69493 bytes
-rw-r--r--manual/plugins/main.tex2
-rw-r--r--manual/plugins/pictureflow.tex89
12 files changed, 91 insertions, 0 deletions
diff --git a/manual/plugins/images/ss-pictureflow-128x128x16.png b/manual/plugins/images/ss-pictureflow-128x128x16.png
new file mode 100644
index 0000000000..b6d0dd42aa
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-128x128x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-pictureflow-132x80x16.png b/manual/plugins/images/ss-pictureflow-132x80x16.png
new file mode 100644
index 0000000000..7238685004
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-132x80x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-pictureflow-138x110x2.png b/manual/plugins/images/ss-pictureflow-138x110x2.png
new file mode 100644
index 0000000000..91060573e2
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-138x110x2.png
Binary files differ
diff --git a/manual/plugins/images/ss-pictureflow-160x128x16.png b/manual/plugins/images/ss-pictureflow-160x128x16.png
new file mode 100644
index 0000000000..b3b3141219
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-160x128x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-pictureflow-160x128x2.png b/manual/plugins/images/ss-pictureflow-160x128x2.png
new file mode 100644
index 0000000000..9d6f699822
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-160x128x2.png
Binary files differ
diff --git a/manual/plugins/images/ss-pictureflow-176x132x16.png b/manual/plugins/images/ss-pictureflow-176x132x16.png
new file mode 100644
index 0000000000..17623a1a63
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-176x132x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-pictureflow-176x220x16.png b/manual/plugins/images/ss-pictureflow-176x220x16.png
new file mode 100644
index 0000000000..beb615959e
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-176x220x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-pictureflow-220x176x16.png b/manual/plugins/images/ss-pictureflow-220x176x16.png
new file mode 100644
index 0000000000..032db2314b
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-220x176x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-pictureflow-240x320x16.png b/manual/plugins/images/ss-pictureflow-240x320x16.png
new file mode 100644
index 0000000000..69d1e26e3a
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-240x320x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-pictureflow-320x240x16.png b/manual/plugins/images/ss-pictureflow-320x240x16.png
new file mode 100644
index 0000000000..1f7b01fb6e
--- /dev/null
+++ b/manual/plugins/images/ss-pictureflow-320x240x16.png
Binary files differ
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 9cf27e00a4..54b051fab7 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -104,6 +104,8 @@ text files%
\opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}}
+\opt{tagcache}{\opt{swcodec}{\input{plugins/pictureflow.tex}}}
+
\opt{lcd_bitmap}{\input{plugins/plasma.tex}}
{\input{plugins/snow.tex}}
diff --git a/manual/plugins/pictureflow.tex b/manual/plugins/pictureflow.tex
new file mode 100644
index 0000000000..87d2857d0d
--- /dev/null
+++ b/manual/plugins/pictureflow.tex
@@ -0,0 +1,89 @@
+\subsection{PictureFlow}
+\screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow}
+PictureFlow is a plugin that provides a visualisation of your albums with
+their associated cover art.
+
+\subsubsection{Requirements}
+PictureFlow uses both the album art (see \wikilink{AlbumArt} in the wiki) and
+database (see \reference{ref:database}) features of Rockbox.
+It is therefore important that these are working correctly before attempting
+to use PictureFlow. In addition, there are some other points of which to be
+aware:
+
+ \begin{itemize}
+ \item PictureFlow will accept album art larger than the dimensions of the
+ screen, but the larger the dimensions, the longer they will take to scale.
+ \item The main playback buffer is used which means that unless the size of the
+ playing tracks is small you will have to stop playback to use PictureFlow.
+ \end{itemize}
+
+\note{PictureFlow is a visualisation only. It cannot be used to select and
+play music.}
+
+\subsubsection{Keys}
+\begin{table}
+ \begin{btnmap}{}{}
+ \opt{scrollwheel,ipodmini,IRIVER_H10_PAD}{
+ \opt{scrollwheel,ipodmini}{\ButtonScrollFwd{} / \ButtonScrollBack}
+ \opt{IRIVER_H10_PAD}{\ButtonScrollUp{} / \ButtonScrollDown}
+ & Scroll through albums / track list\\}
+
+ \nopt{scrollwheel,ipodmini,IRIVER_H10_PAD}{\ButtonLeft{} / \ButtonRight
+ & Scroll through albums\\}
+
+ \nopt{scrollwheel,ipodmini,SANSA_C200_PAD,IRIVER_H10_PAD}{\ButtonUp{} / \ButtonDown
+ & Scroll through track list\\}
+
+ \opt{SANSA_C200_PAD}{\ButtonUp
+ & Scroll up through track list\\}
+
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,GIGABEAT_PAD,%
+ GIGABEATS_PAD,SANSA_E200_PAD,SANSA_C200_PAD,MROBE100_PAD,%
+ IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonSelect}
+ \opt{IRIVER_H10_PAD}{\ButtonRew}
+ & Switch between cover view and track list\\
+
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
+ \opt{IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD,GIGABEAT_PAD,%
+ GIGABEATS_PAD,MROBE100_PAD}{\ButtonMenu}
+ \opt{IAUDIO_X5_PAD}{\ButtonRec}
+ \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonDown}
+ \opt{IRIVER_H10_PAD}{\ButtonFF}
+ & Enter / exit menu\\
+
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
+ \opt{IAUDIO_X5_PAD,GIGABEAT_PAD,SANSA_E200_PAD,SANSA_C200_PAD,%
+ IRIVER_H10_PAD,MROBE_100_PAD}{\ButtonPower}
+ \opt{GIGABEATS_PAD}{\ButtonBack}
+ \opt{IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonSelect+\ButtonMenu}
+ & Exit menu or PictureFlow\\
+ \end{btnmap}
+\end{table}
+
+\subsubsection{Main Menu}
+\begin{description}
+ \item[Settings.] Enter the settings menu.
+ \item[Return.] Exit menu.
+ \item[Exit.] Exit PictureFlow plugin.
+\end{description}
+
+\subsubsection{Settings Menu}
+
+\begin{description}
+ \item[Show FPS.] Displays frames per second on screen.
+ \item[Spacing.] The distance between the front edges of the side slides, i.e. changes
+ the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom.
+ \item[Centre margin.] The distance, in screen pixels, with zoom at 100, between
+ the centre and side slides. Scales with zoom.
+ \item[Number of slides.] Sets the number of slides at each side, including the
+ centre slide. Therefore if set to 4, there will be 3 slides on the left,
+ the centre slide, and then 3 slides on the right.
+ \item[Zoom.] Changes the distance at which slides are rendered from the "camera".
+ \item[Show album title.] Allows setting the album title to be shown above or
+ below the cover art, or not at all.
+ \item[Resize Covers.] Set whether to automatically resize the covers or to leave
+ them at their original size.
+ \item[Rebuild cache.] Rebuild the PictureFlow cache. This is needed in order
+ for PictureFlow to pick up new albums, and may occasionally be needed if albums
+ are removed.
+\end{description}