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
data/doc/magick.html DELETED
@@ -1,570 +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: module Magick</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
- </style>
24
- </head>
25
-
26
- <body>
27
- <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
28
-
29
- <div class="nav">
30
- &laquo;&nbsp;<a href="comtasks.html">Prev</a> | <a href=
31
- "index.html">Contents</a> | <a href=
32
- "ilist.html">Next</a>&nbsp;&raquo;
33
- </div>
34
-
35
- <h1>module Magick</h1>
36
-
37
- <div id="toc">
38
- <h2>Table of Contents</h2>
39
-
40
- <h3>module methods</h3>
41
-
42
- <ul>
43
- <li><a href="#colors">colors</a></li>
44
-
45
- <li><a href="#fonts">fonts</a></li>
46
-
47
- <li><a href="#formats">formats</a></li>
48
-
49
- <li><a href="#limit_resource">limit_resource</a></li>
50
-
51
- <li><a href="#set_log_event_mask">set_log_event_mask</a></li>
52
-
53
- <li><a href="#set_log_format">set_log_format</a></li>
54
-
55
- <li><a href="#trace_proc">trace_proc</a></li>
56
- </ul>
57
- </div>
58
-
59
- <h2 class="methods">module methods</h2>
60
-
61
- <div class="sig">
62
- <h3 id="colors">colors</h3>
63
-
64
- <p>Magick.colors <span class="arg">{ |color| block }</span>
65
- -&gt; <em>Magick</em><br />
66
- Magick.colors -&gt; <em>array</em></p>
67
- </div>
68
-
69
- <div class="desc">
70
- <h4>Description</h4>
71
-
72
- <p>Lists the <a href="imusage.html#color_names">named
73
- colors</a>. If the optional block is present, calls the block
74
- once for each color, passing a Magick::Color object. Otherwise,
75
- returns an array of Magick::Color objects, one for each
76
- color.</p>
77
-
78
- <p>The Magick::Color class is a Struct class with the following
79
- attributes:</p>
80
-
81
- <table class="simple_table" summary="magic color attributes">
82
- <caption>
83
- Magick::Color attributes
84
- </caption>
85
-
86
- <tr>
87
- <th>Attribute</th>
88
-
89
- <th>Value</th>
90
- </tr>
91
-
92
- <tr>
93
- <td>name</td>
94
-
95
- <td>The color name. For example, "red".</td>
96
- </tr>
97
-
98
- <tr>
99
- <td>compliance</td>
100
-
101
- <td>A <a href=
102
- "constants.html#ComplianceType">ComplianceType</a> value
103
- such as X11Compliance.</td>
104
- </tr>
105
-
106
- <tr>
107
- <td>color</td>
108
-
109
- <td>A <a href="struct.html#Pixel">Pixel</a> object
110
- containing the RGB values.</td>
111
- </tr>
112
- </table>
113
-
114
- <h4>Returns</h4>
115
-
116
- <p>If no block is associated with the call, returns an array of
117
- Magick::Color objects.</p>
118
-
119
- <h4>Example</h4>
120
-
121
- <p>This is a small sample of <code>colors.miff</code>, the
122
- complete image created by the example program.</p>
123
-
124
- <p><a href="javascript:popup('colors.rb.html')"><img src=
125
- "ex/colors.gif" title="Click to see the example script" alt=
126
- "Magick::colors example" /></a></p>
127
-
128
- <h4>Magick API</h4>
129
-
130
- <p>GetColorInfo</p>
131
- </div>
132
-
133
- <div class="sig">
134
- <h3 id="fonts">fonts</h3>
135
-
136
- <p>Magick.fonts <span class="arg">{ |font| block }</span> -&gt;
137
- <em>Magick</em><br />
138
- Magick.fonts -&gt; <em>array</em></p>
139
- </div>
140
-
141
- <div class="desc">
142
- <h4>Description</h4>
143
-
144
- <p>Lists the fonts that ImageMagick knows about. If the
145
- optional block is present, calls the block once for each font,
146
- passing a Magick::Font object. Otherwise, returns an array of
147
- Magick::Font objects, one for each font.</p>
148
-
149
- <p>The Magick::Font class is a Struct class with the following
150
- attributes:</p>
151
-
152
- <table summary="font class attributes" class="simple_table">
153
- <caption>
154
- Magick::Font attributes
155
- </caption>
156
-
157
- <tr>
158
- <th>Attribute</th>
159
-
160
- <th>Value</th>
161
- </tr>
162
-
163
- <tr>
164
- <td>name</td>
165
-
166
- <td>The font name. For example, "Palatino-Roman".</td>
167
- </tr>
168
-
169
- <tr>
170
- <td>description</td>
171
-
172
- <td>The font description. For example, "Palatino
173
- Roman".</td>
174
- </tr>
175
-
176
- <tr>
177
- <td>family</td>
178
-
179
- <td>The font family. For example, "Palatino", "Helvetica",
180
- or "Courier".</td>
181
- </tr>
182
-
183
- <tr>
184
- <td>style</td>
185
-
186
- <td>A <a href="constants.html#StyleType">StyleType</a>
187
- value such as <code>NormalStyle</code>.</td>
188
- </tr>
189
-
190
- <tr>
191
- <td>stretch</td>
192
-
193
- <td>A <a href="constants.html#StretchType">StretchType</a>
194
- value such as <code>NormalStretch</code>.</td>
195
- </tr>
196
-
197
- <tr>
198
- <td>weight</td>
199
-
200
- <td>The font weight, one of 100, 200, 300, 400, 500, 600,
201
- 700, 800, or 900.</td>
202
- </tr>
203
-
204
- <tr>
205
- <td>encoding</td>
206
-
207
- <td>The font encoding, such as "AppleRoman". May be
208
- <code>nil</code>.</td>
209
- </tr>
210
-
211
- <tr>
212
- <td>foundry</td>
213
-
214
- <td>The font foundry. "URW", for example. May be
215
- <code>nil</code>.</td>
216
- </tr>
217
-
218
- <tr>
219
- <td>format</td>
220
-
221
- <td>If the font is a Type1 font, has the value "type1",
222
- otherwise <code>nil</code>.</td>
223
- </tr>
224
- </table>
225
-
226
- <h4>Returns</h4>
227
-
228
- <p>If no block is associated with the call, returns an array of
229
- Magick::Font objects.</p>
230
-
231
- <h4>Example</h4>
232
-
233
- <p><a href="javascript:popup('fonts.rb.html')" title=
234
- "The example script">fonts.rb</a></p>
235
-
236
- <h4>Magick API</h4>
237
-
238
- <p>GetFontInfo</p>
239
- </div>
240
-
241
- <div class="sig">
242
- <h3 id="formats">formats</h3>
243
-
244
- <p>Magick.formats <span class="arg">{ |f,v| block }</span>
245
- -&gt; <em>Magick</em><br />
246
- Magick.formats -&gt; <em>hash</em></p>
247
- </div>
248
-
249
- <div class="desc">
250
- <h4>Description</h4>
251
-
252
- <p>Describes the image formats supported by ImageMagick. If the
253
- optional block is present, calls the block once for each image
254
- format. The first argument, <em>f</em>, is the format name. The
255
- second argument, <em>v</em>, is the properties string described
256
- below.</p>
257
-
258
- <h4>Returns</h4>A hash of image formats and their properties.
259
- Each key in the returned hash is the name of a supported image
260
- format. Each value is a string in the form "BRWA". The details
261
- are in this table:
262
-
263
- <table summary="format string symbols" class="simple_table">
264
- <caption>
265
- Format property codes
266
- </caption>
267
-
268
- <tr>
269
- <th>Code</th>
270
-
271
- <th>Definition</th>
272
- </tr>
273
-
274
- <tr>
275
- <td>B</td>
276
-
277
- <td>is "*" if the format has native blob support, and "-"
278
- otherwise.</td>
279
- </tr>
280
-
281
- <tr>
282
- <td>R</td>
283
-
284
- <td>is "r" if ImageMagick can read the format, and "-"
285
- otherwise.</td>
286
- </tr>
287
-
288
- <tr>
289
- <td>W</td>
290
-
291
- <td>is "w" if ImageMagick can write the format, and "-"
292
- otherwise.</td>
293
- </tr>
294
-
295
- <tr>
296
- <td>A</td>
297
-
298
- <td>is "+" if the format supports multi-image files, and
299
- "-" otherwise.</td>
300
- </tr>
301
- </table>
302
-
303
- <h4>Example</h4>
304
- <pre>
305
- p Magick.formats &raquo;
306
- {"TIF"=&gt;"*rw+",
307
- "H"=&gt;"*rw-",
308
- "MNG"=&gt;"*rw+",
309
- "NULL"=&gt;"*rw-",
310
- ...
311
- "G"=&gt;"*rw+",
312
- "GIF"=&gt;"*rw+",
313
- "PDB"=&gt;"*rw+"}
314
- </pre>
315
-
316
- <h4>Magick API</h4>
317
-
318
- <p>GetMagickInfo</p>
319
-
320
- <h4>Note</h4>
321
-
322
- <p>ImageMagick depends on external programs for some formats.
323
- Depending on how ImageMagick was installed on your system, some
324
- formats may not be available. If you have questions, ask your
325
- system administrator.</p>
326
- </div>
327
-
328
- <div class="sig">
329
- <h3 id="limit_resource">limit_resource</h3>
330
-
331
- <p>Magick.limit_resource(<span class="arg">resource_type</span>
332
- [, <span class="arg">limit</span>]) -&gt; <span class=
333
- "arg">old_limit</span></p>
334
- </div>
335
-
336
- <div class="desc">
337
- <h4>Description</h4>
338
-
339
- <p>Sets a limit to the amount of a resource, or gets the
340
- current limit for the resource. <span class="imquote">When the
341
- limit is reached, ImageMagick will fail in some fashion or take
342
- compensating actions if possible.</span> The default limits
343
- vary according to the platform. See the ImageMagick
344
- documentation for the <em>-limit</em> option for more
345
- information.</p>
346
-
347
- <h4>Arguments</h4>This method may be called with one or two
348
- arguments. The first argument identifies the resource. If
349
- specified, the second argument is the limit.
350
-
351
- <dl>
352
- <dt>resource_type</dt>
353
-
354
- <dd>One of the symbols <code>:area</code>,
355
- <code>:disk</code>, <code>:file</code>, <code>:map</code>,
356
- <code>:memory</code>, or <code>:time</code>. You may use a
357
- string instead of a symbol.</dd>
358
-
359
- <dt>limit</dt>
360
-
361
- <dd>If present, the limit for the resource. This argument is
362
- always an integer number. If the <span class=
363
- "arg">resource_type</span> is <code>:file</code>, the limit
364
- is the number of open files. If <code>:memory</code> or
365
- <code>:map</code>, the limit is measured megabytes. If
366
- <code>:disk</code>, the limit is measured in gigabytes. If
367
- the <span class="arg">resource_type</span> is
368
- <code>:area</code> the limit is the maximum width * height of
369
- an image in pixels that can reside in pixel cache memory. If
370
- <code>:time</code>, the limit is measured in seconds. If this
371
- argument is omitted the limit is not changed.</dd>
372
- </dl>
373
-
374
- <h4>Returns</h4>
375
-
376
- <p>The current resource limit. If a new limit is specified this
377
- is the limit <em>before</em> the change.</p>
378
-
379
- <h4>Notes</h4>
380
-
381
- <p>This method supercedes <code>set_cache_threshold</code>.</p>
382
-
383
- <p>Setting the <code>:time</code> limit resets the elapsed time
384
- to zero in the pixel cache. Call it before any operation that
385
- you need to set a time limit on.</p>
386
- </div>
387
-
388
- <div class="sig">
389
- <h3 id="set_log_event_mask">set_log_event_mask</h3>
390
-
391
- <p>Magick.set_log_event_mask(<span class=
392
- "arg">event_list</span>)</p>
393
- </div>
394
-
395
- <div class="desc">
396
- <h4>Description</h4>
397
-
398
- <p>Specify which events to log.</p>
399
-
400
- <h4>Argument</h4>
401
-
402
- <p>A string composed of one or more of the following event
403
- types. If more than one event type is specified, separate the
404
- event types with commas.</p>
405
-
406
- <p><code>All, Annotate, Blob, Cache, Coder, Configure,
407
- Deprecate, Draw, Exception, Locale, Module, None, Resource,
408
- Trace, Transform, User, Wand, X11</code></p>
409
-
410
- <h4>Example</h4>
411
- <pre>
412
- Magick.set_log_event_mask("Module,Coder")
413
- </pre>
414
-
415
- <h4>Magick API</h4>
416
-
417
- <p>SetLogEventMask</p>
418
-
419
- <h4>See also</h4>
420
-
421
- <p><a href="#set_log_format">set_log_format</a></p>
422
-
423
- <h4>Log configuration</h4>
424
-
425
- <p>Magick logging is configured with the log.xml file in
426
- Magick's config directory. See <a href=
427
- "http://redux.imagemagick.org/script/resources.php">Resources</a>
428
- in the ImageMagick documentation for more information.</p>
429
-
430
- <p>Use this command to find out about the current log
431
- configuration.</p>
432
- <pre>
433
- convert -list log
434
- </pre>
435
- </div>
436
-
437
- <div class="sig">
438
- <h3 id="set_log_format">set_log_format</h3>
439
-
440
- <p>Magick.set_log_format(<span class="arg">format</span>)</p>
441
- </div>
442
-
443
- <div class="desc">
444
- <h4>Description</h4>
445
-
446
- <p>Specify the event log format.</p>
447
-
448
- <h4>Argument</h4>
449
-
450
- <p>A fprintf-like format string composed of optional "normal"
451
- text (to which no meaning is assigned) and the following format
452
- characters:</p>
453
-
454
- <dl>
455
- <dt>%d</dt>
456
-
457
- <dd>domain</dd>
458
-
459
- <dt>%e</dt>
460
-
461
- <dd>event</dd>
462
-
463
- <dt>%f</dt>
464
-
465
- <dd>function</dd>
466
-
467
- <dt>%l</dt>
468
-
469
- <dd>line</dd>
470
-
471
- <dt>%m</dt>
472
-
473
- <dd>module</dd>
474
-
475
- <dt>%p</dt>
476
-
477
- <dd>process ID</dd>
478
-
479
- <dt>%r</dt>
480
-
481
- <dd>read CPU time</dd>
482
-
483
- <dt>%t</dt>
484
-
485
- <dd>wall clock time</dd>
486
-
487
- <dt>%u</dt>
488
-
489
- <dd>user CPU time</dd>
490
-
491
- <dt>%%</dt>
492
-
493
- <dd>percent sign</dd>
494
-
495
- <dt>\n</dt>
496
-
497
- <dd>newline</dd>
498
-
499
- <dt>\r</dt>
500
-
501
- <dd>carriage return</dd>
502
- </dl>
503
- </div>
504
-
505
- <div class="sig">
506
- <h3 id="trace_proc">trace_proc</h3>
507
-
508
- <p>Magick.trace_proc = <span class="arg">proc</span></p>
509
- </div>
510
-
511
- <div class="desc">
512
- <h4>Description</h4>
513
-
514
- <p>If the Magick module attribute <code>trace_proc</code> is
515
- set to a Proc object, RMagick calls the proc whenever an image
516
- is created or destroyed. You can use this proc to keep track of
517
- which images your program has created and which have been
518
- destroyed.</p>
519
-
520
- <h4>Arguments</h4>
521
-
522
- <p>The proc should accept these four arguments:</p>
523
-
524
- <dl>
525
- <dt>which</dt>
526
-
527
- <dd>A symbol that indicates which operation the proc is being
528
- called for. If the proc is called for an image creation, the
529
- value is :c. If called for an image destruction, the value is
530
- :d.</dd>
531
-
532
- <dt>description</dt>
533
-
534
- <dd>A string describing the image. This is the same string
535
- that would be returned by calling the image's inspect
536
- method.</dd>
537
-
538
- <dt>id</dt>
539
-
540
- <dd>A unique identifier for the image. This identifier is not
541
- the same as the object's object_id. No two images will have
542
- the same id at the same time. However, the id of an image
543
- that has been destroyed may be reused for a subsequent
544
- image.</dd>
545
-
546
- <dt>method</dt>
547
-
548
- <dd>The name of the method responsible for creating or
549
- destroying the image.</dd>
550
- </dl>
551
-
552
- <h4>Notes</h4>
553
-
554
- <p>If called while Ruby is cleaning up after the program has
555
- finished, any methods the proc calls may not be executed.</p>
556
-
557
- <p>Use <a href="info.html#user_option">the "user" option</a> to
558
- add an additional identifying string to the image's
559
- description.</p>
560
- </div>
561
-
562
- <p class="spacer">&nbsp;</p>
563
-
564
- <div class="nav">
565
- &laquo;&nbsp;<a href="comtasks.html">Prev</a> | <a href=
566
- "index.html">Contents</a> | <a href=
567
- "ilist.html">Next</a>&nbsp;&raquo;
568
- </div>
569
- </body>
570
- </html>