RubyGems - rmagick - Versions diffs - 2.2.2 → 2.3.0 - Mend

rmagick 2.2.2 → 2.3.0

Potentially problematic release.

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

Files changed (55) hide show

data/doc/draw.html CHANGED Viewed

@@ -6,7 +6,7 @@
   <meta name="generator" content=
   "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
-  <title>RMagick 2.2.2: class Draw</title>
+  <title>RMagick 2.3.0: class Draw</title>
   <meta http-equiv="Content-Type" content=
   "text/html; charset=us-ascii" />
   <meta name="GENERATOR" content="Quanta Plus" />
@@ -25,7 +25,7 @@
 </head>
 <body>
-  <h6 id="header">RMagick 2.2.2 User's Guide and Reference</h6>
+  <h6 id="header">RMagick 2.3.0 User's Guide and Reference</h6>
   <div class="nav">
     &laquo;&nbsp;<a href="image3.html">Prev</a> | <a href=
@@ -539,7 +539,7 @@ title.annotate(montage, 0,0,0,40, 'Named Colors') {
     <h4>Description</h4>
     <p>Same as <a href="#dup">dup</a> except the frozen state of
-    the original is propogated to the copy.</p>
+    the original is propagated to the copy.</p>
     <h4>Returns</h4>
@@ -2210,7 +2210,7 @@ draw.decorate(LineThroughDecoration)
   <div class="desc">
     <h4>Description</h4>
-    <p>Define a skew tranformation along the x-axis.</p>
+    <p>Define a skew transformation along the x-axis.</p>
     <h4>Arguments</h4>
@@ -2242,7 +2242,7 @@ draw.decorate(LineThroughDecoration)
   <div class="desc">
     <h4>Description</h4>
-    <p>Define a skew tranformation along the y-axis.</p>
+    <p>Define a skew transformation along the y-axis.</p>
     <h4>Arguments</h4>

data/doc/ex/mask.rb CHANGED Viewed

@@ -23,11 +23,11 @@ gc.annotate(q, 0, 0, 0, 0, "Flower Hat") do
 end
 # Set the matte attribute to false, indicating the absence of an alpha channel
-# in the mask image. Assign the mask image to the mask= attribute of the image
+# in the mask image. Assign the mask image to the mask= attribute of the image
 # being masked.
 q.matte = false
-img.mask = q
+img.mask q
 # Use the #level method to darken the image under the black part of the mask.

data/doc/ilist.html CHANGED Viewed

@@ -6,7 +6,7 @@
   <meta name="generator" content=
   "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
-  <title>RMagick 2.2.2: class ImageList</title>
+  <title>RMagick 2.3.0: class ImageList</title>
   <meta http-equiv="Content-Type" content=
   "text/html; charset=us-ascii" />
   <meta name="GENERATOR" content="Quanta Plus" />
@@ -20,7 +20,7 @@
 </head>
 <body>
-  <h6 id="header">RMagick 2.2.2 User's Guide and Reference</h6>
+  <h6 id="header">RMagick 2.3.0 User's Guide and Reference</h6>
   <div class="nav">
     &laquo;&nbsp;<a href="magick.html">Prev</a> | <a href=
@@ -374,7 +374,7 @@ ilist.ticks_per_second = 1000
     undefined results. Most of the time RMagick will raise an
     ArgumentError exception. For example, if you call
     <code>collect!</code> on an imagelist you should make sure that
-    the members of theimagelist remain images. If you need to
+    the members of the imagelist remain images. If you need to
     replace images in an imagelist with non-image objects, convert
     the imagelist to an array with the <code>to_a</code> method,
     then modify the array.</p>
@@ -563,7 +563,7 @@ ilist.animate { self.server_name = "other:0.0" }
     <h4>Description</h4>
     <p>Same as <a href="#dup">dup</a>, but the frozen state of the
-    original is propogated to the copy.</p>
+    original is propagated to the copy.</p>
     <h4>Returns</h4>
@@ -760,7 +760,7 @@ imagelist2 = imagelist1.copy
     successor. The resulting imagelist usually produces a much
     smaller file.</p>
-    <p>The <code>desconstruct</code> method starts by copying the
+    <p>The <code>deconstruct</code> method starts by copying the
     first image in the list to the output imagelist. Then, for each
     pair of images, <code>deconstruct</code> computes the smallest
     rectangle that encompasses all the changes between the first
@@ -1519,7 +1519,7 @@ ilist.new_image(100, 100) { self.background_color = "red" }
       first images virtual canvas using the current background
       color, and compose each image in turn onto that canvas.
       Images falling outside that canvas will be clipped. Final
-      image will have a zero virtual canvas offset. This is usally
+      image will have a zero virtual canvas offset. This is usually
       used as one of the final 'image layering' operations
       overlaying all the prepared image layers into a final image.
       For a single image this method can also be used to fillout a
@@ -1536,7 +1536,7 @@ ilist.new_image(100, 100) { self.background_color = "red" }
       'locked' to the origin, by definition, image layers with a
       negative offsets will still be clipped by the top and left
       edges. This method is commonly used to layout individual
-      image using various offset but without knowning the final
+      image using various offset but without knowing the final
       canvas size. The resulting image will, like FlattenLayer not
       have any virtual offset, so can be saved to any image file
       format.</span> This method corresponds to <a href=
@@ -1592,7 +1592,7 @@ ilist.new_image(100, 100) { self.background_color = "red" }
       <dd class="imquote">Remove (and merge time delays) of
       duplicate consecutive images, so as to simplify layer
-      overlays of coalesced animations. Usally this is a result of
+      overlays of coalesced animations. Usually this is a result of
       using a constant time delay across the whole animation, or
       after a larger animation was split into smaller
       sub-animations. The duplicate frames could also have been
@@ -1605,7 +1605,7 @@ ilist.new_image(100, 100) { self.background_color = "red" }
       proper timed animation, a warning is then issued). In a GIF
       animation, such images are usually frames which provide
       partial intermediary updates between the frames that are
-      actually displayed to users. These frames are usally added
+      actually displayed to users. These frames are usually added
       for improved frame optimization in GIF animations.</dd>
     </dl>

data/doc/image1.html CHANGED Viewed

@@ -6,7 +6,7 @@
   <meta name="generator" content=
   "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
-  <title>RMagick 2.2.2: class Image (class methods and instance
+  <title>RMagick 2.3.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.2.2 User's Guide and Reference</h6>
+  <h6 id="header">RMagick 2.3.0 User's Guide and Reference</h6>
   <div class="nav">
     &laquo;&nbsp;<a href="imageattrs.html">Prev</a> | <a href=
@@ -130,6 +130,10 @@ float: left;
           <li><a href="#affine_transform">affine_transform</a></li>
+          <li><a href="#alpha">alpha</a></li>
+          <li><a href="#alpha_q">alpha?</a></li>
           <li><a href="#annotate">annotate</a></li>
           <li><a href="#auto_orient">auto_orient</a></li>
@@ -145,15 +149,17 @@ float: left;
           <li><a href="#blur_channel">blur_channel</a></li>
           <li><a href="#blur_image">blur_image</a></li>
-          <li><a href="#border">border</a></li>
         </ul>
       </div>
       <div class="toccol">
         <ul>
+          <li><a href="#border">border</a></li>
           <li><a href="#border_bang">border!</a></li>
+          <li><a href="#bounding_box">bounding_box</a></li>
           <li><a href="#change_geometry">change_geometry</a></li>
           <li><a href="#changed_q">changed?</a></li>
@@ -225,6 +231,8 @@ float: left;
           <li><a href="#cycle_colormap">cycle_colormap</a></li>
+          <li><a href="#decipher">decipher</a></li>
           <li><a href="#delete_profile">delete_profile</a></li>
           <li><a href="#despeckle">despeckle</a></li>
@@ -800,7 +808,7 @@ img = Image.read_inline(content)
     <p>The value of <span class=
     "arg">img</span>.<code>signature</code> &lt;=&gt; <span class=
-    "arg">other_mage</span>.<code>signature</code>.</p>
+    "arg">other_image</span>.<code>signature</code>.</p>
     <h4>See also</h4>
@@ -824,7 +832,7 @@ img = Image.read_inline(content)
   <div class="desc">
     <h4>Description</h4>
-    <p><span class="imquote">Adaptively blurs the image by bluring
+    <p><span class="imquote">Adaptively blurs the image by blurring
     more intensely near image edges and less intensely far from
     edges.</span> The adaptive_blur method blurs <span class=
     "imquote">the image with a Gaussian operator of the
@@ -1344,6 +1352,82 @@ img = Image.read_inline(content)
     <p>AffineTransformImage</p>
   </div>
+  <div class="sig">
+    <h3 id="alpha">alpha</h3>
+    <p><span class="arg">img</span>.alpha(<span class=
+    "arg">type</span>) -&gt; <em>type</em></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p>Set a flag to indicate whether or not to use alpha channel
+    data.</p>
+    <h4>Arguments</h4>
+    <p>One of the following values of the AlphaChannelType
+    enumeration:</p>
+    <dl>
+      <dt>ActivateAlphaChannel</dt>
+      <dd>Use alpha channel data.</dd>
+      <dt>DeactivateAlphaChannel</dt>
+      <dd>Do not use alpha channel data.</dd>
+      <dt>ResetAlphaChannel</dt>
+      <dd>Set the alpha channel to fully opaque.</dd>
+      <dt>SetAlphaChannel</dt>
+      <dd>Sets the alpha channel to the intensity of the
+      image.</dd>
+    </dl>
+    <h4>Returns</h4>
+    <p>The argument.</p>
+    <h4>See also</h4>
+    <p><a href="#alpha_q">alpha?</a></p>
+    <h4>Notes</h4>
+    <p>Available in ImageMagick 6.3.5 and later.</p>
+    <h4>Magick API</h4>
+    <p>SetImageAlphaChannel</p>
+  </div>
+  <div class="sig">
+    <h3 id="alpha_q">alpha?</h3>
+    <p><span class="arg">img</span>.alpha? -&gt; <code>true</code>
+    or <code>false</code></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p>Returns <code>true</code> if the alpha channel will be used,
+    <code>false</code> otherwise.</p>
+    <h4>See also</h4>
+    <p><a href="#alpha">alpha</a></p>
+    <h4>Magick API</h4>
+    <p>GetImageAlphaChannel</p>
+  </div>
   <div class="sig">
     <h3 id="annotate">annotate</h3>
@@ -1639,7 +1723,7 @@ img = Image.read_inline(content)
       <dd>One or more <a href=
       "constants.html#ChannelType">ChannelType</a> values. If none
-      are specified, all channels are blurred. This is the
+      are specified, the red, green, and blue channels are blurred. This is the
       equivalent of <a href="#blur_image">blur_image</a>.</dd>
     </dl>
@@ -1784,6 +1868,34 @@ img = Image.read_inline(content)
     <p>self</p>
   </div>
+  <div class="sig">
+    <h3 id="bounding_box">bounding_box</h3>
+    <p><span class="arg">img</span>.bounding_box -&gt;
+    <em>rectangle</em></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p>The image's <em>bounding box</em>. The bounding box is the
+    rectangle that encloses all the pixels not in the border color.
+    Uses the current <a href="#fuzz">fuzz</a> value.</p>
+    <h4>Returns</h4>A <a href="struct.html#Rectangle">Rectangle</a>
+    object.
+    <h4>Example</h4>
+    <p>In this example, the bounding box is the gray square
+    enclosing the blue circle. (The coordinates and red circles
+    were added after the bounding box was computed.)</p>
+    <p><a href="javascript:popup('bounding_box.rb.html')"><img src=
+    "ex/bounding_box.gif" alt="ex/bounding_box.rb" title=
+    "Click to see the example script" /></a></p>
+  </div>
   <div class="sig">
     <h3 id="change_geometry">change_geometry</h3>
@@ -2141,7 +2253,7 @@ mona.change_geometry!('320x240') { |cols, rows, img|
     <h4>Description</h4>
     <p>Same as <a href="#dup">dup</a> except the frozen state of
-    the original is propogated to the new copy.</p>
+    the original is propagated to the new copy.</p>
     <h4>Returns</h4>
@@ -2167,10 +2279,10 @@ mona.change_geometry!('320x240') { |cols, rows, img|
     of its replacement value in an LUT gradient image.</p>
     <p class="imquote">The LUT image should be either a single row
-    or column image of replacement colors. The lookup is controled
+    or column image of replacement colors. The lookup is controlled
     by the -interpolate setting, especially for an LUT which is not
     the full length needed by the IM installed Quality (Q) level.
-    Good setings for this is the default 'bilinear' or 'bicubic'
+    Good settings for this is the default 'bilinear' or 'bicubic'
     interpolation setting for a smooth color gradient, or 'integer'
     for a direct unsmoothed lookup of color values.</p>
@@ -2183,7 +2295,7 @@ mona.change_geometry!('320x240') { |cols, rows, img|
     alpha/matte value using the alpha/matte value of the original
     image. As such correct alpha channel lookup for a pure
     gray-scale original image will require a copy of that grayscale
-    to be transfered into its alpha channel before applying the
+    to be transferred into its alpha channel before applying the
     -clut operator.</p>
     <h4>Arguments</h4>
@@ -2394,9 +2506,9 @@ mona.change_geometry!('320x240') { |cols, rows, img|
       <dt>red_pct, green_pct, blue_pct, matte_pct</dt>
       <dd>The percentage of the fill color red, green, blue and
-      matte (tranparency) components to blend with the image pixel.
-      For example, <code>.25</code> is 25%. The matte_pct argument
-      is optional.</dd>
+      matte (transparency) components to blend with the image
+      pixel. For example, <code>.25</code> is 25%. The matte_pct
+      argument is optional.</dd>
       <dt>fill</dt>
@@ -3101,7 +3213,7 @@ f.colors &raquo; 108
   <div class="desc">
     <h4>Description</h4>Returns a copy of the image. The tainted
-    state of the original is propogated to the copy.
+    state of the original is propagated to the copy.
     <h4>Example</h4>
     <pre>
@@ -3389,6 +3501,40 @@ cropped = img.crop(x, y, width, height, true)
     <p>CycleColormapImage</p>
   </div>
+  <div class="sig">
+    <h3 id="decipher">decipher</h3>
+    <p><span class="arg">img</span>.decipher(<span class=
+    "arg">passphrase</span>) -&gt; <em>image</em></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p>Decipher an enciphered image.</p>
+    <h4>Arguments</h4>
+    <p>The passphrase used to encipher the image.</p>
+    <h4>Returns</h4>
+    <p>A new image</p>
+    <h4>Example</h4>
+    <pre>
+deciphered_img = img.decipher("magic word")
+</pre>
+    <h4>Magick API</h4>
+    <p>DecipherImage</p>
+    <h4>See also</h4>
+    <p><a href="image2.html#encipher">encipher</a></p>
+  </div>
   <div class="sig">
     <h3 id="delete_profile">delete_profile</h3>
@@ -3506,7 +3652,7 @@ cropped = img.crop(x, y, width, height, true)
     about their difference.</p>
     <p class="imquote">A small normalized mean square
-    error...suggests the images are very similiar in spatial layout
+    error...suggests the images are very similar in spatial layout
     and color.</p>
     <h4>Returns</h4>
@@ -3851,6 +3997,8 @@ pixels = f.dispatch(0, 0, f.columns, f.rows, "RGB")
       <li>PerspectiveDistortion</li>
+      <li>PerspectiveProjectionDistortion</li>
       <li>ScaleRotateTranslateDistortion</li>
     </ul>

data/doc/image2.html CHANGED Viewed

@@ -6,7 +6,7 @@
   <meta name="generator" content=
   "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
-  <title>RMagick 2.2.2: class Image (instance methods e-o)</title>
+  <title>RMagick 2.3.0: class Image (instance methods e-o)</title>
   <meta http-equiv="Content-Type" content=
   "text/html; charset=us-ascii" />
   <meta name="GENERATOR" content="Quanta Plus" />
@@ -47,7 +47,7 @@ td.ds {
 </head>
 <body>
-  <h6 id="header">RMagick 2.2.2 User's Guide and Reference</h6>
+  <h6 id="header">RMagick 2.3.0 User's Guide and Reference</h6>
   <div class="nav">
     &laquo;&nbsp;<a href="image1.html">Prev</a> | <a href=
@@ -78,6 +78,8 @@ td.ds {
           <li><a href="#emboss">emboss</a></li>
+          <li><a href="#encipher">encipher</a></li>
           <li><a href="#enhance">enhance</a></li>
           <li><a href="#equalize">equalize</a></li>
@@ -163,6 +165,8 @@ td.ds {
       <div class="toccol">
         <ul>
+          <li><a href="#mask">mask</a></li>
           <li><a href="#map">map</a></li>
           <li><a href=
@@ -383,6 +387,40 @@ td.ds {
     <p>EmbossImage</p>
   </div>
+  <div class="sig">
+    <h3 id="encipher">encipher</h3>
+    <p><span class="arg">img</span>.encipher(<span class=
+    "arg">passphrase</span>) -&gt; <em>image</em></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p>Encipher an image.</p>
+    <h4>Arguments</h4>
+    <p>The passphrase.</p>
+    <h4>Returns</h4>
+    <p>A new image</p>
+    <h4>Example</h4>
+    <pre>
+enciphered_img = img.encipher("magic word")
+</pre>
+    <h4>Magick API</h4>
+    <p>EncipherImage</p>
+    <h4>See also</h4>
+    <p><a href="image1.html#decipher">decipher</a></p>
+  </div>
   <div class="sig">
     <h3 id="enhance">enhance</h3>
@@ -759,7 +797,7 @@ scanline = img.export_pixels(0, r, img.columns, 1, "RGB");
       <dt>height</dt>
-      <dd>The heigth of the new image</dd>
+      <dd>The height of the new image</dd>
       <dt>x, y</dt>
@@ -1245,7 +1283,7 @@ scanline = img.export_pixels(0, r, img.columns, 1, "RGB");
     <h4>Returns</h4>
     <p>The elements in the returned array are 2-element arrays in
-    the form [name, value]. If &times;Magick does not know the name
+    the form [name, value]. If ImageMagick does not know the name
     for an entry it uses "unknown." There may be more than one
     entry for "unknown" in the returned array. If there is no entry
     with the specified name the value is set to
@@ -2110,7 +2148,7 @@ img.import_pixels(0, r, img.columns, 1, "RGB", scanline);
     the <code>pixels</code> array into a string by calling
     <code>pack</code>, but it does demonstrate the use of a string
     <span class="arg">pixels</span> argument. Note that this
-    example assumes that &times;Magick is configured with
+    example assumes that ImageMagick is configured with
     QuantumDepth=8.</p>
     <pre>
 hat = Image.read("Flower_Hat.jpg").first
@@ -2272,7 +2310,7 @@ img.level(white_point, gamma, black_point) -&gt; image # wrong!
 </pre>
     <p>That is, the <code>gamma</code> and <code>white_point</code>
-    arguments were swapped. In an effort to maintain compatiblity
+    arguments were swapped. In an effort to maintain compatibility
     with older scripts that expect that signature,
     <code>level</code> inspects its arguments and will interchange
     <code>white_point</code> and gamma if they "look" incorrect.
@@ -2461,7 +2499,7 @@ img.level(white_point, gamma, black_point) -&gt; image # wrong!
     <p><a href="#magnify_bang">magnify!</a>, <a href=
     "#minify">minify</a>, <a href="image3.html#resize">resize</a>,
-    <a href="image3.html#scale">scal</a></p>
+    <a href="image3.html#scale">scale</a></p>
     <h4>Magick API</h4>
@@ -2536,6 +2574,65 @@ img.level(white_point, gamma, black_point) -&gt; image # wrong!
     <p>MapImage</p>
   </div>
+  <div class="sig">
+    <h3 id="mask">mask</h3>
+    <p><span class="arg">img</span>.mask([<span class=
+    "arg">image</span> or <code>nil</code>]) -&gt;
+    <em>mask_image</em></p>
+  </div>
+  <div class="desc">
+    <h4>Description</h4>
+    <p>Sets an image clip mask created from the specified mask
+    image. <span class="imquote">The mask image must have the same
+    dimensions as the image being masked.</span> If not, the mask
+    image is resized to match. <span class="imquote">If the mask
+    image has an alpha channel the opacity of each pixel is used to
+    define the mask. Otherwise, the intensity (gray level) of each
+    pixel is used.</span></p>
+    <p>In general, if the mask image does not have an alpha
+    channel, a white pixel in the mask prevents changes to the
+    corresponding pixel in the image being masked, while a black
+    pixel allows changes. A pixel that is neither black nor white
+    will allow partial changes depending on its intensity.</p>
+    <p>Use <a href="image1.html#alpha">alpha</a> to specify whether
+    or not the mask image has an alpha channel.</p>
+    <h4>Arguments</h4>
+    <p>If the value is an imagelist, uses the current image as the
+    mask image. To remove the mask, pass <code>nil</code> instead
+    of an image.</p>
+    <p>To get a copy of the current mask, omit the argument
+    entirely.</p>
+    <h4>Example</h4>
+    <p class="rollover"><a href=
+    "javascript:popup('mask.rb.html')"><img src="ex/mask.jpg" alt=
+    "mask example" title="Click to see the example script"
+    onmouseover="this.src='ex/images/Flower_Hat.jpg'" onmouseout=
+    "this.src='ex/mask.jpg'" /></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>A copy of the current mask, or <code>nil</code> if no mask
+    is defined.</p>
+    <h4>Notes</h4>
+    <p>This method makes a copy of the image to use as the mask.
+    This means that if you want to change the mask you must call
+    this method to establish the changed image as the mask.</p>
+  </div>
   <div class="sig">
     <h3 id="matte_fill_to_border">matte_fill_to_border</h3>
@@ -3306,7 +3403,7 @@ img = img.opaque('white', 'red')
   <div class="desc">
     <h4>Description</h4>
-    <p>DIthers the image to a predefined pattern. The <span class=
+    <p>Dithers the image to a predefined pattern. The <span class=
     "arg">threshold_map</span> argument defines the pattern to
     use.</p>