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,514 +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: ImageMagick Conventions</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
- * Modify the example style for the scripts on this page.
24
- */
25
- .example {
26
- margin-left: 100px;
27
- margin-right: 100px;
28
- margin-bottom: 1em;
29
- }
30
- #rgbfmts {
31
- border-collapse: separate;
32
- border-spacing: 0;
33
- border: thin solid black;
34
- background-color: #f0f0f0;
35
- margin: 1em auto 1em auto;
36
- width: 70%;
37
- }
38
- #rgbfmts td {
39
- padding: 3px 1em 3px 1em;
40
- border-width: 0;
41
- }
42
- #rgbfmts caption {
43
- font-weight: bold;
44
- }
45
- .evenrow {
46
- background-color: #f0f0f0;
47
- }
48
- .oddrow {
49
- background-color: white;
50
- }
51
- #geostr {
52
- width:100%;
53
- font-weight: bold;
54
- text-align: center;
55
- }
56
- #bi_format_list {
57
- margin-left: 100px;
58
- }
59
- #bi_format_list h4 {
60
- padding-left: 5px;
61
- position: relative;
62
- left: -100px;
63
- background-image: url(ex/images/graydient230x6.gif);
64
- background-repeat: repeat-y;
65
- }
66
-
67
- /*]]>*/
68
- </style>
69
- </head>
70
-
71
- <body>
72
- <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
73
-
74
- <div class="nav">
75
- &laquo;&nbsp;<a href="usage.html">Prev</a> | <a href=
76
- "index.html">Contents</a> | <a href=
77
- "optequiv.html">Next</a>&nbsp;&raquo;
78
- </div>
79
-
80
- <h1>RMagick: ImageMagick Conventions</h1>
81
-
82
- <div id="toc">
83
- <h2>Table of Contents</h2>
84
-
85
- <ul style="margin-left: 15px; padding-top: 1em">
86
- <li><a href="#formats">Image formats and filenames</a></li>
87
-
88
- <li><a href="#frames">Selecting frames from a multi-frame
89
- image file</a></li>
90
-
91
- <li><a href="#color_names">Color names</a></li>
92
-
93
- <li><a href="#geometry">The geometry string</a></li>
94
-
95
- <li><a href="#classtype">DirectClass and PseudoClass</a></li>
96
-
97
- <li><a href="#builtin_formats">Built-in image
98
- formats</a></li>
99
- </ul>
100
- </div>
101
-
102
- <h2 id="formats">Image formats and filenames</h2>
103
-
104
- <p>ImageMagick supports over 100 major <a href=
105
- "http://www.imagemagick.org/script/formats.php">image
106
- formats</a>.</p>
107
-
108
- <p>ImageMagick determines the format (GIF, PNG, JPEG, etc.) of an
109
- image file either from its magic number, the filename suffix
110
- (.gif, .png, .jpg) or from a prefix attached to the filename. For
111
- example, <code>ps:mydoc</code> indicates that <code>mydoc</code>
112
- is a Postscript file. <span class="imquote">The magic number
113
- takes precedence over the filename suffix and the prefix takes
114
- precedence over the magic number and the suffix in input files.
115
- The prefix takes precedence over the filename suffix in output
116
- files.</span></p>
117
-
118
- <p>This makes it easy to convert an image file to another format.
119
- Simply write the image file using a name that has either a prefix
120
- or a suffix corresponding to the format you want.</p>
121
-
122
- <p><em>Note:</em> Keep in mind that files in some formats may
123
- only be read by ImageMagick, not written.</p>
124
-
125
- <h2 id="frames">Selecting frames from a multi-frame image
126
- file</h2>
127
-
128
- <p>When reading a multi-frame image file such as an AVI you can
129
- specify the subset of frames by adding a list of frame number(s)
130
- to the end of the file name enclosed in square brackets. For
131
- example, "my_movie.avi[0]" tells ImageMagick to read only the
132
- first frame. In general,</p>
133
-
134
- <dl>
135
- <dt>[N]</dt>
136
-
137
- <dd>identifies a single frame. Frame numbers start at 0.
138
- Negative numbers cause frames to be selected from the end of
139
- the image file.</dd>
140
-
141
- <dt>[M,N,O]</dt>
142
-
143
- <dd>identifies multiple non-sequential frame numbers.</dd>
144
-
145
- <dt>[N-M]</dt>
146
-
147
- <dd>identifies the sequence of frames numbered N through
148
- M.</dd>
149
-
150
- <dt>[M,N-O,P]</dt>
151
-
152
- <dd>identifies both non-sequential and sequential frame
153
- numbers</dd>
154
- </dl>
155
-
156
- <p>Note that the entire image file will be read into memory
157
- before the frames are selected. See <a href=
158
- "http://www.cit.gu.edu.au/~anthony/graphics/imagick6/files/#read">
159
- this page</a> for additional uses of the [] modifier.</p>
160
-
161
- <h2 id="color_names">Color names</h2>
162
-
163
- <p>Many RMagick methods expect color name arguments or return
164
- color names. A color name can be</p>
165
-
166
- <ol>
167
- <li>an <a href=
168
- "http://en.wikipedia.org/wiki/X11_color_names">X11 color
169
- name</a> such as "red", "chocolate", or "lightslategray".</li>
170
-
171
- <li>an <a href=
172
- "http://www.w3.org/TR/SVG/types.html#ColorKeywords">SVG color
173
- name</a> (similar to the X color names), or</li>
174
-
175
- <li>a string in one of the formats shown in the following
176
- table.</li>
177
- </ol>
178
-
179
- <table id="rgbfmts" summary="color name formats">
180
- <caption>
181
- Color name formats
182
- </caption>
183
-
184
- <tr class="oddrow">
185
- <td>#RGB</td>
186
-
187
- <td>4 bits for each channel</td>
188
- </tr>
189
-
190
- <tr class="evenrow">
191
- <td>#RRGGBB</td>
192
-
193
- <td>8 bits for each channel</td>
194
- </tr>
195
-
196
- <tr class="oddrow">
197
- <td>#RRRGGGBBB</td>
198
-
199
- <td>12 bits for each channel</td>
200
- </tr>
201
-
202
- <tr class="evenrow">
203
- <td>#RRRRGGGGBBBB</td>
204
-
205
- <td>16 bits for each channel</td>
206
- </tr>
207
-
208
- <tr class="oddrow">
209
- <td>#RGBA</td>
210
-
211
- <td>4 bits for each channel, plus the alpha channel</td>
212
- </tr>
213
-
214
- <tr class="evenrow">
215
- <td>#RRGGBBAA</td>
216
-
217
- <td>8 bits for each channel, plus the alpha channel</td>
218
- </tr>
219
-
220
- <tr class="oddrow">
221
- <td>#RRRGGGBBBAAA</td>
222
-
223
- <td>12 bits for each channel, plus the alpha channel</td>
224
- </tr>
225
-
226
- <tr class="evenrow">
227
- <td>#RRRRGGGGBBBBAAAA</td>
228
-
229
- <td>16 bits for each channel, plus the alpha channel</td>
230
- </tr>
231
-
232
- <tr class="oddrow">
233
- <td>cmyk(c,m,y,k)</td>
234
-
235
- <td>CMYK functional notation. c, m, y, and k are either 4
236
- integers 0-QuantumRange or 4 percentages 0%-100%.</td>
237
- </tr>
238
-
239
- <tr class="evenrow">
240
- <td>cmyka(c,m,y,a)</td>
241
-
242
- <td>CMYK functional notation plus the alpha channel.</td>
243
- </tr>
244
-
245
- <tr class="oddrow">
246
- <td>rgb(r,g,b)</td>
247
-
248
- <td>SVG functional notation. r, g, and b are either 3
249
- integers 0-QuantumRange or 3 percentages 0%-100%.</td>
250
- </tr>
251
-
252
- <tr class="evenrow">
253
- <td>rgba(r,g,b,a)</td>
254
-
255
- <td>SVG functional notation plus the alpha channel.</td>
256
- </tr>
257
-
258
- <tr class="oddrow">
259
- <td>hsl(h,s,l)</td>
260
-
261
- <td>Hue, saturation, lightness. The <em>hue</em> value (h)
262
- should be a number in the range 0 &lt;= n &lt; 360. The
263
- <em>saturation</em> (s) and <em>lightness</em> (l) values
264
- should be numbers in the range 0 &lt;= n &lt;= 100.</td>
265
- </tr>
266
-
267
- <tr class="evenrow">
268
- <td>hsla(h,s,l,a)</td>
269
-
270
- <td>Hue, saturation, lightness, plus the alpha channel.</td>
271
- </tr>
272
- </table>
273
-
274
- <p>The alpha channel is the opacity of the image, which can range
275
- from 0 (Magick::OpaqueOpacity) to QuantumRange
276
- (Magick::TransparentOpacity).</p>
277
-
278
- <p>A <code>Pixel</code> object contains the numeric
279
- representation of a color. The <a href=
280
- "struct.html#Pixel.from_color">Pixel.from_color</a> method
281
- converts a color name to a pixel. There are two methods to
282
- convert a pixel to a color name. The <a href=
283
- "struct.html#Pixel.to_color">Pixel#to_color</a> method requires
284
- that you specify whether the alpha (opacity) channel is used, the
285
- depth (8 or 16) and the color standard to use. The <a href=
286
- "image3.html#to_color">Image#to_color</a> method uses the image's
287
- depth and <a href="imageattrs.html#matte">matte</a> attributes.
288
- If <code>matte</code> is false the opacity value is ignored.</p>
289
-
290
- <p><em>Hint:</em> You can specify the transparent color as
291
- "none", "transparent", "#00000000", or rgba(0, 0, 0, 0.0).</p>
292
-
293
- <p><a href="http://www.imagemagick.org/script/color.php">This</a>
294
- is ImageMagick's page about color names.</p>
295
-
296
- <h2 id="geometry">The geometry string</h2>
297
-
298
- <p>RMagick methods frequently require a <code>geometry</code>
299
- string argument. This string generally specifies width and height
300
- values as well as x and y offset values. The values are usually
301
- specified in pixels (but see the % flag, below).</p>
302
-
303
- <p>This is the format of the geometry string. Any of the values
304
- may be omitted, depending on the context:</p>
305
- <pre id="geostr">
306
- &lt;width&gt;x&lt;height&gt;+-&lt;x&gt;+-&lt;y&gt;{%@!&lt;&gt;}
307
- </pre>
308
-
309
- <p><a href=
310
- "http://www.imagemagick.org/script/command-line-options.php#resize">
311
- This</a> is the ImageMagick description of the geometry
312
- string:</p>
313
-
314
- <div class="imquote">
315
- <p>By default, the width and height are maximum values. That
316
- is, the image is expanded or contracted to fit the width and
317
- height value while maintaining the aspect ratio of the image.
318
- Append an exclamation point to the geometry to force the image
319
- size to exactly the size you specify. For example, if you
320
- specify 640x480! the image width is set to 640 pixels and
321
- height to 480.</p>
322
-
323
- <p>If only the width is specified, the width assumes the value
324
- and the height is chosen to maintain the aspect ratio of the
325
- image. Similarly, if only the height is specified (e.g.,
326
- "x256"), the width is chosen to maintain the aspect ratio. To
327
- specify a percentage width or height instead, append %. The
328
- image size is multiplied by the width and height percentages to
329
- obtain the final image dimensions. To increase the size of an
330
- image, use a value greater than 100 (e.g. 125%). To decrease an
331
- image's size, use a percentage less than 100.</p>
332
-
333
- <p>Use @ to specify the maximum area in pixels of an image.</p>
334
-
335
- <p>Use &gt; to change the dimensions of the image only if its
336
- width or height exceeds the geometry specification. &lt;
337
- resizes the image only if both of its dimensions are less than
338
- the geometry specification. For example, if you specify
339
- '640x480&gt;' and the image size is 256x256, the image size
340
- does not change. However, if the image is 512x512 or 1024x1024,
341
- it is resized to 480x480.</p>
342
-
343
- <p>Use ^ to set a minimum image size limit. The geometry
344
- 640x480^, for example, means the image width will not be less
345
- than 640 and the image height will not be less than 480 pixels
346
- after the resize. One of those dimensions will match the
347
- requested size, but the image will likely overflow the space
348
- requested to preserve its aspect ratio.</p>
349
- </div>
350
-
351
- <p>The x and y offsets, if present, can be preceded with either a
352
- + or - sign. The + causes x and y to be measured from the left or
353
- top edges, respectively. Conversely, - measures from the right or
354
- bottom edges. Offsets are always measured in pixels.</p>
355
-
356
- <p>Any method that accepts a geometry string will also accept a
357
- <a href="struct.html#Geometry"><code>Geometry</code></a>
358
- object.</p>
359
-
360
- <p>Some RMagick methods interpret the geometry string values
361
- differently. Where this is the case the documentation for the
362
- method will explain the differences.</p>
363
-
364
- <h2 id="classtype">DirectClass and PseudoClass</h2>
365
-
366
- <p>ImageMagick classifies all images into two <em>classes</em>,
367
- PseudoClass and DirectClass.</p>
368
-
369
- <div class="imquote">
370
- <p>DirectClass images are continuous-tone images stored as RGB
371
- (red, green, blue), RGBA (red, green, blue, alpha), or CMYK
372
- (cyan, yellow, magenta, black) intensity values as defined by
373
- the <code>colorspace</code> [attribute].</p>
374
-
375
- <p>PseudoClass images are colormapped RGB images. The colormap
376
- is stored as a series of red, green, and blue pixel values,
377
- each value being a byte in size. If the image depth is 16, each
378
- colormap entry consumes two bytes with the most significant
379
- byte being first. The number of colormap entries is defined by
380
- the <code>colors</code> [attribute].</p>
381
- </div>
382
-
383
- <p>GIF format images are PseudoClass. JPEG format images are
384
- DirectClass. You can change the class of a image with the
385
- <code><a href=
386
- "imageattrs.html#class_type_eq">class_type=</a></code>
387
- method.</p>
388
-
389
- <h2 id="builtin_formats">Built-in image formats</h2>
390
-
391
- <p>Some of the image formats that ImageMagick supports are
392
- special-purpose formats that are built-in to ImageMagick itself.
393
- That is, even though you can "read" images in these formats, they
394
- do not correspond to any real image files.</p>
395
-
396
- <p>These are the built-in formats that I know something about.
397
- (There are more but I've never used them.) When the format is
398
- marked with an <sup>*</sup>, you must supply the desired size of
399
- the image in order to "read" it. Specify the size by assigning a
400
- string in the form "WxH" to the <code>size</code> attribute in
401
- the <code>read</code> method's additional parms block. For
402
- example, to create a image in the gradient format that is 100
403
- pixels wide and 200 pixels high, use:</p>
404
- <pre class="example">
405
- i = Image.read("gradient:red-blue") { self.size = "100x200" }
406
- </pre>
407
-
408
- <p>See <a href="javascript:popup('demo.rb.html')">demo.rb</a> for
409
- more examples of reading built-in formats.</p>
410
-
411
- <div id="bi_format_list">
412
- <h4>caption<sup>*</sup></h4>
413
-
414
- <p>The caption format is used to create an image from a text
415
- string. Ex: "caption:My caption text".</p>
416
-
417
- <p>If you specify only the width in the <code>size</code>
418
- argument, ImageMagick will wrap the text and compute the
419
- necessary height. In addition to <code>size</code> (which is
420
- required) you can use the following <a href=
421
- "info.html">optional arguments</a>:</p>
422
-
423
- <ul>
424
- <li>antialias</li>
425
-
426
- <li>background_color</li>
427
-
428
- <li>border_color</li>
429
-
430
- <li>density</li>
431
-
432
- <li>fill</li>
433
-
434
- <li>font</li>
435
-
436
- <li>gravity</li>
437
-
438
- <li>pointsize</li>
439
-
440
- <li>stroke</li>
441
-
442
- <li>stroke_width</li>
443
-
444
- <li>undercolor</li>
445
- </ul>
446
-
447
- <h4>gradient<sup>*</sup></h4>
448
-
449
- <p>Gradient filenames have the form
450
- <code>"gradient:color1-color2"</code>. These images are created
451
- by gradually changing from <code>color1</code> at the top edge
452
- to <code>color2</code> at the bottom. Don't confuse this image
453
- format with the <a href=
454
- "struct.html#GradientFill">GradientFill</a> class, which is
455
- part of RMagick.</p>
456
-
457
- <h4>granite</h4>
458
-
459
- <p>A mottled gray image suitable for use as a tiled background
460
- texture. Ex: <code>"granite:"</code>.</p>
461
-
462
- <h4>logo</h4>
463
-
464
- <p>The ImageMagick logo. Ex: <code>"logo:"</code>.</p>
465
-
466
- <h4>netscape</h4>
467
-
468
- <p>The 216-color "Web safe" cube. Ex:
469
- <code>"netscape:"</code>.</p>
470
-
471
- <h4>null<sup>*</sup></h4>
472
-
473
- <p>An empty image. Ex: <code>"null:"</code>.</p>
474
-
475
- <h4>pattern</h4>
476
-
477
- <p>This format supplies a number of built-in patterns that may
478
- be referenced by specifying the pattern name. For example,
479
- <code>pattern:checkerboard</code>. For a list of acceptable
480
- patterns, see <a href=
481
- "http://www.imagemagick.org/script/formats.php">this page.</a>
482
- If you do not specify a size the pattern's default size is
483
- used. If you specify a size the pattern will be repeated as
484
- necessary to fill the image.</p>
485
-
486
- <h4>plasma<sup>*</sup></h4>
487
-
488
- <p>Creates a swirly, psychedelic image. Specify a pair of
489
- colors in the filename (<code>"plasma:red-blue"</code>) or
490
- specify the filename <code>"plasma:fractal"</code> for best
491
- results.</p>
492
-
493
- <h4>rose</h4>
494
-
495
- <p>A small picture of a rose. Ex: <code>"rose:"</code>.</p>
496
-
497
- <h4>xc<sup>*</sup></h4>
498
-
499
- <p>Specify a <a href="#color_names">color name</a> after the
500
- xc: prefix. For example, <code>"xc:red"</code>. This format is
501
- simply an image of the specified color. You can get exactly the
502
- same results by specifying the background color when creating
503
- an image.</p>
504
- </div>
505
-
506
- <p class="spacer"></p>
507
-
508
- <div class="nav">
509
- &laquo; <a href="usage.html">Prev</a> | <a href=
510
- "index.html">Contents</a> | <a href="optequiv.html">Next</a>
511
- &raquo;
512
- </div>
513
- </body>
514
- </html>