doc/imageattrs.html in rmagick-2.2.2 vs doc/imageattrs.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 (attribute methods)</title>
+ <title>RMagick 2.3.0: class Image (attribute methods)</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" />
@@ -23,11 +23,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="ilist.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"image1.html">Next</a> »
@@ -43,12 +43,10 @@
<h3>attribute methods</h3>
<div>
<div class="toccol">
<ul>
- <li><a href="#alpha">alpha</a></li>
-
<li><a href="#background_color">background_color</a></li>
<li><a href="#base_columns">base_columns</a></li>
<li><a href="#base_filename">base_filename</a></li>
@@ -62,12 +60,10 @@
<li><a href="#blur">blur</a></li>
<li><a href="#border_color">border_color</a></li>
- <li><a href="#bounding_box">bounding_box</a></li>
-
<li><a href="#chromaticity">chromaticity</a></li>
<li><a href="#class_type">class_type</a></li>
<li><a href="#color_profile">color_profile</a></li>
@@ -120,12 +116,10 @@
<li><a href="#interlace">interlace</a></li>
<li><a href="#iptc_profile">iptc_profile</a></li>
- <li><a href="#mask">mask</a></li>
-
<li><a href="#matte">matte</a></li>
<li><a href=
"#mean_error_per_pixel">mean_error_per_pixel</a></li>
@@ -188,54 +182,10 @@
</div>
<h2 class="methods">attribute methods</h2>
<div class="sig">
- <h3 id="alpha">alpha</h3>
-
- <p><span class="arg">img</span>.alpha = <span class=
- "arg">type</span></p>
- </div>
-
- <div class="desc">
- <h4>Description</h4>
-
- <p>Set a flag to indicate whether or not to use alpha channel
- data. Set-only.</p>
-
- <h4>Arguments</h4>
-
- <p>One of the following values of the AlphaChannelType
- enumeration:</p>
-
- <dl>
- <dt>ActivateAlphaChannel</dt>
-
- <dd>Use alpha channel data. Equivalent to <code>img.matte =
- true</code>.</dd>
-
- <dt>DeactivateAlphaChannel</dt>
-
- <dd>Do not use alpha channel data. Equivalent to
- <code>img.matte = false</code>.</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>See also</h4>
-
- <p><a href="#matte">matte</a></p>
- </div>
-
- <div class="sig">
<h3 id="background_color">background_color</h3>
<p><span class="arg">img.</span>background_color ->
<em>string</em><br />
<span class="arg">img</span>.background_color = <span class=
@@ -377,38 +327,10 @@
<p>A color name.</p>
</div>
<div class="sig">
- <h3 id="bounding_box">bounding_box</h3>
-
- <p><span class="arg">img</span>.bounding_box ->
- <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. Get-only.</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="chromaticity">chromaticity</h3>
<p><span class="arg">img.</span>chromaticity ->
<em>chromaticity</em><br />
<span class="arg">img.</span>chromaticity = <span class=
@@ -1042,65 +964,10 @@
"image1.html#each_profile">each_profile</a>. <a href=
"image3.html#profile_bang">profile!</a></p>
</div>
<div class="sig">
- <h3 id="mask">mask</h3>
-
- <p><span class="arg">img</span>.mask -> <em>image</em> or
- <code>nil</code><br />
- <span class="arg">img.</span>mask = <em>image</em> or
- <em>imagelist</em> or <code>nil</code></p>
- </div>
-
- <div class="desc">
- <h4>Description</h4>
-
- <p>The <code>mask=</code> attribute writer 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="#matte">matte=</a> to specify whether or not
- the mask image has an alpha channel.</p>
-
- <p>The <code>mask</code> attribute reader returns a copy of the
- clip mask. This is <em>not</em> a copy of the mask image that
- was used to create the clip mask, nor is it the clip mask image
- itself. Therefore, modifying the image returned by
- <code>mask</code> does not change the clip mask itself. To
- change the clip mask you must assign a new image to the
- <code>mask=</code> attribute writer.</p>
-
- <h4>Arguments</h4>
-
- <p>If the value is an imagelist, uses the current image as the
- mask image. Assign <code>nil</code> to remove the clip
- mask.</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>
- </div>
-
- <div class="sig">
<h3 id="matte">matte</h3>
<p><span class="arg">img.</span>matte -> <code>true</code>
<em>or</em> <code>false</code><br />
<span class="arg">img.</span>matte = <code>true</code> or
@@ -1112,11 +979,11 @@
<p>If <code>true</code>, honor the opacity values in the image
pixels. See <a href="struct.html#Pixel">Pixel</a>.</p>
<p>This attribute is deprecated in ImageMagick 6.3.5 and later.
- Use <a href="#alpha">alpha</a> instead.</p>
+ Use <a href="image1.html#alpha">alpha</a> instead.</p>
</div>
<div class="sig">
<h3 id="mean_error_per_pixel">mean_error_per_pixel</h3>
@@ -1540,10 +1407,10 @@
<div class="sig">
<h3 id="ticks_per_second">ticks_per_second</h3>
<p><span class="arg">img.</span>ticks_per_second ->
<em>integer</em><br />
- <span class="arg">iamge.</span>ticks_per_second = <span class=
+ <span class="arg">image.</span>ticks_per_second = <span class=
"arg">integer</span></p>
</div>
<div class="desc">
<h4>Description</h4>