summaryrefslogtreecommitdiff
path: root/manual/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'manual/plugins')
-rw-r--r--manual/plugins/images/ss-rockpaint-128x128x16.pngbin1706 -> 1252 bytes
-rw-r--r--manual/plugins/images/ss-rockpaint-132x80x16.pngbin0 -> 1133 bytes
-rw-r--r--manual/plugins/images/ss-rockpaint-160x128x16.pngbin0 -> 1285 bytes
-rw-r--r--manual/plugins/images/ss-rockpaint-176x132x16.pngbin0 -> 1290 bytes
-rw-r--r--manual/plugins/images/ss-rockpaint-176x220x16.pngbin0 -> 2580 bytes
-rw-r--r--manual/plugins/images/ss-rockpaint-220x176x16.pngbin0 -> 2512 bytes
-rw-r--r--manual/plugins/images/ss-rockpaint-240x320x16.pngbin0 -> 3173 bytes
-rw-r--r--manual/plugins/images/ss-rockpaint-320x240x16.pngbin0 -> 3018 bytes
-rw-r--r--manual/plugins/main.tex2
-rw-r--r--manual/plugins/rockpaint.tex145
10 files changed, 147 insertions, 0 deletions
diff --git a/manual/plugins/images/ss-rockpaint-128x128x16.png b/manual/plugins/images/ss-rockpaint-128x128x16.png
index 72514c994d..c02af21d8d 100644
--- a/manual/plugins/images/ss-rockpaint-128x128x16.png
+++ b/manual/plugins/images/ss-rockpaint-128x128x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-rockpaint-132x80x16.png b/manual/plugins/images/ss-rockpaint-132x80x16.png
new file mode 100644
index 0000000000..0f00197f79
--- /dev/null
+++ b/manual/plugins/images/ss-rockpaint-132x80x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-rockpaint-160x128x16.png b/manual/plugins/images/ss-rockpaint-160x128x16.png
new file mode 100644
index 0000000000..a3dac2553c
--- /dev/null
+++ b/manual/plugins/images/ss-rockpaint-160x128x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-rockpaint-176x132x16.png b/manual/plugins/images/ss-rockpaint-176x132x16.png
new file mode 100644
index 0000000000..0047ffcb59
--- /dev/null
+++ b/manual/plugins/images/ss-rockpaint-176x132x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-rockpaint-176x220x16.png b/manual/plugins/images/ss-rockpaint-176x220x16.png
new file mode 100644
index 0000000000..c7b0d74e2d
--- /dev/null
+++ b/manual/plugins/images/ss-rockpaint-176x220x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-rockpaint-220x176x16.png b/manual/plugins/images/ss-rockpaint-220x176x16.png
new file mode 100644
index 0000000000..a5e46cc40c
--- /dev/null
+++ b/manual/plugins/images/ss-rockpaint-220x176x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-rockpaint-240x320x16.png b/manual/plugins/images/ss-rockpaint-240x320x16.png
new file mode 100644
index 0000000000..987b9375fb
--- /dev/null
+++ b/manual/plugins/images/ss-rockpaint-240x320x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-rockpaint-320x240x16.png b/manual/plugins/images/ss-rockpaint-320x240x16.png
new file mode 100644
index 0000000000..0e2edbd4fb
--- /dev/null
+++ b/manual/plugins/images/ss-rockpaint-320x240x16.png
Binary files differ
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 5e9246a3de..d371009a7e 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -181,6 +181,8 @@ the associated file. Viewers are stored in the
181 181
182{\input{plugins/random_folder_advance_config.tex}} 182{\input{plugins/random_folder_advance_config.tex}}
183 183
184\opt{lcd_color}{\input{plugins/rockpaint.tex}}
185
184\opt{recorder,recorderv2fm,ondio}{\input{plugins/split_editor.tex}} 186\opt{recorder,recorderv2fm,ondio}{\input{plugins/split_editor.tex}}
185 187
186{\input{plugins/stats.tex}} 188{\input{plugins/stats.tex}}
diff --git a/manual/plugins/rockpaint.tex b/manual/plugins/rockpaint.tex
new file mode 100644
index 0000000000..c9dfc5fc54
--- /dev/null
+++ b/manual/plugins/rockpaint.tex
@@ -0,0 +1,145 @@
1% $Id$ %
2\subsection{Rockpaint}
3\screenshot{plugins/images/ss-rockpaint}{Rockpaint}%
4{img:Rockpaint}
5Rockpaint is a bitmap (\fname{.bmp}) editor for Rockbox. It can open any \fname{.bmp} file
6whose dimensions are the same size as your device's screen or smaller; it can
7also create empty bitmaps for you to work with.\\
8
9\subsubsection{Opening A File}
10To open a file, you may use either the context menu option "Open With" in the
11File Browser, or you may enter Rockpaint first using the Plugins menu and open
12a file from there. To perform the latter, simply press Rockpaint's Menu button
13or move the cursor beyond the bottom of the screen; then move the cursor onto
14"Menu" and select it. Finally, select "Load" and navigate to the image you
15wish to open.\\
16
17\subsubsection{Tools}
18Rockpaint offers several tools to aid you in editing; you can view them by
19either pressing Rockpaint's "Menu" key or by attempting to move the cursor
20beyond the bottom of the screen. From top to bottom and left to right, and
21by section, they are as follows:
22\begin{description}
23 \item[Colour Picker]
24 The top left tool shows your colours that are at the ready. To
25 swap them, "click" on the background colour. To edit the foreground colour,
26 click on it.
27 \item[Preset Pallete]
28 Several preset colours are availible. Clicking on one changes
29 the foreground of the Colour Picker to the selected colour.
30 \item[Pencil]
31 Draws as you move the cursor. You can change the brush size with the
32 Menu option "Brush Size". Use the Select key to toggle the tool while editing
33 the image.
34 \item[Selection tool]
35 Allows you to select a rectangular region; once you do, you
36 will be shown a menu of options (including "cancel" if you make a mistake).
37 \item[Line tool]
38 Draws a straight line.
39 \item[Curve tool]
40 Allows you to draw a line and curve it.
41 \item[Rectangle tool]
42 Draws an unfilled rectangle.
43 \item[Circle tool]
44 Draws an unfilled circle.
45 \item[Gradient fill]
46 To use this tool, click at the starting and ending points.
47 Starting with the background and going to the foreground colour, Rockpaint
48 will fill the region with a gradual colour change.
49 \item[Bucket fill]
50 Fills an same-colour or empty region with a colour.
51 \item[Dropper]
52 Click on a colour in the image to change the foreground colour to it.
53 \item[Eraser]
54 The opposite of the pencil; it changes painted pixels to white.
55 \item[Text tool]
56 "Draws" text on the image.
57 \item[Filled rectangle]
58 Same as the Rectangle tool, but fills it with colour.
59 \item[Filled circle]
60 Same as the Circle tool, but fills it with colour.
61 \item[Curved Gradient Fill]
62 Same as Gradient fill, but you must draw two lines.
63 Rockpaint will draw a curved, gradual change of colour in the region.
64 \item[Menu]
65 This opens the Main Menu. You can also press the Menu key to open it.
66\end{description}
67
68\subsubsection{Main Menu}
69The main menu consists of the following:
70\begin{description}
71 \item[Resume]
72 Closes the Main Menu.
73 \item[New]
74 Creates a new canvas and discards the current file. BE CAREFUL.
75 You will lose any unsaved changes in the file that is currently open.
76 \item[Load]
77 Loads a bitmap file. Simply navigate to the file as you
78 would in the file browser.
79 \item[Save]
80 Saves the current file. If it has not been saved before,
81 you will be given a chance to name it and choose the saving location.
82 \item[Brush speed]
83 Changes the speed at which the selection cursor
84 moves when you hold down a movement button.
85 \item[Brush size]
86 Allows you to adjust the drawing size of the pencil tool.
87 \item[Choose colour]
88 Allows you to manually edit the foreground colour.
89 You can edit the RBG and/or the HSV values.
90 \item[Grid size]
91 Allows you to show or hide a grid over the canvas,
92 and to specify its size.
93 \item[Exit]
94 Exits Rockpaint.
95\end{description}
96
97\warn{BE CAREFUL. Rockpaint will NOT prompt you to save
98if you select Exit, so any unsaved changes will be lost.}
99
100\begin{table}
101\begin{btnmap}{}{}
102 \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{
103 \nopt{IRIVER_H300_PAD,GIGABEAT_S_PAD}{\ButtonPower}
104 \opt{IRIVER_H300_PAD}{\ButtonOff}
105 \opt{GIGABEAT_S_PAD}{\ButtonBack}
106 & Quits Rockpaint immediately.\\
107 }
108
109 \ButtonLeft
110 & Moves the cursor to the left.\\
111
112 \ButtonRight
113 & Moves the cursor to the right.\\
114
115 \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,IRIVER_H10_PAD}{\ButtonUp}
116 \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonMenu}
117 \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
118 & Moves the cursor up.\\
119
120 \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,IRIVER_H10_PAD}{\ButtonDown}
121 \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonPlay}
122 \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
123 & Moves the cursor down.\\
124
125 \opt{IRIVER_H300_PAD}{\ButtonOn}%
126 \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect+\ButtonMenu}%
127 \opt{SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonSelect+\ButtonPower}%
128 \opt{IAUDIO_X5_PAD}{\ButtonPlay}%
129 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonMenu}%
130 \opt{IRIVER_H10_PAD}{\ButtonPlay}%
131 & Displays the Main Menu.\\
132
133 \opt{IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonRec}
134 \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonMenu+\ButtonLeft}
135 \opt{GIGABEAT_PAD}{\ButtonA}
136 \opt{IRIVER_H10_PAD}{\ButtonRew}
137 \opt{GIGABEAT_S_PAD}{\ButtonPlay}
138 & Displays the toolbar.\\
139
140 \nopt{IRIVER_H10_PAD}{\ButtonSelect}%
141 \opt{IRIVER_H10_PAD}{\ButtonFF}%
142 & Toggles the brush and selects objects.\\
143
144 \end{btnmap}
145\end{table}