446e312020b1e0909d2a95342ddf52263d3e285a
[geeqie.git] / doc / docbook / GuideOptionsImage.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <section id="GuideOptionsImage">\r
3   <title>Image Options</title>\r
4   <para>This section describes the options presented under the Image Tab of the preferences dialog.</para>\r
5   <section id="Zoom">\r
6     <title>Zoom</title>\r
7     <variablelist>\r
8       <varlistentry>\r
9         <term>\r
10           <guilabel>Quality</guilabel>\r
11         </term>\r
12         <listitem>\r
13           <para>\r
14             Selects the method used to scale the size of an image:\r
15             <variablelist>\r
16               <varlistentry>\r
17                 <term>\r
18                   <guilabel>Nearest</guilabel>\r
19                 </term>\r
20                 <listitem>\r
21                   <para>Fastest scaler, but results in poor image quality.</para>\r
22                 </listitem>\r
23               </varlistentry>\r
24               <varlistentry>\r
25                 <term>\r
26                   <guilabel>Tiles</guilabel>\r
27                 </term>\r
28                 <listitem>\r
29                   <para>Results are somewhat close to bilinear, with better speed.</para>\r
30                 </listitem>\r
31               </varlistentry>\r
32               <varlistentry>\r
33                 <term>\r
34                   <guilabel>Bilinear</guilabel>\r
35                 </term>\r
36                 <listitem>\r
37                   <para>High quality results, moderately fast.</para>\r
38                 </listitem>\r
39               </varlistentry>\r
40             </variablelist>\r
41           </para>\r
42         </listitem>\r
43       </varlistentry>\r
44       <varlistentry>\r
45         <term>\r
46           <guilabel>Use GPU acceleration via Clutter library</guilabel>\r
47         </term>\r
48         <listitem>\r
49           <para>Use alternate renderer. Geeqie must be compiled with the --enable-gpu-accel option.</para>\r
50         </listitem>\r
51       </varlistentry>\r
52       <varlistentry>\r
53         <term>\r
54           <guilabel>Two pass zooming</guilabel>\r
55         </term>\r
56         <listitem>\r
57           <para>\r
58             Enables Geeqie to first display a scaled image using the\r
59             <emphasis>Nearest</emphasis>\r
60             zoom quality. After image decoding is complete, the image is scaled again using the selected\r
61             <emphasis>Zoom Quality</emphasis>\r
62             method. This allows faster display of an image as it is decoded from the source file.\r
63           </para>\r
64         </listitem>\r
65       </varlistentry>\r
66       <varlistentry>\r
67         <term>\r
68           <guilabel>Zoom increment</guilabel>\r
69         </term>\r
70         <listitem>\r
71           <para>Adjusts the step size when zooming in or out on an image. This value corresponds to the percentage of the original image.</para>\r
72         </listitem>\r
73       </varlistentry>\r
74     </variablelist>\r
75   </section>\r
76   <section id="FitImageToWindow">\r
77     <title>Fit Image To Window</title>\r
78     <variablelist>\r
79       <varlistentry>\r
80         <term>\r
81           <guilabel>Allow enlargement of image (max. size in %)</guilabel>\r
82         </term>\r
83         <listitem>\r
84           <para>\r
85             Enable this to allow Geeqie to increase the image size for images that are smaller than the current view area when the zoom is set to\r
86             <emphasis>Fit image to window</emphasis>\r
87             . This value sets the maximum expansion permitted in percent i.e. 100% is full-size.\r
88           </para>\r
89         </listitem>\r
90       </varlistentry>\r
91       <varlistentry>\r
92         <term>\r
93           <guilabel>Virtual window size (% of actual window)</guilabel>\r
94         </term>\r
95         <listitem>\r
96           <para>\r
97             This value will set the virtual size of the window when\r
98             <emphasis>Fit image to window</emphasis>\r
99             is set. Instead of using the actual size of the window, the specified percentage of the window will be used. It allows one to keep a border around the image (values lower than 100%) or to auto zoom the image (values greater than 100%). It affects fullscreen mode too.\r
100           </para>\r
101         </listitem>\r
102       </varlistentry>\r
103     </variablelist>\r
104   </section>\r
105   <section id="TileSize">\r
106     <title>Tile Size</title>\r
107     <variablelist>\r
108       <varlistentry>\r
109         <term>\r
110           <guilabel>Tile size in pixels</guilabel>\r
111         </term>\r
112         <listitem>\r
113           <para>\r
114             This option is only available when GPU acceleration is not selected. It sets the size in pixels that large images are split into during rendering. Setting a larger value will reduce the tiling effect seen as the image is displayed, but will also slightly increase the delay until the first part of the image is seen.\r
115           </para>\r
116         </listitem>\r
117       </varlistentry>\r
118     </variablelist>\r
119   </section>\r
120   <section id="Appearance">\r
121     <title>Appearance</title>\r
122     <variablelist>\r
123       <varlistentry>\r
124         <term>\r
125           <guilabel>Custom border color</guilabel>\r
126         </term>\r
127         <listitem>\r
128           <para>Enable this to draw the image background (the area around the image) in the specified color.</para>\r
129         </listitem>\r
130       </varlistentry>\r
131     </variablelist>\r
132     <variablelist>\r
133       <varlistentry>\r
134         <term>\r
135           <guilabel>Border color</guilabel>\r
136         </term>\r
137         <listitem>\r
138           <para>Use this color chooser to define the color to use as image background.</para>\r
139           <note>\r
140             <para>\r
141               You may use the\r
142               <emphasis>Virtual window size</emphasis>\r
143               (see above) option to keep a border around the image in fullscreen mode.\r
144             </para>\r
145           </note>\r
146         </listitem>\r
147       </varlistentry>\r
148     </variablelist>\r
149     <variablelist>\r
150       <varlistentry>\r
151         <term>\r
152           <guilabel>Alpha channel color 1/2</guilabel>\r
153         </term>\r
154         <listitem>\r
155           <para>These two colors define the checkerboard background used when images with an alpha channel are displayed.</para>\r
156         </listitem>\r
157       </varlistentry>\r
158     </variablelist>\r
159   </section>\r
160   <section id="Convenience">\r
161     <title>Convenience</title>\r
162     <variablelist>\r
163       <varlistentry>\r
164         <term>\r
165           <guilabel>Auto rotate proofs using EXIF information</guilabel>\r
166         </term>\r
167         <listitem>\r
168           <para>Auto rotate images on print proof sheet.</para>\r
169         </listitem>\r
170       </varlistentry>\r
171     </variablelist>\r
172   </section>\r
173 </section>\r