doc/image2.html in rmagick-2.2.2 vs doc/image2.html in rmagick-2.3.0
- old
+ new
@@ -4,11 +4,11 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<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" />
<meta name="Copyright" content=
"Copyright (C) 2006 by Timothy P. Hunter" />
@@ -45,11 +45,11 @@
/*]]>*/
</style>
</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">
« <a href="image1.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"image3.html">Next</a> »
@@ -76,10 +76,12 @@
<li><a href="#edge">edge</a></li>
<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>
<li><a href="#equalize_channel">equalize_channel</a></li>
@@ -161,10 +163,12 @@
</ul>
</div>
<div class="toccol">
<ul>
+ <li><a href="#mask">mask</a></li>
+
<li><a href="#map">map</a></li>
<li><a href=
"#matte_fill_to_border">matte_fill_to_border</a></li>
@@ -382,10 +386,44 @@
<p>EmbossImage</p>
</div>
<div class="sig">
+ <h3 id="encipher">encipher</h3>
+
+ <p><span class="arg">img</span>.encipher(<span class=
+ "arg">passphrase</span>) -> <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>
<p><span class="arg">img</span>.enhance ->
<em>image</em></p>
</div>
@@ -757,11 +795,11 @@
<dd>The width of the new image</dd>
<dt>height</dt>
- <dd>The heigth of the new image</dd>
+ <dd>The height of the new image</dd>
<dt>x, y</dt>
<dd>The upper-left corner of the new image is positioned at
-<span class="arg">x</span>, -<span class=
@@ -1243,11 +1281,11 @@
<p>Zero or more EXIF entry names.</p>
<h4>Returns</h4>
<p>The elements in the returned array are 2-element arrays in
- the form [name, value]. If ×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
<code>nil</code>.</p>
@@ -2108,11 +2146,11 @@
<p>This example is contrived since there's no need to convert
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 ×Magick is configured with
+ example assumes that ImageMagick is configured with
QuantumDepth=8.</p>
<pre>
hat = Image.read("Flower_Hat.jpg").first
pixels = hat.export_pixels(0, 0, hat.columns, hat.rows, "RGB")
char_buffer = pixels.pack("C*")
@@ -2270,11 +2308,11 @@
<pre>
img.level(white_point, gamma, black_point) -> 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.
That is, if <code>gamma</code> is > 10.0, or if
<code>white_point</code> is < 10.0, or if <code>gamma</code>
@@ -2459,11 +2497,11 @@
<h4>See also</h4>
<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>
<p>MagnifyImage</p>
</div>
@@ -2535,10 +2573,69 @@
<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>]) ->
+ <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>
<p><span class=
"arg">img</span>.matte_fill_to_border(<span class=
"arg">x</span>, <span class="arg">y</span>) ->
@@ -3304,10 +3401,10 @@
</div>
<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>
<h4>Arguments</h4>