rmagick 4.1.0.rc2 → 4.1.0

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 (412) hide show
  1. checksums.yaml +4 -4
  2. data/.codeclimate.yml +63 -0
  3. data/.editorconfig +3 -0
  4. data/.github/workflows/ci.yml +148 -0
  5. data/.gitignore +3 -1
  6. data/.rspec +1 -0
  7. data/.rubocop.yml +24 -0
  8. data/.rubocop_todo.yml +80 -270
  9. data/.yardopts +5 -0
  10. data/CHANGELOG.md +63 -0
  11. data/CONTRIBUTING.md +14 -10
  12. data/README.md +292 -0
  13. data/Rakefile +16 -22
  14. data/before_install_linux.sh +22 -32
  15. data/before_install_osx.sh +56 -2
  16. data/ext/RMagick/extconf.rb +100 -94
  17. data/ext/RMagick/rmagick.c +77 -104
  18. data/ext/RMagick/rmagick.h +74 -70
  19. data/ext/RMagick/rmdraw.c +261 -444
  20. data/ext/RMagick/rmenum.c +96 -113
  21. data/ext/RMagick/rmfill.c +46 -77
  22. data/ext/RMagick/rmilist.c +136 -244
  23. data/ext/RMagick/rmimage.c +3395 -4166
  24. data/ext/RMagick/rminfo.c +531 -737
  25. data/ext/RMagick/rmkinfo.c +21 -87
  26. data/ext/RMagick/rmmain.c +405 -245
  27. data/ext/RMagick/rmmontage.c +60 -126
  28. data/ext/RMagick/rmpixel.c +401 -345
  29. data/ext/RMagick/rmstruct.c +62 -88
  30. data/ext/RMagick/rmutil.c +112 -218
  31. data/lib/rmagick/version.rb +1 -1
  32. data/lib/rmagick_internal.rb +128 -77
  33. data/lib/rvg/clippath.rb +2 -1
  34. data/lib/rvg/container.rb +10 -5
  35. data/lib/rvg/describable.rb +1 -1
  36. data/lib/rvg/embellishable.rb +5 -4
  37. data/lib/rvg/misc.rb +15 -12
  38. data/lib/rvg/paint.rb +2 -1
  39. data/lib/rvg/pathdata.rb +12 -11
  40. data/lib/rvg/rvg.rb +8 -4
  41. data/lib/rvg/stylable.rb +9 -7
  42. data/lib/rvg/text.rb +11 -6
  43. data/lib/rvg/transformable.rb +3 -2
  44. data/lib/rvg/units.rb +1 -1
  45. data/rmagick.gemspec +7 -6
  46. metadata +31 -421
  47. data/.appveyor.yml +0 -57
  48. data/.circleci/config.yml +0 -56
  49. data/.ruby-version +0 -1
  50. data/.simplecov +0 -27
  51. data/.travis.yml +0 -64
  52. data/Doxyfile +0 -1514
  53. data/README.textile +0 -259
  54. data/benchmarks/memory/README.md +0 -50
  55. data/benchmarks/memory/image_new.rb +0 -8
  56. data/benchmarks/memory/rmagick.gnuplot +0 -16
  57. data/doc/.cvsignore +0 -1
  58. data/doc/comtasks.html +0 -287
  59. data/doc/constants.html +0 -1581
  60. data/doc/css/doc.css +0 -299
  61. data/doc/css/popup.css +0 -34
  62. data/doc/css/ref.css +0 -67
  63. data/doc/draw.html +0 -3272
  64. data/doc/ex/InitialCoords.rb +0 -22
  65. data/doc/ex/NewCoordSys.rb +0 -30
  66. data/doc/ex/OrigCoordSys.rb +0 -16
  67. data/doc/ex/PreserveAspectRatio.rb +0 -204
  68. data/doc/ex/RotateScale.rb +0 -36
  69. data/doc/ex/Skew.rb +0 -38
  70. data/doc/ex/Use01.rb +0 -15
  71. data/doc/ex/Use02.rb +0 -20
  72. data/doc/ex/Use03.rb +0 -16
  73. data/doc/ex/ViewBox.rb +0 -31
  74. data/doc/ex/adaptive_threshold.rb +0 -9
  75. data/doc/ex/add_noise.rb +0 -16
  76. data/doc/ex/affine.rb +0 -48
  77. data/doc/ex/affine_transform.rb +0 -20
  78. data/doc/ex/arc.rb +0 -49
  79. data/doc/ex/arcpath.rb +0 -32
  80. data/doc/ex/arcs01.rb +0 -28
  81. data/doc/ex/arcs02.rb +0 -59
  82. data/doc/ex/average.rb +0 -15
  83. data/doc/ex/axes.rb +0 -64
  84. data/doc/ex/baseline_shift01.rb +0 -17
  85. data/doc/ex/bilevel_channel.rb +0 -8
  86. data/doc/ex/blur_image.rb +0 -12
  87. data/doc/ex/border.rb +0 -10
  88. data/doc/ex/bounding_box.rb +0 -42
  89. data/doc/ex/cbezier1.rb +0 -41
  90. data/doc/ex/cbezier2.rb +0 -41
  91. data/doc/ex/cbezier3.rb +0 -41
  92. data/doc/ex/cbezier4.rb +0 -42
  93. data/doc/ex/cbezier5.rb +0 -42
  94. data/doc/ex/cbezier6.rb +0 -53
  95. data/doc/ex/channel.rb +0 -25
  96. data/doc/ex/charcoal.rb +0 -12
  97. data/doc/ex/chop.rb +0 -29
  98. data/doc/ex/circle.rb +0 -33
  99. data/doc/ex/circle01.rb +0 -16
  100. data/doc/ex/clip_path.rb +0 -60
  101. data/doc/ex/coalesce.rb +0 -57
  102. data/doc/ex/color_fill_to_border.rb +0 -29
  103. data/doc/ex/color_floodfill.rb +0 -28
  104. data/doc/ex/color_histogram.rb +0 -47
  105. data/doc/ex/color_reset.rb +0 -11
  106. data/doc/ex/colorize.rb +0 -16
  107. data/doc/ex/colors.rb +0 -64
  108. data/doc/ex/compose_mask.rb +0 -22
  109. data/doc/ex/composite.rb +0 -133
  110. data/doc/ex/composite_layers.rb +0 -52
  111. data/doc/ex/composite_tiled.rb +0 -21
  112. data/doc/ex/contrast.rb +0 -36
  113. data/doc/ex/crop.rb +0 -31
  114. data/doc/ex/crop_with_gravity.rb +0 -42
  115. data/doc/ex/cubic01.rb +0 -43
  116. data/doc/ex/cubic02.rb +0 -91
  117. data/doc/ex/cycle_colormap.rb +0 -21
  118. data/doc/ex/dissolve.rb +0 -12
  119. data/doc/ex/drawcomp.rb +0 -41
  120. data/doc/ex/drop_shadow.rb +0 -60
  121. data/doc/ex/edge.rb +0 -11
  122. data/doc/ex/ellipse.rb +0 -45
  123. data/doc/ex/ellipse01.rb +0 -21
  124. data/doc/ex/emboss.rb +0 -11
  125. data/doc/ex/enhance.rb +0 -28
  126. data/doc/ex/equalize.rb +0 -11
  127. data/doc/ex/evenodd.rb +0 -42
  128. data/doc/ex/fill_pattern.rb +0 -23
  129. data/doc/ex/flatten_images.rb +0 -36
  130. data/doc/ex/flip.rb +0 -11
  131. data/doc/ex/flop.rb +0 -11
  132. data/doc/ex/font_styles.rb +0 -32
  133. data/doc/ex/fonts.rb +0 -16
  134. data/doc/ex/frame.rb +0 -12
  135. data/doc/ex/gaussian_blur.rb +0 -11
  136. data/doc/ex/get_multiline_type_metrics.rb +0 -41
  137. data/doc/ex/get_pixels.rb +0 -45
  138. data/doc/ex/get_type_metrics.rb +0 -142
  139. data/doc/ex/gradientfill.rb +0 -27
  140. data/doc/ex/grav.rb +0 -45
  141. data/doc/ex/gravity.rb +0 -78
  142. data/doc/ex/group.rb +0 -26
  143. data/doc/ex/hatchfill.rb +0 -27
  144. data/doc/ex/image.rb +0 -44
  145. data/doc/ex/images/Apple.miff +0 -0
  146. data/doc/ex/images/Ballerina.jpg +0 -0
  147. data/doc/ex/images/Ballerina3.jpg +0 -0
  148. data/doc/ex/images/Button_0.gif +0 -0
  149. data/doc/ex/images/Button_1.gif +0 -0
  150. data/doc/ex/images/Button_2.gif +0 -0
  151. data/doc/ex/images/Button_3.gif +0 -0
  152. data/doc/ex/images/Button_4.gif +0 -0
  153. data/doc/ex/images/Button_5.gif +0 -0
  154. data/doc/ex/images/Button_6.gif +0 -0
  155. data/doc/ex/images/Button_7.gif +0 -0
  156. data/doc/ex/images/Button_8.gif +0 -0
  157. data/doc/ex/images/Button_9.gif +0 -0
  158. data/doc/ex/images/Button_A.gif +0 -0
  159. data/doc/ex/images/Button_B.gif +0 -0
  160. data/doc/ex/images/Button_C.gif +0 -0
  161. data/doc/ex/images/Button_D.gif +0 -0
  162. data/doc/ex/images/Button_E.gif +0 -0
  163. data/doc/ex/images/Button_F.gif +0 -0
  164. data/doc/ex/images/Button_G.gif +0 -0
  165. data/doc/ex/images/Button_H.gif +0 -0
  166. data/doc/ex/images/Button_I.gif +0 -0
  167. data/doc/ex/images/Button_J.gif +0 -0
  168. data/doc/ex/images/Button_K.gif +0 -0
  169. data/doc/ex/images/Button_L.gif +0 -0
  170. data/doc/ex/images/Button_M.gif +0 -0
  171. data/doc/ex/images/Button_N.gif +0 -0
  172. data/doc/ex/images/Button_O.gif +0 -0
  173. data/doc/ex/images/Button_P.gif +0 -0
  174. data/doc/ex/images/Button_Q.gif +0 -0
  175. data/doc/ex/images/Button_R.gif +0 -0
  176. data/doc/ex/images/Button_S.gif +0 -0
  177. data/doc/ex/images/Button_T.gif +0 -0
  178. data/doc/ex/images/Button_U.gif +0 -0
  179. data/doc/ex/images/Button_V.gif +0 -0
  180. data/doc/ex/images/Button_W.gif +0 -0
  181. data/doc/ex/images/Button_X.gif +0 -0
  182. data/doc/ex/images/Button_Y.gif +0 -0
  183. data/doc/ex/images/Button_Z.gif +0 -0
  184. data/doc/ex/images/Cheetah.jpg +0 -0
  185. data/doc/ex/images/Coffee.png +0 -0
  186. data/doc/ex/images/Flower_Hat.jpg +0 -0
  187. data/doc/ex/images/Gold_Statue.jpg +0 -0
  188. data/doc/ex/images/Hot_Air_Balloons.jpg +0 -0
  189. data/doc/ex/images/Hot_Air_Balloons_H.jpg +0 -0
  190. data/doc/ex/images/Leaf.miff +0 -0
  191. data/doc/ex/images/No.png +0 -0
  192. data/doc/ex/images/Polynesia.jpg +0 -0
  193. data/doc/ex/images/Red_Rocks.jpg +0 -0
  194. data/doc/ex/images/Rocks_On_Beach.miff +0 -0
  195. data/doc/ex/images/Shorts.jpg +0 -0
  196. data/doc/ex/images/Snake.png +0 -0
  197. data/doc/ex/images/Violin.jpg +0 -0
  198. data/doc/ex/images/Yellow_Rose.miff +0 -0
  199. data/doc/ex/images/big-duck.gif +0 -0
  200. data/doc/ex/images/duck.gif +0 -0
  201. data/doc/ex/images/duck0.gif +0 -0
  202. data/doc/ex/images/duck1.gif +0 -0
  203. data/doc/ex/images/duck10.gif +0 -0
  204. data/doc/ex/images/duck11.gif +0 -0
  205. data/doc/ex/images/duck12.gif +0 -0
  206. data/doc/ex/images/duck13.gif +0 -0
  207. data/doc/ex/images/duck14.gif +0 -0
  208. data/doc/ex/images/duck15.gif +0 -0
  209. data/doc/ex/images/duck2.gif +0 -0
  210. data/doc/ex/images/duck3.gif +0 -0
  211. data/doc/ex/images/duck4.gif +0 -0
  212. data/doc/ex/images/duck5.gif +0 -0
  213. data/doc/ex/images/duck6.gif +0 -0
  214. data/doc/ex/images/duck7.gif +0 -0
  215. data/doc/ex/images/duck8.gif +0 -0
  216. data/doc/ex/images/duck9.gif +0 -0
  217. data/doc/ex/images/graydient230x6.gif +0 -0
  218. data/doc/ex/images/image_with_profile.jpg +0 -0
  219. data/doc/ex/images/logo400x83.gif +0 -0
  220. data/doc/ex/images/model.miff +0 -0
  221. data/doc/ex/images/notimplemented.gif +0 -0
  222. data/doc/ex/images/smile.miff +0 -0
  223. data/doc/ex/images/spin.gif +0 -0
  224. data/doc/ex/implode.rb +0 -34
  225. data/doc/ex/level.rb +0 -11
  226. data/doc/ex/level_colors.rb +0 -11
  227. data/doc/ex/line.rb +0 -41
  228. data/doc/ex/line01.rb +0 -21
  229. data/doc/ex/mask.rb +0 -35
  230. data/doc/ex/matte_fill_to_border.rb +0 -39
  231. data/doc/ex/matte_floodfill.rb +0 -32
  232. data/doc/ex/matte_replace.rb +0 -39
  233. data/doc/ex/median_filter.rb +0 -28
  234. data/doc/ex/modulate.rb +0 -11
  235. data/doc/ex/mono.rb +0 -23
  236. data/doc/ex/morph.rb +0 -25
  237. data/doc/ex/mosaic.rb +0 -37
  238. data/doc/ex/motion_blur.rb +0 -11
  239. data/doc/ex/negate.rb +0 -11
  240. data/doc/ex/negate_channel.rb +0 -9
  241. data/doc/ex/nested_rvg.rb +0 -21
  242. data/doc/ex/nonzero.rb +0 -42
  243. data/doc/ex/normalize.rb +0 -11
  244. data/doc/ex/oil_paint.rb +0 -11
  245. data/doc/ex/opacity.rb +0 -37
  246. data/doc/ex/ordered_dither.rb +0 -11
  247. data/doc/ex/path.rb +0 -63
  248. data/doc/ex/pattern1.rb +0 -25
  249. data/doc/ex/pattern2.rb +0 -26
  250. data/doc/ex/polaroid.rb +0 -26
  251. data/doc/ex/polygon.rb +0 -23
  252. data/doc/ex/polygon01.rb +0 -21
  253. data/doc/ex/polyline.rb +0 -22
  254. data/doc/ex/polyline01.rb +0 -21
  255. data/doc/ex/posterize.rb +0 -8
  256. data/doc/ex/preview.rb +0 -8
  257. data/doc/ex/qbezierpath.rb +0 -52
  258. data/doc/ex/quad01.rb +0 -34
  259. data/doc/ex/quantize-m.rb +0 -25
  260. data/doc/ex/radial_blur.rb +0 -9
  261. data/doc/ex/raise.rb +0 -8
  262. data/doc/ex/random_threshold_channel.rb +0 -13
  263. data/doc/ex/rect01.rb +0 -14
  264. data/doc/ex/rect02.rb +0 -20
  265. data/doc/ex/rectangle.rb +0 -34
  266. data/doc/ex/reduce_noise.rb +0 -28
  267. data/doc/ex/remap.rb +0 -11
  268. data/doc/ex/remap_images.rb +0 -19
  269. data/doc/ex/resize_to_fill.rb +0 -8
  270. data/doc/ex/resize_to_fit.rb +0 -8
  271. data/doc/ex/roll.rb +0 -9
  272. data/doc/ex/rotate.rb +0 -44
  273. data/doc/ex/rotate_f.rb +0 -14
  274. data/doc/ex/roundrect.rb +0 -33
  275. data/doc/ex/rubyname.rb +0 -30
  276. data/doc/ex/rvg_clippath.rb +0 -12
  277. data/doc/ex/rvg_linecap.rb +0 -42
  278. data/doc/ex/rvg_linejoin.rb +0 -40
  279. data/doc/ex/rvg_opacity.rb +0 -18
  280. data/doc/ex/rvg_pattern.rb +0 -26
  281. data/doc/ex/rvg_stroke_dasharray.rb +0 -11
  282. data/doc/ex/segment.rb +0 -11
  283. data/doc/ex/sepiatone.rb +0 -7
  284. data/doc/ex/shade.rb +0 -11
  285. data/doc/ex/shadow.rb +0 -30
  286. data/doc/ex/shave.rb +0 -15
  287. data/doc/ex/shear.rb +0 -10
  288. data/doc/ex/sketch.rb +0 -17
  289. data/doc/ex/skewx.rb +0 -51
  290. data/doc/ex/skewy.rb +0 -47
  291. data/doc/ex/smile.rb +0 -126
  292. data/doc/ex/solarize.rb +0 -11
  293. data/doc/ex/sparse_color.rb +0 -55
  294. data/doc/ex/splice.rb +0 -8
  295. data/doc/ex/spread.rb +0 -11
  296. data/doc/ex/stegano.rb +0 -54
  297. data/doc/ex/stroke_dasharray.rb +0 -42
  298. data/doc/ex/stroke_fill.rb +0 -10
  299. data/doc/ex/stroke_linecap.rb +0 -44
  300. data/doc/ex/stroke_linejoin.rb +0 -48
  301. data/doc/ex/stroke_width.rb +0 -49
  302. data/doc/ex/swirl.rb +0 -17
  303. data/doc/ex/text.rb +0 -37
  304. data/doc/ex/text01.rb +0 -16
  305. data/doc/ex/text_align.rb +0 -36
  306. data/doc/ex/text_antialias.rb +0 -37
  307. data/doc/ex/text_styles.rb +0 -19
  308. data/doc/ex/text_undercolor.rb +0 -28
  309. data/doc/ex/texture_fill_to_border.rb +0 -34
  310. data/doc/ex/texture_floodfill.rb +0 -32
  311. data/doc/ex/texturefill.rb +0 -24
  312. data/doc/ex/threshold.rb +0 -13
  313. data/doc/ex/to_blob.rb +0 -13
  314. data/doc/ex/translate.rb +0 -39
  315. data/doc/ex/transparent.rb +0 -38
  316. data/doc/ex/transpose.rb +0 -9
  317. data/doc/ex/transverse.rb +0 -9
  318. data/doc/ex/tref01.rb +0 -24
  319. data/doc/ex/triangle01.rb +0 -15
  320. data/doc/ex/trim.rb +0 -23
  321. data/doc/ex/tspan01.rb +0 -17
  322. data/doc/ex/tspan02.rb +0 -17
  323. data/doc/ex/tspan03.rb +0 -19
  324. data/doc/ex/unsharp_mask.rb +0 -28
  325. data/doc/ex/viewex.rb +0 -33
  326. data/doc/ex/vignette.rb +0 -12
  327. data/doc/ex/watermark.rb +0 -27
  328. data/doc/ex/wave.rb +0 -9
  329. data/doc/ex/wet_floor.rb +0 -58
  330. data/doc/ex/writing_mode01.rb +0 -26
  331. data/doc/ex/writing_mode02.rb +0 -26
  332. data/doc/ilist.html +0 -2056
  333. data/doc/image1.html +0 -4680
  334. data/doc/image2.html +0 -3665
  335. data/doc/image3.html +0 -4522
  336. data/doc/imageattrs.html +0 -1638
  337. data/doc/imusage.html +0 -514
  338. data/doc/index.html +0 -416
  339. data/doc/info.html +0 -1499
  340. data/doc/magick.html +0 -570
  341. data/doc/optequiv.html +0 -2435
  342. data/doc/rvg.html +0 -975
  343. data/doc/rvgclip.html +0 -248
  344. data/doc/rvggroup.html +0 -305
  345. data/doc/rvgimage.html +0 -289
  346. data/doc/rvgpattern.html +0 -475
  347. data/doc/rvgshape.html +0 -406
  348. data/doc/rvgstyle.html +0 -270
  349. data/doc/rvgtext.html +0 -465
  350. data/doc/rvgtspan.html +0 -238
  351. data/doc/rvgtut.html +0 -530
  352. data/doc/rvguse.html +0 -145
  353. data/doc/rvgxform.html +0 -294
  354. data/doc/scripts/doc.js +0 -22
  355. data/doc/scripts/stripeTables.js +0 -23
  356. data/doc/struct.html +0 -1339
  357. data/doc/usage.html +0 -1621
  358. data/examples/constitute.rb +0 -7
  359. data/examples/crop_with_gravity.rb +0 -43
  360. data/examples/demo.rb +0 -323
  361. data/examples/describe.rb +0 -41
  362. data/examples/find_similar_region.rb +0 -34
  363. data/examples/histogram.rb +0 -312
  364. data/examples/identify.rb +0 -174
  365. data/examples/image_opacity.rb +0 -28
  366. data/examples/import_export.rb +0 -31
  367. data/examples/pattern_fill.rb +0 -37
  368. data/examples/rotating_text.rb +0 -45
  369. data/examples/spinner.rb +0 -49
  370. data/examples/thumbnail.rb +0 -64
  371. data/examples/vignette.rb +0 -78
  372. data/spec/rmagick/ImageList1_spec.rb +0 -24
  373. data/spec/rmagick/draw_spec.rb +0 -155
  374. data/spec/rmagick/image/blue_shift_spec.rb +0 -14
  375. data/spec/rmagick/image/channel_entropy_spec.rb +0 -9
  376. data/spec/rmagick/image/composite_spec.rb +0 -72
  377. data/spec/rmagick/image/constitute_spec.rb +0 -13
  378. data/spec/rmagick/image/dispatch_spec.rb +0 -16
  379. data/spec/rmagick/image/dissolve_spec.rb +0 -54
  380. data/spec/rmagick/image/from_blob_spec.rb +0 -12
  381. data/spec/rmagick/image/ping_spec.rb +0 -12
  382. data/spec/rmagick/image/properties_spec.rb +0 -27
  383. data/spec/rmagick/image/read_spec.rb +0 -28
  384. data/spec/spec_helper.rb +0 -9
  385. data/spec/support/issue_200/app.rb +0 -8
  386. data/test/Draw.rb +0 -351
  387. data/test/Enum.rb +0 -228
  388. data/test/Fill.rb +0 -93
  389. data/test/Image1.rb +0 -606
  390. data/test/Image2.rb +0 -1408
  391. data/test/Image3.rb +0 -1086
  392. data/test/ImageList1.rb +0 -858
  393. data/test/ImageList2.rb +0 -375
  394. data/test/Image_attributes.rb +0 -635
  395. data/test/Import_Export.rb +0 -111
  396. data/test/Info.rb +0 -436
  397. data/test/KernelInfo.rb +0 -59
  398. data/test/Magick.rb +0 -311
  399. data/test/Pixel.rb +0 -259
  400. data/test/PolaroidOptions.rb +0 -23
  401. data/test/Preview.rb +0 -26
  402. data/test/Struct.rb +0 -45
  403. data/test/appearance/Montage.rb +0 -26
  404. data/test/appearance/appearance_assertion.rb +0 -13
  405. data/test/appearance/expected/montage_border_color.jpg +0 -0
  406. data/test/cmyk.icm +0 -0
  407. data/test/lib/internal/Draw.rb +0 -811
  408. data/test/lib/internal/Geometry.rb +0 -98
  409. data/test/lib/internal/Magick.rb +0 -40
  410. data/test/srgb.icm +0 -0
  411. data/test/test_all_basic.rb +0 -49
  412. data/test/tmpnam_test.rb +0 -50
@@ -1,1638 +0,0 @@
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 6 November 2007), see www.w3.org" />
8
-
9
- <title>RMagick 0.0.0: class Image (attribute methods)</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) 2006 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
-
23
- /*]]>*/
24
- </style>
25
- </head>
26
-
27
- <body>
28
- <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
29
-
30
- <div class="nav">
31
- &laquo;&nbsp;<a href="ilist.html">Prev</a> | <a href=
32
- "index.html">Contents</a> | <a href=
33
- "image1.html">Next</a>&nbsp;&raquo;
34
- </div>
35
-
36
- <h1>class Image <span class="superclass">&lt; Object</span>
37
- (attribute methods)<br />
38
- <span class="mixin">mixes in Comparable</span></h1>
39
-
40
- <div id="toc">
41
- <h2>Table of Contents</h2>
42
-
43
- <h3>attribute methods</h3>
44
-
45
- <div>
46
- <div class="toccol">
47
- <ul>
48
- <li><a href="#background_color">background_color</a></li>
49
-
50
- <li><a href="#base_columns">base_columns</a></li>
51
-
52
- <li><a href="#base_filename">base_filename</a></li>
53
-
54
- <li><a href="#base_rows">base_rows</a></li>
55
-
56
- <li><a href="#bias">bias</a></li>
57
-
58
- <li><a href=
59
- "#black_point_compensation">black_point_compensation</a></li>
60
-
61
- <li><a href="#blur">blur</a></li>
62
-
63
- <li><a href="#border_color">border_color</a></li>
64
-
65
- <li><a href="#chromaticity">chromaticity</a></li>
66
-
67
- <li><a href="#class_type">class_type</a></li>
68
-
69
- <li><a href="#color_profile">color_profile</a></li>
70
-
71
- <li><a href="#colors">colors</a></li>
72
-
73
- <li><a href="#colorspace">colorspace</a></li>
74
-
75
- <li><a href="#columns">columns</a></li>
76
-
77
- <li><a href="#compose">compose</a></li>
78
-
79
- <li><a href="#compression">compression</a></li>
80
-
81
- <li><a href="#delay">delay</a></li>
82
-
83
- <li><a href="#density">density</a></li>
84
-
85
- <li><a href="#depth">depth</a></li>
86
-
87
- <li><a href="#directory">directory</a></li>
88
- </ul>
89
- </div>
90
-
91
- <div class="toccol">
92
- <ul>
93
- <li><a href="#dispose">dispose</a></li>
94
-
95
- <li><a href="#extract_info">extract_info</a></li>
96
-
97
- <li><a href="#filename">filename</a></li>
98
-
99
- <li><a href="#filesize">filesize</a></li>
100
-
101
- <li><a href="#filter">filter</a></li>
102
-
103
- <li><a href="#format">format</a></li>
104
-
105
- <li><a href="#fuzz">fuzz</a></li>
106
-
107
- <li><a href="#gamma">gamma</a></li>
108
-
109
- <li><a href="#geometry">geometry</a></li>
110
-
111
- <li><a href="#gravity">gravity</a></li>
112
-
113
- <li><a href="#image_type">image_type</a></li>
114
-
115
- <li><a href="#interlace">interlace</a></li>
116
-
117
- <li><a href="#iptc_profile">iptc_profile</a></li>
118
-
119
- <li><a href="#matte">matte</a></li>
120
-
121
- <li><a href=
122
- "#mean_error_per_pixel">mean_error_per_pixel</a></li>
123
-
124
- <li><a href="#mime_type">mime_type</a></li>
125
-
126
- <li><a href="#monitor">monitor</a></li>
127
-
128
- <li><a href="#montage">montage</a></li>
129
-
130
- <li><a href=
131
- "#normalized_mean_error">normalized_mean_error</a></li>
132
-
133
- <li><a href=
134
- "#normalized_maximum_error">normalized_maximum_error</a></li>
135
- </ul>
136
- </div>
137
-
138
- <div class="toccol">
139
- <ul>
140
- <li><a href="#number_colors">number_colors</a></li>
141
-
142
- <li><a href="#offset">offset</a></li>
143
-
144
- <li><a href="#opacity">opacity</a></li>
145
-
146
- <li><a href="#orientation">orientation</a></li>
147
-
148
- <li><a href="#page">page</a></li>
149
-
150
- <li><a href=
151
- "#pixel_interpolation_method">pixel_interpolation_method</a></li>
152
-
153
- <li><a href="#quality">quality</a></li>
154
-
155
- <li><a href="#quantum_depth">quantum_depth</a></li>
156
-
157
- <li><a href="#rendering_intent">rendering_intent</a></li>
158
-
159
- <li><a href="#rows">rows</a></li>
160
-
161
- <li><a href="#scene">scene</a></li>
162
-
163
- <li><a href="#start_loop">start_loop</a></li>
164
-
165
- <li><a href="#ticks_per_second">ticks_per_second</a></li>
166
-
167
- <li><a href="#total_colors">total_colors</a></li>
168
-
169
- <li><a href=
170
- "#total_ink_density">total_ink_density</a></li>
171
-
172
- <li><a href="#units">units</a></li>
173
-
174
- <li><a href=
175
- "#virtual_pixel_method">virtual_pixel_method</a></li>
176
-
177
- <li><a href="#x_resolution">x_resolution</a></li>
178
-
179
- <li><a href="#y_resolution">y_resolution</a></li>
180
- </ul>
181
- </div>
182
- </div>
183
- </div>
184
-
185
- <h2 class="methods">attribute methods</h2>
186
-
187
- <div class="sig">
188
- <h3 id="background_color">background_color</h3>
189
-
190
- <p><span class="arg">img.</span>background_color -&gt;
191
- <em>string</em><br />
192
- <span class="arg">img</span>.background_color = <span class=
193
- "arg">string</span> or <span class="arg">pixel</span></p>
194
- </div>
195
-
196
- <div class="desc">
197
- <h4>Description</h4>
198
-
199
- <p>The image's background color. By default the background
200
- color is "white".</p>
201
-
202
- <h4>Argument</h4>Either a <a href=
203
- "imusage.html#color_names">color name</a> or a <a href=
204
- "struct.html#Pixel">Pixel</a> object.
205
-
206
- <h4>Returns</h4>
207
-
208
- <p>A color name.</p>
209
- </div>
210
-
211
- <div class="sig">
212
- <h3 id="base_columns">base_columns</h3>
213
-
214
- <p><span class="arg">img.</span>base_columns -&gt;
215
- <em>integer</em></p>
216
- </div>
217
-
218
- <div class="desc">
219
- <h4>Description</h4>
220
-
221
- <p>The number of columns in the image before any
222
- transformations. Get-only.</p>
223
- </div>
224
-
225
- <div class="sig">
226
- <h3 id="base_filename">base_filename</h3>
227
-
228
- <p><span class="arg">img</span>.base_filename -&gt;
229
- <em>string</em></p>
230
- </div>
231
-
232
- <div class="desc">
233
- <h4>Description</h4>
234
-
235
- <p>The image's original filename before any transformations.
236
- Get-only.</p>
237
- </div>
238
-
239
- <div class="sig">
240
- <h3 id="base_rows">base_rows</h3>
241
-
242
- <p><span class="arg">img.</span>base_rows -&gt;
243
- <em>integer</em></p>
244
- </div>
245
-
246
- <div class="desc">
247
- <h4>Description</h4>
248
-
249
- <p>The number of rows in the image before any transformations.
250
- Get-only.</p>
251
- </div>
252
-
253
- <div class="sig">
254
- <h3 id="bias">bias</h3>
255
-
256
- <p><span class="arg">img</span>.bias -&gt; <em>float</em><br />
257
- <span class="arg">img</span>.bias = <span class=
258
- "arg">float</span><br />
259
- <span class="arg">img</span>.bias = <span class=
260
- "arg">string</span></p>
261
- </div>
262
-
263
- <div class="desc">
264
- <h4>Description</h4>
265
-
266
- <p class="imquote">Add bias when convolving an image</p>
267
-
268
- <h4>Argument</h4>
269
-
270
- <p>Either a number between 0.0 and 1.0 or a string in the form
271
- "NN%".</p>
272
- </div>
273
-
274
- <div class="sig">
275
- <h3 id="black_point_compensation">black_point_compensation</h3>
276
-
277
- <p><span class="arg">img</span>.black_point_compensation -&gt;
278
- <code>true</code> or <code>false</code><br />
279
- <span class="arg">img</span>.black_point_compensation =
280
- <code>true</code> or <code>false</code> -&gt; <em>self</em></p>
281
- </div>
282
-
283
- <div class="desc">
284
- <h4>Description</h4>
285
-
286
- <p>Use black point compensation. Typically used in CMYK-to-RGB
287
- conversion along with <code>image.</code><a href=
288
- "#rendering_intent">rendering_intent</a>=<a href=
289
- "constants.html#RenderingIntent">Magick::RelativeIntent</a></p>
290
- </div>
291
-
292
- <div class="sig">
293
- <h3 id="blur">blur</h3>
294
-
295
- <p><span class="arg">img.</span>blur -&gt; <em>float</em><br />
296
- <span class="arg">img.</span>blur = <span class=
297
- "arg">float</span></p>
298
- </div>
299
-
300
- <div class="desc">
301
- <h4>Description</h4>The blur factor to use when resizing. See
302
- <a href="image3.html#resize">resize</a>.
303
-
304
- <h4>Argument</h4>
305
-
306
- <p>&gt; 1.0 is blurry, &lt; 1.0 is sharp.</p>
307
- </div>
308
-
309
- <div class="sig">
310
- <h3 id="border_color">border_color</h3>
311
-
312
- <p><span class="arg">img.</span>border_color -&gt;
313
- <em>string</em><br />
314
- <span class="arg">img.</span>border_color = <span class=
315
- "arg">string</span> or <span class="arg">pixel</span></p>
316
- </div>
317
-
318
- <div class="desc">
319
- <h4>Description</h4>The image's border color. The default
320
- border color is "#dfdfdf" (gray).
321
-
322
- <h4>Argument</h4>
323
-
324
- <p>Either a <a href="imusage.html#color_names">color name</a>
325
- or a <a href="struct.html#Pixel">Pixel</a> object.</p>
326
-
327
- <h4>Returns</h4>
328
-
329
- <p>A color name.</p>
330
- </div>
331
-
332
- <div class="sig">
333
- <h3 id="chromaticity">chromaticity</h3>
334
-
335
- <p><span class="arg">img.</span>chromaticity -&gt;
336
- <em>chromaticity</em><br />
337
- <span class="arg">img.</span>chromaticity = <span class=
338
- "arg">chromaticity</span></p>
339
- </div>
340
-
341
- <div class="desc">
342
- <h4>Description</h4>
343
-
344
- <p>The <span class="imquote">red, green, blue, and white-point
345
- chromaticity values.</span>.</p>
346
-
347
- <h4>Argument</h4>A <a href=
348
- "struct.html#Chromaticity">Chromaticity</a> object.
349
-
350
- <h4>Returns</h4>A <a href=
351
- "struct.html#Chromaticity">Chromaticity</a> object.
352
- </div>
353
-
354
- <div class="sig">
355
- <h3 id="class_type">class_type</h3>
356
-
357
- <p><span class="arg">img.</span>class_type -&gt;
358
- <em>storage_class</em><br />
359
- <span class="arg">img.</span>class_type = <span class=
360
- "arg">storage_class</span></p>
361
- </div>
362
-
363
- <div class="desc">
364
- <h4>Description</h4>
365
-
366
- <p>The image's <em>storage class</em>. <span class="imquote">If
367
- DirectClass then the pixels contain valid RGB or CMYK colors.
368
- If PseudoClass then the image has a colormap referenced by the
369
- pixel's index member.</span></p>
370
-
371
- <h4>Argument</h4>
372
-
373
- <p>A <a href="constants.html#ClassType">ClassType</a>
374
- constant.</p>
375
-
376
- <h4>Returns</h4>
377
-
378
- <p>A <a href="constants.html#ClassType">ClassType</a>
379
- constant.</p>
380
- </div>
381
-
382
- <div class="sig">
383
- <h3 id="color_profile">color_profile</h3>
384
-
385
- <p><span class="arg">img.</span>color_profile -&gt;
386
- <em>string</em><br />
387
- <span class="arg">img.</span>color_profile = <span class=
388
- "arg">string</span></p>
389
- </div>
390
-
391
- <div class="desc">
392
- <h4>Description</h4>
393
-
394
- <p>The <a href="http://www.color.org/icc_specs2.html">ICC color
395
- profile</a>.</p>
396
-
397
- <h4>Argument</h4>
398
-
399
- <p>A color profile is represented as a string. If the argument
400
- is <code>nil</code> instead of <span class="arg">string</span>
401
- then any ICC color profile present in the image is deleted.</p>
402
-
403
- <p>The setter form of this attribute deletes any existing ICC
404
- color profile(s) before adding the new one. If you need to add
405
- both source and destination profiles use <a href=
406
- "image1.html#add_profile">add_profile</a> or <a href=
407
- "image3.html#profile_bang">profile!</a>.</p>
408
-
409
- <h4>Returns</h4>
410
-
411
- <p>The current color profile, or <code>nil</code> if there is
412
- no profile.</p>
413
-
414
- <h4>See also</h4>
415
-
416
- <p><a href="image1.html#add_profile">add_profile</a>, <a href=
417
- "image1.html#delete_profile">delete_profile</a>, <a href=
418
- "image1.html#each_profile">each_profile</a>, <a href=
419
- "image3.html#profile_bang">profile!</a></p>
420
- </div>
421
-
422
- <div class="sig">
423
- <h3 id="colors">colors</h3>
424
-
425
- <p><span class="arg">img.</span>colors -&gt;
426
- <em>integer</em></p>
427
- </div>
428
-
429
- <div class="desc">
430
- <h4>Description</h4>
431
-
432
- <p>The number of colors in the colormap. Only meaningful for
433
- <a href="constants.html#ClassType">PseudoClass</a> images.
434
- Get-only.</p>
435
- </div>
436
-
437
- <div class="sig">
438
- <h3 id="colorspace">colorspace</h3>
439
-
440
- <p><span class="arg">img.</span>colorspace -&gt;
441
- <em>colorspace</em><br />
442
- <span class="arg">img.</span>colorspace = <span class=
443
- "arg">colorspace</span></p>
444
- </div>
445
-
446
- <div class="desc">
447
- <h4>Description</h4>
448
-
449
- <p class="imquote">Image pixel interpretation. If the <a href=
450
- "constants.html#ColorspaceType">colorspace</a> is RGBColorspace
451
- the pixels are red, green, blue. If <a href="#matte">matte</a>
452
- is true, then red, green, blue, and opacity. If it is
453
- CMYKColorspace, the pixels are cyan, yellow, magenta, black.
454
- Otherwise the colorspace is ignored.</p>
455
-
456
- <h4>Argument</h4>
457
-
458
- <p>A <a href="constants.html#ColorspaceType">ColorspaceType</a>
459
- constant.</p>
460
-
461
- <h4>Returns</h4>
462
-
463
- <p>A <a href="constants.html#ColorspaceType">ColorspaceType</a>
464
- constant.</p>
465
- </div>
466
-
467
- <div class="sig">
468
- <h3 id="columns">columns</h3>
469
-
470
- <p><span class="arg">img.</span>columns -&gt;
471
- <em>integer</em></p>
472
- </div>
473
-
474
- <div class="desc">
475
- <h4>Description</h4>
476
-
477
- <p>The width of the image in pixels. Get-only.</p>
478
- </div>
479
-
480
- <div class="sig">
481
- <h3 id="compose">compose</h3>
482
-
483
- <p><span class="arg">img.</span>compose -&gt;
484
- <em>operator</em><br />
485
- <span class="arg">img.</span>compose = <span class=
486
- "arg">operator</span></p>
487
- </div>
488
-
489
- <div class="desc">
490
- <h4>Description</h4>
491
-
492
- <p>The image composite operator. The default is
493
- OverCompositeOp. See <a href=
494
- "ilist.html#montage">montage</a>.</p>
495
-
496
- <h4>Argument</h4>
497
-
498
- <p>A <a href="constants.html#CompositeOperator">composite
499
- operator</a> constant.</p>
500
-
501
- <h4>Returns</h4>
502
-
503
- <p>A <a href="constants.html#CompositeOperator">composite
504
- operator</a> constant.</p>
505
- </div>
506
-
507
- <div class="sig">
508
- <h3 id="compression">compression</h3>
509
-
510
- <p><span class="arg">img.</span>compression -&gt;
511
- <em>type</em><br />
512
- <span class="arg">img.</span>compression = <span class=
513
- "arg">type</span></p>
514
- </div>
515
-
516
- <div class="desc">
517
- <h4>Description</h4>The image compression type. The default is
518
- the compression type of the specified image file.
519
-
520
- <h4>Argument</h4>
521
-
522
- <p>A <a href=
523
- "constants.html#CompressionType">CompressionType</a>
524
- constant.</p>
525
-
526
- <h4>Returns</h4>
527
-
528
- <p>A <a href=
529
- "constants.html#CompressionType">CompressionType</a>
530
- constant.</p>
531
- </div>
532
-
533
- <div class="sig">
534
- <h3 id="delay">delay</h3>
535
-
536
- <p><span class="arg">img.</span>delay -&gt;
537
- <em>integer</em><br />
538
- <span class="arg">img.</span>delay = <span class=
539
- "arg">integer</span></p>
540
- </div>
541
-
542
- <div class="desc">
543
- <h4>Description</h4>
544
-
545
- <p>Number of ticks which must expire before displaying the next
546
- image in an animated sequence. The default number of ticks is
547
- 0. By default there are 100 ticks per second but this number
548
- can be changed via the <a href=
549
- "#ticks_per_second">ticks_per_second</a> attribute.</p>
550
-
551
- <h4>Argument</h4>An integer value between 0 and 65535,
552
- inclusive.
553
-
554
- <h4>Returns</h4>
555
-
556
- <p>The current delay value.</p>
557
- </div>
558
-
559
- <div class="sig">
560
- <h3 id="density">density</h3>
561
-
562
- <p><span class="arg">img.</span>density -&gt;
563
- <em>string</em><br />
564
- <span class="arg">img.</span>density = <span class=
565
- "arg">string</span> or <span class="arg">geometry</span></p>
566
- </div>
567
-
568
- <div class="desc">
569
- <h4>Description</h4>
570
-
571
- <p>The <span class="imquote">vertical and horizontal resolution
572
- in pixels of the image.</span> The default is "72x72".</p>
573
-
574
- <h4>Argument</h4>
575
-
576
- <p>The density may be expressed either as a string or a
577
- <a href="struct.html#Geometry">Geometry</a> object. If a
578
- string, it is in the form "XxY", or simply "X". If "Y" is
579
- omitted it is set to "X". To specify the density with a
580
- Geometry object, set the <code>width</code> attribute to the x
581
- resolution and the <code>height</code> argument to the y
582
- resolution. If <code>height</code> is nil, <code>width</code>
583
- will be used as the y resolution as well.</p>
584
-
585
- <h4>Returns</h4>
586
-
587
- <p>The image density represented as a string.</p>
588
-
589
- <h4>See also</h4>
590
-
591
- <p>Also see <a href="#x_resolution">x_resolution</a> and
592
- <a href="#y_resolution">y_resolution</a>.</p>
593
- </div>
594
-
595
- <div class="sig">
596
- <h3 id="depth">depth</h3>
597
-
598
- <p><span class="arg">img.</span>depth -&gt;
599
- <em>integer</em></p>
600
- </div>
601
-
602
- <div class="desc">
603
- <h4>Description</h4>
604
-
605
- <p>The image depth (8, 16, or 32). Get-only.</p>
606
- </div>
607
-
608
- <div class="sig">
609
- <h3 id="directory">directory</h3>
610
-
611
- <p><span class="arg">img.</span>directory -&gt;
612
- <em>string</em></p>
613
- </div>
614
-
615
- <div class="desc">
616
- <h4>Description</h4>
617
-
618
- <p><span class="imquote">Tile names from within an image
619
- montage. Only valid after calling <a href=
620
- "ilist.html#montage">montage</a> or reading a MIFF file which
621
- contains a directory.</span> Get-only.</p>
622
-
623
- <h4>Returns</h4>
624
-
625
- <p>A newline ("\n")-delimited list of the images in the
626
- montage.</p>
627
- </div>
628
-
629
- <div class="sig">
630
- <h3 id="dispose">dispose</h3>
631
-
632
- <p><span class="arg">img.</span>dispose -&gt;
633
- <em>method</em><br />
634
- <span class="arg">img.</span>dispose = <span class=
635
- "arg">method</span></p>
636
- </div>
637
-
638
- <div class="desc">
639
- <h4>Description</h4>
640
-
641
- <p class="imquote">GIF disposal method. This attribute is used
642
- to control how successive images are rendered (how the
643
- preceding image is disposed of) when creating a GIF
644
- animation.</p>
645
-
646
- <h4>Argument</h4>
647
-
648
- <p>An integer corresponding to the disposal method.</p>
649
-
650
- <h4>Returns</h4>A <a href=
651
- "constants.html#DisposeType">DisposeType</a> constant.
652
- </div>
653
-
654
- <div class="sig">
655
- <h3 id="extract_info">extract_info</h3>
656
-
657
- <p><span class="arg">img.</span>extract_info -&gt;
658
- <em>rectangle</em><br />
659
- <span class="arg">img.</span>extract_info = <span class=
660
- "arg">rectangle</span></p>
661
- </div>
662
-
663
- <div class="desc">
664
- <h4>Description</h4>
665
-
666
- <p>Specify a rectangle within an image, or retrieve the
667
- rectangle specified when the image was constituted. See
668
- <a href="info.html#extract">extract=</a>.</p>
669
-
670
- <h4>Argument</h4>
671
-
672
- <p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
673
-
674
- <h4>Returns</h4>
675
-
676
- <p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
677
- </div>
678
-
679
- <div class="sig">
680
- <h3 id="filename">filename</h3>
681
-
682
- <p><span class="arg">img.</span>filename -&gt;
683
- <em>string</em></p>
684
- </div>
685
-
686
- <div class="desc">
687
- <h4>Description</h4>
688
-
689
- <p>The image filename. Get-only.</p>
690
- </div>
691
-
692
- <div class="sig">
693
- <h3 id="filesize">filesize</h3>
694
-
695
- <p><span class="arg">img.</span>filesize -&gt;
696
- <em>integer</em></p>
697
- </div>
698
-
699
- <div class="desc">
700
- <h4>Description</h4>
701
-
702
- <p>The image filesize in bytes. Get-only.</p>
703
- </div>
704
-
705
- <div class="sig">
706
- <h3 id="filter">filter</h3>
707
-
708
- <p><span class="arg">img.</span>filter -&gt;
709
- <em>type</em><br />
710
- <span class="arg">img.</span>filter = <span class=
711
- "arg">type</span></p>
712
- </div>
713
-
714
- <div class="desc">
715
- <h4>Description</h4>
716
-
717
- <p class="imquote">Filter to use when resizing image. The
718
- reduction filter employed has a significant effect on the time
719
- required to resize an image and the resulting quality. The
720
- default filter is Lanczos which has been shown to produce high
721
- quality results when reducing most images.</p>
722
-
723
- <h4>Argument</h4>
724
-
725
- <p>A <a href="constants.html#FilterTypes">FilterTypes</a>
726
- constant.</p>
727
-
728
- <h4>Returns</h4>A <a href=
729
- "constants.html#FilterTypes">FilterTypes</a> constant.
730
- </div>
731
-
732
- <div class="sig">
733
- <h3 id="format">format</h3>
734
-
735
- <p><span class="arg">img.</span>format -&gt;
736
- <em>string</em><br />
737
- <span class="arg">img.</span>format = <span class=
738
- "arg">string</span></p>
739
- </div>
740
-
741
- <div class="desc">
742
- <h4>Description</h4>
743
-
744
- <p>The image encoding format. For example, "GIF" or "PNG". See
745
- <a href="magick.html#formats">formats</a>.</p>
746
-
747
- <h4>Argument</h4>
748
-
749
- <p>The format name.</p>
750
-
751
- <h4>Returns</h4>
752
-
753
- <p>The format name.</p>
754
- </div>
755
-
756
- <div class="sig">
757
- <h3 id="fuzz">fuzz</h3>
758
-
759
- <p><span class="arg">img.</span>fuzz -&gt; <em>float</em><br />
760
- <span class="arg">img.</span>fuzz = <span class=
761
- "arg">integer</span> or <span class="arg">string</span></p>
762
- </div>
763
-
764
- <div class="desc">
765
- <h4>Description</h4>
766
-
767
- <p><span class="imquote">Colors within this distance are
768
- considered equal. A number of algorithms search for a target
769
- color. By default the color must be exact. Use this</span>
770
- [attribute] <span class="imquote">to match colors that are
771
- close to the target color in RGB space.</span></p>
772
-
773
- <p>See <a href="image2.html#opaque">opaque</a>, <a href=
774
- "image3.html#texture_floodfill">texture_floodfill</a>, and
775
- <a href="image3.html#transparent">transparent</a>.</p>
776
-
777
- <h4>Argument</h4>
778
-
779
- <p>The argument may be a floating-point numeric value or a
780
- string in the form "NN%". In the second case, the argument is
781
- computed as a percentage of <a href=
782
- "constants.html#Miscellaneous_constants">QuantumRange</a>. For
783
- example, a value of '5%' sets <code>fuzz</code> to
784
- 0.05*QuantumRange.</p>
785
-
786
- <h4>Returns</h4>
787
-
788
- <p>A <code>Float</code></p>
789
- </div>
790
-
791
- <div class="sig">
792
- <h3 id="gamma">gamma</h3>
793
-
794
- <p><span class="arg">img.</span>gamma -&gt;
795
- <em>float</em><br />
796
- <span>image.</span>gamma = <span class="arg">float</span></p>
797
- </div>
798
-
799
- <div class="desc">
800
- <h4>Description</h4>
801
-
802
- <p class="imquote">Gamma level of the image. The same color
803
- image displayed on two different workstations may look
804
- different due to differences in the display monitor. Use gamma
805
- correction to adjust for this color difference.</p>
806
- </div>
807
-
808
- <div class="sig">
809
- <h3 id="geometry">geometry</h3>
810
-
811
- <p><span class="arg">img.</span>geometry -&gt;
812
- <em>string</em><br />
813
- <span class="arg">img.</span>geometry = <span class=
814
- "arg">string</span> or <span class="arg">geometry</span></p>
815
- </div>
816
-
817
- <div class="desc">
818
- <h4>Description</h4>
819
-
820
- <p class="imquote">Preferred size of the image when
821
- encoding.</p>
822
-
823
- <h4>Argument</h4>
824
-
825
- <p>A <a href="imusage.html#geometry">geometry string</a> or a
826
- <a href="struct.html#Geometry">Geometry</a> object.</p>
827
-
828
- <h4>Returns</h4>
829
-
830
- <p>A <a href="imusage.html#geometry">geometry string</a>.</p>
831
- </div>
832
-
833
- <div class="sig">
834
- <h3 id="gravity">gravity</h3>
835
-
836
- <p><span class="arg">img</span>.gravity -&gt;
837
- <em>gravity</em><br />
838
- <span class="arg">img</span>.gravity = <span class=
839
- "arg">gravity</span></p>
840
- </div>
841
-
842
- <div class="desc">
843
- <h4>Description</h4>
844
-
845
- <p>Used with the <a href=
846
- "ilist.html#composite_layers">ImageList#composite_layers</a>
847
- method. <span class="imquote">The direction that the image
848
- gravitates within the composite.</span></p>
849
-
850
- <h4>Argument</h4>
851
-
852
- <p>A <a href="constants.html#GravityType">GravityType</a>
853
- value.</p>
854
-
855
- <h4>Returns</h4>
856
-
857
- <p>A <a href="constants.html#GravityType">GravityType</a>
858
- value.</p>
859
- </div>
860
-
861
- <div class="sig">
862
- <h3 id="image_type">image_type</h3>
863
-
864
- <p><span class="arg">img.</span>image_type -&gt;
865
- <em>type</em><br />
866
- <span class="arg">img</span>.image_type = <span class=
867
- "arg">type</span></p>
868
- </div>
869
-
870
- <div class="desc">
871
- <h4>Description</h4>
872
-
873
- <p>The image type classification. For example, GrayscaleType.
874
- Don't confuse this attribute with the <a href=
875
- "#format">format</a>, that is "GIF" or "JPG". Get-only.</p>
876
-
877
- <h4>Argument</h4>
878
-
879
- <p>An <a href="constants.html#ImageType">ImageType</a>
880
- value.</p>
881
-
882
- <h4>Returns</h4>
883
-
884
- <p>An <a href="constants.html#ImageType">ImageType</a>
885
- value.</p>
886
- </div>
887
-
888
- <div class="sig">
889
- <h3 id="interlace">interlace</h3>
890
-
891
- <p><span class="arg">img.</span>interlace -&gt;
892
- <em>type</em><br />
893
- <span class="arg">img.</span>interlace = <span class=
894
- "arg">type</span></p>
895
- </div>
896
-
897
- <div class="desc">
898
- <h4>Description</h4>
899
-
900
- <p class="imquote">The type of interlacing scheme (default
901
- NoInterlace). This option is used to specify the type of
902
- interlacing scheme for raw image formats such as RGB or YUV.
903
- NoInterlace means do not interlace, LineInterlace uses scanline
904
- interlacing, and PlaneInterlace uses plane interlacing.
905
- PartitionInterlace is like PlaneInterlace except the different
906
- planes are saved to individual files (e.g. image.R, image.G,
907
- and image.B). Use LineInterlace or PlaneInterlace to create an
908
- interlaced GIF or progressive JPEG image.</p>
909
-
910
- <h4>Argument</h4>
911
-
912
- <p>An <a href="constants.html#InterlaceType">InterlaceType</a>
913
- constant.</p>
914
-
915
- <h4>Returns</h4>
916
-
917
- <p>An <a href="constants.html#InterlaceType">InterlaceType</a>
918
- constant.</p>
919
- </div>
920
-
921
- <div class="sig">
922
- <h3 id="iptc_profile">iptc_profile</h3>
923
-
924
- <p><span class="arg">img.</span>iptc_profile -&gt;
925
- <em>string</em><br />
926
- <span class="arg">img.</span>iptc_profile = <span class=
927
- "arg">string</span></p>
928
- </div>
929
-
930
- <div class="desc">
931
- <h4>Description</h4>
932
-
933
- <p>The <a href="http://www.iptc.org/IIM/">International Press
934
- Telecommunications Council profile</a>.</p>
935
-
936
- <h4>Argument</h4>
937
-
938
- <p>A IPTC profile is represented as a string. If the argument
939
- is <code>nil</code> instead of <span class="arg">string</span>
940
- then any IPTC profile present in the image is deleted.</p>
941
-
942
- <h4>Returns</h4>
943
-
944
- <p>The current IPTC profile, or <code>nil</code> if there is no
945
- profile.</p>
946
-
947
- <h4>See also</h4>
948
-
949
- <p><a href="image1.html#add_profile">add_profile</a>, <a href=
950
- "image1.html#delete_profile">delete_profile</a>, <a href=
951
- "image1.html#each_profile">each_profile</a>. <a href=
952
- "image3.html#profile_bang">profile!</a></p>
953
- </div>
954
-
955
- <div class="sig">
956
- <h3 id="matte">matte</h3>
957
-
958
- <p><span class="arg">img.</span>matte -&gt; <code>true</code>
959
- <em>or</em> <code>false</code><br />
960
- <span class="arg">img.</span>matte = <code>true</code> or
961
- <code>false</code></p>
962
- </div>
963
-
964
- <div class="desc">
965
- <h4>Description</h4>
966
-
967
- <p>If <code>true</code>, honor the opacity values in the image
968
- pixels. See <a href="struct.html#Pixel">Pixel</a>.</p>
969
-
970
- <p>This attribute is deprecated in ImageMagick 6.3.5 and later.
971
- Use <a href="image1.html#alpha">alpha</a> instead.</p>
972
- </div>
973
-
974
- <div class="sig">
975
- <h3 id="mean_error_per_pixel">mean_error_per_pixel</h3>
976
-
977
- <p><span class="arg">img.</span>mean_error_per_pixel -&gt;
978
- <em>float</em></p>
979
- </div>
980
-
981
- <div class="desc">
982
- <h4>Description</h4>
983
-
984
- <p><span class="imquote">The mean error per pixel computed when
985
- a image is color reduced.</span> This attribute is only valid
986
- if the <code>measure_error</code> argument to
987
- <code>quantize</code><a href=
988
- "ilist.html#quantize">[ImageList]</a><a href=
989
- "image3.html#quantize">[Image]</a> is set to <code>true</code>.
990
- Get-only.</p>
991
- </div>
992
-
993
- <div class="sig">
994
- <h3 id="mime_type">mime_type</h3>
995
-
996
- <p><span class="arg">img.</span>mime_type -&gt;
997
- <em>string</em></p>
998
- </div>
999
-
1000
- <div class="desc">
1001
- <h4>Description</h4>
1002
-
1003
- <p><span class="imquote">Returns the officially registered (or
1004
- de facto) MIME media-type.</span> If there is no registered
1005
- media-type, returns "image/x-magick". Get-only.</p>
1006
- </div>
1007
-
1008
- <div class="sig">
1009
- <h3 id="monitor">monitor</h3>
1010
-
1011
- <p><span class="arg">img.</span>monitor = <em>proc</em></p>
1012
- </div>
1013
-
1014
- <div class="desc">
1015
- <h4>Description</h4>
1016
-
1017
- <p>Establish a progress monitor. Most <code>Image</code> and
1018
- <code>ImageList</code> methods will periodically call the
1019
- monitor with arguments indicating the progress of the method.
1020
- The argument is a Proc object that accepts the three arguments
1021
- listed here:</p>
1022
-
1023
- <dl>
1024
- <dt>method_name</dt>
1025
-
1026
- <dd>The name of the monitored method.</dd>
1027
-
1028
- <dt>quantum</dt>
1029
-
1030
- <dd>A number between 0 and <span class="arg">span</span> that
1031
- identifies how much of the operation has been completed (or,
1032
- in some cases, remains to be completed).</dd>
1033
-
1034
- <dt>span</dt>
1035
-
1036
- <dd>The number of quanta needed to complete the
1037
- operation.</dd>
1038
- </dl>
1039
-
1040
- <p>If the monitor proc returns <code>nil</code> or
1041
- <code>false</code> the operation will be immediately
1042
- terminated. To stop monitoring, set <code>monitor</code> to
1043
- <code>nil</code>. Set-only.</p>
1044
-
1045
- <h4>Argument</h4>
1046
-
1047
- <p>Any object that can respond to</p>
1048
- <pre>
1049
- obj.call(method_name, quantum, span)
1050
- </pre>
1051
-
1052
- <p>With very large images it is possible, though not very
1053
- likely, for the <span class="arg">quantum</span> and
1054
- <span class="arg">span</span> arguments to be
1055
- <code>Bignum</code> objects.</p>
1056
-
1057
- <h4>Example</h4>
1058
- <pre>
1059
- img.monitor = Proc.new do |method, offset, span|
1060
- printf("%s is %3.0f%% complete.\n", method, (offset.to_f/span)*100)
1061
- true
1062
- end
1063
-
1064
- img.blur_image(0,20)
1065
- </pre>
1066
-
1067
- <p><em>produces:</em></p>
1068
- <pre>
1069
- blur_image is 0% complete.
1070
- blur_image is 0% complete.
1071
- blur_image is 0% complete.
1072
- blur_image is 1% complete.
1073
- blur_image is 2% complete.
1074
- blur_image is 4% complete.
1075
- blur_image is 7% complete.
1076
- blur_image is 14% complete.
1077
- blur_image is 28% complete.
1078
- blur_image is 56% complete.
1079
- blur_image is 56% complete.
1080
- blur_image is 56% complete.
1081
- blur_image is 56% complete.
1082
- blur_image is 57% complete.
1083
- blur_image is 59% complete.
1084
- blur_image is 63% complete.
1085
- blur_image is 70% complete.
1086
- blur_image is 84% complete.
1087
- blur_image is 100% complete.
1088
- </pre>
1089
-
1090
- <h4>See also</h4>
1091
-
1092
- <p><a href="info.html#monitor">Image::Info#monitor=</a></p>
1093
- </div>
1094
-
1095
- <div class="sig">
1096
- <h3 id="montage">montage</h3>
1097
-
1098
- <p><span class="arg">img.</span>montage -&gt;
1099
- <em>string</em><br /></p>
1100
- </div>
1101
-
1102
- <div class="desc">
1103
- <h4>Description</h4>
1104
-
1105
- <p><span class="imquote">Tile size and offset within an image
1106
- montage. Only valid for</span> [images produced by <a href=
1107
- "ilist.html#montage">montage</a>.] <span class="imquote">The
1108
- string is in the form of a <a href=
1109
- "imusage.html#geometry">geometry</a> string.</span>
1110
- Get-only.</p>
1111
- </div>
1112
-
1113
- <div class="sig">
1114
- <h3 id="normalized_mean_error">normalized_mean_error</h3>
1115
-
1116
- <p><span class="arg">img.</span>normalized_mean_error -&gt;
1117
- <em>float</em></p>
1118
- </div>
1119
-
1120
- <div class="desc">
1121
- <h4>Description</h4>
1122
-
1123
- <p><span class="imquote">The normalized mean error computed
1124
- when an image is color reduced.</span> This attribute is only
1125
- valid if the <code>measure_error</code> argument to
1126
- <code>quantize</code><a href=
1127
- "ilist.html#quantize">[ImageList]</a><a href=
1128
- "image3.html#quantize">[Image]</a> is set to <code>true</code>.
1129
- Get-only.</p>
1130
- </div>
1131
-
1132
- <div class="sig">
1133
- <h3 id="normalized_maximum_error">normalized_maximum_error</h3>
1134
-
1135
- <p><span class="arg" style=
1136
- "padding-left: 20px;">img.</span>normalized_maximum_error -&gt;
1137
- <em>float</em></p>
1138
- </div>
1139
-
1140
- <div class="desc">
1141
- <h4>Description</h4>
1142
-
1143
- <p><span class="imquote">The normalized mean error per pixel
1144
- computed when an image is color reduced.</span> This attribute
1145
- is only valid if the <code>measure_error</code> argument to
1146
- <code>quantize</code><a href=
1147
- "ilist.html#quantize">[ImageList]</a><a href=
1148
- "image3.html#quantize">[Image]</a> is set to <code>true</code>.
1149
- Get-only.</p>
1150
- </div>
1151
-
1152
- <div class="sig">
1153
- <h3 id="number_colors">number_colors</h3>
1154
-
1155
- <p><span class="arg">img.</span>number_colors -&gt;
1156
- <em>integer</em></p>
1157
- </div>
1158
-
1159
- <div class="desc">
1160
- <h4>Description</h4>
1161
-
1162
- <p>Number of unique colors in the image. Get-only.</p>
1163
- </div>
1164
-
1165
- <div class="sig">
1166
- <h3 id="offset">offset</h3>
1167
-
1168
- <p><span class="arg">img.</span>offset -&gt;
1169
- <em>integer</em><br />
1170
- <span class="arg">img.</span>offset = <span class=
1171
- "arg">integer</span></p>
1172
- </div>
1173
-
1174
- <div class="desc">
1175
- <h4>Description</h4>
1176
-
1177
- <p class="imquote">Number of initial bytes to skip over when
1178
- reading raw image.</p>
1179
- </div>
1180
-
1181
- <div class="sig">
1182
- <h3 id="opacity">opacity</h3>
1183
-
1184
- <p><span class="arg">img.</span>opacity = <em>integer</em></p>
1185
- </div>
1186
-
1187
- <div class="desc">
1188
- <h4>Description</h4>
1189
-
1190
- <p><span class="imquote">Attenuates the opacity channel of an
1191
- image. If the image pixels are opaque, they are set to the
1192
- specified opacity level. Otherwise, the pixel opacity values
1193
- are blended with the supplied transparency value.</span>
1194
- Set-only.</p>
1195
-
1196
- <h4>Argument</h4>A number between 0 and QuantumRange. Higher
1197
- numbers increase transparency.
1198
- </div>
1199
-
1200
- <div class="sig">
1201
- <h3 id="orientation">orientation</h3>
1202
-
1203
- <p><span class="arg">img</span>.orientation -&gt;
1204
- <em>type</em><br />
1205
- <span class="arg">img</span>.orientation = <em>type</em></p>
1206
- </div>
1207
-
1208
- <div class="desc">
1209
- <h4>Description</h4>
1210
-
1211
- <p>The value of the Exif Orientation Tag.</p>
1212
-
1213
- <h4>Returns</h4>
1214
-
1215
- <p>An <a href=
1216
- "constants.html#OrientationType">OrientationType</a> value.</p>
1217
-
1218
- <h4>Notes</h4>See <a href=
1219
- "http://jpegclub.org/exif_orientation.html">http://jpegclub.org/exif_orientation.html</a>
1220
- for more information about the Exif Orientation Tag.
1221
- </div>
1222
-
1223
- <div class="sig">
1224
- <h3 id="page">page</h3>
1225
-
1226
- <p><span class="arg">img.</span>page -&gt;
1227
- <em>rectangle</em><br />
1228
- <span class="arg">img.</span>page = <span class=
1229
- "arg">rectangle</span></p>
1230
- </div>
1231
-
1232
- <div class="desc">
1233
- <h4>Description</h4>
1234
-
1235
- <p>When compositing, this attribute describes the position of
1236
- this image with respect to the underlying image. See <a href=
1237
- "ilist.html#coalesce">coalesce</a>, <a href=
1238
- "ilist.html#flatten_images">flatten_images</a>, and <a href=
1239
- "ilist.html#mosaic">mosaic</a>.</p>
1240
-
1241
- <h4>Argument</h4>
1242
-
1243
- <p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
1244
-
1245
- <h4>Returns</h4>
1246
-
1247
- <p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
1248
- </div>
1249
-
1250
- <div class="sig">
1251
- <h3 id="pixel_interpolation_method">
1252
- pixel_interpolation_method</h3>
1253
-
1254
- <p><span class="arg">img</span>.pixel_interpolation_method
1255
- -&gt; <em>method</em><br />
1256
- <span class="arg">img</span>.pixel_interpolation_method =
1257
- <span class="arg">method</span></p>
1258
- </div>
1259
-
1260
- <div class="desc">
1261
- <h4>Description</h4>
1262
-
1263
- <p>Get/set the pixel color interpolation method. Some methods
1264
- (such as <a href="image3.html#wave">wave</a>, <a href=
1265
- "image3.html#swirl">swirl</a>, <a href=
1266
- "image2.html#implode">implode</a>, and <a href=
1267
- "image1.html#composite">composite</a>) use the pixel color
1268
- interpolation method to determine how to blend adjacent
1269
- pixels.</p>
1270
-
1271
- <h4>Argument</h4>
1272
-
1273
- <p>An <a href=
1274
- "constants.html#InterpolatePixelMethod">InterpolatePixelMethod</a>
1275
- enum value.</p>
1276
-
1277
- <h4>Returns</h4>
1278
-
1279
- <p>An <a href=
1280
- "constants.html#InterpolatePixelMethod">InterpolatePixelMethod</a>
1281
- enum value.</p>
1282
- </div>
1283
-
1284
- <div class="sig">
1285
- <h3 id="quality">quality</h3>
1286
-
1287
- <p><span class="arg">img</span>.quality -&gt;
1288
- <em>integer</em></p>
1289
- </div>
1290
-
1291
- <div class="desc">
1292
- <h4>Description</h4>
1293
-
1294
- <p>For JPEG images, returns the Independent JPEG Group quality
1295
- value. This number is a measurement of the amount of
1296
- compression used when the image was saved. Lower numbers mean
1297
- higher compression.</p>
1298
-
1299
- <h4>Returns</h4>
1300
-
1301
- <p>A number between 0-100.</p>
1302
-
1303
- <h4>Notes</h4>
1304
-
1305
- <p>For more information, see <a href=
1306
- "http://www.faqs.org/faqs/jpeg-faq/part1/">The JPEG image
1307
- compression FAQ</a>.</p>
1308
- </div>
1309
-
1310
- <div class="sig">
1311
- <h3 id="quantum_depth">quantum_depth</h3>
1312
-
1313
- <p><span class="arg">img.</span>quantum_depth -&gt;
1314
- <em>integer</em></p>
1315
- </div>
1316
-
1317
- <div class="desc">
1318
- <h4>Description</h4>
1319
-
1320
- <p>The image depth to the nearest Quantum (8, 16, or 32).
1321
- Get-only.</p>
1322
- </div>
1323
-
1324
- <div class="sig">
1325
- <h3 id="rendering_intent">rendering_intent</h3>
1326
-
1327
- <p><span class="arg">img.</span>rendering_intent -&gt;
1328
- <em>type</em><br />
1329
- <span class="arg">img.</span>rendering_intent = <span class=
1330
- "arg">type</span></p>
1331
- </div>
1332
-
1333
- <div class="desc">
1334
- <h4>Description</h4>
1335
-
1336
- <p class="imquote">The type of rendering intent. See <a href=
1337
- "http://www.cambridgeincolour.com/tutorials/color-space-conversion.htm">
1338
- http://www.cambridgeincolour.com/tutorials/color-space-conversion.htm</a></p>
1339
-
1340
- <h4>Argument</h4>
1341
-
1342
- <p>A <a href=
1343
- "constants.html#RenderingIntent">RenderingIntent</a>
1344
- constant.</p>
1345
-
1346
- <h4>Returns</h4>A <a href=
1347
- "constants.html#RenderingIntent">RenderingIntent</a> constant.
1348
- </div>
1349
-
1350
- <div class="sig">
1351
- <h3 id="rows">rows</h3>
1352
-
1353
- <p><span class="arg">img.</span>rows -&gt; <em>integer</em></p>
1354
- </div>
1355
-
1356
- <div class="desc">
1357
- <h4>Description</h4>
1358
-
1359
- <p>The height of the image in pixels. Get-only.</p>
1360
- </div>
1361
-
1362
- <div class="sig">
1363
- <h3 id="scene">scene</h3>
1364
-
1365
- <p><span class="arg">img.</span>scene -&gt;
1366
- <em>integer</em></p>
1367
- </div>
1368
-
1369
- <div class="desc">
1370
- <h4>Description</h4>
1371
-
1372
- <p>The scene number assigned to the image the last time the
1373
- image was written to a multi-image image file. Don't confuse
1374
- this attribute with <code>ImageList</code>'s <a href=
1375
- "ilist.html#scene">scene</a> attribute, which denotes the image
1376
- to which Image methods will be sent.</p>
1377
- </div>
1378
-
1379
- <div class="sig">
1380
- <h3 id="start_loop">start_loop</h3>
1381
-
1382
- <p><span class="arg">img.</span>start_loop -&gt;
1383
- <code>true</code> or <code>false</code><br />
1384
- <span class="arg">img.</span>start_loop = <code>true</code> or
1385
- <code>false</code></p>
1386
- </div>
1387
-
1388
- <div class="desc">
1389
- <h4>Description</h4>
1390
-
1391
- <p>Indicates the first image in an animation.</p>
1392
- </div>
1393
-
1394
- <div class="sig">
1395
- <h3 id="ticks_per_second">ticks_per_second</h3>
1396
-
1397
- <p><span class="arg">img.</span>ticks_per_second -&gt;
1398
- <em>integer</em><br />
1399
- <span class="arg">image.</span>ticks_per_second = <span class=
1400
- "arg">integer</span></p>
1401
- </div>
1402
-
1403
- <div class="desc">
1404
- <h4>Description</h4>
1405
-
1406
- <p>Gets/sets the number of ticks per second. This attribute is
1407
- used in conjunction with the <a href="#delay">delay</a>
1408
- attribute to establish the amount of time that must elapse
1409
- between frames in an animation.The default is 100.</p>
1410
-
1411
- <h4>Returns</h4>
1412
-
1413
- <p>The current number of ticks per second</p>
1414
- </div>
1415
-
1416
- <div class="sig">
1417
- <h3 id="total_colors">total_colors</h3>
1418
-
1419
- <p><span class="arg">img.</span>total_colors -&gt;
1420
- <em>integer</em></p>
1421
- </div>
1422
-
1423
- <div class="desc">
1424
- <h4>Description</h4>
1425
-
1426
- <p>The number of colors in the image after quantization. Set by
1427
- <code>quantize</code> <a href=
1428
- "ilist.html#quantize">[ImageList]</a><a href=
1429
- "image3.html#quantize">[Image]</a> if the
1430
- <code>measure_error</code> argument is <code>true</code>.
1431
- Get-only.</p>
1432
- </div>
1433
-
1434
- <div class="sig">
1435
- <h3 id="total_ink_density">total_ink_density</h3>
1436
-
1437
- <p><span class="arg">img</span>.total_ink_density -&gt;
1438
- float</p>
1439
- </div>
1440
-
1441
- <div class="desc">
1442
- <h4>Description</h4>
1443
-
1444
- <p><span class="imquote">The total ink density for a CMYK
1445
- image. Total Ink Density (TID) is determined by adding the CMYK
1446
- values in the darkest shadow area in an image.</span>
1447
- Get-only.</p>
1448
- </div>
1449
-
1450
- <div class="sig">
1451
- <h3 id="units">units</h3>
1452
-
1453
- <p><span class="arg">img.</span>units -&gt; <em>type</em><br />
1454
- <span class="arg">img.</span>units = <span class=
1455
- "arg">type</span></p>
1456
- </div>
1457
-
1458
- <div class="desc">
1459
- <h4>Description</h4>
1460
-
1461
- <p class="imquote">Units of image resolution.</p>
1462
-
1463
- <h4>Argument</h4>
1464
-
1465
- <p>A <a href="constants.html#ResolutionType">ResolutionType</a>
1466
- constant.</p>
1467
-
1468
- <h4>Returns</h4>
1469
-
1470
- <p>A <a href="constants.html#ResolutionType">ResolutionType</a>
1471
- constant.</p>
1472
-
1473
- <h4>See also</h4>
1474
-
1475
- <p><a href="#x_resolution">x_resolution</a>, <a href=
1476
- "y_resolution">y_resolution</a></p>
1477
- </div>
1478
-
1479
- <div class="sig">
1480
- <h3 id="virtual_pixel_method">virtual_pixel_method</h3>
1481
-
1482
- <p><span class="arg">img</span>.virtual_pixel_method -&gt;
1483
- <em>method</em><br />
1484
- <span class="arg">img</span>.virtual_pixel_method =
1485
- <span class="arg">method</span></p>
1486
- </div>
1487
-
1488
- <div class="desc">
1489
- <h4>Description</h4>
1490
-
1491
- <p>Specify how "virtual pixels" behave. Virtual pixels are
1492
- pixels that are outside the boundaries of the image. Methods
1493
- such as <a href="image1.html#blur_image">blur_image</a>,
1494
- <a href="image3.html#sharpen">sharpen</a>, and <a href=
1495
- "image3.html#wave">wave</a> use virtual pixels.</p>
1496
-
1497
- <h4>Argument</h4>
1498
-
1499
- <p>The virtual pixel method can be any one of the following
1500
- <code>VirtualPixelMethod</code> constants:</p>
1501
-
1502
- <dl>
1503
- <dt>EdgeVirtualPixelMethod</dt>
1504
-
1505
- <dd>Extend the edge pixel toward infinity. This is the
1506
- default.</dd>
1507
-
1508
- <dt>MirrorVirtualPixelMethod</dt>
1509
-
1510
- <dd>Mirror the image.</dd>
1511
-
1512
- <dt>TileVirtualPixelMethod</dt>
1513
-
1514
- <dd>Tile the image.</dd>
1515
-
1516
- <dt>BackgroundVirtualPixelMethod</dt>
1517
-
1518
- <dd>The area surrounding the image is the background
1519
- color.</dd>
1520
-
1521
- <dt>TransparentVirtualPixelMethod</dt>
1522
-
1523
- <dd>The area surrounding the image is transparent
1524
- blackness.</dd>
1525
-
1526
- <dt>BlackVirtualPixelMethod</dt>
1527
-
1528
- <dd class="imquote">The area surrounding the image is
1529
- black.</dd>
1530
-
1531
- <dt>GrayVirtualPixelMethod</dt>
1532
-
1533
- <dd class="imquote">The area surrounding the image is
1534
- gray.</dd>
1535
-
1536
- <dt>WhiteVirtualPixelMethod</dt>
1537
-
1538
- <dd class="imquote">The area surrounding the image is
1539
- white.</dd>
1540
-
1541
- <dt>RandomVirtualPixelMethod</dt>
1542
-
1543
- <dd class="imquote">Choose a random pixel from the
1544
- image.</dd>
1545
-
1546
- <dt>DitherVirtualPixelMethod</dt>
1547
-
1548
- <dd class="imquote">use a dithered pattern to choose a pixel
1549
- in a 32x32 neighborhood.</dd>
1550
-
1551
- <dt>HorizontalTileVirtualPixelMethod</dt>
1552
-
1553
- <dd class="imquote">Horizontally tile the image</dd>
1554
-
1555
- <dt>VerticalTileVirtualPixelMethod</dt>
1556
-
1557
- <dd class="imquote">Vertically tile the image</dd>
1558
-
1559
- <dt>HorizontalTileEdgeVirtualPixelMethod</dt>
1560
-
1561
- <dd class="imquote">Horizontally tile the image and replicate
1562
- the side edge pixels</dd>
1563
-
1564
- <dt>VerticalTileEdgeVirtualPixelMethod</dt>
1565
-
1566
- <dd class="imquote">Vertically tile the image and replicate
1567
- the side edge pixels</dd>
1568
-
1569
- <dt>CheckerTileVirtualPixelMethod</dt>
1570
-
1571
- <dd class="imquote">Alternate squares with image and
1572
- background color</dd>
1573
- </dl>
1574
-
1575
- <p>Some of these values are not supported by older versions of
1576
- ImageMagick. To see what values are available, enter the
1577
- following code in irb:</p>
1578
- <pre>
1579
- Magick::VirtualPixelMethod.values {|v| puts v}
1580
- </pre>
1581
-
1582
- <h4>Returns</h4>
1583
-
1584
- <p>A <code>VirtualPixelMethod</code> constant.</p>
1585
-
1586
- <h4>Example</h4>
1587
- <pre>
1588
- img.virtual_pixel_method = Magick::TransparentVirtualPixelMethod
1589
- </pre>
1590
- </div>
1591
-
1592
- <div class="sig">
1593
- <h3 id="x_resolution">x_resolution</h3>
1594
-
1595
- <p><span class="arg">img.</span>x_resolution -&gt;
1596
- <em>float</em><br />
1597
- <span class="arg">img.</span>x_resolution = <span class=
1598
- "arg">float</span></p>
1599
- </div>
1600
-
1601
- <div class="desc">
1602
- <h4>Description</h4>
1603
-
1604
- <p class="imquote">Horizontal resolution of the image.</p>
1605
-
1606
- <h4>See also</h4>
1607
-
1608
- <p><a href="#units">units</a></p>
1609
- </div>
1610
-
1611
- <div class="sig">
1612
- <h3 id="y_resolution">y_resolution</h3>
1613
-
1614
- <p><span class="arg">img.</span>y_resolution -&gt;
1615
- <em>float</em><br />
1616
- <span class="arg">img.</span>y_resolution = <span class=
1617
- "arg">float</span></p>
1618
- </div>
1619
-
1620
- <div class="desc">
1621
- <h4>Description</h4>
1622
-
1623
- <p class="imquote">Vertical resolution of the image.</p>
1624
-
1625
- <h4>See also</h4>
1626
-
1627
- <p><a href="#units">units</a></p>
1628
- </div>
1629
-
1630
- <p class="spacer">&nbsp;</p>
1631
-
1632
- <div class="nav">
1633
- &laquo;&nbsp;<a href="ilist.html">Prev</a> | <a href=
1634
- "index.html">Contents</a> | <a href=
1635
- "image1.html">Next</a>&nbsp;&raquo;
1636
- </div>
1637
- </body>
1638
- </html>