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