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,416 +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 1 September 2005), see www.w3.org" />
8
-
9
- <title>RMagick 0.0.0 User's Guide and Reference</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
- <style type="text/css">
17
- /*<![CDATA[*/
18
-
19
- /* Styles local to this page. */
20
-
21
- #logo {
22
- position: absolute;
23
- top: 0;
24
- left: 0;
25
- width: 100%;
26
- background-color: black;
27
- margin: 0;
28
- }
29
- #logoborder {
30
- margin: 0;
31
- padding-left: 10px;
32
- font-weight: 700;
33
- font-style: italic;
34
- background-color: #900;
35
- color: #c0c0c0;
36
- }
37
- #magick {
38
- position:absolute;
39
- top: 20px;
40
- left: 380px;
41
- padding-left: 15px;
42
- margin-bottom: 0;
43
- color: #c0c0c0;
44
- background-color: black;
45
- font-weight: 700;
46
- font-family: sans-serif;
47
- }
48
- .tm {
49
- vertical-align: super;
50
- font-size: x-small;
51
- }
52
-
53
- h1 {
54
- text-align: left;
55
- background-color: #900;
56
- color: #ebebeb;
57
- padding: 5px .3em .5em .3em;
58
- margin-top: 110px;
59
- margin-bottom: 0;
60
- }
61
-
62
- h2 {
63
- margin-top: 0;
64
- margin-bottom: 0;
65
- padding-left: .3em;
66
- padding-right: .3em;
67
- padding-bottom: .5em;
68
- padding-top: .5em;
69
- background-color: #545454;
70
- color: white;
71
- }
72
-
73
- #toc ul {
74
- padding-top: 1em;
75
- padding-bottom: 1em;
76
- list-style: none;
77
- font-weight: bold;
78
- }
79
- #toc ul ul {
80
- padding-top: 0;
81
- list-style: square;
82
- font-weight: normal;
83
- }
84
- #toc ul ul ul {
85
- list-style: circle;
86
- }
87
-
88
- #Introduction {
89
- background-color: #663;
90
- margin-bottom: 1em;
91
- }
92
-
93
- #version {
94
- padding-top: 1em;
95
- margin-left: 0;
96
- margin-right: 0;
97
- }
98
- /*]]>*/
99
- </style>
100
- </head>
101
-
102
- <body>
103
- <div id="logo">
104
- <img alt="" src="ex/images/logo400x83.gif" />
105
- </div>
106
-
107
- <p id="magick">Ruby+ImageMagick<span class="tm">TM</span><br />
108
- Version 0.0.0</p>
109
-
110
- <h1>User's Guide and Reference</h1>
111
-
112
- <h2>Table of Contents</h2>
113
-
114
- <div id="toc">
115
- <ul>
116
- <li><a href="#introduction">Introduction</a></li>
117
-
118
- <li>User's Guide</li>
119
-
120
- <li style="list-style: none">
121
- <ul>
122
- <li><a href="usage.html">How to Use RMagick</a></li>
123
-
124
- <li><a href="imusage.html">ImageMagick
125
- Conventions</a></li>
126
-
127
- <li><a href="optequiv.html">Magick Command Options and
128
- Their Equivalent Methods</a></li>
129
-
130
- <li><a href="comtasks.html">Common Tasks</a></li>
131
- </ul>
132
- </li>
133
-
134
- <li>Reference</li>
135
-
136
- <li style="list-style: none">
137
- <ul>
138
- <li>Modules</li>
139
-
140
- <li style="list-style: none">
141
- <ul>
142
- <li><a href="magick.html">Magick</a></li>
143
- </ul>
144
- </li>
145
-
146
- <li>Classes</li>
147
-
148
- <li style="list-style: none">
149
- <ul>
150
- <li><a href="ilist.html">ImageList</a></li>
151
-
152
- <li><a href="imageattrs.html">Image (attribute
153
- methods)</a></li>
154
-
155
- <li><a href="image1.html">Image (class methods and
156
- instance methods a-d)</a></li>
157
-
158
- <li><a href="image2.html">Image (instance methods
159
- e-o)</a></li>
160
-
161
- <li><a href="image3.html">Image (instance methods
162
- p-w)</a></li>
163
-
164
- <li><a href="draw.html">Draw</a></li>
165
- </ul>
166
- </li>
167
-
168
- <li>
169
- <a href="struct.html">Miscellaneous classes</a>
170
-
171
- <ul>
172
- <li><a href="struct.html#view">Image::View</a></li>
173
-
174
- <li><a href="struct.html#Geometry">Geometry</a></li>
175
-
176
- <li><a href="struct.html#Pixel">Pixel</a></li>
177
-
178
- <li><a href="struct.html#struct">Struct
179
- classes</a></li>
180
-
181
- <li><a href="struct.html#fill">Fill classes</a></li>
182
-
183
- <li><a href="struct.html#exception">Exception
184
- classes</a></li>
185
- </ul>
186
- </li>
187
-
188
- <li><a href="info.html">Image::Info - Optional method
189
- arguments</a></li>
190
-
191
- <li><a href="constants.html">Constants</a></li>
192
- </ul>
193
- </li>
194
-
195
- <li>RVG - Ruby Vector Graphics</li>
196
-
197
- <li style="list-style:none">
198
- <ul>
199
- <li><a href="rvgtut.html">Drawing with RVG: A
200
- tutorial</a></li>
201
-
202
- <li>RVG Reference
203
-
204
- <ul>
205
- <li><a href="rvg.html">class RVG</a></li>
206
-
207
- <li><a href="rvggroup.html">class RVG::Group</a></li>
208
-
209
- <li><a href="rvgimage.html">class RVG::Image</a></li>
210
-
211
- <li><a href="rvgpattern.html">class
212
- RVG::Pattern</a></li>
213
-
214
- <li><a href="rvgclip.html">class
215
- RVG::ClipPath</a></li>
216
-
217
- <li><a href="rvgtext.html">class RVG::Text</a></li>
218
-
219
- <li><a href="rvgtspan.html">class RVG::Tspan</a></li>
220
-
221
- <li><a href="rvguse.html">class RVG::Use</a></li>
222
-
223
- <li><a href="rvgstyle.html">The styles
224
- method</a></li>
225
-
226
- <li><a href="rvgshape.html">The shapes
227
- methods</a></li>
228
-
229
- <li><a href="rvgxform.html">The transform
230
- methods</a></li>
231
- </ul>
232
- </li>
233
- </ul>
234
- </li>
235
- </ul>
236
- </div>
237
-
238
- <h2 id="introduction">Introduction</h2>
239
-
240
- <h3>What is RMagick?</h3>
241
-
242
- <p>RMagick is a binding from Ruby to the ImageMagick <span class=
243
- "tm">TM</span> image manipulation library. Here's how the
244
- <a href="http://www.imagemagick.org">ImageMagick home page</a>
245
- describes ImageMagick:</p>
246
-
247
- <div class="imquote">
248
- <p>ImageMagick<span style=
249
- "font-size: x-small; vertical-align: super">TM</span>... is a
250
- free software suite to create, edit, and compose bitmap images.
251
- It can read, convert and write images in a large variety of
252
- formats. Images can be cropped, colors can be changed, various
253
- effects can be applied, images can be rotated and combined, and
254
- text, lines, polygons, ellipses and B&eacute;zier curves can be
255
- added to images and stretched and rotated.</p>
256
- </div>
257
-
258
- <p>ImageMagick offers a full range of image processing tools that
259
- provide the capability to:</p>
260
-
261
- <div class="imquote">
262
- <ul>
263
- <li>Convert an image from one format to another (e.g. TIFF to
264
- JPEG)</li>
265
-
266
- <li>Resize, rotate, sharpen, color reduce, or add special
267
- effects to an image</li>
268
-
269
- <li>Create a montage of image thumbnails</li>
270
-
271
- <li>Create a transparent image suitable for use on the
272
- Web</li>
273
-
274
- <li>Turn a group of images into a GIF animation sequence</li>
275
-
276
- <li>Create a composite image by combining several separate
277
- images</li>
278
-
279
- <li>Draw shapes or text on an image</li>
280
-
281
- <li>Decorate an image with a border or frame</li>
282
-
283
- <li>Describe the format and characteristics of an image</li>
284
- </ul>
285
- </div>
286
-
287
- <p>RMagick is a complete interface to ImageMagick. Version 1.0.0
288
- was released in February, 2003. Within its four major classes and
289
- 18 minor classes RMagick defines over 650 methods and 350
290
- constants. RMagick exploits Ruby idioms such as blocks and
291
- iterators, Struct classes, symbols, ?- and !-suffixed methods,
292
- and exceptions.</p>
293
-
294
- <h3>About this document</h3>
295
-
296
- <p>This document describes Version 0.0.0 of RMagick. It is
297
- divided into 4 parts. The first is this page. The second part is
298
- a user's guide covering both RMagick and ImageMagick usage and
299
- conventions. The third part is a reference guide to the
300
- ImageList, Image, and Draw classes. This guide includes many
301
- examples. The fourth part covers Ruby Vector Graphics (RVG). RVG
302
- is a facade for Draw that provides a high-level API for scalable
303
- vector graphics. The RVG section includes a tutorial and complete
304
- reference documentation.</p>
305
-
306
- <p>Accompanying the HTML documentation is a set of over 175
307
- example RMagick programs. Each is a complete, stand-alone program
308
- that either creates an image from scratch or modifies an input
309
- image using one or more RMagick methods. The output images are
310
- used as illustrations in the HTML documentation. Throughout this
311
- document, click any example image to see the program that created
312
- it.</p>
313
-
314
- <h4>Conventions</h4>
315
-
316
- <p><b>Names&nbsp;&nbsp;</b>I've tried to follow existing Ruby
317
- conventions in this document. A class is identified by its name,
318
- which always starts with a capital letter. An object is referred
319
- to by its class name, starting with a small letter. For example,
320
- a generic ImageList object is referred to as an
321
- <em>imagelist</em>. Class methods are identified like this:
322
- <code>Class.method</code>. Instance methods are identified like
323
- this: <code>Class#method</code>.</p>
324
-
325
- <p>RMagick is implemented in the <b>Magick</b> module, therefore
326
- its constants are in the Magick namespace. However, for clarity
327
- I've omitted the <code>Magick::</code> prefix in most places in
328
- this document. You can use the <code>include Magick</code>
329
- statement to add the constants and methods to the Object
330
- namespace.</p>
331
-
332
- <p><b>ImageMagick documentation&nbsp;&nbsp;</b><span class=
333
- "imquote">Text that looks like this</span> is quoted from the
334
- ImageMagick documentation.</p>
335
-
336
- <p><b>Example programs and images&nbsp;&nbsp;</b> All of the
337
- example images on these pages were created by RMagick. Click the
338
- image to see the program code. (You may need to configure your
339
- browser to allow JavaScript and pop-up windows.) All example
340
- images show the result of applying the method. Many example
341
- images show the "before" image as well. When the image is
342
- accompanied by this symbol <img style="display:inline" src=
343
- "ex/images/spin.gif" alt="rollover" /> mouse over the image to
344
- see the "before" version.</p>
345
-
346
- <h3>How to get help</h3>
347
-
348
- <p>If you have a question that is not answered by these pages,
349
- you can post it at the <a href=
350
- "http://rubyforge.org/projects/rmagick">Support Request
351
- Tracker</a> or the <a href=
352
- "http://rubyforge.org/projects/rmagick">Feature Request
353
- Tracker</a> on RubyForge, or email me at <code>rmagick at
354
- rubyforge dot org</code>.</p>
355
-
356
- <h3><a name="bugs" id="bugs">Reporting bugs</a></h3>
357
-
358
- <p>Please report problems with RMagick installation and usage to
359
- the <a href="http://rubyforge.org/projects/rmagick/">Bug
360
- Tracker</a> at RubyForge, or email me at <code>rmagick at
361
- rubyforge dot org</code>.</p>
362
-
363
- <p>For quickest results, include the RMagick, ImageMagick and
364
- Ruby version numbers, along with a thorough description of the
365
- problem. RMagick will tell you both its version number and
366
- ImageMagick's version number. Simply bring up irb and run this
367
- command:</p>
368
- <pre class="example" id="version">
369
- $ ruby -rRMagick -e "puts Magick::Long_version"
370
- This is RMagick 2.0.0 ($Date: 2009/02/28 23:50:16 $) Copyright (C) 2007 by Timothy P. Hunter
371
- Built with ImageMagick 6.3.7 12/20/07 Q16 http://www.imagemagick.org
372
- Built for ruby 1.8.6
373
- Web page: http://rmagick.rubyforge.org
374
- Email: rmagick@rubyforge.org
375
- </pre>
376
-
377
- <p>(Using RubyGems?&nbsp;&nbsp;If you haven't added
378
- <code>rubygems</code> to your RUBYOPT environment variable you
379
- may need to use this command instead: <code>ruby -rubygems -r
380
- RMagick -e "puts Magick::Long_version"</code>.)</p>
381
-
382
- <p>It will help a lot if you supply a small Ruby program that
383
- reproduces the problem. Don't forget to include any input image
384
- files!</p>
385
-
386
- <p>Please remember I can't help with Ruby or ImageMagick
387
- installation and configuration problems. For help with Ruby, post
388
- your questions to <code>comp.lang.ruby</code>. For help with
389
- ImageMagick, you can post to the <a href=
390
- "http://www.imagemagick.org/discourse-server/">ImageMagick
391
- Discourse Server</a>.</p>
392
-
393
- <p>I'm not an image processing guru, either, so I probably won't
394
- be able to help with questions about specific image formats and
395
- transformations. I will be glad, however, to intermediate between
396
- RMagick users and the ImageMagick developers.</p>
397
-
398
- <h3><a name="copyrights" id="copyrights">Copyright
399
- Notices</a></h3>
400
-
401
- <ul>
402
- <li>RMagick &copy; 2002-2009 Timothy P. Hunter.</li>
403
-
404
- <li>ImageMagick &copy; 1999-2009 ImageMagick Studio.</li>
405
-
406
- <li>Ruby is copyrighted free software by Yukihiro
407
- Matsumoto.</li>
408
- </ul>
409
-
410
- <div class="nav">
411
- &laquo; <a href="index.html">Prev</a> | <a href=
412
- "index.html">Contents</a> | <a href="usage.html">Next</a>
413
- &raquo;
414
- </div>
415
- </body>
416
- </html>
@@ -1,1499 +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::Info - Optional method
10
- arguments</title>
11
- <meta http-equiv="Content-Type" content=
12
- "text/html; charset=us-ascii" />
13
- <meta name="GENERATOR" content="Quanta Plus" />
14
- <meta name="Copyright" content=
15
- "Copyright (C) 2006 by Timothy P. Hunter" />
16
- <link rel="stylesheet" type="text/css" href="css/doc.css" />
17
- <script type="text/javascript" src="scripts/doc.js">
18
- </script>
19
- <style type="text/css">
20
- /*<![CDATA[*/
21
-
22
- /* Styles local to this page. */
23
-
24
- h2 {
25
- margin-top: 1em;
26
- margin-bottom: 1em;
27
- padding-left: .3em;
28
- padding-right: .3em;
29
- padding-bottom: .5em;
30
- padding-top: .5em;
31
- background-color: #545454;
32
- color: white;
33
- }
34
-
35
- #intro h2 {
36
- clear: both;
37
- }
38
- #compression_notes li {
39
- font-style: italic;
40
- }
41
-
42
- /*]]>*/
43
- </style>
44
- </head>
45
-
46
- <body>
47
- <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
48
-
49
- <div class="nav">
50
- &laquo;&nbsp;<a href="struct.html">Prev</a> | <a href=
51
- "index.html">Contents</a> | <a href=
52
- "constants.html">Next</a>&nbsp;&raquo;
53
- </div>
54
-
55
- <h1>class Image::Info - Optional method arguments</h1>
56
-
57
- <div id="toc">
58
- <h2>Table of Contents</h2>
59
-
60
- <h3>instance methods</h3>
61
-
62
- <ul>
63
- <li><a href="#aset">[]=</a></li>
64
-
65
- <li><a href="#aref">[]</a></li>
66
-
67
- <li><a href="#channel">channel</a></li>
68
-
69
- <li><a href="#define">define</a></li>
70
-
71
- <li><a href="#undefine">undefine</a></li>
72
- </ul>
73
-
74
- <h3>attribute methods</h3>
75
-
76
- <div class="toccol">
77
- <ul>
78
- <li><a href="#antialias">antialias</a></li>
79
-
80
- <li><a href="#attenuate">attenuate</a></li>
81
-
82
- <li><a href="#authenticate">authenticate</a></li>
83
-
84
- <li><a href="#background_color">background_color</a></li>
85
-
86
- <li><a href="#border_color">border_color</a></li>
87
-
88
- <li><a href="#caption">caption</a></li>
89
-
90
- <li><a href="#colorspace">colorspace</a></li>
91
-
92
- <li><a href="#comment">comment</a></li>
93
-
94
- <li><a href="#compression">compression</a></li>
95
-
96
- <li><a href="#delay">delay</a></li>
97
-
98
- <li><a href="#density">density</a></li>
99
-
100
- <li><a href="#depth">depth</a></li>
101
-
102
- <li><a href="#dispose">dispose</a></li>
103
-
104
- <li><a href="#dither">dither</a></li>
105
-
106
- <li><a href="#endian">endian</a></li>
107
- </ul>
108
- </div>
109
-
110
- <div class="toccol">
111
- <ul>
112
- <li><a href="#extract">extract</a></li>
113
-
114
- <li><a href="#filename">filename</a></li>
115
-
116
- <li><a href="#fill">fill</a></li>
117
-
118
- <li><a href="#font">font</a></li>
119
-
120
- <li><a href="#format">format</a></li>
121
-
122
- <li><a href="#fuzz">fuzz</a></li>
123
-
124
- <li><a href="#gravity">gravity</a></li>
125
-
126
- <li><a href="#image_type">image_type</a></li>
127
-
128
- <li><a href="#interlace">interlace</a></li>
129
-
130
- <li><a href="#label">label</a></li>
131
-
132
- <li><a href="#matte_color">matte_color</a></li>
133
-
134
- <li><a href="#monitor">monitor</a></li>
135
-
136
- <li><a href="#monochrome">monochrome</a></li>
137
-
138
- <li><a href="#orientation">orientation</a></li>
139
-
140
- <li><a href="#origin">origin</a></li>
141
- </ul>
142
- </div>
143
-
144
- <div class="toccol">
145
- <ul>
146
- <li><a href="#page">page</a></li>
147
-
148
- <li><a href="#pointsize">pointsize</a></li>
149
-
150
- <li><a href="#quality">quality</a></li>
151
-
152
- <li><a href="#sampling_factor">sampling_factor</a></li>
153
-
154
- <li><a href="#scene">scene</a></li>
155
-
156
- <li><a href="#server_name">server_name</a></li>
157
-
158
- <li><a href="#size">size</a></li>
159
-
160
- <li><a href="#stroke">stroke</a></li>
161
-
162
- <li><a href="#stroke_width">stroke_width</a></li>
163
-
164
- <li><a href="#tile_offset">tile_offset</a></li>
165
-
166
- <li><a href="#texture">texture</a></li>
167
-
168
- <li><a href="#transparent_color">transparent_color</a></li>
169
-
170
- <li><a href="#undercolor">undercolor</a></li>
171
-
172
- <li><a href="#units">units</a></li>
173
-
174
- <li><a href="#view">view</a></li>
175
- </ul>
176
- </div>
177
- </div>
178
-
179
- <div id="intro">
180
- <h2>The Image::Info class</h2>
181
-
182
- <p>Some <code>Image</code> and <code>ImageList</code> methods,
183
- such as <code>read</code> and <code>write</code>, accept an
184
- "optional arguments" block in which you can set attributes that
185
- modify the method's output. These attributes belong to the
186
- <code>Image::Info</code> class. The <code>Image::Info</code>
187
- class exists only to accept optional arguments for those
188
- <code>Image</code> and <code>ImageList</code> methods.</p>
189
-
190
- <p>This page explains the methods defined in the
191
- <code>Image::Info</code> class. Generally, each
192
- <code>Image</code> or <code>ImageList</code> method that uses
193
- the <code>Image::Info</code> class to get optional arguments
194
- will only accept some of the attributes listed on this page,
195
- that is, only those attributes that are meaningful for the
196
- particular method. Any other attributes that you set are
197
- ignored. Also, some attributes are only used by a subset of the
198
- image formats. See the ImageMagick documentation for more
199
- information.</p>
200
-
201
- <p>Remember, you do not ever need to create an
202
- <code>Image::Info</code> object. The object is created for you
203
- before the optional arguments block is entered and destroyed
204
- after the block is exited.</p>
205
-
206
- <p>All the attributes in the <code>Image::Info</code> class are
207
- read/write. For simplicity, and because usually you only set
208
- these attributes, this page only describes the setter version
209
- of each attribute method.</p>
210
- </div>
211
-
212
- <h2 class="methods">instance methods</h2>
213
-
214
- <div class="sig">
215
- <h3 id="aset">[]=</h3>
216
-
217
- <p><span class="arg">self</span>[<span class=
218
- "arg">format</span>, <span class="arg">key</span>] =
219
- <span class="arg">value</span> -&gt; <span class=
220
- "arg">self</span><br />
221
- <span class="arg">self</span>[<span class="arg">key</span>] =
222
- <span class="arg">value</span> -&gt; <span class=
223
- "arg">self</span></p>
224
- </div>
225
-
226
- <div class="desc">
227
- <h4>Description</h4>
228
-
229
- <p>Define an option. An alternative to <a href=
230
- "#define">define</a>, below. Use this method to set options for
231
- reading or writing certain image formats. The list of supported
232
- options changes from release to release. For a list of the
233
- valid image formats, keys, and values, refer to the
234
- documentation for the -define option for the release of
235
- ImageMagick installed on your system.</p>
236
-
237
- <h4>Arguments</h4>
238
-
239
- <dl>
240
- <dt>format</dt>
241
-
242
- <dd>An image format name such as "ps" or "tiff". (Depending
243
- on the key, this argument may be omitted.)</dd>
244
-
245
- <dt>key</dt>
246
-
247
- <dd>A string that identifies the option.</dd>
248
-
249
- <dt>value</dt>
250
-
251
- <dd>The value of the option. <span class="arg">Value</span>
252
- can be any object that responds to <code>to_s</code>. Use
253
- <code>nil</code> to set the key to a null value.</dd>
254
- </dl>
255
-
256
- <h4 id="user_option">The "user" option</h4>
257
-
258
- <p>The "user" option is unique to RMagick. It may be set to any
259
- string. If this option is used when creating an image via one
260
- of the methods listed below then the new image gets the value
261
- assigned as a property as if <code>img["user"]</code> had been
262
- used. In addition, the value is displayed in the string
263
- returned by <code>Image#inspect</code>. The "user" property can
264
- be used to help distinguish otherwise similar images when
265
- debugging.</p>
266
-
267
- <p>For example,</p>
268
- <pre>
269
- img = Magick::Image.new(10,10) do
270
- self['user'] = __FILE__ + ':' + __LINE__.to_s
271
- end &raquo; 10x10 DirectClass 16-bit user:test.rb:3
272
- </pre>
273
-
274
- <p>These methods propogate the value of the "user" option to
275
- new image(s): <code>Image.new, ImageList.new,
276
- ImageList.new_image, Image.capture, Image.from_blob,
277
- ImageList.from_blob, Image.read, ImageList.read,
278
- Image.read_inline, and Image.ping</code>.</p>
279
-
280
- <h4>Returns</h4>
281
-
282
- <p>self</p>
283
-
284
- <h4>Example</h4>
285
- <pre>
286
- self["tiff", "bits-per-sample"] = 2
287
- </pre>
288
-
289
- <h4>Magick API</h4>
290
-
291
- <p>SetImageOption</p>
292
- </div>
293
-
294
- <div class="sig">
295
- <h3 id="aref">[]</h3>
296
-
297
- <p><span class="arg">self</span>[<span class=
298
- "arg">format</span>, <span class="arg">key</span>] -&gt;
299
- <em>value</em><br />
300
- <span class="arg">self</span>[<span class="arg">key</span>]
301
- -&gt; <em>value</em></p>
302
- </div>
303
-
304
- <div class="desc">
305
- <h4>Description</h4>
306
-
307
- <p>Returns the value of the specified option for the specified
308
- format.</p>
309
-
310
- <h4>Arguments</h4>
311
-
312
- <dl>
313
- <dt>format</dt>
314
-
315
- <dd>An image format name such as "ps" or "tiff". (Depending
316
- on the key, this argument may be omitted.)</dd>
317
-
318
- <dt>key</dt>
319
-
320
- <dd>A string that identifies the option.</dd>
321
- </dl>
322
-
323
- <h4>Returns</h4>
324
-
325
- <p>The value of the option. Always a string.</p>
326
-
327
- <h4>Example</h4>
328
- <pre>
329
- self["tiff", "bits-per-sample"] &raquo; 2
330
- </pre>
331
-
332
- <h4>Magick API</h4>
333
-
334
- <p>GetImageOption</p>
335
- </div>
336
-
337
- <div class="sig">
338
- <h3 id="channel">channel</h3>
339
-
340
- <p><span class="arg">self</span>.channel([<span class=
341
- "arg">channel</span> [, <span class=
342
- "arg">channel</span>...]])</p>
343
- </div>
344
-
345
- <div class="desc">
346
- <h4>Description</h4>
347
-
348
- <p>Restrict the method to the specified channel(s). This
349
- attribute is set-only.</p>
350
-
351
- <h4>Argument</h4>
352
-
353
- <p>The arguments may be any <a href=
354
- "constants.html#ChannelType">ChannelType</a> values.</p>
355
-
356
- <h4>Notes</h4>
357
-
358
- <p>If you call <code>channel</code> with no arguments,
359
- <em>all</em> channels are included. If you do not call
360
- <code>channel</code> at all, the channels used do not include
361
- the alpha channel.</p>
362
- </div>
363
-
364
- <div class="sig">
365
- <h3 id="define">define</h3>
366
-
367
- <p><span class="arg">self</span>.define(<span class=
368
- "arg">format</span>, <span class="arg">key</span>[,
369
- <span class="arg">value</span>])</p>
370
- </div>
371
-
372
- <div class="desc">
373
- <h4>Description</h4>
374
-
375
- <p>Define a format-specific option. See <a href=
376
- "#aset">[]=</a>, above.</p>
377
-
378
- <h4>Arguments</h4>
379
-
380
- <dl>
381
- <dt>format</dt>
382
-
383
- <dd>An image format name such as "ps" or "tiff".</dd>
384
-
385
- <dt>key</dt>
386
-
387
- <dd>A string that identifies the option.</dd>
388
-
389
- <dt>value</dt>
390
-
391
- <dd>The value of the option. <span class="arg">Value</span>
392
- can be any object that responds to <code>to_s</code>. If
393
- omitted, the key is simply defined to an null value.</dd>
394
- </dl>
395
-
396
- <h4>Returns</h4>
397
-
398
- <p>self</p>
399
-
400
- <h4>Example</h4>
401
- <pre>
402
- self.define("tiff", "bits-per-sample", 2)
403
- </pre>
404
-
405
- <h4>Magick API</h4>
406
-
407
- <p>SetImageOption</p>
408
- </div>
409
-
410
- <div class="sig">
411
- <h3 id="undefine">undefine</h3>
412
-
413
- <p><span class="arg">self</span>.undefine(<span class=
414
- "arg">format</span>, <span class="arg">key</span>)</p>
415
- </div>
416
-
417
- <div class="desc">
418
- <h4>Description</h4>
419
-
420
- <p>Delete an option definition set by <a href="#aset">[]=</a>
421
- or <a href="#define">define</a>. This is not the same as
422
- setting the option to a null value. The <code>undefine</code>
423
- method removes the option name from the list of options for the
424
- specified format.</p>
425
-
426
- <h4>Arguments</h4>
427
-
428
- <dl>
429
- <dt>format</dt>
430
-
431
- <dd>An image format name such as "ps" or "tiff".</dd>
432
-
433
- <dt>key</dt>
434
-
435
- <dd>A string that identifies the option.</dd>
436
- </dl>
437
-
438
- <h4>Returns</h4>
439
-
440
- <p>self</p>
441
-
442
- <h4>Example</h4>
443
- <pre>
444
- self.undefine("tiff", "bits-per-sample")
445
-
446
- </pre>
447
- </div>
448
-
449
- <h2 class="methods">attribute methods</h2>
450
-
451
- <div class="sig">
452
- <h3 id="antialias">antialias</h3>
453
-
454
- <p><span class="arg">self.</span>antialias= <span class=
455
- "arg"><code>true</code></span> or <span class=
456
- "arg"><code>false</code></span></p>
457
- </div>
458
-
459
- <div class="desc">
460
- <h4>Description</h4>
461
-
462
- <p><span class="imquote">Control antialiasing of rendered
463
- Postscript and Postscript or TrueType fonts.</span> The default
464
- is <code>true</code>.</p>
465
- </div>
466
-
467
- <div class="sig">
468
- <h3 id="attenuate">attenuate</h3>
469
-
470
- <p><span class="arg">self</span>.attenuate= <span class=
471
- "arg">number</span></p>
472
- </div>
473
-
474
- <div class="desc">
475
- <h4>Description</h4>
476
-
477
- <p class="imquote">Lessen (or intensify) when adding noise to
478
- an image.</p>
479
- </div>
480
-
481
- <div class="sig">
482
- <h3 id="authenticate">authenticate</h3>
483
-
484
- <p><span class="arg">self.</span>authenticate= <span class=
485
- "arg">string</span></p>
486
- </div>
487
-
488
- <div class="desc">
489
- <h4>Description</h4>
490
-
491
- <p class="imquote">Decrypt an image with this password.</p>
492
-
493
- <p>This attribute can be used to specify the password to be
494
- used when reading an image or image sequence that is in an
495
- encrypted format, such as PDF.</p>
496
- </div>
497
-
498
- <div class="sig">
499
- <h3 id="background_color">background_color</h3>
500
-
501
- <p><span class="arg">self.</span>background_color= <span class=
502
- "arg">string</span> or <span class="arg">pixel</span></p>
503
- </div>
504
-
505
- <div class="desc">
506
- <h4>Description</h4>
507
-
508
- <p>Set the image background color. The default is "white".</p>
509
-
510
- <h4>Arguments</h4>
511
-
512
- <p>A <a href="imusage.html#color_names">color name</a> or a
513
- <a href="struct.html#Pixel">Pixel</a>.</p>
514
- </div>
515
-
516
- <div class="sig">
517
- <h3 id="border_color">border_color</h3>
518
-
519
- <p><span class="arg">self.</span>border_color= <span class=
520
- "arg">string</span> or <span class="arg">pixel</span></p>
521
- </div>
522
-
523
- <div class="desc">
524
- <h4>Description</h4>
525
-
526
- <p>Set the image border color. The default is "#dfdfdf".</p>
527
-
528
- <h4>Arguments</h4>
529
-
530
- <p>A <a href="imusage.html#color_names">color name</a> or a
531
- <a href="struct.html#Pixel">Pixel</a>.</p>
532
- </div>
533
-
534
- <div class="sig">
535
- <h3 id="caption">caption</h3>
536
-
537
- <p><span class="arg">self.</span>caption= <span class=
538
- "arg">string</span></p>
539
- </div>
540
-
541
- <div class="desc">
542
- <h4>Description</h4>
543
-
544
- <p>When used with <a href="image1.html#read">Image.read</a>,
545
- assigns a caption to an image. The caption is an image
546
- property:</p>
547
- <pre>
548
- img = Magick::Image.read("xc:white") do
549
- self.caption = "a new caption"
550
- self.size = "20x20"
551
- end
552
- p img.first.properties &raquo; {"caption"=&gt;"a new caption"}
553
- p img.first['caption'] &raquo; "a new caption"
554
- </pre>
555
-
556
- <h4>Arguments</h4>
557
-
558
- <p>A string.</p>
559
- </div>
560
-
561
- <div class="sig">
562
- <h3 id="colorspace">colorspace</h3>
563
-
564
- <p><span class="arg">self.</span>colorspace= <span class=
565
- "arg">colorspace</span></p>
566
- </div>
567
-
568
- <div class="desc">
569
- <h4>Description</h4>
570
-
571
- <p>Specifies the image pixel interpretation.</p>
572
-
573
- <h4>Arguments</h4>A <a href=
574
- "constants.html#ColorspaceType">ColorspaceType</a> constant.
575
- </div>
576
-
577
- <div class="sig">
578
- <h3 id="comment">comment</h3>
579
-
580
- <p><span class="arg">self.</span>comment= <span class=
581
- "arg">string</span></p>
582
- </div>
583
-
584
- <div class="desc">
585
- <h4>Description</h4>
586
-
587
- <p class="imquote">Use this option to assign a specific comment
588
- to the image, when writing to an image format that supports
589
- comments.</p>
590
-
591
- <h4>Arguments</h4>
592
-
593
- <p class="imquote">You can include the image filename, type,
594
- width, height, or other image attribute by embedding special
595
- format characters listed under the <a href=
596
- "draw.html#annotate">annotate</a> method.</p>
597
- </div>
598
-
599
- <div class="sig">
600
- <h3 id="compression">compression</h3>
601
-
602
- <p><span class="arg">self.</span>compression= <span class=
603
- "arg">type</span></p>
604
- </div>
605
-
606
- <div class="desc">
607
- <h4>Description</h4>
608
-
609
- <p>Specifies the type of compression used when writing the
610
- image. Only some image formats support compression. For those
611
- that do, only some compression types are supported. If you
612
- specify an compression type that is not supported, the default
613
- compression type (usually NoCompression) is used instead.</p>
614
-
615
- <p>Some compression types support varying levels of
616
- compression. See the <a href=
617
- "#quality"><code>quality</code></a> attribute.</p>
618
-
619
- <p>The following table shows the image formats that support
620
- compression. For each format, the right-hand column shows the
621
- supported compression types. The default compression type is
622
- shown in <strong>bold</strong>.</p>
623
-
624
- <table class="simple_table" summary=
625
- "supported compression types by image format">
626
- <caption>
627
- Supported Compression Types
628
- </caption>
629
-
630
- <tr>
631
- <th>Format</th>
632
-
633
- <th>Compression Types</th>
634
- </tr>
635
-
636
- <tr>
637
- <td>BMP</td>
638
-
639
- <td><strong>NoCompression</strong>, RLECompression</td>
640
- </tr>
641
-
642
- <tr>
643
- <td>DIB</td>
644
-
645
- <td><strong>NoCompression</strong>, RLECompression</td>
646
- </tr>
647
-
648
- <tr>
649
- <td>FPX</td>
650
-
651
- <td><strong>NoCompression</strong>, JPEGCompression</td>
652
- </tr>
653
-
654
- <tr>
655
- <td>GIF</td>
656
-
657
- <td><strong>LZWCompression</strong></td>
658
- </tr>
659
-
660
- <tr>
661
- <td>JNG</td>
662
-
663
- <td><strong>NoCompression</strong>, JPEGCompression</td>
664
- </tr>
665
-
666
- <tr>
667
- <td>JP2</td>
668
-
669
- <td><strong>JPEGCompression</strong>,
670
- LosslessJPEGCompression</td>
671
- </tr>
672
-
673
- <tr>
674
- <td>JPG</td>
675
-
676
- <td><strong>JPEGCompression</strong>,
677
- LosslessJPEGCompression</td>
678
- </tr>
679
-
680
- <tr>
681
- <td>MIFF</td>
682
-
683
- <td><strong>NoCompression</strong>, RLECompression</td>
684
- </tr>
685
-
686
- <tr>
687
- <td>MNG</td>
688
-
689
- <td><strong>NoCompression</strong>, JPEGCompression</td>
690
- </tr>
691
-
692
- <tr>
693
- <td>PALM</td>
694
-
695
- <td><strong>NoCompression</strong>, FaxCompression,
696
- RLECompression</td>
697
- </tr>
698
-
699
- <tr>
700
- <td>PDB</td>
701
-
702
- <td><strong>NoCompression</strong>, RLECompression</td>
703
- </tr>
704
-
705
- <tr>
706
- <td>PDF</td>
707
-
708
- <td><strong>NoCompression</strong>, JPEGCompression,
709
- LZWCompression, ZipCompression</td>
710
- </tr>
711
-
712
- <tr>
713
- <td>PICT</td>
714
-
715
- <td><strong>NoCompression</strong>, JPEGCompression</td>
716
- </tr>
717
-
718
- <tr>
719
- <td>PNG</td>
720
-
721
- <td><strong>NoCompression</strong>, ZIPCompression</td>
722
- </tr>
723
-
724
- <tr>
725
- <td>PS</td>
726
-
727
- <td><strong>NoCompression</strong>, RLECompression</td>
728
- </tr>
729
-
730
- <tr>
731
- <td>PS2</td>
732
-
733
- <td><strong>RLECompression</strong>, FaxCompression,
734
- JPEGCompression, LZWCompression, NoCompression</td>
735
- </tr>
736
-
737
- <tr>
738
- <td>PS3</td>
739
-
740
- <td><strong>FaxCompression</strong>, JPEGCompression,
741
- LZWCompression, NoCompression, RLECompression,
742
- ZipCompression</td>
743
- </tr>
744
-
745
- <tr>
746
- <td>TIFF</td>
747
-
748
- <td><strong>NoCompression</strong>, FaxCompression,
749
- Group4Compression, JPEGCompression, LZWCompression,
750
- RLECompression, ZipCompression</td>
751
- </tr>
752
- </table>
753
-
754
- <h5>Notes</h5>
755
-
756
- <ol id="compression_notes">
757
- <li>NoCompression is accepted for all image formats. Except
758
- as noted in the table, it is the default.</li>
759
-
760
- <li>This table is based on my examination of the ImageMagick
761
- source code. It is not necessarily complete and it may
762
- contain mistakes. If you need an authoritative list, you
763
- should consult the ImageMagick developers.</li>
764
- </ol>
765
-
766
- <h4>Arguments</h4>A <a href=
767
- "constants.html#CompressionType">CompressionType</a> constant.
768
- </div>
769
-
770
- <div class="sig">
771
- <h3 id="density">density</h3>
772
-
773
- <p><span class="arg">self.</span>density= <span class=
774
- "arg">string</span> or <span class="arg">geometry</span></p>
775
- </div>
776
-
777
- <div class="desc">
778
- <h4>Description</h4>
779
-
780
- <p>Specifies the vertical and horizontal resolution in pixels.
781
- The default density is "72.0x72.0". This attribute can be used
782
- when writing JBIG, PCL, PS, PS2, and PS3 format images.</p>
783
-
784
- <p>This attribute can also be used to specify the width and
785
- height of HISTOGRAM format images. For HISTOGRAM, the default
786
- is 256x200.</p>
787
-
788
- <h4>Arguments</h4>
789
-
790
- <p>The argument can be either a string in the form "XxY" where
791
- "X" is the horizontal resolution and "Y" is the vertical
792
- resolution, or a <a href="struct.html#Geometry">Geometry</a>
793
- object where <code>width</code> is the horizontal resolution
794
- and <code>height</code> is the vertical resolution.</p>
795
- </div>
796
-
797
- <div class="sig">
798
- <h3 id="delay">delay</h3>
799
-
800
- <p><span class="arg">self.</span>delay= <span class=
801
- "arg">integer</span></p>
802
- </div>
803
-
804
- <div class="desc">
805
- <h4>Description</h4>
806
-
807
- <p class="imquote">This attribute is useful for regulating the
808
- animation of image sequences. <em>delay</em>/100 seconds must
809
- expire before the display of the next image. The default is no
810
- delay between each showing of the image sequence. The maximum
811
- delay is 65535.</p>
812
- </div>
813
-
814
- <div class="sig">
815
- <h3 id="depth">depth</h3>
816
-
817
- <p><span class="arg">self.</span>depth= <span class=
818
- "arg">integer</span></p>
819
- </div>
820
-
821
- <div class="desc">
822
- <h4>Description</h4>
823
-
824
- <p>Specifies the image depth.</p>
825
-
826
- <h4>Arguments</h4>
827
-
828
- <p>Either 8, 16, or 32. You can specify 16 and 32 only when
829
- ImageMagick was compiled with a QuantumDepth that allows these
830
- depth values.</p>
831
-
832
- <p>Use <code>depth</code> to specify the depth of CMYK, GRAY,
833
- RGB, RGBA, MAP, and XC format images. See also <a href=
834
- "#size"><code>size</code></a>.</p>
835
- </div>
836
-
837
- <div class="sig">
838
- <h3 id="dispose">dispose</h3>
839
-
840
- <p><span class="arg">self.</span>dispose= <span class=
841
- "arg">type</span></p>
842
- </div>
843
-
844
- <div class="desc">
845
- <h4>Description</h4>
846
-
847
- <p class="imquote">The argument indicates the way in which the
848
- graphic is to be treated after being displayed.</p>
849
-
850
- <h4>Argument</h4>
851
-
852
- <p>A <a href="constants.html#DisposeType">DisposeType</a>
853
- constant.</p>
854
- </div>
855
-
856
- <div class="sig">
857
- <h3 id="dither">dither</h3>
858
-
859
- <p><span class="arg">self.</span>dither= <span class=
860
- "arg"><code>true</code></span> or <span class=
861
- "arg"><code>false</code></span></p>
862
- </div>
863
-
864
- <div class="desc">
865
- <h4>Description</h4>
866
-
867
- <p>This attribute can be used when writing GIF images.</p>
868
-
869
- <p class="imquote">Apply Floyd/Steinberg error diffusion to the
870
- image. The basic strategy of dithering is to trade intensity
871
- resolution for spatial resolution by averaging the intensities
872
- of several neighboring pixels. Images which suffer from severe
873
- contouring when reducing colors can be improved with this
874
- option.</p>
875
- </div>
876
-
877
- <div class="sig">
878
- <h3 id="endian">endian</h3>
879
-
880
- <p><span class="arg">self</span>.endian= <span class=
881
- "arg">type</span></p>
882
- </div>
883
-
884
- <div class="desc">
885
- <h4>Description</h4>
886
-
887
- <p>Specify the endianess of the image when reading the image
888
- file.</p>
889
-
890
- <h4>Argument</h4>
891
-
892
- <p>One of the following Magick::EndianType enum values:</p>
893
-
894
- <ul>
895
- <li>MSBEndian</li>
896
-
897
- <li>LSBEndian</li>
898
- </ul>
899
- </div>
900
-
901
- <div class="sig">
902
- <h3 id="extract">extract</h3>
903
-
904
- <p><span class="arg"><em>self.</em></span>extract= <span class=
905
- "arg">string</span> or <span class="arg">geometry</span></p>
906
- </div>
907
-
908
- <div class="desc">
909
- <h4>Description</h4>
910
-
911
- <p>Specifies a portion of an image to be extracted when the
912
- image is constituted. This attribute can be used to identify a
913
- subset of an image that is otherwise too large to keep in
914
- memory.</p>
915
-
916
- <h4>Arguments</h4>
917
-
918
- <p>Either a geometry string or a <a href=
919
- "struct.html#Geometry">Geometry</a> object. For example:
920
- <code>self.extract = "200x200+100+100"</code>.</p>
921
- </div>
922
-
923
- <div class="sig">
924
- <h3 id="filename">filename</h3>
925
-
926
- <p><span class="arg">self.</span>filename= <span class=
927
- "arg">string</span></p>
928
- </div>
929
-
930
- <div class="desc">
931
- <h4>Description</h4>
932
-
933
- <p>See <a href="image1.html#capture">capture</a>.</p>
934
- </div>
935
-
936
- <div class="sig">
937
- <h3 id="fill">fill</h3>
938
-
939
- <p><span class="arg">self.</span>fill= <span class=
940
- "arg">string</span> or <span class="arg">pixel</span></p>
941
- </div>
942
-
943
- <div class="desc">
944
- <h4>Description</h4>
945
-
946
- <p>Specifies the fill color to use when creating an image with
947
- the "caption:" format..</p>
948
-
949
- <h4>Arguments</h4>
950
-
951
- <p>A <a href="imusage.html#color_names">color name</a> or a
952
- <a href="struct.html#Pixel">pixel</a>.</p>
953
- </div>
954
-
955
- <div class="sig">
956
- <h3 id="font">font</h3>
957
-
958
- <p><span class="arg">self.</span>font= <span class=
959
- "arg">string</span></p>
960
- </div>
961
-
962
- <div class="desc">
963
- <h4>Description</h4>
964
-
965
- <p>Set the text rendering font.</p>
966
- </div>
967
-
968
- <div class="sig">
969
- <h3 id="format">format</h3>
970
-
971
- <p><span class="arg">self.</span>format= <span class=
972
- "arg">string</span></p>
973
- </div>
974
-
975
- <div class="desc">
976
- <h4>Description</h4>
977
-
978
- <p>Set the image format, "GIF" or "JPG" for example.</p>
979
-
980
- <h4>Arguments</h4>
981
-
982
- <p>See <a href=
983
- "http://www.imagemagick.org/script/formats.php">File
984
- Formats</a>.</p>
985
- </div>
986
-
987
- <div class="sig">
988
- <h3 id="fuzz">fuzz</h3>
989
-
990
- <p><span class="arg">self.</span>fuzz= <span class=
991
- "arg">number</span> or <span class="arg">string</span></p>
992
- </div>
993
-
994
- <div class="desc">
995
- <h4>Description</h4>
996
-
997
- <p>Set the level of "fuzziness" for comparing pixels. By
998
- default the pixels must be identical to be considered equal.
999
- The larger the <code>fuzz</code> value the more difference is
1000
- tolerated. See <a href=
1001
- "imageattrs.html#fuzz">Image#fuzz</a>.</p>
1002
-
1003
- <h4>Arguments</h4>
1004
-
1005
- <p>The argument may be a numeric value or a string in the form
1006
- "NN%". In the second case, the argument is computed as a
1007
- percentage of <a href=
1008
- "constants.html#Miscellaneous_constants">QuantumRange</a>. For
1009
- example, a value of '5%' sets <code>fuzz</code> to
1010
- 0.05*QuantumRange.</p>
1011
- </div>
1012
-
1013
- <div class="sig">
1014
- <h3 id="gravity">gravity</h3>
1015
-
1016
- <p><span class="arg">self.</span>gravity= <span class=
1017
- "arg">gravity</span></p>
1018
- </div>
1019
-
1020
- <div class="desc">
1021
- <h4>Description</h4>
1022
-
1023
- <p class="imquote">The direction text gravitates to when
1024
- annotating the image.</p>
1025
-
1026
- <p class="imquote">The direction you choose specifies where to
1027
- position the text when annotating the image. For example, a
1028
- gravity of <code>CenterGravity</code> forces the text to be
1029
- centered within the image. By default, the image gravity is
1030
- <code>NorthWestGravity</code>.</p>
1031
-
1032
- <p>This attribute can be used to position the text when
1033
- creating an image with the "caption:" format.</p>
1034
-
1035
- <h4>Arguments</h4>
1036
-
1037
- <p>A <a href="constants.html#GravityType">GravityType</a>
1038
- constant.</p>
1039
- </div>
1040
-
1041
- <div class="sig">
1042
- <h3 id="image_type">image_type</h3>
1043
-
1044
- <p><span class="arg">self.</span>image_type= <span class=
1045
- "arg">image_type</span></p>
1046
- </div>
1047
-
1048
- <div class="desc">
1049
- <h4>Description</h4>
1050
-
1051
- <p>The image type classification. For example, GrayscaleType.
1052
- Don't confuse this attribute with the <a href=
1053
- "#format">format</a> such as "GIF" or "JPG".</p>
1054
-
1055
- <h4>Arguments</h4>
1056
-
1057
- <p>An <a href="constants.html#ImageType">ImageType</a>
1058
- constant.</p>
1059
- </div>
1060
-
1061
- <div class="sig">
1062
- <h3 id="interlace">interlace</h3>
1063
-
1064
- <p><span class="arg">self.</span>interlace= <span class=
1065
- "arg">type</span></p>
1066
- </div>
1067
-
1068
- <div class="desc">
1069
- <h4>Description</h4>
1070
-
1071
- <p><span class="imquote">[S]pecify the type of interlacing
1072
- scheme for raw image formats such as RGB or YUV. NoInterlace
1073
- means do not interlace, LineInterlace uses scanline
1074
- interlacing, and PlaneInterlace uses plane interlacing.
1075
- PartitionInterlace is like PlaneInterlace except the different
1076
- planes are saved to individual files (e.g. image.R, image.G,
1077
- and image.B). Use LineInterlace or PlaneInterlace to create an
1078
- interlaced GIF or progressive JPEG image.</span> The default is
1079
- NoInterlace.</p>
1080
-
1081
- <h4>Arguments</h4>
1082
-
1083
- <p>An <a href="constants.html#InterlaceType">InterlaceType</a>
1084
- constant.</p>
1085
- </div>
1086
-
1087
- <div class="sig">
1088
- <h3 id="label">label</h3>
1089
-
1090
- <p><span class="arg">self.</span>label= <span class=
1091
- "arg">string</span></p>
1092
- </div>
1093
-
1094
- <div class="desc">
1095
- <h4>Description</h4>
1096
-
1097
- <p><span class="imquote">Use this option to assign a specific
1098
- label to the image, when writing to an image format that
1099
- supports labels, such as TIFF, PNG, MIFF, or PostScript. You
1100
- can include the the image filename, type, width, height, or
1101
- other image attribute by embedding special format
1102
- characters.</span> See <a href=
1103
- "draw.html#annotate">annotate</a> for details.</p>
1104
- </div>
1105
-
1106
- <div class="sig">
1107
- <h3 id="matte_color">matte_color</h3>
1108
-
1109
- <p><span class="arg">self.</span>matte_color= <span class=
1110
- "arg">string</span> or <span class="arg">pixel</span></p>
1111
- </div>
1112
-
1113
- <div class="desc">
1114
- <h4>Description</h4>
1115
-
1116
- <p>Set the image transparent color. The default is
1117
- "#bdbdbd".</p>
1118
-
1119
- <h4>Arguments</h4>
1120
-
1121
- <p>A <a href="imusage.html#color_names">color name</a> or a
1122
- <a href="struct.html#Pixel">pixel</a>.</p>
1123
- </div>
1124
-
1125
- <div class="sig">
1126
- <h3 id="monitor">monitor</h3>
1127
-
1128
- <p><span class="arg">self.</span>monitor= <span class=
1129
- "arg">proc</span></p>
1130
- </div>
1131
-
1132
- <div class="desc">
1133
- <h4>Description</h4>
1134
-
1135
- <p>Set a <code>Proc</code> object as a progress monitor. This
1136
- proc can be used to monitor the progress of methods that accept
1137
- optional arguments such as <code>read</code> and
1138
- <code>write</code>. To stop monitoring, set the monitor to
1139
- <code>nil</code>. See <a href=
1140
- "imageattrs.html#monitor">Image#monitor</a> for more
1141
- information about the proc. This attribute is set-only.</p>
1142
-
1143
- <p>If you assign a monitor to an image with
1144
- <code>self.monitor=</code> when the image is created, the image
1145
- object inherits the monitor. Any methods applied to the new
1146
- image will be monitored as well.</p>
1147
-
1148
- <p>This method supercedes the <code>Magick.set_monitor</code>
1149
- method.</p>
1150
- </div>
1151
-
1152
- <div class="sig">
1153
- <h3 id="monochrome">monochrome</h3>
1154
-
1155
- <p><span class="arg">self.</span>monochrome= <span class=
1156
- "arg"><code>true</code></span> or <span class=
1157
- "arg"><code>false</code></span></p>
1158
- </div>
1159
-
1160
- <div class="desc">
1161
- <h4>Description</h4>
1162
-
1163
- <p>Transform the image to black and white on input. Only the
1164
- EPT, PDF, and PS formats respect this attribute.</p>
1165
- </div>
1166
-
1167
- <div class="sig">
1168
- <h3 id="orientation">orientation</h3>
1169
-
1170
- <p><span class="arg">self</span>.orientation=<span class=
1171
- "arg">type</span></p>
1172
- </div>
1173
-
1174
- <div class="desc">
1175
- <h4>Description</h4>
1176
-
1177
- <p>Specifies the orientation of the image pixels.</p>
1178
-
1179
- <h4>Argument</h4>
1180
-
1181
- <p>An <a href=
1182
- "constants.html#OrientationType">OrientationType</a> value.</p>
1183
- </div>
1184
-
1185
- <div class="sig">
1186
- <h3 id="origin">origin</h3>
1187
-
1188
- <p><span class="arg">self</span>.origin=<span class=
1189
- "arg">string</span> or <span class="arg">geometry</span></p>
1190
- </div>
1191
-
1192
- <div class="desc">
1193
- <h4>Description</h4>
1194
-
1195
- <p>Set the image origin.</p>
1196
-
1197
- <h4>Argument</h4>
1198
-
1199
- <p>A <a href="imusage.html#geometry">geometry string</a> of the
1200
- form <code>+x+y</code> (a "-" may be used instead of "+" to
1201
- indicate a negative offset) or a <a href=
1202
- "struct.html#Geometry">Geometry</a> object.</p>
1203
- </div>
1204
-
1205
- <div class="sig">
1206
- <h3 id="page">page</h3>
1207
-
1208
- <p><span class="arg">self.</span>page= <span class=
1209
- "arg">string</span> or <span class="arg">geometry</span></p>
1210
- </div>
1211
-
1212
- <div class="desc">
1213
- <h4>Description</h4>
1214
-
1215
- <p>Set the equivalent size of the Postscript page. The default
1216
- is "612x792&gt;".</p>
1217
-
1218
- <h4>Arguments</h4>
1219
-
1220
- <p>A <a href="imusage.html#geometry">geometry string</a> or a
1221
- <a href="struct.html#Geometry">Geometry</a> object.</p>
1222
- </div>
1223
-
1224
- <div class="sig">
1225
- <h3 id="pointsize">pointsize</h3>
1226
-
1227
- <p><span class="arg">self.</span>pointsize= <span class=
1228
- "arg">number</span></p>
1229
- </div>
1230
-
1231
- <div class="desc">
1232
- <h4>Description</h4>
1233
-
1234
- <p>Set the font size in points. Useful when creating "caption:"
1235
- format images, for example.</p>
1236
- </div>
1237
-
1238
- <div class="sig">
1239
- <h3 id="quality">quality</h3>
1240
-
1241
- <p><span class="arg">self.</span>quality= <span class=
1242
- "arg">integer</span></p>
1243
- </div>
1244
-
1245
- <div class="desc">
1246
- <h4>Description</h4>
1247
-
1248
- <p>The compression level for JPEG, MPEG, JPEG-2000, MIFF, MNG,
1249
- and PNG image format. Corresponds to ImageMagick's -quality
1250
- option. The default is 75. See <em><a href=
1251
- "comtasks.html#compressing">Compressing image
1252
- files</a></em>.</p>
1253
- </div>
1254
-
1255
- <div class="sig">
1256
- <h3 id="sampling_factor">sampling_factor</h3>
1257
-
1258
- <p><span class="arg">self.</span>sampling_factor= <span class=
1259
- "arg">string</span></p>
1260
- </div>
1261
-
1262
- <div class="desc">
1263
- <h4>Description</h4>
1264
-
1265
- <p class="imquote">sampling factors used by JPEG or MPEG-2
1266
- encoder and YUV decoder/encoder.</p>
1267
-
1268
- <p class="imquote">This attribute specifies the sampling
1269
- factors to be used by the JPEG encoder for chroma downsampling.
1270
- If this attribute is omitted, the JPEG library will use its own
1271
- default values. When reading or writing the YUV format and when
1272
- writing the M2V (MPEG-2) format, use sampling-factor="2x1" to
1273
- specify the 4:2:2 downsampling method.</p>
1274
-
1275
- <h4>Argument</h4>
1276
-
1277
- <p>A string in the form
1278
- "<em>horizontal-factor</em><strong>x</strong><em>vertical-factor</em>"</p>
1279
- </div>
1280
-
1281
- <div class="sig">
1282
- <h3 id="scene">scene</h3>
1283
-
1284
- <p><span class="arg">self</span>.scene= <span class=
1285
- "arg">number</span></p>
1286
- </div>
1287
-
1288
- <div class="desc">
1289
- <h4>Description</h4>
1290
-
1291
- <p>Set the scene number of an image or the first image in a
1292
- sequence.</p>
1293
- </div>
1294
-
1295
- <div class="sig">
1296
- <h3 id="server_name">server_name</h3>
1297
-
1298
- <p><span class="arg">self.</span>server_name= <span class=
1299
- "arg">string</span></p>
1300
- </div>
1301
-
1302
- <div class="desc">
1303
- <h4>Description</h4>
1304
-
1305
- <p>Set the X11 display to obtain fonts from.</p>
1306
- </div>
1307
-
1308
- <div class="sig">
1309
- <h3 id="size">size</h3>
1310
-
1311
- <p><span class="arg"><em>self.</em>size= <em>string</em></span>
1312
- or <span class="arg">geometry</span></p>
1313
- </div>
1314
-
1315
- <div class="desc">
1316
- <h4>Description</h4>
1317
-
1318
- <p>Set the width and height of the image when reading a
1319
- <a href="imusage.html#builtin_formats">built-in image
1320
- format</a> that does not have an inherent size, or when reading
1321
- an image from a multi-resolution file format such as Photo CD,
1322
- JBIG, or JPEG.</p>
1323
-
1324
- <p>Use <code>size</code> to specify the width and height of
1325
- images in the CMYK, DIB, EMF, GRAY, RGB, RGBA, UYVY, YUV, or XC
1326
- formats, the width and height of some <a href=
1327
- "imusage.html#builtin_formats">built in formats</a>, or the
1328
- subimage size of PTIF-format images.</p>
1329
-
1330
- <h4>Arguments</h4>
1331
-
1332
- <p>A <a href="imusage.html#geometry">geometry string</a> or a
1333
- <a href="struct.html#Geometry">Geometry</a> object.</p>
1334
- </div>
1335
-
1336
- <div class="sig">
1337
- <h3 id="stroke">stroke</h3>
1338
-
1339
- <p><span class="arg">self.</span>stroke= <span class=
1340
- "arg">string</span> or <span class="arg">pixel</span></p>
1341
- </div>
1342
-
1343
- <div class="desc">
1344
- <h4>Description</h4>
1345
-
1346
- <p>Specifies the stroke color to use when creating an image
1347
- with the "caption:" format..</p>
1348
-
1349
- <h4>Arguments</h4>
1350
-
1351
- <p>A <a href="imusage.html#color_names">color name</a> or a
1352
- <a href="struct.html#Pixel">pixel</a>.</p>
1353
- </div>
1354
-
1355
- <div class="sig">
1356
- <h3 id="stroke_width">stroke_width</h3>
1357
-
1358
- <p><span class="arg">self.</span>stroke_width=
1359
- <em>number</em></p>
1360
- </div>
1361
-
1362
- <div class="desc">
1363
- <h4>Description</h4>
1364
-
1365
- <p>Specifies the stroke width to use when creating an image
1366
- with the "caption:" format..</p>
1367
-
1368
- <h4>Arguments</h4>
1369
-
1370
- <p>The stroke width.</p>
1371
- </div>
1372
-
1373
- <div class="sig">
1374
- <h3 id="texture">texture</h3>
1375
-
1376
- <p><span class="arg">self</span>.texture= <span class=
1377
- "arg">image</span></p>
1378
- </div>
1379
-
1380
- <div class="desc">
1381
- <h4>Description</h4>
1382
-
1383
- <p>Set a texture to tile onto the image background. Corresponds
1384
- to the -texture option to ImageMagick's convert and mogrify
1385
- commands. This attribute is set-only.</p>
1386
-
1387
- <h4>Argument</h4>
1388
-
1389
- <p>An image</p>
1390
- </div>
1391
-
1392
- <div class="sig">
1393
- <h3 id="transparent_color">transparent_color</h3>
1394
-
1395
- <p><span class="arg">self</span>.transparent_color=
1396
- <span class="arg">string</span> or <span class=
1397
- "arg">pixel</span></p>
1398
- </div>
1399
-
1400
- <div class="desc">
1401
- <h4>Description</h4>
1402
-
1403
- <p class="imquote">The transparent color. Sometimes used for
1404
- saving to image formats such as GIF and PNG8 which uses this
1405
- color to represent boolean transparency. This does not make a
1406
- color transparent, just defines what color the transparent
1407
- color will be in the color pallette of the saved image.</p>
1408
-
1409
- <p class="imquote">This attribute allows you to have both a
1410
- opaque visible color as well as a transparent color of the same
1411
- color value without conflict. That is you can use the same
1412
- color for both the transparent and opaque color areas within an
1413
- image. This in turn frees to you to select a transparenct color
1414
- that is appropriate when a image is displayed by application
1415
- that does not handle a transparent color index, while allowing
1416
- RMagick to correctly handle images of this type.</p>
1417
- </div>
1418
-
1419
- <div class="sig">
1420
- <h3 id="tile_offset">tile_offset</h3>
1421
-
1422
- <p><span class="arg">self</span>.tile_offset= <span class=
1423
- "arg">string</span> or <span class="arg">geometry</span></p>
1424
- </div>
1425
-
1426
- <div class="desc">
1427
- <h4>Description</h4>
1428
-
1429
- <p class="imquote">Specifies the offset for tile images,
1430
- relative to the background image it will be tiled on.</p>
1431
-
1432
- <p>This attribute is useful with the "tile:" and "pattern:"
1433
- image formats.</p>
1434
-
1435
- <h4>Arguments</h4>
1436
-
1437
- <p>A <a href="imusage.html#geometry">geometry string</a> or a
1438
- <a href="struct.html#Geometry">Geometry</a> object.</p>
1439
- </div>
1440
-
1441
- <div class="sig">
1442
- <h3 id="undercolor">undercolor</h3>
1443
-
1444
- <p><span class="arg">self.</span>undercolor= <span class=
1445
- "arg">string</span> or <span class="arg">pixel</span></p>
1446
- </div>
1447
-
1448
- <div class="desc">
1449
- <h4>Description</h4>
1450
-
1451
- <p>Specifies the undercolor color to use when creating an image
1452
- with the "caption:" format..</p>
1453
-
1454
- <h4>Arguments</h4>
1455
-
1456
- <p>A <a href="imusage.html#color_names">color name</a> or a
1457
- <a href="struct.html#Pixel">pixel</a>.</p>
1458
- </div>
1459
-
1460
- <div class="sig">
1461
- <h3 id="units">units</h3>
1462
-
1463
- <p><span class="arg">self.</span>units= <span class=
1464
- "arg">unit</span></p>
1465
- </div>
1466
-
1467
- <div class="desc">
1468
- <h4>Description</h4>
1469
-
1470
- <p>Specifies the units of image resolution.</p>
1471
-
1472
- <h4>Arguments</h4>
1473
-
1474
- <p>A <a href="constants.html#ResolutionType">ResolutionType</a>
1475
- constant.</p>
1476
- </div>
1477
-
1478
- <div class="sig">
1479
- <h3 id="view">view</h3>
1480
-
1481
- <p><span class="arg">self.</span>view= <span class=
1482
- "arg">string</span></p>
1483
- </div>
1484
-
1485
- <div class="desc">
1486
- <h4>Description</h4>
1487
-
1488
- <p>FlashPix viewing parameters.</p>
1489
- </div>
1490
-
1491
- <p class="spacer">&nbsp;</p>
1492
-
1493
- <div class="nav">
1494
- &laquo;&nbsp;<a href="struct.html">Prev</a> | <a href=
1495
- "index.html">Contents</a> | <a href=
1496
- "constants.html">Next</a>&nbsp;&raquo;
1497
- </div>
1498
- </body>
1499
- </html>