rmagick 1.7.1

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of rmagick might be problematic. Click here for more details.

Files changed (239) hide show
  1. data/ChangeLog +232 -0
  2. data/Makefile.in +28 -0
  3. data/README.html +404 -0
  4. data/README.txt +397 -0
  5. data/configure +8554 -0
  6. data/configure.ac +497 -0
  7. data/doc/comtasks.html +241 -0
  8. data/doc/constants.html +1195 -0
  9. data/doc/css/doc.css +299 -0
  10. data/doc/css/popup.css +34 -0
  11. data/doc/draw.html +3108 -0
  12. data/doc/ex/Adispatch.rb +43 -0
  13. data/doc/ex/Zconstitute.rb +9 -0
  14. data/doc/ex/adaptive_threshold.rb +19 -0
  15. data/doc/ex/add_noise.rb +18 -0
  16. data/doc/ex/affine.rb +48 -0
  17. data/doc/ex/affine_transform.rb +20 -0
  18. data/doc/ex/arc.rb +47 -0
  19. data/doc/ex/arcpath.rb +33 -0
  20. data/doc/ex/average.rb +15 -0
  21. data/doc/ex/axes.rb +64 -0
  22. data/doc/ex/bilevel_channel.rb +20 -0
  23. data/doc/ex/blur_image.rb +12 -0
  24. data/doc/ex/border.rb +10 -0
  25. data/doc/ex/bounding_box.rb +48 -0
  26. data/doc/ex/cbezier1.rb +40 -0
  27. data/doc/ex/cbezier2.rb +40 -0
  28. data/doc/ex/cbezier3.rb +40 -0
  29. data/doc/ex/cbezier4.rb +41 -0
  30. data/doc/ex/cbezier5.rb +41 -0
  31. data/doc/ex/cbezier6.rb +51 -0
  32. data/doc/ex/channel.rb +26 -0
  33. data/doc/ex/channel_threshold.rb +48 -0
  34. data/doc/ex/charcoal.rb +12 -0
  35. data/doc/ex/chop.rb +29 -0
  36. data/doc/ex/circle.rb +31 -0
  37. data/doc/ex/clip_path.rb +56 -0
  38. data/doc/ex/coalesce.rb +60 -0
  39. data/doc/ex/color_fill_to_border.rb +29 -0
  40. data/doc/ex/color_floodfill.rb +28 -0
  41. data/doc/ex/color_histogram.rb +60 -0
  42. data/doc/ex/color_reset.rb +11 -0
  43. data/doc/ex/colorize.rb +16 -0
  44. data/doc/ex/colors.rb +65 -0
  45. data/doc/ex/composite.rb +135 -0
  46. data/doc/ex/contrast.rb +37 -0
  47. data/doc/ex/crop.rb +31 -0
  48. data/doc/ex/crop_with_gravity.rb +46 -0
  49. data/doc/ex/cycle_colormap.rb +21 -0
  50. data/doc/ex/demo.rb +324 -0
  51. data/doc/ex/drawcomp.rb +42 -0
  52. data/doc/ex/drop_shadow.rb +60 -0
  53. data/doc/ex/edge.rb +11 -0
  54. data/doc/ex/ellipse.rb +43 -0
  55. data/doc/ex/emboss.rb +11 -0
  56. data/doc/ex/enhance.rb +28 -0
  57. data/doc/ex/equalize.rb +11 -0
  58. data/doc/ex/flatten_images.rb +38 -0
  59. data/doc/ex/flip.rb +11 -0
  60. data/doc/ex/flop.rb +11 -0
  61. data/doc/ex/fonts.rb +20 -0
  62. data/doc/ex/frame.rb +12 -0
  63. data/doc/ex/gaussian_blur.rb +11 -0
  64. data/doc/ex/get_multiline_type_metrics.rb +53 -0
  65. data/doc/ex/get_pixels.rb +48 -0
  66. data/doc/ex/get_type_metrics.rb +140 -0
  67. data/doc/ex/gradientfill.rb +27 -0
  68. data/doc/ex/grav.rb +44 -0
  69. data/doc/ex/gravity.rb +80 -0
  70. data/doc/ex/hatchfill.rb +27 -0
  71. data/doc/ex/images/Ballerina.jpg +0 -0
  72. data/doc/ex/images/Ballerina3.jpg +0 -0
  73. data/doc/ex/images/Button_0.gif +0 -0
  74. data/doc/ex/images/Button_1.gif +0 -0
  75. data/doc/ex/images/Button_2.gif +0 -0
  76. data/doc/ex/images/Button_3.gif +0 -0
  77. data/doc/ex/images/Button_4.gif +0 -0
  78. data/doc/ex/images/Button_5.gif +0 -0
  79. data/doc/ex/images/Button_6.gif +0 -0
  80. data/doc/ex/images/Button_7.gif +0 -0
  81. data/doc/ex/images/Button_8.gif +0 -0
  82. data/doc/ex/images/Button_9.gif +0 -0
  83. data/doc/ex/images/Button_A.gif +0 -0
  84. data/doc/ex/images/Button_B.gif +0 -0
  85. data/doc/ex/images/Button_C.gif +0 -0
  86. data/doc/ex/images/Button_D.gif +0 -0
  87. data/doc/ex/images/Button_E.gif +0 -0
  88. data/doc/ex/images/Button_F.gif +0 -0
  89. data/doc/ex/images/Button_G.gif +0 -0
  90. data/doc/ex/images/Button_H.gif +0 -0
  91. data/doc/ex/images/Button_I.gif +0 -0
  92. data/doc/ex/images/Button_J.gif +0 -0
  93. data/doc/ex/images/Button_K.gif +0 -0
  94. data/doc/ex/images/Button_L.gif +0 -0
  95. data/doc/ex/images/Button_M.gif +0 -0
  96. data/doc/ex/images/Button_N.gif +0 -0
  97. data/doc/ex/images/Button_O.gif +0 -0
  98. data/doc/ex/images/Button_P.gif +0 -0
  99. data/doc/ex/images/Button_Q.gif +0 -0
  100. data/doc/ex/images/Button_R.gif +0 -0
  101. data/doc/ex/images/Button_S.gif +0 -0
  102. data/doc/ex/images/Button_T.gif +0 -0
  103. data/doc/ex/images/Button_U.gif +0 -0
  104. data/doc/ex/images/Button_V.gif +0 -0
  105. data/doc/ex/images/Button_W.gif +0 -0
  106. data/doc/ex/images/Button_X.gif +0 -0
  107. data/doc/ex/images/Button_Y.gif +0 -0
  108. data/doc/ex/images/Button_Z.gif +0 -0
  109. data/doc/ex/images/Cheetah.jpg +0 -0
  110. data/doc/ex/images/Coffee.wmf +0 -0
  111. data/doc/ex/images/Flower_Hat.jpg +0 -0
  112. data/doc/ex/images/Gold_Statue.jpg +0 -0
  113. data/doc/ex/images/Hot_Air_Balloons.jpg +0 -0
  114. data/doc/ex/images/Hot_Air_Balloons_H.jpg +0 -0
  115. data/doc/ex/images/No.wmf +0 -0
  116. data/doc/ex/images/Polynesia.jpg +0 -0
  117. data/doc/ex/images/Red_Rocks.jpg +0 -0
  118. data/doc/ex/images/Shorts.jpg +0 -0
  119. data/doc/ex/images/Snake.wmf +0 -0
  120. data/doc/ex/images/Violin.jpg +0 -0
  121. data/doc/ex/images/graydient230x6.gif +0 -0
  122. data/doc/ex/images/logo400x83.gif +0 -0
  123. data/doc/ex/images/model.miff +0 -0
  124. data/doc/ex/images/notimplemented.gif +0 -0
  125. data/doc/ex/images/smile.miff +0 -0
  126. data/doc/ex/images/spin.gif +0 -0
  127. data/doc/ex/implode.rb +32 -0
  128. data/doc/ex/level.rb +12 -0
  129. data/doc/ex/level_channel.rb +33 -0
  130. data/doc/ex/line.rb +40 -0
  131. data/doc/ex/map.rb +28 -0
  132. data/doc/ex/map_f.rb +15 -0
  133. data/doc/ex/matte_fill_to_border.rb +42 -0
  134. data/doc/ex/matte_floodfill.rb +35 -0
  135. data/doc/ex/matte_replace.rb +42 -0
  136. data/doc/ex/median_filter.rb +28 -0
  137. data/doc/ex/modulate.rb +11 -0
  138. data/doc/ex/mono.rb +23 -0
  139. data/doc/ex/morph.rb +26 -0
  140. data/doc/ex/mosaic.rb +35 -0
  141. data/doc/ex/motion_blur.rb +11 -0
  142. data/doc/ex/negate.rb +11 -0
  143. data/doc/ex/negate_channel.rb +19 -0
  144. data/doc/ex/normalize.rb +11 -0
  145. data/doc/ex/oil_paint.rb +11 -0
  146. data/doc/ex/opacity.rb +38 -0
  147. data/doc/ex/opaque.rb +14 -0
  148. data/doc/ex/ordered_dither.rb +11 -0
  149. data/doc/ex/path.rb +62 -0
  150. data/doc/ex/pattern1.rb +25 -0
  151. data/doc/ex/pattern2.rb +26 -0
  152. data/doc/ex/polygon.rb +24 -0
  153. data/doc/ex/polyline.rb +23 -0
  154. data/doc/ex/posterize.rb +19 -0
  155. data/doc/ex/preview.rb +16 -0
  156. data/doc/ex/qbezierpath.rb +49 -0
  157. data/doc/ex/quantize-m.rb +25 -0
  158. data/doc/ex/radial_blur.rb +19 -0
  159. data/doc/ex/raise.rb +11 -0
  160. data/doc/ex/random_channel_threshold.rb +17 -0
  161. data/doc/ex/random_threshold_channel.rb +18 -0
  162. data/doc/ex/rectangle.rb +33 -0
  163. data/doc/ex/reduce_noise.rb +28 -0
  164. data/doc/ex/roll.rb +9 -0
  165. data/doc/ex/rotate.rb +43 -0
  166. data/doc/ex/rotate_f.rb +14 -0
  167. data/doc/ex/roundrect.rb +32 -0
  168. data/doc/ex/rubyname.rb +31 -0
  169. data/doc/ex/segment.rb +11 -0
  170. data/doc/ex/shade.rb +11 -0
  171. data/doc/ex/shave.rb +15 -0
  172. data/doc/ex/shear.rb +10 -0
  173. data/doc/ex/skewx.rb +50 -0
  174. data/doc/ex/skewy.rb +45 -0
  175. data/doc/ex/smile.rb +124 -0
  176. data/doc/ex/solarize.rb +11 -0
  177. data/doc/ex/splice.rb +16 -0
  178. data/doc/ex/spread.rb +11 -0
  179. data/doc/ex/stegano.rb +50 -0
  180. data/doc/ex/stroke_dasharray.rb +41 -0
  181. data/doc/ex/stroke_linecap.rb +44 -0
  182. data/doc/ex/stroke_linejoin.rb +48 -0
  183. data/doc/ex/stroke_width.rb +47 -0
  184. data/doc/ex/swirl.rb +17 -0
  185. data/doc/ex/text.rb +32 -0
  186. data/doc/ex/text_align.rb +36 -0
  187. data/doc/ex/text_antialias.rb +33 -0
  188. data/doc/ex/text_undercolor.rb +26 -0
  189. data/doc/ex/texture_fill_to_border.rb +34 -0
  190. data/doc/ex/texture_floodfill.rb +31 -0
  191. data/doc/ex/texturefill.rb +25 -0
  192. data/doc/ex/threshold.rb +13 -0
  193. data/doc/ex/to_blob.rb +14 -0
  194. data/doc/ex/translate.rb +37 -0
  195. data/doc/ex/transparent.rb +38 -0
  196. data/doc/ex/trim.rb +25 -0
  197. data/doc/ex/unsharp_mask.rb +28 -0
  198. data/doc/ex/viewex.rb +36 -0
  199. data/doc/ex/wave.rb +9 -0
  200. data/doc/ilist.html +1592 -0
  201. data/doc/image1.html +3009 -0
  202. data/doc/image2.html +2169 -0
  203. data/doc/image3.html +2815 -0
  204. data/doc/imageattrs.html +1319 -0
  205. data/doc/imusage.html +403 -0
  206. data/doc/index.html +418 -0
  207. data/doc/info.html +949 -0
  208. data/doc/magick.html +439 -0
  209. data/doc/scripts/doc.js +9 -0
  210. data/doc/struct.html +1334 -0
  211. data/doc/usage.html +1318 -0
  212. data/examples/describe.rb +44 -0
  213. data/examples/histogram.rb +289 -0
  214. data/examples/image_opacity.rb +29 -0
  215. data/examples/import_export.rb +31 -0
  216. data/examples/pattern_fill.rb +38 -0
  217. data/examples/rotating_text.rb +47 -0
  218. data/examples/thumbnail.rb +65 -0
  219. data/examples/vignette.rb +79 -0
  220. data/ext/RMagick/MANIFEST +239 -0
  221. data/ext/RMagick/extconf.rb.in +21 -0
  222. data/ext/RMagick/rmagick.h +938 -0
  223. data/ext/RMagick/rmagick_config.h.in +170 -0
  224. data/ext/RMagick/rmdraw.c +1308 -0
  225. data/ext/RMagick/rmfill.c +609 -0
  226. data/ext/RMagick/rmilist.c +685 -0
  227. data/ext/RMagick/rmimage.c +7980 -0
  228. data/ext/RMagick/rminfo.c +982 -0
  229. data/ext/RMagick/rmmain.c +1497 -0
  230. data/ext/RMagick/rmutil.c +2685 -0
  231. data/install.rb +1015 -0
  232. data/lib/RMagick.rb +1486 -0
  233. data/metaconfig.in +6 -0
  234. data/post-clean.rb +12 -0
  235. data/post-install.rb +36 -0
  236. data/post-setup.rb +245 -0
  237. data/rmagick.gemspec +22 -0
  238. data/uninstall.rb +71 -0
  239. metadata +286 -0
data/doc/comtasks.html ADDED
@@ -0,0 +1,241 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
+
4
+ <html xmlns="http://www.w3.org/1999/xhtml">
5
+ <head>
6
+ <meta name="generator" content=
7
+ "HTML Tidy for Linux/x86 (vers 1st July 2004), see www.w3.org" />
8
+
9
+ <title>RMagick: Common Tasks</title>
10
+ <meta http-equiv="Content-Type" content=
11
+ "text/html; charset=us-ascii" />
12
+ <meta name="GENERATOR" content="Quanta Plus" />
13
+ <meta name="Copyright" content=
14
+ "Copyright (C) 2004 by Timothy P. Hunter" />
15
+ <link rel="stylesheet" type="text/css" href="css/doc.css" />
16
+ <script type="text/javascript" src="scripts/doc.js">
17
+ </script>
18
+ <style type="text/css">
19
+ /*<![CDATA[*/
20
+
21
+ /* Styles local to this page. */
22
+ #drop_shadow {
23
+ margin-left: auto;
24
+ margin-right: auto;
25
+ width: 250px;
26
+ }
27
+
28
+
29
+ /*]]>*/
30
+ </style>
31
+ </head>
32
+
33
+ <body>
34
+ <h6 id="header">RMagick User's Guide and Reference</h6>
35
+
36
+ <div class="nav">
37
+ &laquo;&nbsp;<a href="imusage.html">Prev</a> | <a href=
38
+ "index.html">Contents</a> | <a href=
39
+ "magick.html">Next</a>&nbsp;&raquo;
40
+ </div>
41
+
42
+ <h1>Common Tasks</h1>
43
+
44
+ <div id="toc">
45
+ <h2>Table of Contents</h2>
46
+
47
+ <ul style="margin-left: 15px; padding-top: 1em">
48
+ <li><a href="#info">Getting information about an
49
+ image</a></li>
50
+
51
+ <li><a href="#convert">Converting an image to another
52
+ format</a></li>
53
+
54
+ <li><a href="#thumb">Making thumbnails</a></li>
55
+
56
+ <li><a href="#resizing">Resizing to a maximum (or minimum)
57
+ size</a></li>
58
+
59
+ <li><a href="#gray">Converting a color image to
60
+ grayscale</a></li>
61
+
62
+ <li><a href="#compressing">Compressing image files</a></li>
63
+
64
+ <li><a href="#shadow">Making a drop shadow</a></li>
65
+
66
+ </ul>
67
+ </div>
68
+
69
+ <h2 id="info">Getting information about an image</h2>
70
+
71
+ <p>One of the most fundamental operations on an image is simply
72
+ getting basic information about the image. RMagick assigns dozens
73
+ of <a href="imageattrs.html">attributes</a> to an image. All you
74
+ have to do is read the image and then call the attribute methods.
75
+ Here's a Ruby program that takes image filenames from the command
76
+ line and then prints a variety of information about each image to
77
+ the terminal.</p>
78
+ <pre class="example">
79
+ require 'RMagick'
80
+ ARGV.each { |file|
81
+ puts file
82
+ img = Magick::Image::read(file).first
83
+ puts " Format: #{img.format}"
84
+ puts " Geometry: #{img.columns}x#{img.rows}"
85
+ puts " Class: " + case img.class_type
86
+ when Magick::DirectClass
87
+ "DirectClass"
88
+ when Magick::PseudoClass
89
+ "PseudoClass"
90
+ end
91
+ puts " Depth: #{img.depth} bits-per-pixel"
92
+ puts " Colors: #{img.number_colors}"
93
+ puts " Filesize: #{img.filesize}"
94
+ puts " Resolution: #{img.x_resolution.to_i}x#{img.y_resolution.to_i} "+
95
+ "pixels/#{img.units == Magick::PixelsPerInchResolution ?
96
+ "inch" : "centimeter"}"
97
+ if img.properties.length &gt; 0
98
+ puts " Properties:"
99
+ img.properties { |name,value|
100
+ puts %Q| #{name} = "#{value}"|
101
+ }
102
+ end
103
+ }
104
+ </pre>
105
+
106
+ <h2 id="convert">Converting an image to another format</h2>
107
+
108
+ <p>Converting an image to another format is as simple as writing
109
+ the image to a file. &times;Magick uses the output filename
110
+ suffix (".jpg" for JPEG, ".gif" for GIF, for example) or prefix
111
+ ("ps:" for PostScript, for example) to determine the format of
112
+ the output image.</p>
113
+
114
+ <h2 id="thumb">Making thumbnails</h2>
115
+
116
+ <p>RMagick gives you four different methods for resizing an
117
+ image: <a href="image3.html#resize"><code>resize</code></a>,
118
+ <a href="image3.html#sample"><code>sample</code></a>, <a href=
119
+ "image3.html#scale"><code>scale</code></a>, and <a href=
120
+ "image3.html#thumbnail"><code>thumbnail</code></a>. All four are
121
+ equally easy to use. Specify the number of columns and rows you
122
+ want the thumbnail to have, like this:</p>
123
+ <pre class="example">
124
+ img = Image.new "bigimage.gif"
125
+ thumb = img.scale(125, 125)
126
+ thumb.write "thumb.gif"
127
+ </pre>
128
+
129
+ <p>Alternatively, just pass a single <code>Float</code> argument
130
+ that represents the change in size. For example, to
131
+ proportionally reduce the size of an image to 25% of its original
132
+ size, do this:</p>
133
+ <pre class="example">
134
+ img = Image.new "bigimage.gif"
135
+ thumb = img.scale(0.25)
136
+ thumb.write "thumb.gif"
137
+ </pre>
138
+
139
+ <p>The <code>resize</code> method gives you more control by
140
+ allowing you to specify a <a href=
141
+ "constants.html#FilterType">filter</a> to use when scaling the
142
+ image. Some filters produce a better-looking thumbnail at the
143
+ expense of extra processing time. You can also use a
144
+ <code>blur</code> argument, which specifies how much blurriness
145
+ or sharpness the resize method should introduce.</p>
146
+
147
+ <p>The <code>sample</code> method, unlike the other two, does not
148
+ do any color interpolation when resizing.</p>
149
+
150
+ <p>The <code>thumbnail</code> method is faster than
151
+ <code>resize</code> if the thumbnail is less than 10% of the size
152
+ of the original image.</p>
153
+
154
+ <h2 id="resizing">Resizing to a maximum (or minimum) size</h2>
155
+
156
+ <p>Say you need to make all your thumbnails no bigger than 64x64
157
+ but with the same aspect ratio as the original. Or, you don't
158
+ want to resize the image if it's already smaller than 64x64. The
159
+ <a href=
160
+ "image1.html#change_geometry"><code>change_geometry</code></a>
161
+ method can help.</p>
162
+
163
+ <p>The <code>change_geometry</code> method accepts an
164
+ &times;Magick <a href="imusage.html#geometry">geometry string</a>
165
+ argument and a block. The geometry string specifies how to change
166
+ the image's size: one or two numbers to specify the new size and
167
+ optional flags to describe any constraints. The
168
+ <code>change_geometry</code> method parses the geometry string
169
+ and computes new width and height values. Then it calls the
170
+ block, passing the values it computed.</p>
171
+
172
+ <p>Within the block you can do whatever you want with the new
173
+ values. Typically you'll call one of the resize methods mentioned
174
+ in the previous section and make the resized image the return
175
+ value from the block. The <code>change_geometry</code> method
176
+ then returns that value to its caller.</p>
177
+
178
+ <h2 id="gray">Converting a color image to grayscale</h2>
179
+
180
+ <p>Use the <a href=
181
+ "image3.html#quantize"><code>quantize</code></a> method with the
182
+ <a href=
183
+ "constants.html#ColorspaceType">Magick::GRAYColorspace</a>
184
+ argument. If you want real "grayscale," quantize the image to 256
185
+ colors. If you want to convert a color image to black-and-white,
186
+ use 2 colors. See <a href=
187
+ "javascript:popup('demo.rb.html')">demo.rb</a>.</p>
188
+
189
+ <h2 id="compressing">Compressing image files</h2>
190
+
191
+ <p>Many image formats, including JPEG, PDF, and BMP, support
192
+ compressed image files. The type of compression used depends on
193
+ the format. Specify the compression type by assigning a <a href=
194
+ "constants.html#CompressionType">CompressionType</a> value to the
195
+ <a href="info.html#compression">compression</a> optional argument
196
+ to the <a href="image3.html#write">write</a> method.</p>
197
+
198
+ <p>The JPEGCompression and ZipCompression types support multiple
199
+ levels of compression. Use the <a href=
200
+ "info.html#quality">quality</a> optional argument to the
201
+ <code>write</code> method. The quality attribute is a number
202
+ between 0 and 100, with 100 representing the least compression.
203
+ When you compress an image using JPEGCompression, more
204
+ compression usually results in a lower-quality image. When you
205
+ compress an image using ZipCompression, more compression usually
206
+ takes longer.</p>
207
+
208
+ <p>For more information, see the &times;Magick documentation for
209
+ the <code>-quality</code> option to the utility commands.</p>
210
+ <pre class="example">
211
+ img.write("myimage.jpg") { self.quality = 50 }
212
+ </pre>
213
+
214
+ <h2 id="shadow">Making a drop shadow</h2>
215
+
216
+ <p>Here's one way to make a drop shadow behind text. Make the
217
+ shadow first by drawing the text in a light gray color. Position
218
+ the text slightly to the right and down from where the real text
219
+ will be. Then use the <a href=
220
+ "image1.html#blur_image"><code>blur_image</code></a> method to
221
+ make the shadow by blurring the text. Finally, draw the text
222
+ again in whatever color you want. <em>(Click the image to see the
223
+ Ruby program that created it.)</em></p>
224
+
225
+ <div id="drop_shadow">
226
+ <a href="javascript:popup('drop_shadow.rb.html')"><img src=
227
+ "ex/drop_shadow.gif" title="Click to see the example script"
228
+ alt="drop shadow example" /></a>
229
+ </div>
230
+
231
+ <hr />
232
+
233
+ <p class="spacer"> </p>
234
+
235
+ <div class="nav">
236
+ &laquo; <a href="imusage.html">Prev</a> | <a href=
237
+ "index.html">Contents</a> | <a href="magick.html">Next</a>
238
+ &raquo;
239
+ </div>
240
+ </body>
241
+ </html>
@@ -0,0 +1,1195 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
+
4
+ <html xmlns="http://www.w3.org/1999/xhtml">
5
+ <head>
6
+ <meta name="generator" content=
7
+ "HTML Tidy for Linux/x86 (vers 1st July 2003), see www.w3.org" />
8
+
9
+ <title>RMagick: Constants</title>
10
+ <meta http-equiv="Content-Type" content=
11
+ "text/html; charset=us-ascii" />
12
+ <meta name="GENERATOR" content="Quanta Plus" />
13
+ <meta name="Copyright" content=
14
+ "Copyright (C) 2004 by Timothy P. Hunter" />
15
+ <link rel="stylesheet" type="text/css" href="css/doc.css" />
16
+ <script type="text/javascript" src="scripts/doc.js">
17
+ </script>
18
+ <style type="text/css">
19
+ /*<![CDATA[*/
20
+
21
+ /* Styles local to this page. */
22
+ dl, p {
23
+ margin-left: 100px;
24
+ margin-right:100px;
25
+ }
26
+ dt {
27
+ font-family: monospace;
28
+ }
29
+
30
+ /*
31
+ * Deliberately similar styling to the .sig h3
32
+ */
33
+ h3.const {
34
+ background-color: #c0c0c0;
35
+ color: #000;
36
+ padding-left: 5px;
37
+ margin-top: 2em;
38
+ }
39
+
40
+ /*
41
+ * Modify .simple_table for the MaxRGB/QuantumDepth table.
42
+ * The major differences are the centered text and the auto width.
43
+ */
44
+ #maxrgb {
45
+ border-collapse: collapse;
46
+ border: thin solid black;
47
+ background-color: #f8f8f8;
48
+ margin-top: 1em;
49
+ margin-right: auto;
50
+ margin-bottom: 1em;
51
+ margin-left: auto;
52
+ text-align: center;
53
+ width: auto;
54
+ }
55
+ #maxrgb caption {
56
+ font-weight: bold;
57
+ }
58
+
59
+ /*]]>*/
60
+ </style>
61
+ </head>
62
+
63
+ <body>
64
+ <h6 id="header">RMagick User's Guide and Reference</h6>
65
+
66
+ <div class="nav">
67
+ &laquo;&nbsp;<a href="info.html">Prev</a> | <a href=
68
+ "index.html">Contents</a> | <a href=
69
+ "index.html">Next</a>&nbsp;&raquo;
70
+ </div>
71
+
72
+ <h1>Constants</h1>
73
+
74
+ <div id="toc">
75
+ <h2>Table of Contents</h2>
76
+
77
+ <h3>Constants</h3>
78
+
79
+ <div class="toccol">
80
+ <ul>
81
+ <li><a href="#Miscellaneous_constants">Miscellaneous
82
+ constants</a></li>
83
+
84
+ <li><a href="#AlignType">AlignType</a></li>
85
+
86
+ <li><a href="#ChannelType">ChannelType</a></li>
87
+
88
+ <li><a href="#ClassType">ClassType</a></li>
89
+
90
+ <li><a href="#ColorspaceType">ColorspaceType</a></li>
91
+
92
+ <li><a href="#ComplianceType">ComplianceType</a></li>
93
+
94
+ <li><a href="#CompositeOperator">CompositeOperator</a></li>
95
+
96
+ <li><a href="#CompressionType">CompressionType</a></li>
97
+ </ul>
98
+ </div>
99
+
100
+ <div class="toccol">
101
+ <ul>
102
+ <li><a href="#DecorationType">DecorationType</a></li>
103
+
104
+ <li><a href="#DisposeType">DisposeType</a></li>
105
+
106
+ <li><a href="#EndianType">EndianType</a></li>
107
+
108
+ <li><a href="#FilterType">FilterType</a></li>
109
+
110
+ <li><a href="#GravityType">GravityType</a></li>
111
+
112
+ <li><a href="#ImageType">ImageType</a></li>
113
+
114
+ <li><a href="#InterlaceType">InterlaceType</a></li>
115
+
116
+ <li><a href="#NoiseType">NoiseType</a></li>
117
+ </ul>
118
+ </div>
119
+
120
+ <div class="toccol">
121
+ <ul>
122
+ <li>&nbsp;</li>
123
+
124
+ <li><a href="#Opacity">Opacity</a></li>
125
+
126
+ <li><a href="#PaintMethod">PaintMethod</a></li>
127
+
128
+ <li><a href="#RenderingIntent">RenderingIntent</a></li>
129
+
130
+ <li><a href="#ResolutionType">ResolutionType</a></li>
131
+
132
+ <li><a href="#StretchType">StretchType</a></li>
133
+
134
+ <li><a href="#StyleType">StyleType</a></li>
135
+
136
+ <li><a href="#WeightType">WeightType</a></li>
137
+ </ul>
138
+ </div>
139
+ </div>
140
+
141
+ <h2 class="methods">Constants</h2>
142
+
143
+ <h3 class="const" style="margin-top:0" id=
144
+ "Miscellaneous_constants">Miscellaneous constants</h3>
145
+
146
+ <dl>
147
+ <dt>Long_version</dt>
148
+
149
+ <dd>An extended form of the <code>Version</code> constant with
150
+ the format shown here:<br />
151
+ <code>This is RMagick 1.4.0 ($Date: 2004/07/31 22:03:25 $)
152
+ Copyright (C) 2004 by Timothy P. Hunter<br />
153
+ Built with ImageMagick 6.0.0 02/25/04 Q8
154
+ http://www.imagemagick.org<br />
155
+ Built for ruby 1.8.1 (2003-12-25) [i686-linux]<br />
156
+ Web page: http://rmagick.rubyforge.org<br />
157
+ Email: rmagick@rubyforge.org</code></dd>
158
+
159
+ <dt>MagickVersion</dt>
160
+
161
+ <dd>The &times;Magick version string. This has the form:<br />
162
+ <code>@(#)ImageMagick X.Y.Z MM/DD/YY Q:16
163
+ http://www.imagemagick.org</code><br />
164
+ or<br />
165
+ <code>GraphicsMagick 1.0 05/05/03 Q8
166
+ http://www.GraphicsMagick.org/</code></dd>
167
+
168
+ <dt>MaxRGB</dt>
169
+
170
+ <dd>The maximum value of a <em>Quantum</em>. A quantum is one
171
+ of the red, green, blue, or opacity elements of a pixel in the
172
+ RGB colorspace, or cyan, yellow, magenta, or black elements in
173
+ the CYMK colorspace.</dd>
174
+
175
+ <dt>QuantumDepth</dt>
176
+
177
+ <dd>
178
+ The number of bits in a quantum. The relationship between
179
+ QuantumDepth and MaxRGB is summarized in this table.
180
+
181
+ <table summary="number of bits in a quantum" id="maxrgb">
182
+ <caption>
183
+ How MaxRGB and QuantumDepth are related
184
+ </caption>
185
+
186
+ <tr>
187
+ <th>QuantumDepth</th>
188
+
189
+ <th>MaxRGB</th>
190
+ </tr>
191
+
192
+ <tr>
193
+ <td>8</td>
194
+
195
+ <td>255</td>
196
+ </tr>
197
+
198
+ <tr>
199
+ <td>16</td>
200
+
201
+ <td>65535</td>
202
+ </tr>
203
+
204
+ <tr>
205
+ <td>32</td>
206
+
207
+ <td>4294967295</td>
208
+ </tr>
209
+ </table>
210
+ </dd>
211
+
212
+ <dt>Version</dt>
213
+
214
+ <dd>The RMagick version string. This has the form:<br />
215
+ <code>RMagick major.minor.teeny</code></dd>
216
+ </dl>
217
+
218
+ <h3 class="const" id="AlignType">AlignType</h3>
219
+
220
+ <p>Specify text alignment. See <a href=
221
+ "draw.html#Draw.align_eq">align=</a>, <a href=
222
+ "draw.html#Draw.text_align">text_align</a>.</p>
223
+
224
+ <dl>
225
+ <dt>UndefinedAlign</dt>
226
+
227
+ <dt>LeftAlign</dt>
228
+
229
+ <dt>CenterAlign</dt>
230
+
231
+ <dt>RightAlign</dt>
232
+ </dl>
233
+
234
+ <h3 class="const" id="ChannelType">ChannelType</h3>
235
+
236
+ <p>Specify an image channel. See <a href=
237
+ "image1.html#channel">channel</a>.</p>
238
+
239
+ <dl>
240
+ <dt>UndefinedChannel</dt>
241
+
242
+ <dt>RedChannel</dt>
243
+
244
+ <dt>GreenChannel</dt>
245
+
246
+ <dt>BlueChannel</dt>
247
+
248
+ <dt>MagentaChannel</dt>
249
+
250
+ <dt>YellowChannel</dt>
251
+
252
+ <dt>BlackChannel</dt>
253
+
254
+ <dt>OpacityChannel</dt>
255
+
256
+ <dt>AllChannels</dt>
257
+ </dl>
258
+
259
+ <h3 class="const" id="ClassType">ClassType</h3>
260
+
261
+ <p>Specify the image storage class. See <a href=
262
+ "imageattrs.html#class_type">class_type</a>.</p>
263
+
264
+ <dl>
265
+ <dt>UndefinedClass</dt>
266
+
267
+ <dd>No storage class has been specified.</dd>
268
+
269
+ <dt>DirectClass</dt>
270
+
271
+ <dd class="imquote">Image is composed of pixels which represent
272
+ literal color values.</dd>
273
+
274
+ <dt>PseudoClass</dt>
275
+
276
+ <dd class="imquote">Image is composed of pixels which specify
277
+ an index in a color palette.</dd>
278
+ </dl>
279
+
280
+ <h3 class="const" id="ColorspaceType">ColorspaceType</h3>
281
+
282
+ <p class="imquote">Specify the colorspace that quantization
283
+ (color reduction and mapping) is done under or to specify the
284
+ colorspace when encoding an output image. Colorspaces are ways of
285
+ describing colors to fit the requirements of a particular
286
+ application (e.g. Television, offset printing, color
287
+ monitors).&nbsp; Color reduction, by default, takes place in the
288
+ RGBColorspace. Empirical evidence suggests that distances in
289
+ color spaces such as YUVColorspace or YIQColorspace correspond to
290
+ perceptual color differences more closely than do distances in
291
+ RGB space. These color spaces may give better results when color
292
+ reducing an image.</p>
293
+
294
+ <p><span class="imquote">When encoding an output image, the
295
+ colorspaces RGBColorspace, CMYKColorspace, and GRAYColorspace may
296
+ be specified. The CMYKColorspace option is only applicable when
297
+ writing TIFF, JPEG, and Adobe Photoshop bitmap (PSD)
298
+ files.</span> See <a href=
299
+ "imageattrs.html#colorspace">colorspace</a>.</p>
300
+
301
+ <dl>
302
+ <dt>UndefinedColorspace</dt>
303
+
304
+ <dd>No colorspace has been specified.</dd>
305
+
306
+ <dt>RGBColorspace</dt>
307
+
308
+ <dd class="imquote">Red-Green-Blue colorspace</dd>
309
+
310
+ <dt>GRAYColorspace</dt>
311
+
312
+ <dd>&nbsp;</dd>
313
+
314
+ <dt>TransparentColorspace</dt>
315
+
316
+ <dd class="imquote">The Transparent color space behaves
317
+ uniquely in that it preserves the matte channel of the image if
318
+ it exists.</dd>
319
+
320
+ <dt>OHTAColorspace</dt>
321
+
322
+ <dd>&nbsp;</dd>
323
+
324
+ <dt>XYZColorspace</dt>
325
+
326
+ <dd>&nbsp;</dd>
327
+
328
+ <dt>YCbCrColorspace</dt>
329
+
330
+ <dd>&nbsp;</dd>
331
+
332
+ <dt>YIQColorspace</dt>
333
+
334
+ <dd>&nbsp;</dd>
335
+
336
+ <dt>YPbPrColorspace</dt>
337
+
338
+ <dd>&nbsp;</dd>
339
+
340
+ <dt>YUVColorspace</dt>
341
+
342
+ <dd class="imquote">Y-signal, U-signal, and V-signal
343
+ colorspace. YUV is most widely used to encode color for use in
344
+ television transmission.</dd>
345
+
346
+ <dt>CMYKColorspace</dt>
347
+
348
+ <dd class="imquote">Cyan-Magenta-Yellow-Black colorspace. CYMK
349
+ is a subtractive color system used by printers and
350
+ photographers for the rendering of colors with ink or emulsion,
351
+ normally on a white surface.</dd>
352
+
353
+ <dt>SRGBColorspace</dt>
354
+
355
+ <dd>In &times;Magick, this constant is named sRGBColorspace,
356
+ but since Ruby constants must start with an uppercase letter, I
357
+ had to change it.</dd>
358
+
359
+ <dt>HSLColorspace</dt>
360
+
361
+ <dd>Available in ImageMagick 5.5.7.</dd>
362
+
363
+ <dt>HWBColorspace</dt>
364
+
365
+ <dd>Available in ImageMagick 5.5.7.</dd>
366
+ </dl>
367
+
368
+ <h3 class="const" id="ComplianceType">ComplianceType</h3>
369
+
370
+ <p>Specify the color standard from which color names are chosen.
371
+ See <a href="struct.html#Pixel">to_color</a>.</p>
372
+
373
+ <dl>
374
+ <dt>SVGCompliance</dt>
375
+
376
+ <dd>Adhere to SVG color standard.</dd>
377
+
378
+ <dt>X11Compliance</dt>
379
+
380
+ <dd>Adhere to X11 color standard.</dd>
381
+
382
+ <dt>XPMCompliance</dt>
383
+
384
+ <dd>Adhere to XPM color standard.</dd>
385
+
386
+ <dt>AllCompliance</dt>
387
+
388
+ <dd>The union of the 3 color standards.</dd>
389
+ </dl>
390
+
391
+ <h3 class="const" id="CompositeOperator">CompositeOperator</h3>
392
+
393
+ <p><span class="imquote">Select the image composition algorithm
394
+ used to compose a <code>composite image</code> with a
395
+ <code>image</code>. By default, each of the <code>composite
396
+ image</code> pixels are replaced by the corresponding
397
+ <code>image</code> tile pixel. Specify
398
+ <code>CompositeOperator</code> to select a different
399
+ algorithm.</span> See <a href=
400
+ "image1.html#composite">composite</a>.</p>
401
+
402
+ <dl>
403
+ <dt>UndefinedCompositeOp</dt>
404
+
405
+ <dd>No composite operator has been specified.</dd>
406
+
407
+ <dt>OverCompositeOp</dt>
408
+
409
+ <dd><span class="imquote">The result is the union of the the
410
+ two image shapes with <code>composite image</code> obscuring
411
+ <code>image</code> in the region of overlap.</span> The matte
412
+ channel of the composite image is respected, so that if the
413
+ composite pixel is part or all transparent, the corresponding
414
+ image pixel will show through.</dd>
415
+
416
+ <dt>InCompositeOp</dt>
417
+
418
+ <dd class="imquote">The result is simply <code>composite
419
+ image</code> cut by the shape of <code>image</code>. None of
420
+ the image data of <code>image</code> is included in the
421
+ result.</dd>
422
+
423
+ <dt>OutCompositeOp</dt>
424
+
425
+ <dd class="imquote">The resulting image is <code>composite
426
+ image</code> with the shape of <code>image</code> cut out.</dd>
427
+
428
+ <dt>AtopCompositeOp</dt>
429
+
430
+ <dd class="imquote">The result is the same shape as
431
+ <code>image</code>, with <code>composite image</code> obscuring
432
+ <code>image</code> where the image shapes overlap. Note that
433
+ this differs from OverCompositeOp because the portion of
434
+ <code>composite image</code> outside of <code>image</code>'s
435
+ shape does not appear in the result.</dd>
436
+
437
+ <dt>XorCompositeOp</dt>
438
+
439
+ <dd class="imquote">The result is the image data from both
440
+ <code>composite image</code> and <code>image</code> that is
441
+ outside the overlap region. The overlap region will be
442
+ blank.</dd>
443
+
444
+ <dt>PlusCompositeOp</dt>
445
+
446
+ <dd class="imquote">The result is just the sum of
447
+ the&nbsp;image data. Output values are cropped to 255 (no
448
+ overflow). This operation is independent of the matte
449
+ channels.</dd>
450
+
451
+ <dt>MinusCompositeOp</dt>
452
+
453
+ <dd class="imquote">The result of composite image - image, with
454
+ overflow cropped to zero. The matte chanel is ignored (set to
455
+ 255, full coverage).</dd>
456
+
457
+ <dt>AddCompositeOp</dt>
458
+
459
+ <dd class="imquote">The result of <code>composite image</code>
460
+ + <code>image</code>, with overflow wrapping around (mod
461
+ 256).</dd>
462
+
463
+ <dt>SubtractCompositeOp</dt>
464
+
465
+ <dd class="imquote">The result of <code>composite image</code>
466
+ - <code>image</code>, with underflow wrapping around (mod 256).
467
+ The add and subtract operators can be used to perform
468
+ reversable transformations.</dd>
469
+
470
+ <dt>DifferenceCompositeOp</dt>
471
+
472
+ <dd class="imquote">The result of abs(<code>composite
473
+ image</code> - <code>image</code>). This is useful for
474
+ comparing two very similar images.</dd>
475
+
476
+ <dt>MultiplyCompositeOp</dt>
477
+
478
+ <dd class="imquote">Multiplies the color of each target image
479
+ pixel by the color of the corresponding composite image pixel.
480
+ The result color is always darker.</dd>
481
+
482
+ <dt>BumpmapCompositeOp</dt>
483
+
484
+ <dd class="imquote">The result <code>image</code> shaded by
485
+ <code>composite image</code>.</dd>
486
+
487
+ <dt>ReplaceCompositeOp</dt>
488
+
489
+ <dd class="imquote">The resulting image is image replaced with
490
+ composite image. Here the matte information is ignored.
491
+ Available in ImageMagick 6.0.0.</dd>
492
+
493
+ <dt>CopyCompositeOp</dt>
494
+
495
+ <dd>Replace the target image with the composite image.</dd>
496
+
497
+ <dt>CopyRedCompositeOp</dt>
498
+
499
+ <dd>Copy the red channel from the composite image to the target
500
+ image.</dd>
501
+
502
+ <dt>CopyGreenCompositeOp</dt>
503
+
504
+ <dd>Copy the green channel from the composite image to the
505
+ target image.</dd>
506
+
507
+ <dt>CopyBlueCompositeOp</dt>
508
+
509
+ <dd>Copy the blue channel from the composite image to the
510
+ target image.</dd>
511
+
512
+ <dt>CopyOpacityCompositeOp</dt>
513
+
514
+ <dd>If the composite image's <a href=
515
+ "imageattrs.html#matte">matte</a> attribute is
516
+ <code>true</code>, copy the opacity channel from the composite
517
+ image to the target image. Otherwise, set the target image
518
+ pixel's opacity to the intensity of the corresponding pixel in
519
+ the composite image.</dd>
520
+
521
+ <dt>ClearCompositeOp</dt>
522
+
523
+ <dd>Make the target image transparent. The composite image is
524
+ ignored.</dd>
525
+
526
+ <dt>DissolveCompositeOp</dt>
527
+
528
+ <dd>&nbsp;</dd>
529
+
530
+ <dt>DisplaceCompositeOp</dt>
531
+
532
+ <dd>Displace target image pixels as defined by a displacement
533
+ map. The amount of displacement can be controlled via the
534
+ <a href="imageattrs.html#geometry">geometry</a> attribute of
535
+ the composite image. The default is "20x20".</dd>
536
+
537
+ <dt>ModulateCompositeOp</dt>
538
+
539
+ <dd>&nbsp;</dd>
540
+
541
+ <dt>ThresholdCompositeOp</dt>
542
+
543
+ <dd>&nbsp;</dd>
544
+
545
+ <dt>NoCompositeOp</dt>
546
+
547
+ <dd>&nbsp;</dd>
548
+
549
+ <dt>DarkenCompositeOp</dt>
550
+
551
+ <dd>Replace target image pixels with darker pixels from the
552
+ composite image.</dd>
553
+
554
+ <dt>LightenCompositeOp</dt>
555
+
556
+ <dd>Replace target image pixels with lighter pixels from the
557
+ composite image.</dd>
558
+
559
+ <dt>HueCompositeOp</dt>
560
+
561
+ <dd>Each pixel in the result image is the combination of the
562
+ hue of the target image and the saturation and brightness of
563
+ the composite image.</dd>
564
+
565
+ <dt>SaturateCompositeOp</dt>
566
+
567
+ <dd>Each pixel in the result image is the combination of the
568
+ saturation of the target image and the hue and brightness of
569
+ the composite image.</dd>
570
+
571
+ <dt>ColorizeCompositeOp</dt>
572
+
573
+ <dd>Each pixel in the result image is the combination of the
574
+ brightness of the target image and the saturation and hue of
575
+ the composite image. This is the <em>opposite</em> of
576
+ LuminizeCompositeOp.</dd>
577
+
578
+ <dt>LuminizeCompositeOp</dt>
579
+
580
+ <dd>Each pixel in the result image is the combination of the
581
+ brightness of the composite image and the saturation and hue of
582
+ the target image. This is the <em>opposite</em> of
583
+ ColorizeCompositeOp.</dd>
584
+
585
+ <dt>ScreenCompositeOp</dt>
586
+
587
+ <dd>Multiplies the inverse of each image's color
588
+ information.</dd>
589
+
590
+ <dt>OverlayCompositeOp</dt>
591
+
592
+ <dd>&nbsp;</dd>
593
+
594
+ <dt>CopyCyanCompositeOp</dt>
595
+
596
+ <dd>Copy the cyan channel from the composite image to the
597
+ target image. Available in ImageMagick 5.5.7.</dd>
598
+
599
+ <dt>CopyMagentaCompositeOp</dt>
600
+
601
+ <dd>Copy the magenta channel from the composite image to the
602
+ target image. Available in ImageMagick 5.5.7.</dd>
603
+
604
+ <dt>CopyYellowCompositeOp</dt>
605
+
606
+ <dd>Copy the yellow channel from the composite image to the
607
+ target image. Available in ImageMagick 5.5.7.</dd>
608
+
609
+ <dt>CopyBlackCompositeOp</dt>
610
+
611
+ <dd>Copy the black channel from the composite image to the
612
+ target image. Available in ImageMagick 5.5.7.</dd>
613
+
614
+ <dt>DstAtopCompositeOp</dt>
615
+
616
+ <dd>Available in ImageMagick 6.0.0</dd>
617
+
618
+ <dt>DstCompositeOp</dt>
619
+
620
+ <dd>Available in ImageMagick 6.0.0</dd>
621
+
622
+ <dt>DstInCompositeOp</dt>
623
+
624
+ <dd>Available in ImageMagick 6.0.0</dd>
625
+
626
+ <dt>DstOutCompositeOp</dt>
627
+
628
+ <dd>Available in ImageMagick 6.0.0</dd>
629
+
630
+ <dt>DstOverCompositeOp</dt>
631
+
632
+ <dd>Available in ImageMagick 6.0.0</dd>
633
+
634
+ <dt>SrcAtopCompositeOp</dt>
635
+
636
+ <dd>Available in ImageMagick 6.0.0</dd>
637
+
638
+ <dt>SrcCompositeOp</dt>
639
+
640
+ <dd>Available in ImageMagick 6.0.0</dd>
641
+
642
+ <dt>SrcInCompositeOp</dt>
643
+
644
+ <dd>Available in ImageMagick 6.0.0</dd>
645
+
646
+ <dt>SrcOutCompositeOp</dt>
647
+
648
+ <dd>Available in ImageMagick 6.0.0</dd>
649
+
650
+ <dt>SrcOverCompositeOp</dt>
651
+
652
+ <dd>Available in ImageMagick 6.0.0</dd>
653
+
654
+ <dt>ColorDodgeCompositeOp</dt>
655
+
656
+ <dd>Available in ImageMagick 6.0.0</dd>
657
+
658
+ <dt>ExclusionCompositeOp</dt>
659
+
660
+ <dd>Available in ImageMagick 6.0.0</dd>
661
+
662
+ <dt>HardLightCompositeOp</dt>
663
+
664
+ <dd>Available in ImageMagick 6.0.0</dd>
665
+
666
+ <dt>SoftLightCompositeOp</dt>
667
+
668
+ <dd>Available in ImageMagick 6.0.0</dd>
669
+ </dl>
670
+
671
+ <h3 class="const" id="CompressionType">CompressionType</h3>
672
+
673
+ <p><span class="imquote">Express the desired compression type
674
+ when encoding an image. Be aware that most image types only
675
+ support a sub-set of the available compression types. If the
676
+ compression type specified is incompatable with the image,
677
+ &times;Magick selects a compression type compatable with the
678
+ image type.</span> See <a href=
679
+ "imageattrs.html#compression">compression</a>.</p>
680
+
681
+ <dl>
682
+ <dt>UndefinedCompression</dt>
683
+
684
+ <dd>No compression type has been specified.</dd>
685
+
686
+ <dt>NoCompression</dt>
687
+
688
+ <dd>The default for most formats.</dd>
689
+
690
+ <dt>BZipCompression</dt>
691
+
692
+ <dd class="imquote">BZip (Burrows-Wheeler block-sorting text
693
+ compression algorithm and Huffman coding)&nbsp; as used by
694
+ bzip2 utilities</dd>
695
+
696
+ <dt>FaxCompression</dt>
697
+
698
+ <dd class="imquote">CCITT Group 3 FAX compression</dd>
699
+
700
+ <dt>Group4Compression</dt>
701
+
702
+ <dd class="imquote">CCITT Group 4 FAX compression (used only
703
+ for TIFF)</dd>
704
+
705
+ <dt>JPEGCompression</dt>
706
+
707
+ <dd>JPEG compression. See <a href=
708
+ "http://www.faqs.org/faqs/jpeg-faq/part1/">The JPEG image
709
+ compression FAQ</a>.</dd>
710
+
711
+ <dt>LosslessJPEGCompression</dt>
712
+
713
+ <dd>This compression format is almost never used.</dd>
714
+
715
+ <dt>LZWCompression</dt>
716
+
717
+ <dd class="imquote">Lempel-Ziv-Welch (LZW) compression</dd>
718
+
719
+ <dt>RunlengthEncodedCompression</dt>
720
+
721
+ <dd>See the Wikipedia page for <a href=
722
+ "http://en.wikipedia.org/wiki/Run_length_encoding">Run-length
723
+ encoding</a>.</dd>
724
+
725
+ <dt>ZipCompression</dt>
726
+
727
+ <dd class="imquote">Lempel-Ziv compression (LZ77) as used in
728
+ PKZIP and GNU gzip.</dd>
729
+ </dl>
730
+
731
+ <h3 class="const" id="DecorationType">DecorationType</h3>
732
+
733
+ <p>Use with the <a href="draw.html#decorate">decorate=</a> method
734
+ in the Draw class to specify the text decoration for the <a href=
735
+ "draw.html#annotate">annotate</a> method.</p>
736
+
737
+ <dl>
738
+ <dt>NoDecoration</dt>
739
+
740
+ <dd>Don't decorate the text.</dd>
741
+
742
+ <dt>UnderlineDecoration</dt>
743
+
744
+ <dd>Underline the text.</dd>
745
+
746
+ <dt>OverlineDecoration</dt>
747
+
748
+ <dd>Overline the text.</dd>
749
+
750
+ <dt>LineThroughDecoration</dt>
751
+
752
+ <dd>Draw a horizontal line through the middle of the text.</dd>
753
+ </dl>
754
+
755
+ <h3 class="const" id="DisposeType">DisposeType</h3>
756
+
757
+ <p>The value of the <a href="imageattrs.html#dispose">dispose</a>
758
+ attribute.</p>
759
+
760
+ <dl>
761
+ <dt>UndefinedDispose</dt>
762
+
763
+ <dt>NoneDispose</dt>
764
+
765
+ <dt>BackgroundDispose</dt>
766
+
767
+ <dt>PreviousDispose</dt>
768
+ </dl>
769
+
770
+ <h3 class="const" id="EndianType">EndianType</h3>
771
+
772
+ <p>The value of the <a href="imageattrs.html#endian">endian</a>
773
+ attribute.</p>
774
+
775
+ <dl>
776
+ <dt>UndefinedEndian</dt>
777
+
778
+ <dt>LSBEndian</dt>
779
+
780
+ <dt>MSBEndian</dt>
781
+ </dl>
782
+
783
+ <h3 class="const" id="FilterType">FilterType</h3>
784
+
785
+ <p><span class="imquote">Used to adjust the filter algorithm used
786
+ when resizing images. Different filters experience varying
787
+ degrees of success with various images and can take sigificantly
788
+ different amounts of processing time. &times;Magick uses the
789
+ LanczosFilter by default since this filter has been shown to
790
+ provide the best results for most images in a reasonable amount
791
+ of time. Other filter types (e.g. TriangleFilter) may execute
792
+ much faster but may show artifacts when the image is re-sized or
793
+ around diagonal lines. The only way to be sure is to test the
794
+ filter with sample images.</span> See <a href=
795
+ "image3.html#resize">resize</a>.</p>
796
+
797
+ <dl>
798
+ <dt>UndefinedFilter</dt>
799
+
800
+ <dt>PointFilter</dt>
801
+
802
+ <dt>BoxFilter</dt>
803
+
804
+ <dt>TriangleFilter</dt>
805
+
806
+ <dt>HermiteFilter</dt>
807
+
808
+ <dt>HanningFilter</dt>
809
+
810
+ <dt>HammingFilter</dt>
811
+
812
+ <dt>BlackmanFilter</dt>
813
+
814
+ <dt>GaussianFilter</dt>
815
+
816
+ <dt>QuadraticFilter</dt>
817
+
818
+ <dt>CubicFilter</dt>
819
+
820
+ <dt>CatromFilter</dt>
821
+
822
+ <dt>MitchellFilter</dt>
823
+
824
+ <dt>LanczosFilter</dt>
825
+
826
+ <dt>BesselFilter</dt>
827
+
828
+ <dt>SincFilter</dt>
829
+ </dl>
830
+
831
+ <h3 class="const" id="GravityType">GravityType</h3>
832
+
833
+ <p><span class="imquote">Specify positioning of an object (e.g.
834
+ text, image) within a bounding region (e.g. an image). Gravity
835
+ provides a convenient way to locate objects irrespective of the
836
+ size of the bounding region, in other words, you don't need to
837
+ provide absolute coordinates in order to position an object. A
838
+ common default for gravity is <em>NorthWestGravity</em>.</span>
839
+ See <a href="draw.html#annotate">annotate</a> and <a href=
840
+ "image1.html#composite">composite</a>.</p>
841
+
842
+ <dl>
843
+ <dt>ForgetGravity</dt>
844
+
845
+ <dd class="imquote">Don't use gravity.</dd>
846
+
847
+ <dt>NorthWestGravity</dt>
848
+
849
+ <dd class="imquote">Position object at top-left of region</dd>
850
+
851
+ <dt>NorthGravity</dt>
852
+
853
+ <dd class="imquote">Postiion object at top-center of
854
+ region</dd>
855
+
856
+ <dt>NorthEastGravity</dt>
857
+
858
+ <dd class="imquote">Position object at top-right of region</dd>
859
+
860
+ <dt>WestGravity</dt>
861
+
862
+ <dd class="imquote">Position object at left-center of
863
+ region</dd>
864
+
865
+ <dt>CenterGravity</dt>
866
+
867
+ <dd class="imquote">Position object at center of region</dd>
868
+
869
+ <dt>EastGravity</dt>
870
+
871
+ <dd class="imquote">Position object at right-center of
872
+ region</dd>
873
+
874
+ <dt>SouthWestGravity</dt>
875
+
876
+ <dd class="imquote">Position object at left-bottom of
877
+ region</dd>
878
+
879
+ <dt>SouthGravity</dt>
880
+
881
+ <dd class="imquote">Position object at bottom-center of
882
+ region</dd>
883
+
884
+ <dt>SouthEastGravity</dt>
885
+
886
+ <dd class="imquote">Position object at bottom-right of
887
+ region</dd>
888
+ </dl>
889
+
890
+ <h3 class="const" id="ImageType">ImageType</h3>
891
+
892
+ <p>Indicate <span class="imquote">the type classification of the
893
+ image.</span> See <a href=
894
+ "imageattrs.html#image_type">image_type</a> and <a href=
895
+ "info.html#image_type_eq">image_type=</a>.</p>
896
+
897
+ <dl>
898
+ <dt>UndefinedType</dt>
899
+
900
+ <dd>No type has been specified.</dd>
901
+
902
+ <dt>BilevelType</dt>
903
+
904
+ <dd class="imquote">Monochrome image</dd>
905
+
906
+ <dt>GrayscaleType</dt>
907
+
908
+ <dd class="imquote">Grayscale image</dd>
909
+
910
+ <dt>PaletteType</dt>
911
+
912
+ <dd class="imquote">Indexed color (palette) image</dd>
913
+
914
+ <dt>PaletteMatteType</dt>
915
+
916
+ <dd class="imquote">Indexed color (palette) image with
917
+ opacity</dd>
918
+
919
+ <dt>TrueColorType</dt>
920
+
921
+ <dd class="imquote">Truecolor image</dd>
922
+
923
+ <dt>TrueColorMatteTypeType</dt>
924
+
925
+ <dd class="imquote">Truecolor image with opacity</dd>
926
+
927
+ <dt>ColorSeparationType</dt>
928
+
929
+ <dd class="imquote">Cyan/Yellow/Magenta/Black (CYMK) image</dd>
930
+
931
+ <dt>ColorSeparationMatteType</dt>
932
+
933
+ <dd>&nbsp;</dd>
934
+
935
+ <dt>OptimizeType</dt>
936
+
937
+ <dd>&nbsp;</dd>
938
+ </dl>
939
+
940
+ <h3 class="const" id="InterlaceType">InterlaceType</h3>
941
+
942
+ <p>Specify <span class="imquote">the ordering of the red, green,
943
+ and blue pixel information in the image. Interlacing is usually
944
+ used to make image information available to the user faster by
945
+ taking advantage of the space vs time tradeoff. For example,
946
+ interlacing allows images on the Web to be recognizable sooner
947
+ and satellite images to accumulate/render with image resolution
948
+ increasing over time. Use <code>LineInterlace</code> or
949
+ <code>PlaneInterlace</code> to create an interlaced GIF or
950
+ progressive JPEG image.</span> See <a href=
951
+ "imageattrs.html#interlace">interlace</a>.</p>
952
+
953
+ <dl>
954
+ <dt>UndefinedInterlace</dt>
955
+
956
+ <dd>No interlace type has been specified.</dd>
957
+
958
+ <dt>NoInterlace</dt>
959
+
960
+ <dd class="imquote">Don't interlace image
961
+ (RGBRGBRGBRGBRGBRGB...)</dd>
962
+
963
+ <dt>LineInterlace</dt>
964
+
965
+ <dd class="imquote">Use scanline interlacing
966
+ (RRR...GGG...BBB...RRR...GGG...BBB...)</dd>
967
+
968
+ <dt>PlaneInterlace</dt>
969
+
970
+ <dd class="imquote">Use plane interlacing
971
+ (RRRRRR...GGGGGG...BBBBBB...)</dd>
972
+
973
+ <dt>PartitionInterlace</dt>
974
+
975
+ <dd class="imquote">Similar to plane interlacing except that
976
+ the different planes are saved to individual files (e.g.
977
+ image.R, image.G, and image.B)</dd>
978
+ </dl>
979
+
980
+ <h3 class="const" id="NoiseType">NoiseType</h3>
981
+
982
+ <p><span class="imquote">Select the type of noise to be added to
983
+ the image.</span> See <a href=
984
+ "image1.html#add_noise">add_noise</a>.</p>
985
+
986
+ <dl>
987
+ <dt>UniformNoise</dt>
988
+
989
+ <dt>GaussianNoise</dt>
990
+
991
+ <dt>MultiplicativeGaussianNoise</dt>
992
+
993
+ <dt>ImpulseNoise</dt>
994
+
995
+ <dt>LaplacianNoise</dt>
996
+
997
+ <dt>PoissonNoise</dt>
998
+ </dl>
999
+
1000
+ <h3 class="const" id="Opacity">Opacity</h3>
1001
+
1002
+ <p>represent the maximum and minimum levels of opacity. You can
1003
+ specify a partial level of opacity by choosing a number between
1004
+ OpaqueOpacity and TransparentOpacity. For example, 25% opacity is
1005
+ <code>abs(Magick::TransparentOpacity-Magick::OpaqueOpacity) *
1006
+ 0.25</code></p>
1007
+
1008
+ <dl>
1009
+ <dt>TransparentOpacity</dt>
1010
+
1011
+ <dd>The minimum amount of opacity.</dd>
1012
+
1013
+ <dt>OpaqueOpacity</dt>
1014
+
1015
+ <dd>The maximum amount of opacity.</dd>
1016
+ </dl>
1017
+
1018
+ <h3 class="const" id="PaintMethod">PaintMethod</h3>
1019
+
1020
+ <p class="imquote">Specify how pixel colors are to be replaced in
1021
+ the image. See <a href=
1022
+ "image2.html#matte_floodfill">matte_floodfill</a> and <a href=
1023
+ "image3.html#texture_floodfill">texture_floodfill</a>.</p>
1024
+
1025
+ <dl>
1026
+ <dt>PointMethod</dt>
1027
+
1028
+ <dd class="imquote">Replace pixel color at point.</dd>
1029
+
1030
+ <dt>ReplaceMethod</dt>
1031
+
1032
+ <dd class="imquote">Replace color for all image pixels matching
1033
+ color at point.</dd>
1034
+
1035
+ <dt>FloodfillMethod</dt>
1036
+
1037
+ <dd class="imquote">Replace color for pixels surrounding point
1038
+ until encountering pixel that fails to match color at
1039
+ point.</dd>
1040
+
1041
+ <dt>FillToBorderMethod</dt>
1042
+
1043
+ <dd class="imquote">Replace color for pixels surrounding point
1044
+ until encountering pixels matching border color.</dd>
1045
+
1046
+ <dt>ResetMethod</dt>
1047
+
1048
+ <dd class="imquote">Replace colors for <strong>all</strong>
1049
+ pixels in image with fill color.</dd>
1050
+ </dl>
1051
+
1052
+ <h3 class="const" id="RenderingIntent">RenderingIntent</h3>
1053
+
1054
+ <p><span class="imquote">Rendering intent is a concept defined by
1055
+ ICC Spec ICC.1:1998-09, "File Format for Color Profiles".
1056
+ ImageMagick uses RenderingIntent in order to support ICC Color
1057
+ Profiles.</span></p>
1058
+
1059
+ <p class="imquote">From the specification: "Rendering intent
1060
+ specifies the style of reproduction to be used during the
1061
+ evaluation of this profile in a sequence of profiles. It applies
1062
+ specifically to that profile in the sequence and not to the
1063
+ entire sequence. Typically, the user or application will set the
1064
+ rendering intent dynamically at runtime or embedding time."</p>
1065
+
1066
+ <p>See <a href=
1067
+ "imageattrs.html#rendering_intent">rendering_intent</a>.</p>
1068
+
1069
+ <dl>
1070
+ <dt>UndefinedIntent</dt>
1071
+
1072
+ <dd>No intent has been specified.</dd>
1073
+
1074
+ <dt>SaturationIntent</dt>
1075
+
1076
+ <dd class="imquote">A rendering intent that specifies the
1077
+ saturation of the pixels in the image is preserved perhaps at
1078
+ the expense of accuracy in hue and lightness.</dd>
1079
+
1080
+ <dt>PerceptualIntent</dt>
1081
+
1082
+ <dd class="imquote">A rendering intent that specifies the full
1083
+ gamut of the image is compressed or expanded to fill the gamut
1084
+ of the destination device. Gray balance is preserved but
1085
+ colorimetric accuracy might not be preserved.</dd>
1086
+
1087
+ <dt>AbsoluteIntent</dt>
1088
+
1089
+ <dd class="imquote">Absolute colorimetric</dd>
1090
+
1091
+ <dt>RelativeIntent</dt>
1092
+
1093
+ <dd class="imquote">Relative colorimetric</dd>
1094
+ </dl>
1095
+
1096
+ <h3 class="const" id="ResolutionType">ResolutionType</h3>
1097
+
1098
+ <p><span class="imquote">By default, ImageMagick defines
1099
+ resolutions in pixels per inch. ResolutionType provides a means
1100
+ to adjust this.</span> See <a href=
1101
+ "imageattrs.html#units">units</a>.</p>
1102
+
1103
+ <dl>
1104
+ <dt>UndefinedResolution</dt>
1105
+
1106
+ <dd>No resolution has been specified.</dd>
1107
+
1108
+ <dt>PixelsPerInchResolution</dt>
1109
+
1110
+ <dd class="imquote">Density specifications are specified in
1111
+ units of pixels per inch (english units).</dd>
1112
+
1113
+ <dt>PixelsPerCentimeterResolution</dt>
1114
+
1115
+ <dd class="imquote">Density specifications are specified in
1116
+ units of pixels per centimeter (metric units).</dd>
1117
+ </dl>
1118
+
1119
+ <h3 class="const" id="StretchType">StretchType</h3>
1120
+
1121
+ <p>See <a href="draw.html#font_stretch_eq">font_stretch=</a>.</p>
1122
+
1123
+ <dl>
1124
+ <dt>NormalStretch</dt>
1125
+
1126
+ <dt>UltraCondensedStretch</dt>
1127
+
1128
+ <dt>ExtraCondensedStretch</dt>
1129
+
1130
+ <dt>CondensedStretch</dt>
1131
+
1132
+ <dt>SemiCondensedStretch</dt>
1133
+
1134
+ <dt>SemiExpandedStretch</dt>
1135
+
1136
+ <dt>ExpandedStretch</dt>
1137
+
1138
+ <dt>ExtraExpandedStretch</dt>
1139
+
1140
+ <dt>UltraExpandedStretch</dt>
1141
+
1142
+ <dt>AnyStretch</dt>
1143
+ </dl>
1144
+
1145
+ <h3 class="const" id="StyleType">StyleType</h3>
1146
+
1147
+ <p>See <a href="draw.html#font_style_eq">font_style=</a>.</p>
1148
+
1149
+ <dl>
1150
+ <dt>NormalStyle</dt>
1151
+
1152
+ <dt>ItalicStyle</dt>
1153
+
1154
+ <dt>ObliqueStyle</dt>
1155
+
1156
+ <dt>AnyStyle</dt>
1157
+ </dl>
1158
+
1159
+ <h3 class="const" id="WeightType">WeightType</h3>
1160
+
1161
+ <p>The font weight can be specified as one of 100, 200, 300, 400,
1162
+ 500, 600, 700, 800, or 900, or one of the following constants.
1163
+ See <a href="draw.html#font_weight_eq">font_weight=</a>.</p>
1164
+
1165
+ <dl>
1166
+ <dt>AnyWeight</dt>
1167
+
1168
+ <dd>No weight specfied.</dd>
1169
+
1170
+ <dt>NormalWeight</dt>
1171
+
1172
+ <dd>Equivalent to 400</dd>
1173
+
1174
+ <dt>BoldWeight</dt>
1175
+
1176
+ <dd>Equivalent to 700</dd>
1177
+
1178
+ <dt>BolderWeight</dt>
1179
+
1180
+ <dd>Increases weight by 100</dd>
1181
+
1182
+ <dt>LighterWeight</dt>
1183
+
1184
+ <dd>Decreases weight by 100</dd>
1185
+ </dl>
1186
+
1187
+ <p class="spacer">&nbsp;</p>
1188
+
1189
+ <div class="nav">
1190
+ &laquo;&nbsp;<a href="info.html">Prev</a> | <a href=
1191
+ "index.html">Contents</a> | <a href=
1192
+ "index.html">Next</a>&nbsp;&raquo;
1193
+ </div>
1194
+ </body>
1195
+ </html>