RubyGems - rmagick - Versions diffs - 2.5.2 → 2.6.0 - Mend

rmagick 2.5.2 → 2.6.0

Potentially problematic release.

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

Files changed (52) hide show

data/ChangeLog +29 -0
data/README.html +7 -7
data/doc/comtasks.html +2 -2
data/doc/constants.html +22 -5
data/doc/draw.html +2 -2
data/doc/ex/affinity.rb +12 -0
data/doc/ex/affinity_images.rb +21 -0
data/doc/ex/composite_tiled.rb +23 -0
data/doc/ex/images/Apple.miff +0 -0
data/doc/ex/images/Leaf.miff +0 -0
data/doc/ex/images/Rocks_On_Beach.miff +0 -0
data/doc/ex/images/Yellow_Rose.miff +0 -0
data/doc/ex/level_colors.rb +11 -0
data/doc/ilist.html +72 -30
data/doc/image1.html +305 -34
data/doc/image2.html +144 -18
data/doc/image3.html +111 -8
data/doc/imageattrs.html +10 -2
data/doc/imusage.html +5 -5
data/doc/index.html +3 -3
data/doc/info.html +2 -2
data/doc/magick.html +2 -2
data/doc/optequiv.html +54 -9
data/doc/rvg.html +2 -2
data/doc/rvgclip.html +2 -2
data/doc/rvggroup.html +2 -2
data/doc/rvgimage.html +2 -2
data/doc/rvgpattern.html +2 -2
data/doc/rvgshape.html +2 -2
data/doc/rvgstyle.html +2 -2
data/doc/rvgtext.html +2 -2
data/doc/rvgtspan.html +2 -2
data/doc/rvgtut.html +2 -2
data/doc/rvguse.html +2 -2
data/doc/rvgxform.html +2 -2
data/doc/struct.html +2 -2
data/doc/usage.html +27 -8
data/ext/RMagick/MANIFEST +9 -3
data/ext/RMagick/extconf.rb +19 -3
data/ext/RMagick/rmagick.h +23 -7
data/ext/RMagick/rmdraw.c +74 -22
data/ext/RMagick/rmfill.c +2 -2
data/ext/RMagick/rmilist.c +79 -29
data/ext/RMagick/rmimage.c +904 -393
data/ext/RMagick/rminfo.c +9 -9
data/ext/RMagick/rmmain.c +64 -9
data/ext/RMagick/rmutil.c +158 -44
data/lib/RMagick.rb +32 -1
data/rmagick.gemspec +1 -1
metadata +10 -4
data/doc/ex/map.rb +0 -28
data/doc/ex/map_f.rb +0 -15

data/doc/image1.html CHANGED

@@ -6,7 +6,7 @@
   <meta name="generator" content=
   "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
-  <title>RMagick 2.5.2: class Image (class methods and instance
+  <title>RMagick 2.6.0: class Image (class methods and instance
   methods a-d)</title>
   <meta http-equiv="Content-Type" content=
   "text/html; charset=us-ascii" />
@@ -48,7 +48,7 @@ float: left;
 </head>
 <body>
-  <h6 id="header">RMagick 2.5.2 User's Guide and Reference</h6>
+  <h6 id="header">RMagick 2.6.0 User's Guide and Reference</h6>
   <div class="nav">
     &laquo;&nbsp;<a href="imageattrs.html">Prev</a> | <a href=
@@ -132,6 +132,8 @@ float: left;
           <li><a href="#affine_transform">affine_transform</a></li>
+          <li><a href="#affinity">affinity</a></li>
           <li><a href="#alpha">alpha</a></li>
           <li><a href="#alpha_q">alpha?</a></li>
@@ -204,12 +206,17 @@ float: left;
           <li><a href="#composite">composite</a></li>
           <li><a href="#composite_bang">composite!</a></li>
+          <li><a href="#composite_affine">composite_affine</a></li>
+          <li><a href="#composite_tiled">composite_tiled</a></li>
         </ul>
       </div>
       <div class="toccol">
         <ul>
-          <li><a href="#composite_affine">composite_affine</a></li>
+          <li><a href=
+          "#composite_tiled_bang">composite_tiled!</a></li>
           <li><a href=
           "#compress_colormap_bang">compress_colormap!</a></li>
@@ -240,6 +247,8 @@ float: left;
           <li><a href="#delete_profile">delete_profile</a></li>
+          <li><a href="#deskew">deskew</a></li>
           <li><a href="#despeckle">despeckle</a></li>
           <li><a href="#destroy_bang">destroy!</a></li>
@@ -1447,6 +1456,62 @@ img = Image.read_inline(content)
     <p>AffineTransformImage</p>
   </div>
+  <div class="sig">
+    <h3 id="affinity">affinity</h3>
+    <p><span class="arg">img</span>.affinity(<span class=
+    "arg">affinity_image</span>, <span class=
+    "arg">dither</span>=RiemersmaDitherMethod) -&gt; <em>self</em></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p>Reduce the number of colors in <span class="arg">img</span>
+    to the colors used by <span class="arg">affinity_image</span>.
+    If a dither method is specified <span class="imquote">then the
+    given colors are dithered over the image as necessary,
+    otherwise the closest color (in RGB colorspace) is selected to
+    replace that pixel in the image.</span></p>
+    <h4>Arguments</h4>
+    <dl>
+      <dt>affinity_image</dt>
+      <dd>The reference image</dd>
+      <dt>dither</dt>
+      <dd>A <a href="constants.html#DitherMethod">DitherMethod</a>
+      value. RiemersmaDitherMethod is the default. To disable
+      dithering specify NoDitherMethod.</dd>
+    </dl>
+    <h4>Returns</h4>
+    <p>self</p>
+    <h4>Example</h4>
+    <p class="rollover"><a href=
+    "javascript:popup('affinity.rb.html')"><img onmouseover=
+    "this.src='ex/images/Flower_Hat.jpg'" onmouseout=
+    "this.src='ex/affinity.jpg'" src="ex/affinity.jpg" alt=
+    "affinity example" title=
+    "Click to see the example script" /></a> <img src=
+    "ex/images/spin.gif" alt="" class="spin" style="left: 202px;"
+    title="Mouse over the example to see the original image" /></p>
+    <h4>See also</h4>
+    <p><a href="ilist.html#affinity">ImageList#affinity</a></p>
+    <h4>Magick API</h4>
+    <p>AffinityImage (available in ImageMagick 6.4.3-6)</p>
+  </div>
   <div class="sig">
     <h3 id="alpha">alpha</h3>
@@ -1915,7 +1980,7 @@ img = Image.read_inline(content)
       <dd>Border color. Use a <a href=
       "imusage.html#color_names">named color</a> or a <a href=
-      "struct.html#Pixel">Pixel</a> object.</dd>
+      "struct.html#Pixel">pixel</a> object.</dd>
     </dl>
     <h4>Returns</h4>
@@ -2557,7 +2622,7 @@ mona.change_geometry!('320x240') { |cols, rows, img|
     <h4>Returns</h4>
     <p>A hash. Each key in the hash is a <a href=
-    "struct.html#Pixel">Pixel</a> representing a color that appears
+    "struct.html#Pixel">pixel</a> representing a color that appears
     in the image. The value associated with the key is the number
     of times that color appears in the image. <em>Caution:</em> if
     the image contains many colors the hash will be very large. You
@@ -2609,8 +2674,8 @@ mona.change_geometry!('320x240') { |cols, rows, img|
       <dt>fill</dt>
-      <dd>A color name or a <a href="struct.html#Pixel">Pixel</a>
-      structure</dd>
+      <dd>A color name or a <a href=
+      "struct.html#Pixel">Pixel</a></dd>
     </dl>
     <h4>Returns</h4>
@@ -2676,7 +2741,7 @@ mona.change_geometry!('320x240') { |cols, rows, img|
       <dd>Optional. If specified, may be either a <a href=
       "imusage.html#color_names">color name</a> or a <a href=
-      "struct.html#Pixel">Pixel</a>.</dd>
+      "struct.html#Pixel">pixel</a>.</dd>
     </dl>
     <h4>Returns</h4>
@@ -2768,8 +2833,9 @@ f.color_reset!(red)
     <p><span class="arg">img</span>.compare_channel(<span class=
     "arg">img</span>, <span class="arg">metric</span> [,
-    <span class="arg">channel...</span>]) -&gt; [<em>image</em>,
-    <em>float</em>]</p>
+    <span class="arg">channel...</span>]) [ <span class=
+    "arg">{&nbsp;optional arguments&nbsp;}</span> ] -&gt;
+    [<em>image</em>, <em>float</em>]</p>
   </div>
   <div class="desc">
@@ -2797,6 +2863,29 @@ f.color_reset!(red)
       specified channels contribute to the comparison and the
       distortion value. If no channels are specified, compares all
       channels.</dd>
+      <dt>optional arguments</dt>
+      <dd>
+        If present, <code>compare_channel</code> yields to a block
+        in which you can set optional arguments by setting
+        attributes on <em>self</em>. In both cases <span class=
+        "arg">color</span> may be either a <a href=
+        "imusage.html#color_names">color name</a> or a <a href=
+        "struct.html#Pixel">pixel</a>.
+        <dl>
+          <dt>self.highlight_color = color</dt>
+          <dd>Emphasize pixel differences with this color. The
+          default is partially transparent red.</dd>
+          <dt>self.lowlight_color = color</dt>
+          <dd>Demphasize pixel differences with this color. The
+          default is partially transparent white.</dd>
+        </dl>
+      </dd>
     </dl>
     <h4>Returns</h4>
@@ -3064,6 +3153,88 @@ f.color_reset!(red)
     <p>DrawAffineImage</p>
   </div>
+  <div class="sig">
+    <h3 id="composite_tiled">composite_tiled</h3>
+    <p><span class="arg">img</span>.composite_tiled(<span class=
+    "arg">src</span>, <span class="arg">composite_op</span> =
+    Magick::OverCompositeOp) -&gt; <em>image</em></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p>Composites multiple copies of the source image across and
+    down the image, producing the same results as ImageMagick's
+    composite command with the -tile option.</p>
+    <h4>Arguments</h4>
+    <dl>
+      <dt>src</dt>
+      <dd>The source image</dd>
+      <dt>composite_op</dt>
+      <dd>A <a href=
+      "constants.html#CompositeOperator">CompositeOperator</a>
+      value</dd>
+    </dl>
+    <h4>Returns</h4>
+    <p>A new image</p>
+    <h4>See also</h4>
+    <p><a href="#composite">composite</a>, <a href=
+    "#composite_tiled_bang">composite_tiled!</a></p>
+    <h4>Magick API</h4>
+    <p>CompositeImage</p>
+  </div>
+  <div class="sig">
+    <h3 id="composite_tiled_bang">composite_tiled!</h3>
+    <p><span class="arg">img</span>.composite_tiled!(<span class=
+    "arg">src</span>, <span class="arg">composite_op</span> =
+    Magick::OverCompositeOp) -&gt; <em>self</em></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p>In-place form of <a href=
+    "#composite_tiled">composite_tiled</a>.</p>
+    <h4>Example</h4>
+    <p class="rollover"><a href=
+    "javascript:popup('composite_tiled.rb.html')"><img onmouseover=
+    "this.src='ex/images/Flower_Hat.jpg'" onmouseout=
+    "this.src='ex/composite_tiled.jpg'" src=
+    "ex/composite_tiled.jpg" alt="composite_tiled example" title=
+    "Click the image to see the example script" /></a> <img src=
+    "ex/images/spin.gif" alt="" class="spin" title=
+    "Mouse over the example to see the original image" /></p>
+    <h4>Returns</h4>
+    <p>self</p>
+    <h4>See also</h4>
+    <p><a href="#composite_bang">composite!</a>, <a href=
+    "#composite_tiled">composite_tiled</a></p>
+    <h4>Magick API</h4>
+    <p>CompositeImage</p>
+  </div>
   <div class="sig">
     <h3 id="compress_colormap">compress_colormap</h3>
@@ -3692,6 +3863,48 @@ deciphered_img = img.decipher("magic word")
     <p>ProfileImage</p>
   </div>
+  <div class="sig">
+    <h3 id="deskew">deskew</h3>
+    <p><span class="arg">img</span>.deskew(<span class=
+    "arg">threshold</span>=0.40, <span class=
+    "arg">auto_crop_width</span>=nil) -&gt; <em>image</em></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p class="imquote">Straightens an image. A <span class=
+    "arg">threshold</span> of 40% works for most images.</p>
+    <h4>Arguments</h4>
+    <dl>
+      <dt>threshold</dt>
+      <dd>A percentage of QuantumRange. Either a Float between 0
+      and 1.0, inclusive, or a string in the form "NN%" where NN is
+      between 0 and 100.</dd>
+      <dt>auto_crop_width</dt>
+      <dd>Specify a value for this argument to cause the deskewed
+      image to be auto-cropped. The argument is the pixel width of
+      the image background (e.g. 40).</dd>
+    </dl>
+    <h4>Returns</h4>
+    <p>A new image</p>
+    <h4>Example</h4>
+    <pre>
+img2 = img.deskew
+</pre>
+    <h4>Magick API</h4>DeskewImage (available in 6.4.2)
+  </div>
   <div class="sig">
     <h3 id="despeckle">despeckle</h3>
@@ -4093,53 +4306,111 @@ pixels = f.dispatch(0, 0, f.columns, f.rows, "RGB")
     <p><span class="arg">img</span>.distort(<span class=
     "arg">type</span>, <span class="arg">points</span>,
-    <span class="arg">bestfit</span>=<code>false</code>) -&gt;
-    <em>image</em></p>
+    <span class="arg">bestfit</span>=<code>false</code>) [
+    <span class="arg">{&nbsp;optional arguments&nbsp;}</span> ]
+    -&gt; <em>image</em></p>
   </div>
   <div class="desc">
     <h4>Description</h4>
     <p>Distort an image using the specified distortion type and its
-    required arguments. This method is the equivalent of
-    ImageMagick's -distort option.</p>
+    required arguments. This method is equivalent to ImageMagick's
+    -distort option.</p>
     <h4>Arguments</h4>
-    <p>Specify one of the following values for the distortion
-    <span class="arg">type</span>:</p>
+    <dl>
+      <dt>type</dt>
+      <dd>
+        One of the following values:
+        <ul>
+          <li>AffineDistortion</li>
+          <li>AffineProjectionDistortion</li>
+          <li>ArcDistortion</li>
+          <li>BarrelDistortion</li>
-    <ul>
-      <li>AffineDistortion</li>
+          <li>BilinearDistortion</li>
-      <li>AffineProjectionDistortion</li>
+          <li>PerspectiveDistortion</li>
-      <li>ArcDistortion</li>
+          <li>PerspectiveProjectionDistortion</li>
-      <li>BilinearDistortion</li>
+          <li>PolynomialDistortion</li>
-      <li>PerspectiveDistortion</li>
+          <li>ScaleRotateTranslateDistortion</li>
-      <li>PerspectiveProjectionDistortion</li>
+          <li>ShepardsDistortion</li>
+        </ul>
+      </dd>
+      <dt>points</dt>
+      <dd>An array of numbers. The size of the array depends on the
+      distortion type.</dd>
+      <dt>bestfit</dt>
+      <dd class="imquote">If <span class="arg">bestfit</span> is
+      enabled, and the distortion allows it, the destination image
+      is adjusted to ensure the whole source image will just fit
+      within the final destination image, which will be sized and
+      offset accordingly. Also in many cases the virtual offset of
+      the source image will be taken into account in the
+      mapping.</dd>
-      <li>ScaleRotateTranslateDistortion</li>
-    </ul>
+      <dt>optional arguments</dt>
+      <dd>
+        If present, <code>distort</code> yields to a block in which
+        you can set optional arguments by calling methods on
+        <em>self</em>.
+        <dl>
+          <dt>self.define("distort:viewport", "WxH+X+Y")</dt>
-    <p>The <span class="arg">points</span> argument is an array of
-    numbers. The size of the array depends on the distortion
-    type.</p>
+          <dd>Specify the size and offset of the generated viewport
+          image of the distorted image space. W and H are the width
+          and height, and X and Y are the offset.</dd>
-    <p class="imquote">If <span class="arg">bestfit</span> is
-    enabled, and the distortion allows it, the destination image is
-    adjusted to ensure the whole source image will just fit within
-    the final destination image, which will be sized and offset
-    accordingly. Also in many cases the virtual offset of the
-    source image will be taken into account in the mapping.</p>
+          <dt>self.define("distort:scale", N)</dt>
+          <dd>N is an integer factor. <span class="imquote">Scale
+          the output image (viewport or otherwise) by that factor
+          without changing the viewed contents of the distorted
+          image. This can be used either for 'super-sampling' the
+          image for a higher quality result, or for panning and
+          zooming around the image (with appropriate viewport
+          changes, or post-distort cropping and
+          resizing).</span></dd>
+          <dt>self.verbose(true)</dt>
+          <dd class="imquote">Attempt to output the internal
+          coefficients, and the -fx equivalent to the distortion,
+          for expert study, and debugging purposes. This many not
+          be available for all distorts.</dd>
+        </dl>
+      </dd>
+    </dl>
     <h4>Returns</h4>
     <p>A new image</p>
+    <h4>Example</h4>
+    <pre>
+result = img.distort(Magick::ScaleRotateTranslateDistortion, [0]) do
+                     self.define "distort:viewport", "44x44+15+0"
+                     self.define "distort:scale", 2
+                  end
+</pre>
     <h4>Note</h4>
     <p>See <a href=